diff --git a/.gitignore b/.gitignore index b044fc2c8..d2a57a1fe 100644 --- a/.gitignore +++ b/.gitignore @@ -18,3 +18,4 @@ application-dev-localhost.yaml server/api-service/lowcoder-server/src/main/resources/application-local-dev.yaml translations/locales/node_modules/ server/api-service/lowcoder-server/src/main/resources/application-local-dev-ee.yaml +node_modules diff --git a/README.md b/README.md index 6ba2fff86..ede4bcc29 100644 --- a/README.md +++ b/README.md @@ -7,15 +7,22 @@ <p> Create software applications (internal and customer-facing!) and Meeting/Collaboration tools for your Company and your Customers with minimal coding experience. </p> - <h3 style="margin-top: 0">Lowcoder is the best Retool, Appsmith or Tooljet Alternative.</h3> + <h3 style="margin-top: 0">We think, Lowcoder is simply better than Retool, Appsmith Tooljet, Outsystems or Mendix.</h3> </div> +--- -<img src="https://1167272343-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FjNgeI0mUzgw6Re92iTOw%2Fuploads%2FnwXJC1XBqP2MvTQitPyo%2FApp%20Editor%20%7C%20Main%20Screeen%20clean.png?alt=media&token=e5fba81b-82a7-4c0e-a15d-baa781d5b13a"/> - +## 🎥 Lowcoder Intro Video +<div align="center"> + <a href="https://www.youtube.com/watch?v=AQo0iFWUWiU" target="_blank"> + <img src="https://img.youtube.com/vi/AQo0iFWUWiU/maxresdefault.jpg" alt="Lowcoder Intro Video" width="100%"> + </a> + <p><i>Click the image above to watch the video on YouTube</i> 📺</p> +</div> +--- ## 📢 Use Lowcoder in 3 steps 1. Connect to any data sources or APIs. -2. Build flexible and responsive UI with 100+ components and free layout / design possibilities. +2. Build flexible and responsive UI with 120+ components and free layout / design possibilities. 3. Share with colleagues and customers. ## 💡 Why Lowcoder @@ -23,9 +30,9 @@ One platform for everything instead so many different softwares. (like Website B It's cumbersome to create a single app. You had to design user interfaces, write code in multiple languages and frameworks, and understand how all of that code works together. -NewGen Lowcode Platforms like Retool and others are great for their simplicity and flexibility - like Lowcoder too, but they can also be limited in different ways, especially when it comes to "external" applications for everyone. +NewGen Lowcode Platforms like Retool and others are great for their simplicity and flexibility - like Lowcoder too, but they can also be limited in different ways, especially when it comes to "external" applications for everyone - because their pricing focusses to internal apps and "pay per User". -Lowcoder wants to take a step forward. More specifically, Lowcoder is: +With Lowcoder we did a step forward. More specifically, Lowcoder is: - An all-in-one IDE to create internal or customer-facing (external) apps. - A place to create, build and share building blocks of web applications and whole websites. - The tool and community to support your business, and lower the cost and time to develop interactive applications. @@ -34,9 +41,9 @@ Lowcoder wants to take a step forward. More specifically, Lowcoder is: - The only platform which has extensibility plugin architecture [Check Community Contributions](https://www.npmjs.com/search?q=lowcoder-comp) ## 🪄 Features -- **Visual UI builder** with 100+ built-in components. Save 90% of time to build apps. +- **Visual UI builder** with 120+ built-in components. Save 90% of time to build apps. - **Modules** for reusable (!) embedable component sets in the UI builder. -- **Embed Lowcoder Apps as native parts of any Website** instead of iFrame (!). [Demo](https://lowcoder.cloud/about), [Docu](https://docs.lowcoder.cloud/lowcoder-documentation/lowcoder-extension/native-embed-sdk) +- **Embed Lowcoder Apps as native parts of any Website** instead of iFrame (!). [Demo](http://demo-lowcoder.42web.io/ecommerce/), [Docu](https://docs.lowcoder.cloud/lowcoder-documentation/lowcoder-extension/native-embed-sdk) - **Video Meeting Components** to create your own individual Web-Meeting tool. - **Query Library** for reusable data queries of your data sources. - **Custom components** to develop own components and use them in the UI builder. @@ -107,7 +114,3 @@ Accelerate the growth of Lowcoder and unleash its potential with your Sponsorshi [Be a Sponsor](https://github.com/sponsors/lowcoder-org) Like ... [@Darkjamin](https://github.com/Darkjamin), [@spacegoats-io](https://github.com/spacegoats-io), [@Jomedya](https://github.com/Jomedya), [@CHSchuepfer](https://github.com/CHSchuepfer), Thank you very much!! - -## Intro Video - -[](https://youtu.be/s4ltAqS0hzM?feature=shared) diff --git a/client/VERSION b/client/VERSION index bd4053bfb..e46a05b19 100644 --- a/client/VERSION +++ b/client/VERSION @@ -1 +1 @@ -2.6.3 \ No newline at end of file +2.6.4 \ No newline at end of file diff --git a/client/config/test/transform/babelTransform.js b/client/config/test/transform/babelTransform.js index 703cac21a..36f6cf0d8 100644 --- a/client/config/test/transform/babelTransform.js +++ b/client/config/test/transform/babelTransform.js @@ -8,6 +8,13 @@ export default babelJest.createTransformer({ runtime: "automatic", }, ], + [ + "babel-preset-vite", + { + "env": true, + "glob": false + } + ] ], babelrc: false, configFile: false, diff --git a/client/package.json b/client/package.json index e84c1dbea..f8a736710 100644 --- a/client/package.json +++ b/client/package.json @@ -1,6 +1,6 @@ { "name": "lowcoder-frontend", - "version": "2.6.3", + "version": "2.6.4", "type": "module", "private": true, "workspaces": [ @@ -43,6 +43,7 @@ "add": "^2.0.6", "babel-jest": "^29.3.0", "babel-preset-react-app": "^10.0.1", + "babel-preset-vite": "^1.1.3", "husky": "^8.0.1", "jest": "^29.5.0", "jest-canvas-mock": "^2.5.2", diff --git a/client/packages/lowcoder-cli/actions/build.js b/client/packages/lowcoder-cli/actions/build.js index 04e754e99..7ed38e8f5 100644 --- a/client/packages/lowcoder-cli/actions/build.js +++ b/client/packages/lowcoder-cli/actions/build.js @@ -3,6 +3,7 @@ import fsExtra from "fs-extra"; import { build } from "vite"; import { writeFileSync, existsSync, readFileSync, readdirSync } from "fs"; import { resolve } from "path"; +import { pathToFileURL } from "url"; import paths from "../config/paths.js"; import "../util/log.js"; import chalk from "chalk"; @@ -80,7 +81,9 @@ export default async function buildAction(options) { console.log(""); console.cyan("Building..."); - const viteConfig = await import(paths.appViteConfigJs).default; + const viteConfigURL = pathToFileURL(paths.appViteConfigJs); + const viteConfig = await import(viteConfigURL).default; + console.log(paths.appViteConfigJs); await build(viteConfig); // write package.json diff --git a/client/packages/lowcoder-comps/package.json b/client/packages/lowcoder-comps/package.json index 7cf6fc1af..4fb56a02f 100644 --- a/client/packages/lowcoder-comps/package.json +++ b/client/packages/lowcoder-comps/package.json @@ -1,6 +1,6 @@ { "name": "lowcoder-comps", - "version": "2.6.3", + "version": "2.6.5", "type": "module", "license": "MIT", "dependencies": { @@ -23,6 +23,7 @@ "agora-rtm-sdk": "^1.5.1", "big.js": "^6.2.1", "echarts-extension-gmap": "^1.6.0", + "echarts-gl": "^2.0.9", "echarts-wordcloud": "^2.1.0", "lowcoder-cli": "workspace:^", "lowcoder-sdk": "workspace:^", @@ -58,6 +59,62 @@ "h": 40 } }, + "barChart": { + "name": "Bar Chart", + "icon": "./icons/icon-chart.svg", + "layoutInfo": { + "w": 12, + "h": 40 + } + }, + "lineChart": { + "name": "Line Chart", + "icon": "./icons/icon-chart.svg", + "layoutInfo": { + "w": 12, + "h": 40 + } + }, + "pieChart": { + "name": "Pie Chart", + "icon": "./icons/icon-chart.svg", + "layoutInfo": { + "w": 12, + "h": 40 + } + }, + "scatterChart": { + "name": "Scatter Chart", + "icon": "./icons/icon-chart.svg", + "layoutInfo": { + "w": 12, + "h": 40 + } + }, + "boxplotChart": { + "name": "Boxplot Chart", + "icon": "./icons/icon-chart.svg", + "layoutInfo": { + "w": 12, + "h": 40 + } + }, + "parallelChart": { + "name": "Parallel Chart", + "icon": "./icons/icon-chart.svg", + "layoutInfo": { + "w": 12, + "h": 40 + } + }, + "line3dChart": { + "name": "Line3D Chart", + "icon": "./icons/icon-chart.svg", + "layoutInfo": { + "w": 12, + "h": 40 + } + }, "imageEditor": { "name": "Image Editor", "icon": "./icons/icon-chart.svg", diff --git a/client/packages/lowcoder-comps/src/comps/barChartComp/barChartComp.tsx b/client/packages/lowcoder-comps/src/comps/barChartComp/barChartComp.tsx new file mode 100644 index 000000000..e13818586 --- /dev/null +++ b/client/packages/lowcoder-comps/src/comps/barChartComp/barChartComp.tsx @@ -0,0 +1,320 @@ +import { + changeChildAction, + changeValueAction, + CompAction, + CompActionTypes, + wrapChildAction, +} from "lowcoder-core"; +import { AxisFormatterComp, EchartsAxisType } from "../basicChartComp/chartConfigs/cartesianAxisConfig"; +import { barChartChildrenMap, ChartSize, getDataKeys } from "./barChartConstants"; +import { barChartPropertyView } from "./barChartPropertyView"; +import _ from "lodash"; +import { useContext, useEffect, useMemo, useRef, useState } from "react"; +import ReactResizeDetector from "react-resize-detector"; +import ReactECharts from "../basicChartComp/reactEcharts"; +import { + childrenToProps, + depsConfig, + genRandomKey, + NameConfig, + UICompBuilder, + withDefault, + withExposingConfigs, + withViewFn, + ThemeContext, + chartColorPalette, + getPromiseAfterDispatch, + dropdownControl, + JSONObject, +} from "lowcoder-sdk"; +import { getEchartsLocale, trans } from "i18n/comps"; +import { ItemColorComp } from "comps/basicChartComp/chartConfigs/lineChartConfig"; +import { + echartsConfigOmitChildren, + getEchartsConfig, + getSelectedPoints, +} from "./barChartUtils"; +import 'echarts-extension-gmap'; +import log from "loglevel"; + +let clickEventCallback = () => {}; + +const chartModeOptions = [ + { + label: "ECharts JSON", + value: "json", + } +] as const; + +let BarChartTmpComp = (function () { + return new UICompBuilder({mode:dropdownControl(chartModeOptions,'ui'),...barChartChildrenMap}, () => null) + .setPropertyViewFn(barChartPropertyView) + .build(); +})(); + +BarChartTmpComp = withViewFn(BarChartTmpComp, (comp) => { + const mode = comp.children.mode.getView(); + const onUIEvent = comp.children.onUIEvent.getView(); + const onEvent = comp.children.onEvent.getView(); + const echartsCompRef = useRef<ReactECharts | null>(); + const [chartSize, setChartSize] = useState<ChartSize>(); + const firstResize = useRef(true); + const theme = useContext(ThemeContext); + const defaultChartTheme = { + color: chartColorPalette, + backgroundColor: "#fff", + }; + + let themeConfig = defaultChartTheme; + try { + themeConfig = theme?.theme.chart ? JSON.parse(theme?.theme.chart) : defaultChartTheme; + } catch (error) { + log.error('theme chart error: ', error); + } + + const triggerClickEvent = async (dispatch: any, action: CompAction<JSONValue>) => { + await getPromiseAfterDispatch( + dispatch, + action, + { autoHandleAfterReduce: true } + ); + onEvent('click'); + } + + useEffect(() => { + const echartsCompInstance = echartsCompRef?.current?.getEchartsInstance(); + if (!echartsCompInstance) { + return _.noop; + } + echartsCompInstance?.on("click", (param: any) => { + document.dispatchEvent(new CustomEvent("clickEvent", { + bubbles: true, + detail: { + action: 'click', + data: param.data, + } + })); + triggerClickEvent( + comp.dispatch, + changeChildAction("lastInteractionData", param.data, false) + ); + }); + return () => { + echartsCompInstance?.off("click"); + document.removeEventListener('clickEvent', clickEventCallback) + }; + }, []); + + useEffect(() => { + // bind events + const echartsCompInstance = echartsCompRef?.current?.getEchartsInstance(); + if (!echartsCompInstance) { + return _.noop; + } + echartsCompInstance?.on("selectchanged", (param: any) => { + const option: any = echartsCompInstance?.getOption(); + document.dispatchEvent(new CustomEvent("clickEvent", { + bubbles: true, + detail: { + action: param.fromAction, + data: getSelectedPoints(param, option) + } + })); + + if (param.fromAction === "select") { + comp.dispatch(changeChildAction("selectedPoints", getSelectedPoints(param, option), false)); + onUIEvent("select"); + } else if (param.fromAction === "unselect") { + comp.dispatch(changeChildAction("selectedPoints", getSelectedPoints(param, option), false)); + onUIEvent("unselect"); + } + + triggerClickEvent( + comp.dispatch, + changeChildAction("lastInteractionData", getSelectedPoints(param, option), false) + ); + }); + // unbind + return () => { + echartsCompInstance?.off("selectchanged"); + document.removeEventListener('clickEvent', clickEventCallback) + }; + }, [onUIEvent]); + + const echartsConfigChildren = _.omit(comp.children, echartsConfigOmitChildren); + const childrenProps = childrenToProps(echartsConfigChildren); + const option = useMemo(() => { + return getEchartsConfig( + childrenProps as ToViewReturn<typeof echartsConfigChildren>, + chartSize, + themeConfig + ); + }, [theme, childrenProps, chartSize, ...Object.values(echartsConfigChildren)]); + + useEffect(() => { + comp.children.mapInstance.dispatch(changeValueAction(null, false)) + if(comp.children.mapInstance.value) return; + }, [option]) + + return ( + <ReactResizeDetector + onResize={(w, h) => { + if (w && h) { + setChartSize({ w: w, h: h }); + } + if (!firstResize.current) { + // ignore the first resize, which will impact the loading animation + echartsCompRef.current?.getEchartsInstance().resize(); + } else { + firstResize.current = false; + } + }} + > + <ReactECharts + ref={(e) => (echartsCompRef.current = e)} + style={{ height: "100%" }} + notMerge + lazyUpdate + opts={{ locale: getEchartsLocale() }} + option={option} + mode={mode} + /> + </ReactResizeDetector> + ); +}); + +function getYAxisFormatContextValue( + data: Array<JSONObject>, + yAxisType: EchartsAxisType, + yAxisName?: string +) { + const dataSample = yAxisName && data.length > 0 && data[0][yAxisName]; + let contextValue = dataSample; + if (yAxisType === "time") { + // to timestamp + const time = + typeof dataSample === "number" || typeof dataSample === "string" + ? new Date(dataSample).getTime() + : null; + if (time) contextValue = time; + } + return contextValue; +} + +BarChartTmpComp = class extends BarChartTmpComp { + private lastYAxisFormatContextVal?: JSONValue; + private lastColorContext?: JSONObject; + + updateContext(comp: this) { + // the context value of axis format + let resultComp = comp; + const data = comp.children.data.getView(); + const sampleSeries = comp.children.series.getView().find((s) => !s.getView().hide); + const yAxisContextValue = getYAxisFormatContextValue( + data, + comp.children.yConfig.children.yAxisType.getView(), + sampleSeries?.children.columnName.getView() + ); + if (yAxisContextValue !== comp.lastYAxisFormatContextVal) { + comp.lastYAxisFormatContextVal = yAxisContextValue; + resultComp = comp.setChild( + "yConfig", + comp.children.yConfig.reduce( + wrapChildAction( + "formatter", + AxisFormatterComp.changeContextDataAction({ value: yAxisContextValue }) + ) + ) + ); + } + // item color context + const colorContextVal = { + seriesName: sampleSeries?.children.seriesName.getView(), + value: yAxisContextValue, + }; + if ( + comp.children.chartConfig.children.comp.children.hasOwnProperty("itemColor") && + !_.isEqual(colorContextVal, comp.lastColorContext) + ) { + comp.lastColorContext = colorContextVal; + resultComp = resultComp.setChild( + "chartConfig", + comp.children.chartConfig.reduce( + wrapChildAction( + "comp", + wrapChildAction("itemColor", ItemColorComp.changeContextDataAction(colorContextVal)) + ) + ) + ); + } + return resultComp; + } + + override reduce(action: CompAction): this { + const comp = super.reduce(action); + if (action.type === CompActionTypes.UPDATE_NODES_V2) { + const newData = comp.children.data.getView(); + // data changes + if (comp.children.data !== this.children.data) { + setTimeout(() => { + // update x-axis value + const keys = getDataKeys(newData); + if (keys.length > 0 && !keys.includes(comp.children.xAxisKey.getView())) { + comp.children.xAxisKey.dispatch(changeValueAction(keys[0] || "")); + } + // pass to child series comp + comp.children.series.dispatchDataChanged(newData); + }, 0); + } + return this.updateContext(comp); + } + return comp; + } + + override autoHeight(): boolean { + return false; + } +}; + +let BarChartComp = withExposingConfigs(BarChartTmpComp, [ + depsConfig({ + name: "selectedPoints", + desc: trans("chart.selectedPointsDesc"), + depKeys: ["selectedPoints"], + func: (input) => { + return input.selectedPoints; + }, + }), + depsConfig({ + name: "lastInteractionData", + desc: trans("chart.lastInteractionDataDesc"), + depKeys: ["lastInteractionData"], + func: (input) => { + return input.lastInteractionData; + }, + }), + depsConfig({ + name: "data", + desc: trans("chart.dataDesc"), + depKeys: ["data", "mode"], + func: (input) =>[] , + }), + new NameConfig("title", trans("chart.titleDesc")), +]); + + +export const BarChartCompWithDefault = withDefault(BarChartComp, { + xAxisKey: "date", + series: [ + { + dataIndex: genRandomKey(), + seriesName: trans("chart.spending"), + columnName: "spending", + }, + { + dataIndex: genRandomKey(), + seriesName: trans("chart.budget"), + columnName: "budget", + }, + ], +}); diff --git a/client/packages/lowcoder-comps/src/comps/barChartComp/barChartConstants.tsx b/client/packages/lowcoder-comps/src/comps/barChartComp/barChartConstants.tsx new file mode 100644 index 000000000..668b569be --- /dev/null +++ b/client/packages/lowcoder-comps/src/comps/barChartComp/barChartConstants.tsx @@ -0,0 +1,323 @@ +import { + jsonControl, + JSONObject, + stateComp, + toJSONObjectArray, + toObject, + BoolControl, + withDefault, + StringControl, + NumberControl, + FunctionControl, + dropdownControl, + eventHandlerControl, + valueComp, + withType, + uiChildren, + clickEvent, + styleControl, + EchartDefaultTextStyle, + EchartDefaultChartStyle, + toArray +} from "lowcoder-sdk"; +import { RecordConstructorToComp, RecordConstructorToView } from "lowcoder-core"; +import { BarChartConfig } from "../basicChartComp/chartConfigs/barChartConfig"; +import { XAxisConfig, YAxisConfig } from "../basicChartComp/chartConfigs/cartesianAxisConfig"; +import { LegendConfig } from "../basicChartComp/chartConfigs/legendConfig"; +import { EchartsLegendConfig } from "../basicChartComp/chartConfigs/echartsLegendConfig"; +import { EchartsLabelConfig } from "../basicChartComp/chartConfigs/echartsLabelConfig"; +import { LineChartConfig } from "../basicChartComp/chartConfigs/lineChartConfig"; +import { PieChartConfig } from "../basicChartComp/chartConfigs/pieChartConfig"; +import { ScatterChartConfig } from "../basicChartComp/chartConfigs/scatterChartConfig"; +import { SeriesListComp } from "./seriesComp"; +import { EChartsOption } from "echarts"; +import { i18nObjs, trans } from "i18n/comps"; +import { GaugeChartConfig } from "../basicChartComp/chartConfigs/gaugeChartConfig"; +import { FunnelChartConfig } from "../basicChartComp/chartConfigs/funnelChartConfig"; +import {EchartsTitleVerticalConfig} from "../chartComp/chartConfigs/echartsTitleVerticalConfig"; +import {EchartsTitleConfig} from "../basicChartComp/chartConfigs/echartsTitleConfig"; + +export const ChartTypeOptions = [ + { + label: trans("chart.bar"), + value: "bar", + }, + { + label: trans("chart.line"), + value: "line", + }, + { + label: trans("chart.scatter"), + value: "scatter", + }, + { + label: trans("chart.pie"), + value: "pie", + }, +] as const; + +export const UIEventOptions = [ + { + label: trans("chart.select"), + value: "select", + description: trans("chart.selectDesc"), + }, + { + label: trans("chart.unSelect"), + value: "unselect", + description: trans("chart.unselectDesc"), + }, +] as const; + +export const MapEventOptions = [ + { + label: trans("chart.mapReady"), + value: "mapReady", + description: trans("chart.mapReadyDesc"), + }, + { + label: trans("chart.zoomLevelChange"), + value: "zoomLevelChange", + description: trans("chart.zoomLevelChangeDesc"), + }, + { + label: trans("chart.centerPositionChange"), + value: "centerPositionChange", + description: trans("chart.centerPositionChangeDesc"), + }, +] as const; + +export const XAxisDirectionOptions = [ + { + label: trans("chart.horizontal"), + value: "horizontal", + }, + { + label: trans("chart.vertical"), + value: "vertical", + }, +] as const; + +export type XAxisDirectionType = ValueFromOption<typeof XAxisDirectionOptions>; + +export const noDataAxisConfig = { + animation: false, + xAxis: { + type: "category", + name: trans("chart.noData"), + nameLocation: "middle", + data: [], + axisLine: { + lineStyle: { + color: "#8B8FA3", + }, + }, + }, + yAxis: { + type: "value", + axisLabel: { + color: "#8B8FA3", + }, + splitLine: { + lineStyle: { + color: "#F0F0F0", + }, + }, + }, + tooltip: { + show: false, + }, + series: [ + { + data: [700], + type: "line", + itemStyle: { + opacity: 0, + }, + }, + ], +} as EChartsOption; + +export const noDataPieChartConfig = { + animation: false, + tooltip: { + show: false, + }, + legend: { + formatter: trans("chart.unknown"), + top: "bottom", + selectedMode: false, + }, + color: ["#B8BBCC", "#CED0D9", "#DCDEE6", "#E6E6EB"], + series: [ + { + type: "pie", + radius: "35%", + center: ["25%", "50%"], + silent: true, + label: { + show: false, + }, + data: [ + { + name: "1", + value: 70, + }, + { + name: "2", + value: 68, + }, + { + name: "3", + value: 48, + }, + { + name: "4", + value: 40, + }, + ], + }, + { + type: "pie", + radius: "35%", + center: ["75%", "50%"], + silent: true, + label: { + show: false, + }, + data: [ + { + name: "1", + value: 70, + }, + { + name: "2", + value: 68, + }, + { + name: "3", + value: 48, + }, + { + name: "4", + value: 40, + }, + ], + }, + ], +} as EChartsOption; + +export type ChartSize = { w: number; h: number }; + +export const getDataKeys = (data: Array<JSONObject>) => { + if (!data) { + return []; + } + const dataKeys: Array<string> = []; + data.slice(0, 50).forEach((d) => { + Object.keys(d).forEach((key) => { + if (!dataKeys.includes(key)) { + dataKeys.push(key); + } + }); + }); + return dataKeys; +}; + +const ChartOptionMap = { + bar: BarChartConfig, + line: LineChartConfig, + pie: PieChartConfig, + scatter: ScatterChartConfig, +}; + +const EchartsOptionMap = { + funnel: FunnelChartConfig, + gauge: GaugeChartConfig, +}; + +const ChartOptionComp = withType(ChartOptionMap, "bar"); +const EchartsOptionComp = withType(EchartsOptionMap, "funnel"); +export type CharOptionCompType = keyof typeof ChartOptionMap; + +export const chartUiModeChildren = { + title: withDefault(StringControl, trans("echarts.defaultTitle")), + data: jsonControl(toJSONObjectArray, i18nObjs.defaultDataSource), + xAxisKey: valueComp<string>(""), // x-axis, key from data + xAxisDirection: dropdownControl(XAxisDirectionOptions, "horizontal"), + xAxisData: jsonControl(toArray, []), + series: SeriesListComp, + xConfig: XAxisConfig, + yConfig: YAxisConfig, + legendConfig: LegendConfig, + chartConfig: ChartOptionComp, + onUIEvent: eventHandlerControl(UIEventOptions), +}; + +let chartJsonModeChildren: any = { + echartsOption: jsonControl(toObject, i18nObjs.defaultEchartsJsonOption), + echartsTitle: withDefault(StringControl, trans("echarts.defaultTitle")), + echartsLegendConfig: EchartsLegendConfig, + echartsLabelConfig: EchartsLabelConfig, + echartsConfig: EchartsOptionComp, + echartsTitleVerticalConfig: EchartsTitleVerticalConfig, + echartsTitleConfig:EchartsTitleConfig, + + left:withDefault(NumberControl,trans('chart.defaultLeft')), + right:withDefault(NumberControl,trans('chart.defaultRight')), + top:withDefault(NumberControl,trans('chart.defaultTop')), + bottom:withDefault(NumberControl,trans('chart.defaultBottom')), + + tooltip: withDefault(BoolControl, true), + legendVisibility: withDefault(BoolControl, true), +} +if (EchartDefaultChartStyle && EchartDefaultTextStyle) { + chartJsonModeChildren = { + ...chartJsonModeChildren, + chartStyle: styleControl(EchartDefaultChartStyle, 'chartStyle'), + titleStyle: styleControl(EchartDefaultTextStyle, 'titleStyle'), + xAxisStyle: styleControl(EchartDefaultTextStyle, 'xAxis'), + yAxisStyle: styleControl(EchartDefaultTextStyle, 'yAxisStyle'), + legendStyle: styleControl(EchartDefaultTextStyle, 'legendStyle'), + } +} + +const chartMapModeChildren = { + mapInstance: stateComp(), + getMapInstance: FunctionControl, + mapApiKey: withDefault(StringControl, ''), + mapZoomLevel: withDefault(NumberControl, 3), + mapCenterLng: withDefault(NumberControl, 15.932644), + mapCenterLat: withDefault(NumberControl, 50.942063), + mapOptions: jsonControl(toObject, i18nObjs.defaultMapJsonOption), + onMapEvent: eventHandlerControl(MapEventOptions), + showCharts: withDefault(BoolControl, true), +} + +export type UIChartDataType = { + seriesName: string; + // coordinate chart + x?: any; + y?: any; + // pie or funnel + itemName?: any; + value?: any; +}; + +export type NonUIChartDataType = { + name: string; + value: any; +} + +export const barChartChildrenMap = { + selectedPoints: stateComp<Array<UIChartDataType>>([]), + lastInteractionData: stateComp<Array<UIChartDataType> | NonUIChartDataType>({}), + onEvent: eventHandlerControl([clickEvent] as const), + ...chartUiModeChildren, + ...chartJsonModeChildren, + ...chartMapModeChildren, +}; + +const chartUiChildrenMap = uiChildren(barChartChildrenMap); +export type ChartCompPropsType = RecordConstructorToView<typeof chartUiChildrenMap>; +export type ChartCompChildrenType = RecordConstructorToComp<typeof chartUiChildrenMap>; diff --git a/client/packages/lowcoder-comps/src/comps/barChartComp/barChartPropertyView.tsx b/client/packages/lowcoder-comps/src/comps/barChartComp/barChartPropertyView.tsx new file mode 100644 index 000000000..5f3d41879 --- /dev/null +++ b/client/packages/lowcoder-comps/src/comps/barChartComp/barChartPropertyView.tsx @@ -0,0 +1,150 @@ +import { changeChildAction, CompAction } from "lowcoder-core"; +import { ChartCompChildrenType, ChartTypeOptions,getDataKeys } from "./barChartConstants"; +import { newSeries } from "./seriesComp"; +import { + CustomModal, + Dropdown, + hiddenPropertyView, + Option, + RedButton, + Section, + sectionNames, + controlItem, +} from "lowcoder-sdk"; +import { trans } from "i18n/comps"; + +export function barChartPropertyView( + children: ChartCompChildrenType, + dispatch: (action: CompAction) => void +) { + const series = children.series.getView(); + const columnOptions = getDataKeys(children.data.getView()).map((key) => ({ + label: key, + value: key, + })); + + const uiModePropertyView = ( + <> + <Section name={trans("chart.data")}> + {children.chartConfig.getPropertyView()} + <Dropdown + value={children.xAxisKey.getView()} + options={columnOptions} + label={trans("chart.xAxis")} + onChange={(value) => { + dispatch(changeChildAction("xAxisKey", value)); + }} + /> + {children.chartConfig.getView().subtype === "waterfall" && children.xAxisData.propertyView({ + label: "X-Label-Data" + })} + <Option + items={series} + title={trans("chart.chartSeries")} + itemTitle={(s) => s.getView().seriesName} + popoverTitle={(s) => s.getView().columnName} + content={(s, index) => ( + <> + {s.getPropertyViewWithData(columnOptions)} + { + <RedButton + onClick={() => { + CustomModal.confirm({ + title: trans("chart.delete"), + content: trans("chart.confirmDelete") + `${s.getView().seriesName}?`, + onConfirm: () => + children.series.dispatch(children.series.deleteAction(index)), + confirmBtnType: "delete", + okText: trans("chart.delete"), + }); + }} + > + {trans("chart.delete")} + </RedButton> + } + </> + )} + onAdd={() => { + if (columnOptions.length <= 0) { + return; + } + children.series.dispatch( + children.series.pushAction( + newSeries(trans("chart.customSeries"), columnOptions[0].value) + ) + ); + }} + onMove={(fromIndex, toIndex) => { + const action = children.series.arrayMoveAction(fromIndex, toIndex); + children.series.dispatch(action); + }} + hide={(s) => s.getView().hide} + onHide={(s, hide) => s.children.hide.dispatchChangeValueAction(hide)} + dataIndex={(s) => s.getView().dataIndex} + /> + </Section> + <Section name={sectionNames.interaction}> + <div style={{display: 'flex', flexDirection: 'column', gap: '8px'}}> + {children.onUIEvent.propertyView({title: trans("chart.chartEventHandlers")})} + </div> + <div style={{display: 'flex', flexDirection: 'column', gap: '8px'}}> + {children.onEvent.propertyView()} + </div> + </Section> + <Section name={sectionNames.layout}> + {children.echartsTitleConfig.getPropertyView()} + {children.echartsTitleVerticalConfig.getPropertyView()} + {children.legendConfig.getPropertyView()} + {children.title.propertyView({ label: trans("chart.title") })} + {children.left.propertyView({ label: trans("chart.left"), tooltip: trans("echarts.leftTooltip") })} + {children.right.propertyView({ label: trans("chart.right"), tooltip: trans("echarts.rightTooltip") })} + {children.top.propertyView({ label: trans("chart.top"), tooltip: trans("echarts.topTooltip") })} + {children.bottom.propertyView({ label: trans("chart.bottom"), tooltip: trans("echarts.bottomTooltip") })} + {children.chartConfig.children.compType.getView() !== "pie" && ( + <> + {children.xAxisDirection.propertyView({ + label: trans("chart.xAxisDirection"), + radioButton: true, + })} + {children.xConfig.getPropertyView()} + {children.yConfig.getPropertyView()} + </> + )} + {hiddenPropertyView(children)} + {children.tooltip.propertyView({label: trans("echarts.tooltip"), tooltip: trans("echarts.tooltipTooltip")})} + </Section> + <Section name={sectionNames.chartStyle}> + {children.chartStyle?.getPropertyView()} + </Section> + <Section name={sectionNames.titleStyle}> + {children.titleStyle?.getPropertyView()} + </Section> + <Section name={sectionNames.xAxisStyle}> + {children.xAxisStyle?.getPropertyView()} + </Section> + <Section name={sectionNames.yAxisStyle}> + {children.yAxisStyle?.getPropertyView()} + </Section> + <Section name={sectionNames.legendStyle}> + {children.legendStyle?.getPropertyView()} + </Section> + <Section name={sectionNames.advanced}> + {children.data.propertyView({ + label: trans("chart.data"), + })} + </Section> + </> + ); + + const getChatConfigByMode = (mode: string) => { + switch(mode) { + case "ui": + return uiModePropertyView; + } + } + return ( + <> + {getChatConfigByMode(children.mode.getView())} + </> + ); +} diff --git a/client/packages/lowcoder-comps/src/comps/barChartComp/barChartUtils.ts b/client/packages/lowcoder-comps/src/comps/barChartComp/barChartUtils.ts new file mode 100644 index 000000000..72abe79f7 --- /dev/null +++ b/client/packages/lowcoder-comps/src/comps/barChartComp/barChartUtils.ts @@ -0,0 +1,396 @@ +import { + CharOptionCompType, + ChartCompPropsType, + ChartSize, + noDataAxisConfig, + noDataPieChartConfig, +} from "comps/barChartComp/barChartConstants"; +import { getPieRadiusAndCenter } from "comps/basicChartComp/chartConfigs/pieChartConfig"; +import { EChartsOptionWithMap } from "../basicChartComp/reactEcharts/types"; +import _ from "lodash"; +import { chartColorPalette, isNumeric, JSONObject, loadScript } from "lowcoder-sdk"; +import { calcXYConfig } from "comps/basicChartComp/chartConfigs/cartesianAxisConfig"; +import Big from "big.js"; +import { googleMapsApiUrl } from "../basicChartComp/chartConfigs/chartUrls"; +import opacityToHex from "../../util/opacityToHex"; +import parseBackground from "../../util/gradientBackgroundColor"; +import {ba} from "@fullcalendar/core/internal-common"; +import {chartStyleWrapper, styleWrapper} from "../../util/styleWrapper"; + +export function transformData( + originData: JSONObject[], + xAxis: string, + seriesColumnNames: string[] +) { + // aggregate data by x-axis + const transformedData: JSONObject[] = []; + originData.reduce((prev, cur) => { + if (cur === null || cur === undefined) { + return prev; + } + const groupValue = cur[xAxis] as string; + if (!prev[groupValue]) { + // init as 0 + const initValue: any = {}; + seriesColumnNames.forEach((name) => { + initValue[name] = 0; + }); + prev[groupValue] = initValue; + transformedData.push(prev[groupValue]); + } + // remain the x-axis data + prev[groupValue][xAxis] = groupValue; + seriesColumnNames.forEach((key) => { + if (key === xAxis) { + return; + } else if (isNumeric(cur[key])) { + const bigNum = Big(cur[key]); + prev[groupValue][key] = bigNum.add(prev[groupValue][key]).toNumber(); + } else { + prev[groupValue][key] += 1; + } + }); + return prev; + }, {} as any); + return transformedData; +} + +const notAxisChartSet: Set<CharOptionCompType> = new Set(["pie"] as const); +const notAxisChartSubtypeSet: Set<string> = new Set(["polar"] as const); +export const echartsConfigOmitChildren = [ + "hidden", + "selectedPoints", + "onUIEvent", + "mapInstance" +] as const; +type EchartsConfigProps = Omit<ChartCompPropsType, typeof echartsConfigOmitChildren[number]>; + + +export function isAxisChart(type: CharOptionCompType, subtype: string) { + return !notAxisChartSet.has(type) && !notAxisChartSubtypeSet.has(subtype); +} + +export function getSeriesConfig(props: EchartsConfigProps) { + let visibleSeries = props.series.filter((s) => !s.getView().hide); + if(props.chartConfig.subtype === "waterfall") { + const seriesOn = visibleSeries[0]; + const seriesPlaceholder = visibleSeries[0]; + visibleSeries = [seriesPlaceholder, seriesOn]; + } + const seriesLength = visibleSeries.length; + return visibleSeries.map((s, index) => { + if (isAxisChart(props.chartConfig.type, props.chartConfig.subtype)) { + let encodeX: string, encodeY: string; + const horizontalX = props.xAxisDirection === "horizontal"; + let itemStyle = props.chartConfig.itemStyle; + // FIXME: need refactor... chartConfig returns a function with paramters + if (props.chartConfig.type === "bar") { + // barChart's border radius, depend on x-axis direction and stack state + const borderRadius = horizontalX ? [2, 2, 0, 0] : [0, 2, 2, 0]; + if (props.chartConfig.stack && index === visibleSeries.length - 1) { + itemStyle = { ...itemStyle, borderRadius: borderRadius }; + } else if (!props.chartConfig.stack) { + itemStyle = { ...itemStyle, borderRadius: borderRadius }; + } + + if(props.chartConfig.subtype === "waterfall" && index === 0) { + itemStyle = { + borderColor: 'transparent', + color: 'transparent' + } + } + } + if (horizontalX) { + encodeX = props.xAxisKey; + encodeY = s.getView().columnName; + } else { + encodeX = s.getView().columnName; + encodeY = props.xAxisKey; + } + return { + name: props.chartConfig.subtype === "waterfall" && index === 0?" ":s.getView().seriesName, + columnName: props.chartConfig.subtype === "waterfall" && index === 0?" ":s.getView().columnName, + selectedMode: "single", + select: { + itemStyle: { + borderColor: "#000", + }, + }, + encode: { + x: encodeX, + y: encodeY, + }, + // each type of chart's config + ...props.chartConfig, + itemStyle: itemStyle, + label: { + ...props.chartConfig.label, + ...(!horizontalX && { position: "outside" }), + }, + }; + } else { + const radiusAndCenter = getPieRadiusAndCenter(seriesLength, index, props.chartConfig); + return { + ...props.chartConfig, + columnName: s.getView().columnName, + radius: radiusAndCenter.radius, + center: radiusAndCenter.center, + name: s.getView().seriesName, + selectedMode: "single", + encode: { + itemName: props.xAxisKey, + value: s.getView().columnName, + }, + }; + } + }); +} + +// https://echarts.apache.org/en/option.html +export function getEchartsConfig( + props: EchartsConfigProps, + chartSize?: ChartSize, + theme?: any, +): EChartsOptionWithMap { + // axisChart + const axisChart = isAxisChart(props.chartConfig.type, props.chartConfig.subtype); + const gridPos = { + left: `${props?.left}%`, + right: `${props?.right}%`, + bottom: `${props?.bottom}%`, + top: `${props?.top}%`, + }; + let config: any = { + title: { + text: props.title, + top: props.echartsTitleVerticalConfig.top, + left:props.echartsTitleConfig.top, + textStyle: { + ...styleWrapper(props?.titleStyle, theme?.titleStyle) + } + }, + backgroundColor: parseBackground( props?.chartStyle?.background || theme?.chartStyle?.backgroundColor || "#FFFFFF"), + legend: { + ...props.legendConfig, + textStyle: { + ...styleWrapper(props?.legendStyle, theme?.legendStyle, 15) + } + }, + tooltip: props.tooltip && { + trigger: "axis", + axisPointer: { + type: "line", + lineStyle: { + color: "rgba(0,0,0,0.2)", + width: 2, + type: "solid" + } + } + }, + grid: { + ...gridPos, + containLabel: true, + }, + }; + if(props.chartConfig.race) { + config = { + ...config, + // Disable init animation. + animationDuration: 0, + animationDurationUpdate: 2000, + animationEasing: 'linear', + animationEasingUpdate: 'linear', + } + } + if (props.data.length <= 0) { + // no data + return { + ...config, + ...(axisChart ? noDataAxisConfig : noDataPieChartConfig), + }; + } + const yAxisConfig = props.yConfig(); + const seriesColumnNames = props.series + .filter((s) => !s.getView().hide) + .map((s) => s.getView().columnName); + // y-axis is category and time, data doesn't need to aggregate + let transformedData = + yAxisConfig.type === "category" || yAxisConfig.type === "time" ? props.echartsOption.length && props.echartsOption || props.data : transformData(props.echartsOption.length && props.echartsOption || props.data, props.xAxisKey, seriesColumnNames); + + if(props.chartConfig.subtype === "waterfall") { + config.legend = undefined; + let sum = transformedData.reduce((acc, item) => { + if(typeof item[seriesColumnNames[0]] === 'number') return acc + item[seriesColumnNames[0]]; + else return acc; + }, 0) + const total = sum; + transformedData.map(d => { + d[` `] = sum - d[seriesColumnNames[0]]; + sum = d[` `]; + }) + transformedData = [{[" "]: 0, [seriesColumnNames[0]]: total, [props.xAxisKey]: "Total"}, ...transformedData] + } + + if(props.chartConfig.subtype === "polar") { + config = { + ...config, + polar: { + radius: [props.chartConfig.polarData.polarRadiusStart, props.chartConfig.polarData.polarRadiusEnd], + }, + radiusAxis: { + type: props.chartConfig.polarData.polarIsTangent?'category':undefined, + data: props.chartConfig.polarData.polarIsTangent && props.chartConfig.polarData.labelData.length!==0?props.chartConfig.polarData.labelData:undefined, + max: props.chartConfig.polarData.polarIsTangent?undefined:props.chartConfig.polarData.radiusAxisMax || undefined, + }, + angleAxis: { + type: props.chartConfig.polarData.polarIsTangent?undefined:'category', + data: !props.chartConfig.polarData.polarIsTangent && props.chartConfig.polarData.labelData.length!==0?props.chartConfig.polarData.labelData:undefined, + max: props.chartConfig.polarData.polarIsTangent?props.chartConfig.polarData.radiusAxisMax || undefined:undefined, + startAngle: props.chartConfig.polarData.polarStartAngle, + endAngle: props.chartConfig.polarData.polarEndAngle, + }, + } + } + + config = { + ...config, + dataset: [ + { + source: transformedData, + sourceHeader: false, + }, + ], + series: getSeriesConfig(props).map(series => ({ + ...series, + encode: { + ...series.encode, + y: series.name, + }, + itemStyle: { + ...series.itemStyle, + ...chartStyleWrapper(props?.chartStyle, theme?.chartStyle) + }, + lineStyle: { + ...chartStyleWrapper(props?.chartStyle, theme?.chartStyle) + }, + data: transformedData.map((i: any) => i[series.columnName]) + })), + }; + if (axisChart) { + // pure chart's size except the margin around + let chartRealSize; + if (chartSize) { + const rightSize = + typeof gridPos.right === "number" + ? gridPos.right + : (chartSize.w * parseFloat(gridPos.right)) / 100.0; + chartRealSize = { + // actually it's self-adaptive with the x-axis label on the left, not that accurate but work + w: chartSize.w - gridPos.left - rightSize, + // also self-adaptive on the bottom + h: chartSize.h - gridPos.top - gridPos.bottom, + right: rightSize, + }; + } + const finalXyConfig = calcXYConfig( + props.xConfig, + yAxisConfig, + props.xAxisDirection, + transformedData.map((d) => d[props.xAxisKey]), + chartRealSize + ); + config = { + ...config, + // @ts-ignore + xAxis: { + ...finalXyConfig.xConfig, + axisLabel: { + ...styleWrapper(props?.xAxisStyle, theme?.xAxisStyle, 11) + }, + data: finalXyConfig.xConfig.type === "category" && (props.xAxisData as []).length!==0?props?.xAxisData:transformedData.map((i: any) => i[props.xAxisKey]), + }, + // @ts-ignore + yAxis: { + ...finalXyConfig.yConfig, + axisLabel: { + ...styleWrapper(props?.yAxisStyle, theme?.yAxisStyle, 11) + }, + data: finalXyConfig.yConfig.type === "category" && (props.xAxisData as []).length!==0?props?.xAxisData:transformedData.map((i: any) => i[props.xAxisKey]), + }, + }; + + if(props.chartConfig.race) { + config = { + ...config, + xAxis: { + ...config.xAxis, + animationDuration: 300, + animationDurationUpdate: 300 + }, + yAxis: { + ...config.yAxis, + animationDuration: 300, + animationDurationUpdate: 300 + }, + } + } + } + // console.log("Echarts transformedData and config", transformedData, config); + return config; +} + +export function getSelectedPoints(param: any, option: any) { + const series = option.series; + const dataSource = _.isArray(option.dataset) && option.dataset[0]?.source; + if (series && dataSource) { + return param.selected.flatMap((selectInfo: any) => { + const seriesInfo = series[selectInfo.seriesIndex]; + if (!seriesInfo || !seriesInfo.encode) { + return []; + } + return selectInfo.dataIndex.map((index: any) => { + const commonResult = { + seriesName: seriesInfo.name, + }; + if (seriesInfo.encode.itemName && seriesInfo.encode.value) { + return { + ...commonResult, + itemName: dataSource[index][seriesInfo.encode.itemName], + value: dataSource[index][seriesInfo.encode.value], + }; + } else { + return { + ...commonResult, + x: dataSource[index][seriesInfo.encode.x], + y: dataSource[index][seriesInfo.encode.y], + }; + } + }); + }); + } + return []; +} + +export function loadGoogleMapsScript(apiKey: string) { + const mapsUrl = `${googleMapsApiUrl}?key=${apiKey}`; + const scripts = document.getElementsByTagName('script'); + // is script already loaded + let scriptIndex = _.findIndex(scripts, (script) => script.src.endsWith(mapsUrl)); + if(scriptIndex > -1) { + return scripts[scriptIndex]; + } + // is script loaded with diff api_key, remove the script and load again + scriptIndex = _.findIndex(scripts, (script) => script.src.startsWith(googleMapsApiUrl)); + if(scriptIndex > -1) { + scripts[scriptIndex].remove(); + } + + const script = document.createElement("script"); + script.type = "text/javascript"; + script.src = mapsUrl; + script.async = true; + script.defer = true; + window.document.body.appendChild(script); + + return script; +} diff --git a/client/packages/lowcoder-comps/src/comps/barChartComp/seriesComp.tsx b/client/packages/lowcoder-comps/src/comps/barChartComp/seriesComp.tsx new file mode 100644 index 000000000..9ded885b5 --- /dev/null +++ b/client/packages/lowcoder-comps/src/comps/barChartComp/seriesComp.tsx @@ -0,0 +1,119 @@ +import { + BoolControl, + StringControl, + list, + JSONObject, + isNumeric, + genRandomKey, + Dropdown, + OptionsType, + MultiCompBuilder, + valueComp, +} from "lowcoder-sdk"; +import { trans } from "i18n/comps"; + +import { ConstructorToComp, ConstructorToDataType, ConstructorToView } from "lowcoder-core"; +import { CompAction, CustomAction, customAction, isMyCustomAction } from "lowcoder-core"; + +export type SeriesCompType = ConstructorToComp<typeof SeriesComp>; +export type RawSeriesCompType = ConstructorToView<typeof SeriesComp>; +type SeriesDataType = ConstructorToDataType<typeof SeriesComp>; + +type ActionDataType = { + type: "chartDataChanged"; + chartData: Array<JSONObject>; +}; + +export function newSeries(name: string, columnName: string): SeriesDataType { + return { + seriesName: name, + columnName: columnName, + dataIndex: genRandomKey(), + }; +} + +const seriesChildrenMap = { + columnName: StringControl, + seriesName: StringControl, + hide: BoolControl, + // unique key, for sort + dataIndex: valueComp<string>(""), +}; + +const SeriesTmpComp = new MultiCompBuilder(seriesChildrenMap, (props) => { + return props; +}) + .setPropertyViewFn(() => { + return <></>; + }) + .build(); + +class SeriesComp extends SeriesTmpComp { + getPropertyViewWithData(columnOptions: OptionsType): React.ReactNode { + return ( + <> + {this.children.seriesName.propertyView({ + label: trans("chart.seriesName"), + })} + <Dropdown + value={this.children.columnName.getView()} + options={columnOptions} + label={trans("chart.dataColumns")} + onChange={(value) => { + this.children.columnName.dispatchChangeValueAction(value); + }} + /> + </> + ); + } +} + +const SeriesListTmpComp = list(SeriesComp); + +export class SeriesListComp extends SeriesListTmpComp { + override reduce(action: CompAction): this { + if (isMyCustomAction<ActionDataType>(action, "chartDataChanged")) { + // auto generate series + const actions = this.genExampleSeriesActions(action.value.chartData); + return this.reduce(this.multiAction(actions)); + } + return super.reduce(action); + } + + private genExampleSeriesActions(chartData: Array<JSONObject>) { + const actions: CustomAction[] = []; + if (!chartData || chartData.length <= 0 || !chartData[0]) { + return actions; + } + let delCnt = 0; + const existColumns = this.getView().map((s) => s.getView().columnName); + // delete series not in data + existColumns.forEach((columnName) => { + if (chartData[0]?.[columnName] === undefined) { + actions.push(this.deleteAction(0)); + delCnt++; + } + }); + if (existColumns.length > delCnt) { + // don't generate example if exists + return actions; + } + // generate example series + const exampleKeys = Object.keys(chartData[0]) + .filter((key) => { + return !existColumns.includes(key) && isNumeric(chartData[0][key]); + }) + .slice(0, 3); + exampleKeys.forEach((key) => actions.push(this.pushAction(newSeries(key, key)))); + return actions; + } + + dispatchDataChanged(chartData: Array<JSONObject>): void { + this.dispatch( + customAction<ActionDataType>({ + type: "chartDataChanged", + chartData: chartData, + }) + ); + } +} diff --git a/client/packages/lowcoder-comps/src/comps/basicChartComp/chartConfigs/barChartConfig.tsx b/client/packages/lowcoder-comps/src/comps/basicChartComp/chartConfigs/barChartConfig.tsx index 6c91fe252..ee1188335 100644 --- a/client/packages/lowcoder-comps/src/comps/basicChartComp/chartConfigs/barChartConfig.tsx +++ b/client/packages/lowcoder-comps/src/comps/basicChartComp/chartConfigs/barChartConfig.tsx @@ -1,11 +1,19 @@ import { BoolControl, + NumberControl, + StringControl, + withDefault, dropdownControl, MultiCompBuilder, showLabelPropertyView, + ColorControl, + Dropdown, + toArray, + jsonControl, } from "lowcoder-sdk"; +import { changeChildAction, CompAction } from "lowcoder-core"; import { BarSeriesOption } from "echarts"; -import { trans } from "i18n/comps"; +import { i18nObjs, trans } from "i18n/comps"; const BarTypeOptions = [ { @@ -13,8 +21,12 @@ const BarTypeOptions = [ value: "basicBar", }, { - label: trans("chart.stackedBar"), - value: "stackedBar", + label: trans("chart.waterfallBar"), + value: "waterfall", + }, + { + label: trans("chart.polar"), + value: "polar", }, ] as const; @@ -23,27 +35,105 @@ export const BarChartConfig = (function () { { showLabel: BoolControl, type: dropdownControl(BarTypeOptions, "basicBar"), + barWidth: withDefault(NumberControl, i18nObjs.defaultBarChartOption.barWidth), + showBackground: BoolControl, + backgroundColor: withDefault(ColorControl, i18nObjs.defaultBarChartOption.barBg), + radiusAxisMax: NumberControl, + polarRadiusStart: withDefault(StringControl, '30'), + polarRadiusEnd: withDefault(StringControl, '80%'), + polarStartAngle: withDefault(NumberControl, 90), + polarEndAngle: withDefault(NumberControl, -180), + polarIsTangent: withDefault(BoolControl, false), + stack: withDefault(BoolControl, false), + race: withDefault(BoolControl, false), + labelData: jsonControl(toArray, []), }, (props): BarSeriesOption => { const config: BarSeriesOption = { type: "bar", + subtype: props.type, + realtimeSort: props.race, + seriesLayoutBy: props.race?'column':undefined, label: { show: props.showLabel, position: "top", + valueAnimation: props.race, + }, + barWidth: `${props.barWidth}%`, + showBackground: props.showBackground, + backgroundStyle: { + color: props.backgroundColor, }, + polarData: { + radiusAxisMax: props.radiusAxisMax, + polarRadiusStart: props.polarRadiusStart, + polarRadiusEnd: props.polarRadiusEnd, + polarStartAngle: props.polarStartAngle, + polarEndAngle: props.polarEndAngle, + labelData: props.labelData, + polarIsTangent: props.polarIsTangent, + }, + race: props.race, }; - if (props.type === "stackedBar") { + if (props.stack) { config.stack = "stackValue"; } + if (props.type === "waterfall") { + config.label = undefined; + config.stack = "stackValue"; + } + if (props.type === "polar") { + config.coordinateSystem = 'polar'; + } return config; } ) - .setPropertyViewFn((children) => ( + .setPropertyViewFn((children, dispatch: (action: CompAction) => void) => ( <> + <Dropdown + value={children.type.getView()} + options={BarTypeOptions} + label={trans("chart.barType")} + onChange={(value) => { + dispatch(changeChildAction("type", value)); + }} + /> {showLabelPropertyView(children)} - {children.type.propertyView({ - label: trans("chart.barType"), - radioButton: true, + {children.barWidth.propertyView({ + label: trans("barChart.barWidth"), + })} + {children.type.getView() !== "waterfall" && children.race.propertyView({ + label: trans("barChart.race"), + })} + {children.type.getView() !== "waterfall" && children.stack.propertyView({ + label: trans("barChart.stack"), + })} + {children.showBackground.propertyView({ + label: trans("barChart.showBg"), + })} + {children.showBackground.getView() && children.backgroundColor.propertyView({ + label: trans("barChart.bgColor"), + })} + {children.type.getView() === "polar" && children.polarIsTangent.propertyView({ + label: trans("barChart.polarIsTangent"), + })} + {children.type.getView() === "polar" && children.polarStartAngle.propertyView({ + label: trans("barChart.polarStartAngle"), + })} + {children.type.getView() === "polar" && children.polarEndAngle.propertyView({ + label: trans("barChart.polarEndAngle"), + })} + {children.type.getView() === "polar" && children.radiusAxisMax.propertyView({ + label: trans("barChart.radiusAxisMax"), + })} + {children.type.getView() === "polar" && children.polarRadiusStart.propertyView({ + label: trans("barChart.polarRadiusStart"), + })} + {children.type.getView() === "polar" && children.polarRadiusEnd.propertyView({ + label: trans("barChart.polarRadiusEnd"), + })} + {children.type.getView() === "polar" && children.labelData.propertyView({ + label: trans("barChart.polarLabelData"), })} </> )) diff --git a/client/packages/lowcoder-comps/src/comps/basicChartComp/chartConfigs/lineChartConfig.tsx b/client/packages/lowcoder-comps/src/comps/basicChartComp/chartConfigs/lineChartConfig.tsx index 266e5fbf7..1b88d4a06 100644 --- a/client/packages/lowcoder-comps/src/comps/basicChartComp/chartConfigs/lineChartConfig.tsx +++ b/client/packages/lowcoder-comps/src/comps/basicChartComp/chartConfigs/lineChartConfig.tsx @@ -3,28 +3,18 @@ import { MultiCompBuilder, BoolControl, dropdownControl, + jsonControl, + toArray, showLabelPropertyView, withContext, + ColorControl, StringControl, + NumberControl, + withDefault, ColorOrBoolCodeControl, } from "lowcoder-sdk"; import { trans } from "i18n/comps"; -const BarTypeOptions = [ - { - label: trans("chart.basicLine"), - value: "basicLine", - }, - { - label: trans("chart.stackedLine"), - value: "stackedLine", - }, - { - label: trans("chart.areaLine"), - value: "areaLine", - }, -] as const; - export const ItemColorComp = withContext( new MultiCompBuilder({ value: ColorOrBoolCodeControl }, (props) => props.value) .setPropertyViewFn((children) => @@ -38,13 +28,83 @@ export const ItemColorComp = withContext( ["seriesName", "value"] as const ); +export const SymbolOptions = [ + { + label: trans("chart.rect"), + value: "rect", + }, + { + label: trans("chart.circle"), + value: "circle", + }, + { + label: trans("chart.roundRect"), + value: "roundRect", + }, + { + label: trans("chart.triangle"), + value: "triangle", + }, + { + label: trans("chart.diamond"), + value: "diamond", + }, + { + label: trans("chart.pin"), + value: "pin", + }, + { + label: trans("chart.arrow"), + value: "arrow", + }, + { + label: trans("chart.none"), + value: "none", + }, + { + label: trans("chart.emptyCircle"), + value: "emptyCircle", + }, +] as const; + +export const BorderTypeOptions = [ + { + label: trans("lineChart.solid"), + value: "solid", + }, + { + label: trans("lineChart.dashed"), + value: "dashed", + }, + { + label: trans("lineChart.dotted"), + value: "dotted", + }, +] as const; + export const LineChartConfig = (function () { return new MultiCompBuilder( { showLabel: BoolControl, - type: dropdownControl(BarTypeOptions, "basicLine"), + showEndLabel: BoolControl, + stacked: BoolControl, + area: BoolControl, smooth: BoolControl, + polar: BoolControl, itemColor: ItemColorComp, + symbol: dropdownControl(SymbolOptions, "emptyCircle"), + symbolSize: withDefault(NumberControl, 4), + radiusAxisMax: NumberControl, + polarRadiusStart: withDefault(StringControl, '30'), + polarRadiusEnd: withDefault(StringControl, '80%'), + polarStartAngle: withDefault(NumberControl, 90), + polarEndAngle: withDefault(NumberControl, -180), + polarIsTangent: withDefault(BoolControl, false), + labelData: jsonControl(toArray, []), + //series-line.itemStyle + borderColor: ColorControl, + borderWidth: NumberControl, + borderType: dropdownControl(BorderTypeOptions, 'solid'), }, (props): LineSeriesOption => { const config: LineSeriesOption = { @@ -52,15 +112,13 @@ export const LineChartConfig = (function () { label: { show: props.showLabel, }, + symbol: props.symbol, + symbolSize: props.symbolSize, itemStyle: { color: (params) => { - if (!params.encode || !params.dimensionNames) { - return params.color; - } - const dataKey = params.dimensionNames[params.encode["y"][0]]; const color = (props.itemColor as any)({ seriesName: params.seriesName, - value: (params.data as any)[dataKey], + value: params.data, }); if (color === "true") { return "red"; @@ -69,27 +127,96 @@ export const LineChartConfig = (function () { } return color; }, + borderColor: props.borderColor, + borderWidth: props.borderWidth, + borderType: props.borderType, + }, + polarData: { + polar: props.polar, + radiusAxisMax: props.radiusAxisMax, + polarRadiusStart: props.polarRadiusStart, + polarRadiusEnd: props.polarRadiusEnd, + polarStartAngle: props.polarStartAngle, + polarEndAngle: props.polarEndAngle, + labelData: props.labelData, + polarIsTangent: props.polarIsTangent, }, }; - if (props.type === "stackedLine") { + if (props.stacked) { config.stack = "stackValue"; - } else if (props.type === "areaLine") { + } + if (props.area) { config.areaStyle = {}; } if (props.smooth) { config.smooth = true; } + if (props.showEndLabel) { + config.endLabel = { + show: true, + formatter: '{a}', + distance: 20 + } + } + if (props.polar) { + config.coordinateSystem = 'polar'; + } return config; } ) .setPropertyViewFn((children) => ( <> - {children.type.propertyView({ - label: trans("chart.lineType"), + {children.stacked.propertyView({ + label: trans("lineChart.stacked"), + })} + {children.area.propertyView({ + label: trans("lineChart.area"), + })} + {children.polar.propertyView({ + label: trans("lineChart.polar"), + })} + {children.polar.getView() && children.polarIsTangent.propertyView({ + label: trans("barChart.polarIsTangent"), + })} + {children.polar.getView() && children.polarStartAngle.propertyView({ + label: trans("barChart.polarStartAngle"), + })} + {children.polar.getView() && children.polarEndAngle.propertyView({ + label: trans("barChart.polarEndAngle"), + })} + {children.polar.getView() && children.radiusAxisMax.propertyView({ + label: trans("barChart.radiusAxisMax"), + })} + {children.polar.getView() && children.polarRadiusStart.propertyView({ + label: trans("barChart.polarRadiusStart"), + })} + {children.polar.getView() && children.polarRadiusEnd.propertyView({ + label: trans("barChart.polarRadiusEnd"), + })} + {children.polar.getView() && children.labelData.propertyView({ + label: trans("barChart.polarLabelData"), })} {showLabelPropertyView(children)} + {children.showEndLabel.propertyView({ + label: trans("lineChart.showEndLabel"), + })} {children.smooth.propertyView({ label: trans("chart.smooth") })} + {children.symbol.propertyView({ + label: trans("lineChart.symbol"), + })} + {children.symbolSize.propertyView({ + label: trans("lineChart.symbolSize"), + })} {children.itemColor.getPropertyView()} + {children.borderColor.propertyView({ + label: trans("lineChart.borderColor"), + })} + {children.borderWidth.propertyView({ + label: trans("lineChart.borderWidth"), + })} + {children.borderType.propertyView({ + label: trans("lineChart.borderType"), + })} </> )) .build(); diff --git a/client/packages/lowcoder-comps/src/comps/basicChartComp/chartConfigs/pieChartConfig.tsx b/client/packages/lowcoder-comps/src/comps/basicChartComp/chartConfigs/pieChartConfig.tsx index 0861fb6ba..e8781d5c3 100644 --- a/client/packages/lowcoder-comps/src/comps/basicChartComp/chartConfigs/pieChartConfig.tsx +++ b/client/packages/lowcoder-comps/src/comps/basicChartComp/chartConfigs/pieChartConfig.tsx @@ -1,6 +1,11 @@ import { MultiCompBuilder } from "lowcoder-sdk"; import { PieSeriesOption } from "echarts"; -import { dropdownControl } from "lowcoder-sdk"; +import { + dropdownControl, + NumberControl, + StringControl, + withDefault, + } from "lowcoder-sdk"; import { ConstructorToView } from "lowcoder-core"; import { trans } from "i18n/comps"; @@ -17,6 +22,14 @@ const BarTypeOptions = [ label: trans("chart.rosePie"), value: "rosePie", }, + { + label: trans("chart.calendarPie"), + value: "calendarPie", + }, + { + label: trans("chart.geoPie"), + value: "geoPie", + }, ] as const; // radius percent for each pie chart when one line has [1, 2, 3] pie charts @@ -28,20 +41,37 @@ export const PieChartConfig = (function () { return new MultiCompBuilder( { type: dropdownControl(BarTypeOptions, "basicPie"), + cellSize: withDefault(NumberControl, 40), + range: withDefault(StringControl, "2021-09"), + mapUrl: withDefault(StringControl, "https://echarts.apache.org/examples/data/asset/geo/USA.json"), }, (props): PieSeriesOption => { const config: PieSeriesOption = { type: "pie", + subtype: props.type, label: { show: true, formatter: "{d}%", }, + range: props.range, }; if (props.type === "rosePie") { config.roseType = "area"; - } else if (props.type === "doughnutPie") { + } + if (props.type === "doughnutPie") { config.radius = ["40%", "60%"]; } + if (props.type === "calendarPie") { + config.coordinateSystem = 'calendar'; + config.cellSize = [props.cellSize, props.cellSize]; + config.label = { + ...config.label, + position: 'inside' + }; + } + if (props.type === "geoPie") { + config.mapUrl = props.mapUrl; + } return config; } ) @@ -50,6 +80,15 @@ export const PieChartConfig = (function () { {children.type.propertyView({ label: trans("chart.pieType"), })} + {children.type.getView() === "calendarPie" && children.cellSize.propertyView({ + label: trans("lineChart.cellSize"), + })} + {children.type.getView() === "calendarPie" && children.range.propertyView({ + label: trans("lineChart.range"), + })} + {children.type.getView() === "geoPie" && children.mapUrl.propertyView({ + label: trans("pieChart.mapUrl"), + })} </> )) .build(); diff --git a/client/packages/lowcoder-comps/src/comps/basicChartComp/chartConfigs/scatterChartConfig.tsx b/client/packages/lowcoder-comps/src/comps/basicChartComp/chartConfigs/scatterChartConfig.tsx index edb339bdb..34b5f2cb6 100644 --- a/client/packages/lowcoder-comps/src/comps/basicChartComp/chartConfigs/scatterChartConfig.tsx +++ b/client/packages/lowcoder-comps/src/comps/basicChartComp/chartConfigs/scatterChartConfig.tsx @@ -2,6 +2,10 @@ import { MultiCompBuilder, dropdownControl, BoolControl, + StringControl, + NumberControl, + ColorControl, + withDefault, showLabelPropertyView, } from "lowcoder-sdk"; import { ScatterSeriesOption } from "echarts"; @@ -38,7 +42,19 @@ export const ScatterChartConfig = (function () { return new MultiCompBuilder( { showLabel: BoolControl, + labelIndex: withDefault(NumberControl, 2), shape: dropdownControl(ScatterShapeOptions, "circle"), + singleAxis: BoolControl, + boundaryGap: withDefault(BoolControl, true), + visualMap: BoolControl, + visualMapMin: NumberControl, + visualMapMax: NumberControl, + visualMapDimension: NumberControl, + visualMapColorMin: ColorControl, + visualMapColorMax: ColorControl, + polar: BoolControl, + heatmap: BoolControl, + heatmapMonth: withDefault(StringControl, "2021-09"), }, (props): ScatterSeriesOption => { return { @@ -46,16 +62,82 @@ export const ScatterChartConfig = (function () { symbol: props.shape, label: { show: props.showLabel, + position: 'right', + formatter: function (param) { + return param.data[props.labelIndex]; + }, }, + labelLayout: function () { + return { + x: '88%', + moveOverlap: 'shiftY' + }; + }, + labelLine: { + show: true, + length2: 5, + lineStyle: { + color: '#bbb' + } + }, + singleAxis: props.singleAxis, + boundaryGap: props.boundaryGap, + visualMapData: { + visualMap: props.visualMap, + visualMapMin: props.visualMapMin, + visualMapMax: props.visualMapMax, + visualMapDimension: props.visualMapDimension, + visualMapColorMin: props.visualMapColorMin, + visualMapColorMax: props.visualMapColorMax, + }, + polar: props.polar, + heatmap: props.heatmap, + heatmapMonth: props.heatmapMonth, }; } ) .setPropertyViewFn((children) => ( <> {showLabelPropertyView(children)} + {children.showLabel.getView() && children.labelIndex.propertyView({ + label: trans("scatterChart.labelIndex"), + })} + {children.boundaryGap.propertyView({ + label: trans("scatterChart.boundaryGap"), + })} {children.shape.propertyView({ label: trans("chart.scatterShape"), })} + {children.singleAxis.propertyView({ + label: trans("scatterChart.singleAxis"), + })} + {children.visualMap.propertyView({ + label: trans("scatterChart.visualMap"), + })} + {children.visualMap.getView() && children.visualMapMin.propertyView({ + label: trans("scatterChart.visualMapMin"), + })} + {children.visualMap.getView() && children.visualMapMax.propertyView({ + label: trans("scatterChart.visualMapMax"), + })} + {children.visualMap.getView() && children.visualMapDimension.propertyView({ + label: trans("scatterChart.visualMapDimension"), + })} + {children.visualMap.getView() && children.visualMapColorMin.propertyView({ + label: trans("scatterChart.visualMapColorMin"), + })} + {children.visualMap.getView() && children.visualMapColorMax.propertyView({ + label: trans("scatterChart.visualMapColorMax"), + })} + {children.visualMap.getView() && children.heatmap.propertyView({ + label: trans("scatterChart.heatmap"), + })} + {children.visualMap.getView() && children.heatmapMonth.propertyView({ + label: trans("scatterChart.heatmapMonth"), + })} + {children.polar.propertyView({ + label: trans("scatterChart.polar"), + })} </> )) .build(); diff --git a/client/packages/lowcoder-comps/src/comps/basicChartComp/chartUtils.ts b/client/packages/lowcoder-comps/src/comps/basicChartComp/chartUtils.ts index 402011e6c..6c5020690 100644 --- a/client/packages/lowcoder-comps/src/comps/basicChartComp/chartUtils.ts +++ b/client/packages/lowcoder-comps/src/comps/basicChartComp/chartUtils.ts @@ -276,7 +276,7 @@ export function getEchartsConfig( }, }; } - // log.log("Echarts transformedData and config", transformedData, config); + // console.log("Echarts transformedData and config", transformedData, config); return config; } diff --git a/client/packages/lowcoder-comps/src/comps/basicChartComp/reactEcharts/index.ts b/client/packages/lowcoder-comps/src/comps/basicChartComp/reactEcharts/index.ts index dcb57f0f9..da1f165a1 100644 --- a/client/packages/lowcoder-comps/src/comps/basicChartComp/reactEcharts/index.ts +++ b/client/packages/lowcoder-comps/src/comps/basicChartComp/reactEcharts/index.ts @@ -1,4 +1,5 @@ import * as echarts from "echarts"; +import "echarts-gl"; import "echarts-wordcloud"; import { EChartsReactProps, EChartsInstance, EChartsOptionWithMap } from "./types"; import EChartsReactCore from "./core"; diff --git a/client/packages/lowcoder-comps/src/comps/boxplotChartComp/boxplotChartComp.tsx b/client/packages/lowcoder-comps/src/comps/boxplotChartComp/boxplotChartComp.tsx new file mode 100644 index 000000000..8cd1910b1 --- /dev/null +++ b/client/packages/lowcoder-comps/src/comps/boxplotChartComp/boxplotChartComp.tsx @@ -0,0 +1,282 @@ +import { + changeChildAction, + changeValueAction, + CompAction, + CompActionTypes, + wrapChildAction, +} from "lowcoder-core"; +import { AxisFormatterComp, EchartsAxisType } from "../basicChartComp/chartConfigs/cartesianAxisConfig"; +import { boxplotChartChildrenMap, ChartSize, getDataKeys } from "./boxplotChartConstants"; +import { boxplotChartPropertyView } from "./boxplotChartPropertyView"; +import _ from "lodash"; +import { useContext, useEffect, useMemo, useRef, useState } from "react"; +import ReactResizeDetector from "react-resize-detector"; +import ReactECharts from "../basicChartComp/reactEcharts"; +import * as echarts from "echarts"; +import { + childrenToProps, + depsConfig, + genRandomKey, + NameConfig, + UICompBuilder, + withDefault, + withExposingConfigs, + withViewFn, + ThemeContext, + chartColorPalette, + getPromiseAfterDispatch, + dropdownControl, +} from "lowcoder-sdk"; +import { getEchartsLocale, i18nObjs, trans } from "i18n/comps"; +import { + echartsConfigOmitChildren, + getEchartsConfig, + getSelectedPoints, +} from "./boxplotChartUtils"; +import 'echarts-extension-gmap'; +import log from "loglevel"; + +let clickEventCallback = () => {}; + +const chartModeOptions = [ + { + label: "UI", + value: "ui", + } +] as const; + +let BoxplotChartTmpComp = (function () { + return new UICompBuilder({mode:dropdownControl(chartModeOptions,'ui'),...boxplotChartChildrenMap}, () => null) + .setPropertyViewFn(boxplotChartPropertyView) + .build(); +})(); + +BoxplotChartTmpComp = withViewFn(BoxplotChartTmpComp, (comp) => { + const mode = comp.children.mode.getView(); + const onUIEvent = comp.children.onUIEvent.getView(); + const onEvent = comp.children.onEvent.getView(); + const echartsCompRef = useRef<ReactECharts | null>(); + const [chartSize, setChartSize] = useState<ChartSize>(); + const firstResize = useRef(true); + const theme = useContext(ThemeContext); + const defaultChartTheme = { + color: chartColorPalette, + backgroundColor: "#fff", + }; + + let themeConfig = defaultChartTheme; + try { + themeConfig = theme?.theme.chart ? JSON.parse(theme?.theme.chart) : defaultChartTheme; + } catch (error) { + log.error('theme chart error: ', error); + } + + const triggerClickEvent = async (dispatch: any, action: CompAction<JSONValue>) => { + await getPromiseAfterDispatch( + dispatch, + action, + { autoHandleAfterReduce: true } + ); + onEvent('click'); + } + + useEffect(() => { + const echartsCompInstance = echartsCompRef?.current?.getEchartsInstance(); + if (!echartsCompInstance) { + return _.noop; + } + echartsCompInstance?.on("click", (param: any) => { + document.dispatchEvent(new CustomEvent("clickEvent", { + bubbles: true, + detail: { + action: 'click', + data: param.data, + } + })); + triggerClickEvent( + comp.dispatch, + changeChildAction("lastInteractionData", param.data, false) + ); + }); + return () => { + echartsCompInstance?.off("click"); + document.removeEventListener('clickEvent', clickEventCallback) + }; + }, []); + + useEffect(() => { + // bind events + const echartsCompInstance = echartsCompRef?.current?.getEchartsInstance(); + if (!echartsCompInstance) { + return _.noop; + } + echartsCompInstance?.on("selectchanged", (param: any) => { + const option: any = echartsCompInstance?.getOption(); + document.dispatchEvent(new CustomEvent("clickEvent", { + bubbles: true, + detail: { + action: param.fromAction, + data: getSelectedPoints(param, option) + } + })); + + if (param.fromAction === "select") { + comp.dispatch(changeChildAction("selectedPoints", getSelectedPoints(param, option), false)); + onUIEvent("select"); + } else if (param.fromAction === "unselect") { + comp.dispatch(changeChildAction("selectedPoints", getSelectedPoints(param, option), false)); + onUIEvent("unselect"); + } + + triggerClickEvent( + comp.dispatch, + changeChildAction("lastInteractionData", getSelectedPoints(param, option), false) + ); + }); + // unbind + return () => { + echartsCompInstance?.off("selectchanged"); + document.removeEventListener('clickEvent', clickEventCallback) + }; + }, [onUIEvent]); + + const echartsConfigChildren = _.omit(comp.children, echartsConfigOmitChildren); + const childrenProps = childrenToProps(echartsConfigChildren); + + const option = useMemo(() => { + return getEchartsConfig( + childrenProps as ToViewReturn<typeof echartsConfigChildren>, + chartSize, + themeConfig + ); + }, [theme, childrenProps, chartSize, ...Object.values(echartsConfigChildren)]); + + return ( + <ReactResizeDetector + onResize={(w, h) => { + if (w && h) { + setChartSize({ w: w, h: h }); + } + if (!firstResize.current) { + // ignore the first resize, which will impact the loading animation + echartsCompRef.current?.getEchartsInstance().resize(); + } else { + firstResize.current = false; + } + }} + > + <ReactECharts + ref={(e) => (echartsCompRef.current = e)} + style={{ height: "100%" }} + notMerge + lazyUpdate + opts={{ locale: getEchartsLocale() }} + option={option} + mode={mode} + /> + </ReactResizeDetector> + ); +}); + +function getYAxisFormatContextValue( + data: Array<JSONObject>, + yAxisType: EchartsAxisType, + yAxisName?: string +) { + const dataSample = yAxisName && data.length > 0 && data[0][yAxisName]; + let contextValue = dataSample; + if (yAxisType === "time") { + // to timestamp + const time = + typeof dataSample === "number" || typeof dataSample === "string" + ? new Date(dataSample).getTime() + : null; + if (time) contextValue = time; + } + return contextValue; +} + +BoxplotChartTmpComp = class extends BoxplotChartTmpComp { + private lastYAxisFormatContextVal?: JSONValue; + private lastColorContext?: JSONObject; + + updateContext(comp: this) { + // the context value of axis format + let resultComp = comp; + const data = comp.children.data.getView(); + const yAxisContextValue = getYAxisFormatContextValue( + data, + comp.children.yConfig.children.yAxisType.getView(), + ); + if (yAxisContextValue !== comp.lastYAxisFormatContextVal) { + comp.lastYAxisFormatContextVal = yAxisContextValue; + resultComp = comp.setChild( + "yConfig", + comp.children.yConfig.reduce( + wrapChildAction( + "formatter", + AxisFormatterComp.changeContextDataAction({ value: yAxisContextValue }) + ) + ) + ); + } + return resultComp; + } + + override reduce(action: CompAction): this { + const comp = super.reduce(action); + if (action.type === CompActionTypes.UPDATE_NODES_V2) { + const newData = comp.children.data.getView(); + // data changes + if (comp.children.data !== this.children.data) { + setTimeout(() => { + // update x-axis value + const keys = getDataKeys(newData); + if (keys.length > 0 && !keys.includes(comp.children.xAxisKey.getView())) { + comp.children.xAxisKey.dispatch(changeValueAction(keys[0] || "")); + } + if (keys.length > 0 && !keys.includes(comp.children.yAxisKey.getView())) { + comp.children.yAxisKey.dispatch(changeValueAction(keys[1] || "")); + } + }, 0); + } + return this.updateContext(comp); + } + return comp; + } + + override autoHeight(): boolean { + return false; + } +}; + +let BoxplotChartComp = withExposingConfigs(BoxplotChartTmpComp, [ + depsConfig({ + name: "selectedPoints", + desc: trans("chart.selectedPointsDesc"), + depKeys: ["selectedPoints"], + func: (input) => { + return input.selectedPoints; + }, + }), + depsConfig({ + name: "lastInteractionData", + desc: trans("chart.lastInteractionDataDesc"), + depKeys: ["lastInteractionData"], + func: (input) => { + return input.lastInteractionData; + }, + }), + depsConfig({ + name: "data", + desc: trans("chart.dataDesc"), + depKeys: ["data", "mode"], + func: (input) =>[] , + }), + new NameConfig("title", trans("chart.titleDesc")), +]); + + +export const BoxplotChartCompWithDefault = withDefault(BoxplotChartComp, { + xAxisKey: "date", +}); diff --git a/client/packages/lowcoder-comps/src/comps/boxplotChartComp/boxplotChartConstants.tsx b/client/packages/lowcoder-comps/src/comps/boxplotChartComp/boxplotChartConstants.tsx new file mode 100644 index 000000000..ffec6b31e --- /dev/null +++ b/client/packages/lowcoder-comps/src/comps/boxplotChartComp/boxplotChartConstants.tsx @@ -0,0 +1,248 @@ +import { + jsonControl, + stateComp, + toJSONObjectArray, + toObject, + BoolControl, + ColorControl, + withDefault, + StringControl, + NumberControl, + dropdownControl, + list, + eventHandlerControl, + valueComp, + withType, + uiChildren, + clickEvent, + toArray, + styleControl, + EchartDefaultTextStyle, + EchartDefaultChartStyle, + MultiCompBuilder, +} from "lowcoder-sdk"; +import { RecordConstructorToComp, RecordConstructorToView } from "lowcoder-core"; +import { XAxisConfig, YAxisConfig } from "../basicChartComp/chartConfigs/cartesianAxisConfig"; +import { LegendConfig } from "../basicChartComp/chartConfigs/legendConfig"; +import { EchartsLegendConfig } from "../basicChartComp/chartConfigs/echartsLegendConfig"; +import { EchartsLabelConfig } from "../basicChartComp/chartConfigs/echartsLabelConfig"; +import { EChartsOption } from "echarts"; +import { i18nObjs, trans } from "i18n/comps"; +import {EchartsTitleVerticalConfig} from "../chartComp/chartConfigs/echartsTitleVerticalConfig"; +import {EchartsTitleConfig} from "../basicChartComp/chartConfigs/echartsTitleConfig"; + +export const UIEventOptions = [ + { + label: trans("chart.select"), + value: "select", + description: trans("chart.selectDesc"), + }, + { + label: trans("chart.unSelect"), + value: "unselect", + description: trans("chart.unselectDesc"), + }, +] as const; + +export const XAxisDirectionOptions = [ + { + label: trans("chart.horizontal"), + value: "horizontal", + }, + { + label: trans("chart.vertical"), + value: "vertical", + }, +] as const; + +export type XAxisDirectionType = ValueFromOption<typeof XAxisDirectionOptions>; + +export const noDataAxisConfig = { + animation: false, + xAxis: { + type: "category", + name: trans("chart.noData"), + nameLocation: "middle", + data: [], + axisLine: { + lineStyle: { + color: "#8B8FA3", + }, + }, + }, + yAxis: { + type: "value", + axisLabel: { + color: "#8B8FA3", + }, + splitLine: { + lineStyle: { + color: "#F0F0F0", + }, + }, + }, + tooltip: { + show: false, + }, + series: [ + { + data: [700], + type: "line", + itemStyle: { + opacity: 0, + }, + }, + ], +} as EChartsOption; + +export const noDataBoxplotChartConfig = { + animation: false, + tooltip: { + show: false, + }, + legend: { + formatter: trans("chart.unknown"), + top: "bottom", + selectedMode: false, + }, + color: ["#B8BBCC", "#CED0D9", "#DCDEE6", "#E6E6EB"], + series: [ + { + type: "boxplot", + radius: "35%", + center: ["25%", "50%"], + silent: true, + label: { + show: false, + }, + data: [ + { + name: "1", + value: 70, + }, + { + name: "2", + value: 68, + }, + { + name: "3", + value: 48, + }, + { + name: "4", + value: 40, + }, + ], + }, + { + type: "boxplot", + radius: "35%", + center: ["75%", "50%"], + silent: true, + label: { + show: false, + }, + data: [ + { + name: "1", + value: 70, + }, + { + name: "2", + value: 68, + }, + { + name: "3", + value: 48, + }, + { + name: "4", + value: 40, + }, + ], + }, + ], +} as EChartsOption; + +export type ChartSize = { w: number; h: number }; + +export const getDataKeys = (data: Array<JSONObject>) => { + if (!data) { + return []; + } + const dataKeys: Array<string> = []; + data[0].forEach((key) => { + if (!dataKeys.includes(key)) { + dataKeys.push(key); + } + }); + return dataKeys; +}; + +export const chartUiModeChildren = { + title: withDefault(StringControl, trans("echarts.defaultTitle")), + data: jsonControl(toArray, i18nObjs.defaultDatasourceBoxplot), + xAxisKey: valueComp<string>(""), // x-axis, key from data + xAxisDirection: dropdownControl(XAxisDirectionOptions, "horizontal"), + xAxisData: jsonControl(toArray, []), + yAxisKey: valueComp<string>(""), // x-axis, key from data + xConfig: XAxisConfig, + yConfig: YAxisConfig, + legendConfig: LegendConfig, + onUIEvent: eventHandlerControl(UIEventOptions), +}; + +let chartJsonModeChildren: any = { + echartsOption: jsonControl(toObject, i18nObjs.defaultEchartsJsonOption), + echartsTitle: withDefault(StringControl, trans("echarts.defaultTitle")), + echartsLegendConfig: EchartsLegendConfig, + echartsLabelConfig: EchartsLabelConfig, + echartsTitleVerticalConfig: EchartsTitleVerticalConfig, + echartsTitleConfig:EchartsTitleConfig, + + left:withDefault(NumberControl,trans('chart.defaultLeft')), + right:withDefault(NumberControl,trans('chart.defaultRight')), + top:withDefault(NumberControl,trans('chart.defaultTop')), + bottom:withDefault(NumberControl,trans('chart.defaultBottom')), + + tooltip: withDefault(BoolControl, true), + legendVisibility: withDefault(BoolControl, true), +} + +if (EchartDefaultChartStyle && EchartDefaultTextStyle) { + chartJsonModeChildren = { + ...chartJsonModeChildren, + chartStyle: styleControl(EchartDefaultChartStyle, 'chartStyle'), + titleStyle: styleControl(EchartDefaultTextStyle, 'titleStyle'), + xAxisStyle: styleControl(EchartDefaultTextStyle, 'xAxis'), + yAxisStyle: styleControl(EchartDefaultTextStyle, 'yAxisStyle'), + legendStyle: styleControl(EchartDefaultTextStyle, 'legendStyle'), + } +} + +export type UIChartDataType = { + seriesName: string; + // coordinate chart + x?: any; + y?: any; + // boxplot or funnel + itemName?: any; + value?: any; +}; + +export type NonUIChartDataType = { + name: string; + value: any; +} + +export const boxplotChartChildrenMap = { + selectedPoints: stateComp<Array<UIChartDataType>>([]), + lastInteractionData: stateComp<Array<UIChartDataType> | NonUIChartDataType>({}), + onEvent: eventHandlerControl([clickEvent] as const), + ...chartUiModeChildren, + ...chartJsonModeChildren, +}; + +const chartUiChildrenMap = uiChildren(boxplotChartChildrenMap); +export type ChartCompPropsType = RecordConstructorToView<typeof chartUiChildrenMap>; +export type ChartCompChildrenType = RecordConstructorToComp<typeof chartUiChildrenMap>; diff --git a/client/packages/lowcoder-comps/src/comps/boxplotChartComp/boxplotChartPropertyView.tsx b/client/packages/lowcoder-comps/src/comps/boxplotChartComp/boxplotChartPropertyView.tsx new file mode 100644 index 000000000..b6694e910 --- /dev/null +++ b/client/packages/lowcoder-comps/src/comps/boxplotChartComp/boxplotChartPropertyView.tsx @@ -0,0 +1,95 @@ +import { changeChildAction, CompAction } from "lowcoder-core"; +import { ChartCompChildrenType, getDataKeys } from "./boxplotChartConstants"; +import { + CustomModal, + Dropdown, + hiddenPropertyView, + Option, + RedButton, + Section, + sectionNames, + controlItem, +} from "lowcoder-sdk"; +import { trans } from "i18n/comps"; + +export function boxplotChartPropertyView( + children: ChartCompChildrenType, + dispatch: (action: CompAction) => void +) { + const columnOptions = getDataKeys(children.data.getView()).map((key) => ({ + label: key, + value: key, + })); + + const uiModePropertyView = ( + <> + <Section name={trans("chart.data")}> + <Dropdown + value={children.xAxisKey.getView()} + options={columnOptions} + label={trans("chart.xAxis")} + onChange={(value) => { + dispatch(changeChildAction("xAxisKey", value)); + }} + /> + <Dropdown + value={children.yAxisKey.getView()} + options={columnOptions} + label={trans("chart.yAxis")} + onChange={(value) => { + dispatch(changeChildAction("yAxisKey", value)); + }} + /> + </Section> + <Section name={sectionNames.interaction}> + <div style={{display: 'flex', flexDirection: 'column', gap: '8px'}}> + {children.onUIEvent.propertyView({title: trans("chart.chartEventHandlers")})} + </div> + <div style={{display: 'flex', flexDirection: 'column', gap: '8px'}}> + {children.onEvent.propertyView()} + </div> + </Section> + <Section name={sectionNames.layout}> + {children.echartsTitleConfig.getPropertyView()} + {children.echartsTitleVerticalConfig.getPropertyView()} + {children.legendConfig.getPropertyView()} + {children.title.propertyView({ label: trans("chart.title") })} + {children.left.propertyView({ label: trans("chart.left"), tooltip: trans("echarts.leftTooltip") })} + {children.right.propertyView({ label: trans("chart.right"), tooltip: trans("echarts.rightTooltip") })} + {children.top.propertyView({ label: trans("chart.top"), tooltip: trans("echarts.topTooltip") })} + {children.bottom.propertyView({ label: trans("chart.bottom"), tooltip: trans("echarts.bottomTooltip") })} + {hiddenPropertyView(children)} + {children.tooltip.propertyView({label: trans("echarts.tooltip"), tooltip: trans("echarts.tooltipTooltip")})} + </Section> + <Section name={sectionNames.chartStyle}> + {children.chartStyle?.getPropertyView()} + </Section> + <Section name={sectionNames.titleStyle}> + {children.titleStyle?.getPropertyView()} + </Section> + <Section name={sectionNames.xAxisStyle}> + {children.xAxisStyle?.getPropertyView()} + </Section> + <Section name={sectionNames.yAxisStyle}> + {children.yAxisStyle?.getPropertyView()} + </Section> + <Section name={sectionNames.advanced}> + {children.data.propertyView({ + label: trans("chart.data"), + })} + </Section> + </> + ); + + const getChatConfigByMode = (mode: string) => { + switch(mode) { + case "ui": + return uiModePropertyView; + } + } + return ( + <> + {getChatConfigByMode(children.mode.getView())} + </> + ); +} diff --git a/client/packages/lowcoder-comps/src/comps/boxplotChartComp/boxplotChartUtils.ts b/client/packages/lowcoder-comps/src/comps/boxplotChartComp/boxplotChartUtils.ts new file mode 100644 index 000000000..2bc1904d4 --- /dev/null +++ b/client/packages/lowcoder-comps/src/comps/boxplotChartComp/boxplotChartUtils.ts @@ -0,0 +1,293 @@ +import { + ChartCompPropsType, + ChartSize, + noDataBoxplotChartConfig, +} from "comps/boxplotChartComp/boxplotChartConstants"; +import { EChartsOptionWithMap } from "../basicChartComp/reactEcharts/types"; +import _ from "lodash"; +import { googleMapsApiUrl } from "../basicChartComp/chartConfigs/chartUrls"; +import parseBackground from "../../util/gradientBackgroundColor"; +import {chartStyleWrapper, styleWrapper} from "../../util/styleWrapper"; +// Define the configuration interface to match the original transform + +interface AggregateConfig { + resultDimensions: Array<{ + name: string; + from: string; + method?: string; // e.g., 'min', 'Q1', 'median', 'Q3', 'max' + }>; + groupBy: string; +} + +// Custom transform function +function customAggregateTransform(params: { + upstream: { source: any[] }; + config: AggregateConfig; +}): any[] { + const { upstream, config } = params; + const data = upstream.source; + + // Assume data is an array of arrays, with the first row as headers + const headers = data[0]; + const rows = data.slice(1); + + // Find the index of the groupBy column + const groupByIndex = headers.indexOf(config.groupBy); + if (groupByIndex === -1) { + return []; + } + + // Group rows by the groupBy column + const groups: { [key: string]: any[][] } = {}; + rows.forEach(row => { + const key = row[groupByIndex]; + if (!groups[key]) { + groups[key] = []; + } + groups[key].push(row); + }); + + // Define aggregation functions + const aggregators: { + [method: string]: (values: number[]) => number; + } = { + min: values => Math.min(...values), + max: values => Math.max(...values), + Q1: values => percentile(values, 25), + median: values => percentile(values, 50), + Q3: values => percentile(values, 75), + }; + + // Helper function to calculate percentiles (Q1, median, Q3) + function percentile(arr: number[], p: number): number { + const sorted = arr.slice().sort((a, b) => a - b); + const index = (p / 100) * (sorted.length - 1); + const i = Math.floor(index); + const f = index - i; + if (i === sorted.length - 1) { + return sorted[i]; + } + return sorted[i] + f * (sorted[i + 1] - sorted[i]); + } + + // Prepare output headers from resultDimensions + const outputHeaders = config.resultDimensions.map(dim => dim.name); + + // Compute aggregated data for each group + const aggregatedData: any[][] = []; + for (const key in groups) { + const groupRows = groups[key]; + const row: any[] = []; + + config.resultDimensions.forEach(dim => { + if (dim.from === config.groupBy) { + // Include the group key directly + row.push(key); + } else { + // Find the index of the 'from' column + const fromIndex = headers.indexOf(dim.from); + if (fromIndex === -1) { + return; + } + // Extract values for the 'from' column in this group + const values = groupRows + .map(r => parseFloat(r[fromIndex])) + .filter(v => !isNaN(v)); + if (dim.method && aggregators[dim.method]) { + // Apply the aggregation method + row.push(aggregators[dim.method](values)); + } else { + return; + } + } + }); + + aggregatedData.push(row); + } + + // Return the transformed data with headers + return [outputHeaders, ...aggregatedData]; +} + +export const echartsConfigOmitChildren = [ + "hidden", + "selectedPoints", + "onUIEvent", + "mapInstance" +] as const; +type EchartsConfigProps = Omit<ChartCompPropsType, typeof echartsConfigOmitChildren[number]>; + +// https://echarts.apache.org/en/option.html +export function getEchartsConfig( + props: EchartsConfigProps, + chartSize?: ChartSize, + theme?: any, +): EChartsOptionWithMap { + const gridPos = { + left: `${props?.left}%`, + right: `${props?.right}%`, + bottom: `${props?.bottom}%`, + top: `${props?.top}%`, + }; + + let config: any = { + title: { + text: props.title, + top: props.echartsTitleVerticalConfig.top, + left:props.echartsTitleConfig.top, + textStyle: { + ...styleWrapper(props?.titleStyle, theme?.titleStyle) + } + }, + backgroundColor: parseBackground( props?.chartStyle?.background || theme?.chartStyle?.backgroundColor || "#FFFFFF"), + tooltip: props.tooltip && { + trigger: "axis", + axisPointer: { + type: "line", + lineStyle: { + color: "rgba(0,0,0,0.2)", + width: 2, + type: "solid" + } + } + }, + grid: { + ...gridPos, + containLabel: true, + }, + xAxis: { + name: props.xAxisKey, + nameLocation: 'middle', + nameGap: 30, + scale: true, + axisLabel: { + ...styleWrapper(props?.xAxisStyle, theme?.xAxisStyle, 11) + } + }, + yAxis: { + type: "category", + axisLabel: { + ...styleWrapper(props?.yAxisStyle, theme?.yAxisStyle, 11) + } + }, + dataset: [ + { + id: 'raw', + source: customAggregateTransform({upstream: {source: props.data as any[]}, config:{ + resultDimensions: [ + { name: 'min', from: props.xAxisKey, method: 'min' }, + { name: 'Q1', from: props.xAxisKey, method: 'Q1' }, + { name: 'median', from: props.xAxisKey, method: 'median' }, + { name: 'Q3', from: props.xAxisKey, method: 'Q3' }, + { name: 'max', from: props.xAxisKey, method: 'max' }, + { name: props.yAxisKey, from: props.yAxisKey } + ], + groupBy: props.yAxisKey + }}), + }, + { + id: 'finaldataset', + fromDatasetId: 'raw', + transform: [ + { + type: 'sort', + config: { + dimension: 'Q3', + order: 'asc' + } + } + ] + } + ], + }; + + if (props.data.length <= 0) { + // no data + return { + ...config, + ...noDataBoxplotChartConfig, + }; + } + const yAxisConfig = props.yConfig(); + // y-axis is category and time, data doesn't need to aggregate + let transformedData = props.data; + + config = { + ...config, + series: [{ + name: props.xAxisKey, + type: 'boxplot', + datasetId: 'finaldataset', + encode: { + x: ['min', 'Q1', 'median', 'Q3', 'max'], + y: props.yAxisKey, + itemName: [props.yAxisKey], + tooltip: ['min', 'Q1', 'median', 'Q3', 'max'] + }, + itemStyle: { + color: '#b8c5f2', + ...chartStyleWrapper(props?.chartStyle, theme?.chartStyle) + }, + }], + }; + if(config.series[0].itemStyle.borderWidth === 0) config.series[0].itemStyle.borderWidth = 1; + + // console.log("Echarts transformedData and config", transformedData, config); + return config; +} + +export function getSelectedPoints(param: any, option: any) { + const series = option.series; + const dataSource = _.isArray(option.dataset) && option.dataset[0]?.source; + if (series && dataSource) { + return param.selected.flatMap((selectInfo: any) => { + const seriesInfo = series[selectInfo.seriesIndex]; + if (!seriesInfo || !seriesInfo.encode) { + return []; + } + return selectInfo.dataIndex.map((index: any) => { + const commonResult = { + seriesName: seriesInfo.name, + }; + if (seriesInfo.encode.itemName && seriesInfo.encode.value) { + return { + ...commonResult, + itemName: dataSource[index][seriesInfo.encode.itemName], + value: dataSource[index][seriesInfo.encode.value], + }; + } else { + return { + ...commonResult, + x: dataSource[index][seriesInfo.encode.x], + y: dataSource[index][seriesInfo.encode.y], + }; + } + }); + }); + } + return []; +} + +export function loadGoogleMapsScript(apiKey: string) { + const mapsUrl = `${googleMapsApiUrl}?key=${apiKey}`; + const scripts = document.getElementsByTagName('script'); + // is script already loaded + let scriptIndex = _.findIndex(scripts, (script) => script.src.endsWith(mapsUrl)); + if(scriptIndex > -1) { + return scripts[scriptIndex]; + } + // is script loaded with diff api_key, remove the script and load again + scriptIndex = _.findIndex(scripts, (script) => script.src.startsWith(googleMapsApiUrl)); + if(scriptIndex > -1) { + scripts[scriptIndex].remove(); + } + + const script = document.createElement("script"); + script.type = "text/javascript"; + script.src = mapsUrl; + script.async = true; + script.defer = true; + window.document.body.appendChild(script); + + return script; +} diff --git a/client/packages/lowcoder-comps/src/comps/chartComp/chartConfigs/barChartConfig.tsx b/client/packages/lowcoder-comps/src/comps/chartComp/chartConfigs/barChartConfig.tsx index 6c91fe252..707b16170 100644 --- a/client/packages/lowcoder-comps/src/comps/chartComp/chartConfigs/barChartConfig.tsx +++ b/client/packages/lowcoder-comps/src/comps/chartComp/chartConfigs/barChartConfig.tsx @@ -5,7 +5,7 @@ import { showLabelPropertyView, } from "lowcoder-sdk"; import { BarSeriesOption } from "echarts"; -import { trans } from "i18n/comps"; +import { i18nObjs, trans } from "i18n/comps"; const BarTypeOptions = [ { diff --git a/client/packages/lowcoder-comps/src/comps/line3dChartComp/images/default_ambient_cubemap_texture.hdr b/client/packages/lowcoder-comps/src/comps/line3dChartComp/images/default_ambient_cubemap_texture.hdr new file mode 100644 index 000000000..4d53b3609 Binary files /dev/null and b/client/packages/lowcoder-comps/src/comps/line3dChartComp/images/default_ambient_cubemap_texture.hdr differ diff --git a/client/packages/lowcoder-comps/src/comps/line3dChartComp/images/default_base_texture.jpg b/client/packages/lowcoder-comps/src/comps/line3dChartComp/images/default_base_texture.jpg new file mode 100644 index 000000000..c4a5d335c Binary files /dev/null and b/client/packages/lowcoder-comps/src/comps/line3dChartComp/images/default_base_texture.jpg differ diff --git a/client/packages/lowcoder-comps/src/comps/line3dChartComp/images/default_environment.jpg b/client/packages/lowcoder-comps/src/comps/line3dChartComp/images/default_environment.jpg new file mode 100644 index 000000000..314999840 Binary files /dev/null and b/client/packages/lowcoder-comps/src/comps/line3dChartComp/images/default_environment.jpg differ diff --git a/client/packages/lowcoder-comps/src/comps/line3dChartComp/images/default_height_texture.jpg b/client/packages/lowcoder-comps/src/comps/line3dChartComp/images/default_height_texture.jpg new file mode 100644 index 000000000..9f8dcdf31 Binary files /dev/null and b/client/packages/lowcoder-comps/src/comps/line3dChartComp/images/default_height_texture.jpg differ diff --git a/client/packages/lowcoder-comps/src/comps/line3dChartComp/line3dChartComp.tsx b/client/packages/lowcoder-comps/src/comps/line3dChartComp/line3dChartComp.tsx new file mode 100644 index 000000000..712e224b2 --- /dev/null +++ b/client/packages/lowcoder-comps/src/comps/line3dChartComp/line3dChartComp.tsx @@ -0,0 +1,282 @@ +import { + changeChildAction, + changeValueAction, + CompAction, + CompActionTypes, + wrapChildAction, +} from "lowcoder-core"; +import { AxisFormatterComp, EchartsAxisType } from "../basicChartComp/chartConfigs/cartesianAxisConfig"; +import { line3dChartChildrenMap, ChartSize, getDataKeys } from "./line3dChartConstants"; +import { line3dChartPropertyView } from "./line3dChartPropertyView"; +import _ from "lodash"; +import { useContext, useEffect, useMemo, useRef, useState } from "react"; +import ReactResizeDetector from "react-resize-detector"; +import ReactECharts from "../basicChartComp/reactEcharts"; +import * as echarts from "echarts"; +import { + childrenToProps, + depsConfig, + genRandomKey, + NameConfig, + UICompBuilder, + withDefault, + withExposingConfigs, + withViewFn, + ThemeContext, + chartColorPalette, + getPromiseAfterDispatch, + dropdownControl, +} from "lowcoder-sdk"; +import { getEchartsLocale, i18nObjs, trans } from "i18n/comps"; +import { + echartsConfigOmitChildren, + getEchartsConfig, + getSelectedPoints, +} from "./line3dChartUtils"; +import 'echarts-extension-gmap'; +import log from "loglevel"; + +let clickEventCallback = () => {}; + +const chartModeOptions = [ + { + label: "UI", + value: "ui", + } +] as const; + +let Line3DChartTmpComp = (function () { + return new UICompBuilder({mode:dropdownControl(chartModeOptions,'ui'),...line3dChartChildrenMap}, () => null) + .setPropertyViewFn(line3dChartPropertyView) + .build(); +})(); + +Line3DChartTmpComp = withViewFn(Line3DChartTmpComp, (comp) => { + const mode = comp.children.mode.getView(); + const onUIEvent = comp.children.onUIEvent.getView(); + const onEvent = comp.children.onEvent.getView(); + const echartsCompRef = useRef<ReactECharts | null>(); + const [chartSize, setChartSize] = useState<ChartSize>(); + const firstResize = useRef(true); + const theme = useContext(ThemeContext); + const defaultChartTheme = { + color: chartColorPalette, + backgroundColor: "#fff", + }; + + let themeConfig = defaultChartTheme; + try { + themeConfig = theme?.theme.chart ? JSON.parse(theme?.theme.chart) : defaultChartTheme; + } catch (error) { + log.error('theme chart error: ', error); + } + + const triggerClickEvent = async (dispatch: any, action: CompAction<JSONValue>) => { + await getPromiseAfterDispatch( + dispatch, + action, + { autoHandleAfterReduce: true } + ); + onEvent('click'); + } + + useEffect(() => { + const echartsCompInstance = echartsCompRef?.current?.getEchartsInstance(); + if (!echartsCompInstance) { + return _.noop; + } + echartsCompInstance?.on("click", (param: any) => { + document.dispatchEvent(new CustomEvent("clickEvent", { + bubbles: true, + detail: { + action: 'click', + data: param.data, + } + })); + triggerClickEvent( + comp.dispatch, + changeChildAction("lastInteractionData", param.data, false) + ); + }); + return () => { + echartsCompInstance?.off("click"); + document.removeEventListener('clickEvent', clickEventCallback) + }; + }, []); + + useEffect(() => { + // bind events + const echartsCompInstance = echartsCompRef?.current?.getEchartsInstance(); + if (!echartsCompInstance) { + return _.noop; + } + echartsCompInstance?.on("selectchanged", (param: any) => { + const option: any = echartsCompInstance?.getOption(); + document.dispatchEvent(new CustomEvent("clickEvent", { + bubbles: true, + detail: { + action: param.fromAction, + data: getSelectedPoints(param, option) + } + })); + + if (param.fromAction === "select") { + comp.dispatch(changeChildAction("selectedPoints", getSelectedPoints(param, option), false)); + onUIEvent("select"); + } else if (param.fromAction === "unselect") { + comp.dispatch(changeChildAction("selectedPoints", getSelectedPoints(param, option), false)); + onUIEvent("unselect"); + } + + triggerClickEvent( + comp.dispatch, + changeChildAction("lastInteractionData", getSelectedPoints(param, option), false) + ); + }); + // unbind + return () => { + echartsCompInstance?.off("selectchanged"); + document.removeEventListener('clickEvent', clickEventCallback) + }; + }, [onUIEvent]); + + const echartsConfigChildren = _.omit(comp.children, echartsConfigOmitChildren); + const childrenProps = childrenToProps(echartsConfigChildren); + + const option = useMemo(() => { + return getEchartsConfig( + childrenProps as ToViewReturn<typeof echartsConfigChildren>, + chartSize, + themeConfig + ); + }, [theme, childrenProps, chartSize, ...Object.values(echartsConfigChildren)]); + + return ( + <ReactResizeDetector + onResize={(w, h) => { + if (w && h) { + setChartSize({ w: w, h: h }); + } + if (!firstResize.current) { + // ignore the first resize, which will impact the loading animation + echartsCompRef.current?.getEchartsInstance().resize(); + } else { + firstResize.current = false; + } + }} + > + <ReactECharts + ref={(e) => (echartsCompRef.current = e)} + style={{ height: "100%" }} + notMerge + lazyUpdate + opts={{ locale: getEchartsLocale() }} + option={option} + mode={mode} + /> + </ReactResizeDetector> + ); +}); + +function getYAxisFormatContextValue( + data: Array<JSONObject>, + yAxisType: EchartsAxisType, + yAxisName?: string +) { + const dataSample = yAxisName && data.length > 0 && data[0][yAxisName]; + let contextValue = dataSample; + if (yAxisType === "time") { + // to timestamp + const time = + typeof dataSample === "number" || typeof dataSample === "string" + ? new Date(dataSample).getTime() + : null; + if (time) contextValue = time; + } + return contextValue; +} + +Line3DChartTmpComp = class extends Line3DChartTmpComp { + private lastYAxisFormatContextVal?: JSONValue; + private lastColorContext?: JSONObject; + + updateContext(comp: this) { + // the context value of axis format + let resultComp = comp; + const data = comp.children.data.getView(); + const yAxisContextValue = getYAxisFormatContextValue( + data, + comp.children.yConfig.children.yAxisType.getView(), + ); + if (yAxisContextValue !== comp.lastYAxisFormatContextVal) { + comp.lastYAxisFormatContextVal = yAxisContextValue; + resultComp = comp.setChild( + "yConfig", + comp.children.yConfig.reduce( + wrapChildAction( + "formatter", + AxisFormatterComp.changeContextDataAction({ value: yAxisContextValue }) + ) + ) + ); + } + return resultComp; + } + + override reduce(action: CompAction): this { + const comp = super.reduce(action); + if (action.type === CompActionTypes.UPDATE_NODES_V2) { + const newData = comp.children.data.getView(); + // data changes + if (comp.children.data !== this.children.data) { + setTimeout(() => { + // update x-axis value + const keys = getDataKeys(newData); + if (keys.length > 0 && !keys.includes(comp.children.xAxisKey.getView())) { + comp.children.xAxisKey.dispatch(changeValueAction(keys[0] || "")); + } + if (keys.length > 0 && !keys.includes(comp.children.yAxisKey.getView())) { + comp.children.yAxisKey.dispatch(changeValueAction(keys[1] || "")); + } + }, 0); + } + return this.updateContext(comp); + } + return comp; + } + + override autoHeight(): boolean { + return false; + } +}; + +let Line3DChartComp = withExposingConfigs(Line3DChartTmpComp, [ + depsConfig({ + name: "selectedPoints", + desc: trans("chart.selectedPointsDesc"), + depKeys: ["selectedPoints"], + func: (input) => { + return input.selectedPoints; + }, + }), + depsConfig({ + name: "lastInteractionData", + desc: trans("chart.lastInteractionDataDesc"), + depKeys: ["lastInteractionData"], + func: (input) => { + return input.lastInteractionData; + }, + }), + depsConfig({ + name: "data", + desc: trans("chart.dataDesc"), + depKeys: ["data", "mode"], + func: (input) =>[] , + }), + new NameConfig("title", trans("chart.titleDesc")), +]); + + +export const Line3DChartCompWithDefault = withDefault(Line3DChartComp, { + xAxisKey: "date", +}); diff --git a/client/packages/lowcoder-comps/src/comps/line3dChartComp/line3dChartConstants.tsx b/client/packages/lowcoder-comps/src/comps/line3dChartComp/line3dChartConstants.tsx new file mode 100644 index 000000000..41a405c55 --- /dev/null +++ b/client/packages/lowcoder-comps/src/comps/line3dChartComp/line3dChartConstants.tsx @@ -0,0 +1,176 @@ +import { + jsonControl, + stateComp, + toJSONObjectArray, + toObject, + BoolControl, + ColorControl, + withDefault, + StringControl, + NumberControl, + dropdownControl, + list, + eventHandlerControl, + valueComp, + withType, + uiChildren, + clickEvent, + toArray, + styleControl, + EchartDefaultTextStyle, + EchartDefaultChartStyle, + MultiCompBuilder, +} from "lowcoder-sdk"; +import { RecordConstructorToComp, RecordConstructorToView } from "lowcoder-core"; +import { XAxisConfig, YAxisConfig } from "../basicChartComp/chartConfigs/cartesianAxisConfig"; +import { LegendConfig } from "../basicChartComp/chartConfigs/legendConfig"; +import { EchartsLegendConfig } from "../basicChartComp/chartConfigs/echartsLegendConfig"; +import { EchartsLabelConfig } from "../basicChartComp/chartConfigs/echartsLabelConfig"; +import { EChartsOption } from "echarts"; +import { i18nObjs, trans } from "i18n/comps"; +import {EchartsTitleVerticalConfig} from "../chartComp/chartConfigs/echartsTitleVerticalConfig"; +import {EchartsTitleConfig} from "../basicChartComp/chartConfigs/echartsTitleConfig"; + +export const UIEventOptions = [ + { + label: trans("chart.select"), + value: "select", + description: trans("chart.selectDesc"), + }, + { + label: trans("chart.unSelect"), + value: "unselect", + description: trans("chart.unselectDesc"), + }, +] as const; + +export const XAxisDirectionOptions = [ + { + label: trans("chart.horizontal"), + value: "horizontal", + }, + { + label: trans("chart.vertical"), + value: "vertical", + }, +] as const; + +export type XAxisDirectionType = ValueFromOption<typeof XAxisDirectionOptions>; + +export const noDataAxisConfig = { + animation: false, + xAxis: { + type: "category", + name: trans("chart.noData"), + nameLocation: "middle", + data: [], + axisLine: { + lineStyle: { + color: "#8B8FA3", + }, + }, + }, + yAxis: { + type: "value", + axisLabel: { + color: "#8B8FA3", + }, + splitLine: { + lineStyle: { + color: "#F0F0F0", + }, + }, + }, + tooltip: { + show: false, + }, + series: [ + { + data: [700], + type: "line", + itemStyle: { + opacity: 0, + }, + }, + ], +} as EChartsOption; + +export const noDataLine3DChartConfig = { + animation: false, + tooltip: { + show: false, + }, + legend: { + formatter: trans("chart.unknown"), + top: "bottom", + selectedMode: false, + }, + color: ["#B8BBCC", "#CED0D9", "#DCDEE6", "#E6E6EB"], + series: [], +} as EChartsOption; + +export type ChartSize = { w: number; h: number }; + +export const getDataKeys = (data: Array<JSONObject>) => { + if (!data) { + return []; + } + const dataKeys: Array<string> = []; + data[0].forEach((key) => { + if (!dataKeys.includes(key)) { + dataKeys.push(key); + } + }); + return dataKeys; +}; + +export const chartUiModeChildren = { + title: withDefault(StringControl, trans("echarts.defaultTitle")), + data: jsonControl(toArray, i18nObjs.defaultDatasource3DGlobe), + xAxisKey: valueComp<string>(""), // x-axis, key from data + xAxisDirection: dropdownControl(XAxisDirectionOptions, "horizontal"), + xAxisData: jsonControl(toArray, []), + yAxisKey: valueComp<string>(""), // x-axis, key from data + xConfig: XAxisConfig, + yConfig: YAxisConfig, + legendConfig: LegendConfig, + environment: withDefault(StringControl, trans("line3dchart.defaultEnvironment")), + baseTexture: withDefault(StringControl, trans("line3dchart.defaultBaseTexture")), + heightTexture: withDefault(StringControl, trans("line3dchart.defaultHeightTexture")), + background: withDefault(ColorControl, "black"), + lineStyleWidth: withDefault(NumberControl, 1), + lineStyleColor: withDefault(ColorControl, "rgb(50, 50, 150)"), + lineStyleOpacity: withDefault(NumberControl, 0.1), + effectShow: withDefault(BoolControl, true), + effectWidth: withDefault(NumberControl, 2), + effectLength: withDefault(NumberControl, 0.15), + effectOpacity: withDefault(NumberControl, 1), + effectColor: withDefault(ColorControl, 'rgb(30, 30, 60)'), + onUIEvent: eventHandlerControl(UIEventOptions), +}; + +export type UIChartDataType = { + seriesName: string; + // coordinate chart + x?: any; + y?: any; + // line3d or funnel + itemName?: any; + value?: any; +}; + +export type NonUIChartDataType = { + name: string; + value: any; +} + +export const line3dChartChildrenMap = { + selectedPoints: stateComp<Array<UIChartDataType>>([]), + lastInteractionData: stateComp<Array<UIChartDataType> | NonUIChartDataType>({}), + onEvent: eventHandlerControl([clickEvent] as const), + ...chartUiModeChildren, +}; + +const chartUiChildrenMap = uiChildren(line3dChartChildrenMap); +export type ChartCompPropsType = RecordConstructorToView<typeof chartUiChildrenMap>; +export type ChartCompChildrenType = RecordConstructorToComp<typeof chartUiChildrenMap>; diff --git a/client/packages/lowcoder-comps/src/comps/line3dChartComp/line3dChartPropertyView.tsx b/client/packages/lowcoder-comps/src/comps/line3dChartComp/line3dChartPropertyView.tsx new file mode 100644 index 000000000..bbcebf358 --- /dev/null +++ b/client/packages/lowcoder-comps/src/comps/line3dChartComp/line3dChartPropertyView.tsx @@ -0,0 +1,62 @@ +import { changeChildAction, CompAction } from "lowcoder-core"; +import { ChartCompChildrenType, getDataKeys } from "./line3dChartConstants"; +import { + CustomModal, + Dropdown, + hiddenPropertyView, + Option, + RedButton, + Section, + sectionNames, + controlItem, +} from "lowcoder-sdk"; +import { trans } from "i18n/comps"; + +export function line3dChartPropertyView( + children: ChartCompChildrenType, + dispatch: (action: CompAction) => void +) { + const uiModePropertyView = ( + <> + <Section name={trans('chart.data')}> + {children.environment.propertyView({label: trans("line3dchart.environment")})} + {children.baseTexture.propertyView({label: trans("line3dchart.baseTexture")})} + {children.heightTexture.propertyView({label: trans("line3dchart.heightTexture")})} + {children.background.propertyView({label: trans("line3dchart.background")})} + {children.lineStyleWidth.propertyView({label: trans("line3dchart.lineStyleWidth")})} + {children.lineStyleColor.propertyView({label: trans("line3dchart.lineStyleColor")})} + {children.lineStyleOpacity.propertyView({label: trans("line3dchart.lineStyleOpacity")})} + {children.effectShow.propertyView({label: trans("line3dchart.effectShow")})} + {children.effectShow.getView() && children.effectWidth.propertyView({label: trans("line3dchart.effectTrailWidth")})} + {children.effectShow.getView() && children.effectLength.propertyView({label: trans("line3dchart.effectTrailLength")})} + {children.effectShow.getView() && children.effectOpacity.propertyView({label: trans("line3dchart.effectTrailOpacity")})} + {children.effectShow.getView() && children.effectColor.propertyView({label: trans("line3dchart.effectTrailColor")})} + </Section> + <Section name={sectionNames.interaction}> + <div style={{display: 'flex', flexDirection: 'column', gap: '8px'}}> + {children.onUIEvent.propertyView({title: trans("chart.chartEventHandlers")})} + </div> + <div style={{display: 'flex', flexDirection: 'column', gap: '8px'}}> + {children.onEvent.propertyView()} + </div> + </Section> + <Section name={sectionNames.advanced}> + {children.data.propertyView({ + label: trans("chart.data"), + })} + </Section> + </> + ); + + const getChatConfigByMode = (mode: string) => { + switch(mode) { + case "ui": + return uiModePropertyView; + } + } + return ( + <> + {getChatConfigByMode(children.mode.getView())} + </> + ); +} diff --git a/client/packages/lowcoder-comps/src/comps/line3dChartComp/line3dChartUtils.ts b/client/packages/lowcoder-comps/src/comps/line3dChartComp/line3dChartUtils.ts new file mode 100644 index 000000000..d1be05edf --- /dev/null +++ b/client/packages/lowcoder-comps/src/comps/line3dChartComp/line3dChartUtils.ts @@ -0,0 +1,239 @@ +import { + ChartCompPropsType, + ChartSize, + noDataLine3DChartConfig, +} from "comps/line3dChartComp/line3dChartConstants"; +import { EChartsOptionWithMap } from "../basicChartComp/reactEcharts/types"; +import _ from "lodash"; +import { googleMapsApiUrl } from "../basicChartComp/chartConfigs/chartUrls"; +import parseBackground from "../../util/gradientBackgroundColor"; +import {chartStyleWrapper, styleWrapper} from "../../util/styleWrapper"; +// Define the configuration interface to match the original transform + +interface AggregateConfig { + resultDimensions: Array<{ + name: string; + from: string; + method?: string; // e.g., 'min', 'Q1', 'median', 'Q3', 'max' + }>; + groupBy: string; +} + +// Custom transform function +function customAggregateTransform(params: { + upstream: { source: any[] }; + config: AggregateConfig; +}): any[] { + const { upstream, config } = params; + const data = upstream.source; + + // Assume data is an array of arrays, with the first row as headers + const headers = data[0]; + const rows = data.slice(1); + + // Find the index of the groupBy column + const groupByIndex = headers.indexOf(config.groupBy); + if (groupByIndex === -1) { + return []; + } + + // Group rows by the groupBy column + const groups: { [key: string]: any[][] } = {}; + rows.forEach(row => { + const key = row[groupByIndex]; + if (!groups[key]) { + groups[key] = []; + } + groups[key].push(row); + }); + + // Define aggregation functions + const aggregators: { + [method: string]: (values: number[]) => number; + } = { + min: values => Math.min(...values), + max: values => Math.max(...values), + Q1: values => percentile(values, 25), + median: values => percentile(values, 50), + Q3: values => percentile(values, 75), + }; + + // Helper function to calculate percentiles (Q1, median, Q3) + function percentile(arr: number[], p: number): number { + const sorted = arr.slice().sort((a, b) => a - b); + const index = (p / 100) * (sorted.length - 1); + const i = Math.floor(index); + const f = index - i; + if (i === sorted.length - 1) { + return sorted[i]; + } + return sorted[i] + f * (sorted[i + 1] - sorted[i]); + } + + // Prepare output headers from resultDimensions + const outputHeaders = config.resultDimensions.map(dim => dim.name); + + // Compute aggregated data for each group + const aggregatedData: any[][] = []; + for (const key in groups) { + const groupRows = groups[key]; + const row: any[] = []; + + config.resultDimensions.forEach(dim => { + if (dim.from === config.groupBy) { + // Include the group key directly + row.push(key); + } else { + // Find the index of the 'from' column + const fromIndex = headers.indexOf(dim.from); + if (fromIndex === -1) { + return; + } + // Extract values for the 'from' column in this group + const values = groupRows + .map(r => parseFloat(r[fromIndex])) + .filter(v => !isNaN(v)); + if (dim.method && aggregators[dim.method]) { + // Apply the aggregation method + row.push(aggregators[dim.method](values)); + } else { + return; + } + } + }); + + aggregatedData.push(row); + } + + // Return the transformed data with headers + return [outputHeaders, ...aggregatedData]; +} + +export const echartsConfigOmitChildren = [ + "hidden", + "selectedPoints", + "onUIEvent", + "mapInstance" +] as const; +type EchartsConfigProps = Omit<ChartCompPropsType, typeof echartsConfigOmitChildren[number]>; + +// https://echarts.apache.org/en/option.html +export function getEchartsConfig( + props: EchartsConfigProps, + chartSize?: ChartSize, + theme?: any, +): EChartsOptionWithMap { + let config: any = { + backgroundColor: props.background, + globe: { + environment: props.environment, + baseTexture: props.baseTexture, + heightTexture: props.heightTexture, + shading: 'realistic', + realisticMaterial: { + roughness: 0.2, + metalness: 0 + }, + postEffect: { + enable: true, + depthOfField: { + enable: false, + focalDistance: 150 + } + }, + displacementScale: 0.1, + displacementQuality: 'high', + temporalSuperSampling: { + enable: true + }, + light: { + ambient: { + intensity: 0.4 + }, + main: { + intensity: 0.4 + }, + }, + viewControl: { + autoRotate: false + }, + silent: true + }, + series: { + type: 'lines3D', + coordinateSystem: 'globe', + blendMode: 'lighter', + lineStyle: { + width: props.lineStyleWidth, + color: props.lineStyleColor, + opacity: props.lineStyleOpacity + }, + data: props.data, + effect: { + show: props.effectShow, + trailWidth: props.effectWidth, + trailLength: props.effectLength, + trailOpacity: props.effectOpacity, + trailColor: props.effectColor + }, + } + }; + console.log(config); + return config; +} + +export function getSelectedPoints(param: any, option: any) { + const series = option.series; + const dataSource = _.isArray(option.dataset) && option.dataset[0]?.source; + if (series && dataSource) { + return param.selected.flatMap((selectInfo: any) => { + const seriesInfo = series[selectInfo.seriesIndex]; + if (!seriesInfo || !seriesInfo.encode) { + return []; + } + return selectInfo.dataIndex.map((index: any) => { + const commonResult = { + seriesName: seriesInfo.name, + }; + if (seriesInfo.encode.itemName && seriesInfo.encode.value) { + return { + ...commonResult, + itemName: dataSource[index][seriesInfo.encode.itemName], + value: dataSource[index][seriesInfo.encode.value], + }; + } else { + return { + ...commonResult, + x: dataSource[index][seriesInfo.encode.x], + y: dataSource[index][seriesInfo.encode.y], + }; + } + }); + }); + } + return []; +} + +export function loadGoogleMapsScript(apiKey: string) { + const mapsUrl = `${googleMapsApiUrl}?key=${apiKey}`; + const scripts = document.getElementsByTagName('script'); + // is script already loaded + let scriptIndex = _.findIndex(scripts, (script) => script.src.endsWith(mapsUrl)); + if(scriptIndex > -1) { + return scripts[scriptIndex]; + } + // is script loaded with diff api_key, remove the script and load again + scriptIndex = _.findIndex(scripts, (script) => script.src.startsWith(googleMapsApiUrl)); + if(scriptIndex > -1) { + scripts[scriptIndex].remove(); + } + + const script = document.createElement("script"); + script.type = "text/javascript"; + script.src = mapsUrl; + script.async = true; + script.defer = true; + window.document.body.appendChild(script); + + return script; +} diff --git a/client/packages/lowcoder-comps/src/comps/lineChartComp/lineChartComp.tsx b/client/packages/lowcoder-comps/src/comps/lineChartComp/lineChartComp.tsx new file mode 100644 index 000000000..be3e5bf65 --- /dev/null +++ b/client/packages/lowcoder-comps/src/comps/lineChartComp/lineChartComp.tsx @@ -0,0 +1,314 @@ +import { + changeChildAction, + changeValueAction, + CompAction, + CompActionTypes, + wrapChildAction, +} from "lowcoder-core"; +import { AxisFormatterComp, EchartsAxisType } from "../basicChartComp/chartConfigs/cartesianAxisConfig"; +import { lineChartChildrenMap, ChartSize, getDataKeys } from "./lineChartConstants"; +import { lineChartPropertyView } from "./lineChartPropertyView"; +import _ from "lodash"; +import { useContext, useEffect, useMemo, useRef, useState } from "react"; +import ReactResizeDetector from "react-resize-detector"; +import ReactECharts from "../basicChartComp/reactEcharts"; +import { + childrenToProps, + depsConfig, + genRandomKey, + NameConfig, + UICompBuilder, + withDefault, + withExposingConfigs, + withViewFn, + ThemeContext, + chartColorPalette, + getPromiseAfterDispatch, + dropdownControl, +} from "lowcoder-sdk"; +import { getEchartsLocale, trans } from "i18n/comps"; +import { ItemColorComp } from "comps/basicChartComp/chartConfigs/lineChartConfig"; +import { + echartsConfigOmitChildren, + getEchartsConfig, + getSelectedPoints, +} from "./lineChartUtils"; +import 'echarts-extension-gmap'; +import log from "loglevel"; + +let clickEventCallback = () => {}; + +const chartModeOptions = [ + { + label: "ECharts JSON", + value: "json", + } +] as const; + +let LineChartTmpComp = (function () { + return new UICompBuilder({mode:dropdownControl(chartModeOptions,'ui'),...lineChartChildrenMap}, () => null) + .setPropertyViewFn(lineChartPropertyView) + .build(); +})(); + +LineChartTmpComp = withViewFn(LineChartTmpComp, (comp) => { + const mode = comp.children.mode.getView(); + const onUIEvent = comp.children.onUIEvent.getView(); + const onEvent = comp.children.onEvent.getView(); + const echartsCompRef = useRef<ReactECharts | null>(); + const [chartSize, setChartSize] = useState<ChartSize>(); + const firstResize = useRef(true); + const theme = useContext(ThemeContext); + const defaultChartTheme = { + color: chartColorPalette, + backgroundColor: "#fff", + }; + + let themeConfig = defaultChartTheme; + try { + themeConfig = theme?.theme.chart ? JSON.parse(theme?.theme.chart) : defaultChartTheme; + } catch (error) { + log.error('theme chart error: ', error); + } + + const triggerClickEvent = async (dispatch: any, action: CompAction<JSONValue>) => { + await getPromiseAfterDispatch( + dispatch, + action, + { autoHandleAfterReduce: true } + ); + onEvent('click'); + } + + useEffect(() => { + const echartsCompInstance = echartsCompRef?.current?.getEchartsInstance(); + if (!echartsCompInstance) { + return _.noop; + } + echartsCompInstance?.on("click", (param: any) => { + document.dispatchEvent(new CustomEvent("clickEvent", { + bubbles: true, + detail: { + action: 'click', + data: param.data, + } + })); + triggerClickEvent( + comp.dispatch, + changeChildAction("lastInteractionData", param.data, false) + ); + }); + return () => { + echartsCompInstance?.off("click"); + document.removeEventListener('clickEvent', clickEventCallback) + }; + }, []); + + useEffect(() => { + // bind events + const echartsCompInstance = echartsCompRef?.current?.getEchartsInstance(); + if (!echartsCompInstance) { + return _.noop; + } + echartsCompInstance?.on("selectchanged", (param: any) => { + const option: any = echartsCompInstance?.getOption(); + document.dispatchEvent(new CustomEvent("clickEvent", { + bubbles: true, + detail: { + action: param.fromAction, + data: getSelectedPoints(param, option) + } + })); + + if (param.fromAction === "select") { + comp.dispatch(changeChildAction("selectedPoints", getSelectedPoints(param, option), false)); + onUIEvent("select"); + } else if (param.fromAction === "unselect") { + comp.dispatch(changeChildAction("selectedPoints", getSelectedPoints(param, option), false)); + onUIEvent("unselect"); + } + + triggerClickEvent( + comp.dispatch, + changeChildAction("lastInteractionData", getSelectedPoints(param, option), false) + ); + }); + // unbind + return () => { + echartsCompInstance?.off("selectchanged"); + document.removeEventListener('clickEvent', clickEventCallback) + }; + }, [onUIEvent]); + + const echartsConfigChildren = _.omit(comp.children, echartsConfigOmitChildren); + const childrenProps = childrenToProps(echartsConfigChildren); + const option = useMemo(() => { + return getEchartsConfig( + childrenProps as ToViewReturn<typeof echartsConfigChildren>, + chartSize, + themeConfig + ); + }, [theme, childrenProps, chartSize, ...Object.values(echartsConfigChildren)]); + + return ( + <ReactResizeDetector + onResize={(w, h) => { + if (w && h) { + setChartSize({ w: w, h: h }); + } + if (!firstResize.current) { + // ignore the first resize, which will impact the loading animation + echartsCompRef.current?.getEchartsInstance().resize(); + } else { + firstResize.current = false; + } + }} + > + <ReactECharts + ref={(e) => (echartsCompRef.current = e)} + style={{ height: "100%" }} + notMerge + lazyUpdate + opts={{ locale: getEchartsLocale() }} + option={option} + mode={mode} + /> + </ReactResizeDetector> + ); +}); + +function getYAxisFormatContextValue( + data: Array<JSONObject>, + yAxisType: EchartsAxisType, + yAxisName?: string +) { + const dataSample = yAxisName && data.length > 0 && data[0][yAxisName]; + let contextValue = dataSample; + if (yAxisType === "time") { + // to timestamp + const time = + typeof dataSample === "number" || typeof dataSample === "string" + ? new Date(dataSample).getTime() + : null; + if (time) contextValue = time; + } + return contextValue; +} + +LineChartTmpComp = class extends LineChartTmpComp { + private lastYAxisFormatContextVal?: JSONValue; + private lastColorContext?: JSONObject; + + updateContext(comp: this) { + // the context value of axis format + let resultComp = comp; + const data = comp.children.data.getView(); + const sampleSeries = comp.children.series.getView().find((s) => !s.getView().hide); + const yAxisContextValue = getYAxisFormatContextValue( + data, + comp.children.yConfig.children.yAxisType.getView(), + sampleSeries?.children.columnName.getView() + ); + if (yAxisContextValue !== comp.lastYAxisFormatContextVal) { + comp.lastYAxisFormatContextVal = yAxisContextValue; + resultComp = comp.setChild( + "yConfig", + comp.children.yConfig.reduce( + wrapChildAction( + "formatter", + AxisFormatterComp.changeContextDataAction({ value: yAxisContextValue }) + ) + ) + ); + } + // item color context + const colorContextVal = { + seriesName: sampleSeries?.children.seriesName.getView(), + value: yAxisContextValue, + }; + if ( + comp.children.chartConfig.children.comp.children.hasOwnProperty("itemColor") && + !_.isEqual(colorContextVal, comp.lastColorContext) + ) { + comp.lastColorContext = colorContextVal; + resultComp = resultComp.setChild( + "chartConfig", + comp.children.chartConfig.reduce( + wrapChildAction( + "comp", + wrapChildAction("itemColor", ItemColorComp.changeContextDataAction(colorContextVal)) + ) + ) + ); + } + return resultComp; + } + + override reduce(action: CompAction): this { + const comp = super.reduce(action); + if (action.type === CompActionTypes.UPDATE_NODES_V2) { + const newData = comp.children.data.getView(); + // data changes + if (comp.children.data !== this.children.data) { + setTimeout(() => { + // update x-axis value + const keys = getDataKeys(newData); + if (keys.length > 0 && !keys.includes(comp.children.xAxisKey.getView())) { + comp.children.xAxisKey.dispatch(changeValueAction(keys[0] || "")); + } + // pass to child series comp + comp.children.series.dispatchDataChanged(newData); + }, 0); + } + return this.updateContext(comp); + } + return comp; + } + + override autoHeight(): boolean { + return false; + } +}; + +let LineChartComp = withExposingConfigs(LineChartTmpComp, [ + depsConfig({ + name: "selectedPoints", + desc: trans("chart.selectedPointsDesc"), + depKeys: ["selectedPoints"], + func: (input) => { + return input.selectedPoints; + }, + }), + depsConfig({ + name: "lastInteractionData", + desc: trans("chart.lastInteractionDataDesc"), + depKeys: ["lastInteractionData"], + func: (input) => { + return input.lastInteractionData; + }, + }), + depsConfig({ + name: "data", + desc: trans("chart.dataDesc"), + depKeys: ["data", "mode"], + func: (input) =>[] , + }), + new NameConfig("title", trans("chart.titleDesc")), +]); + + +export const LineChartCompWithDefault = withDefault(LineChartComp, { + xAxisKey: "date", + series: [ + { + dataIndex: genRandomKey(), + seriesName: trans("chart.spending"), + columnName: "spending", + }, + { + dataIndex: genRandomKey(), + seriesName: trans("chart.budget"), + columnName: "budget", + }, + ], +}); diff --git a/client/packages/lowcoder-comps/src/comps/lineChartComp/lineChartConstants.tsx b/client/packages/lowcoder-comps/src/comps/lineChartComp/lineChartConstants.tsx new file mode 100644 index 000000000..2685f1972 --- /dev/null +++ b/client/packages/lowcoder-comps/src/comps/lineChartComp/lineChartConstants.tsx @@ -0,0 +1,315 @@ +import { + jsonControl, + stateComp, + toJSONObjectArray, + toObject, + BoolControl, + ColorControl, + withDefault, + StringControl, + NumberControl, + dropdownControl, + list, + eventHandlerControl, + valueComp, + withType, + uiChildren, + clickEvent, + toArray, + styleControl, + EchartDefaultTextStyle, + EchartDefaultChartStyle, + MultiCompBuilder, +} from "lowcoder-sdk"; +import { RecordConstructorToComp, RecordConstructorToView } from "lowcoder-core"; +import { BarChartConfig } from "../basicChartComp/chartConfigs/barChartConfig"; +import { XAxisConfig, YAxisConfig } from "../basicChartComp/chartConfigs/cartesianAxisConfig"; +import { LegendConfig } from "../basicChartComp/chartConfigs/legendConfig"; +import { EchartsLegendConfig } from "../basicChartComp/chartConfigs/echartsLegendConfig"; +import { EchartsLabelConfig } from "../basicChartComp/chartConfigs/echartsLabelConfig"; +import { LineChartConfig } from "../basicChartComp/chartConfigs/lineChartConfig"; +import { PieChartConfig } from "../basicChartComp/chartConfigs/pieChartConfig"; +import { ScatterChartConfig } from "../basicChartComp/chartConfigs/scatterChartConfig"; +import { SeriesListComp } from "./seriesComp"; +import { EChartsOption } from "echarts"; +import { i18nObjs, trans } from "i18n/comps"; +import { GaugeChartConfig } from "../basicChartComp/chartConfigs/gaugeChartConfig"; +import { FunnelChartConfig } from "../basicChartComp/chartConfigs/funnelChartConfig"; +import {EchartsTitleVerticalConfig} from "../chartComp/chartConfigs/echartsTitleVerticalConfig"; +import {EchartsTitleConfig} from "../basicChartComp/chartConfigs/echartsTitleConfig"; + +export const ChartTypeOptions = [ + { + label: trans("chart.bar"), + value: "bar", + }, + { + label: trans("chart.line"), + value: "line", + }, + { + label: trans("chart.scatter"), + value: "scatter", + }, + { + label: trans("chart.pie"), + value: "pie", + }, +] as const; + +export const UIEventOptions = [ + { + label: trans("chart.select"), + value: "select", + description: trans("chart.selectDesc"), + }, + { + label: trans("chart.unSelect"), + value: "unselect", + description: trans("chart.unselectDesc"), + }, +] as const; + +export const XAxisDirectionOptions = [ + { + label: trans("chart.horizontal"), + value: "horizontal", + }, + { + label: trans("chart.vertical"), + value: "vertical", + }, +] as const; + +export type XAxisDirectionType = ValueFromOption<typeof XAxisDirectionOptions>; + +export const noDataAxisConfig = { + animation: false, + xAxis: { + type: "category", + name: trans("chart.noData"), + nameLocation: "middle", + data: [], + axisLine: { + lineStyle: { + color: "#8B8FA3", + }, + }, + }, + yAxis: { + type: "value", + axisLabel: { + color: "#8B8FA3", + }, + splitLine: { + lineStyle: { + color: "#F0F0F0", + }, + }, + }, + tooltip: { + show: false, + }, + series: [ + { + data: [700], + type: "line", + itemStyle: { + opacity: 0, + }, + }, + ], +} as EChartsOption; + +export const noDataPieChartConfig = { + animation: false, + tooltip: { + show: false, + }, + legend: { + formatter: trans("chart.unknown"), + top: "bottom", + selectedMode: false, + }, + color: ["#B8BBCC", "#CED0D9", "#DCDEE6", "#E6E6EB"], + series: [ + { + type: "pie", + radius: "35%", + center: ["25%", "50%"], + silent: true, + label: { + show: false, + }, + data: [ + { + name: "1", + value: 70, + }, + { + name: "2", + value: 68, + }, + { + name: "3", + value: 48, + }, + { + name: "4", + value: 40, + }, + ], + }, + { + type: "pie", + radius: "35%", + center: ["75%", "50%"], + silent: true, + label: { + show: false, + }, + data: [ + { + name: "1", + value: 70, + }, + { + name: "2", + value: 68, + }, + { + name: "3", + value: 48, + }, + { + name: "4", + value: 40, + }, + ], + }, + ], +} as EChartsOption; + +const areaPiecesChildrenMap = { + color: ColorControl, + from: StringControl, + to: StringControl, + // unique key, for sort + dataIndex: valueComp<string>(""), +}; +const AreaPiecesTmpComp = new MultiCompBuilder(areaPiecesChildrenMap, (props) => { + return props; +}) + .setPropertyViewFn((children: any) => + (<> + {children.color.propertyView({label: trans("lineChart.color")})} + {children.from.propertyView({label: trans("lineChart.from")})} + {children.to.propertyView({label: trans("lineChart.to")})} + </>) + ) + .build(); + +export type ChartSize = { w: number; h: number }; + +export const getDataKeys = (data: Array<JSONObject>) => { + if (!data) { + return []; + } + const dataKeys: Array<string> = []; + data.slice(0, 50).forEach((d) => { + Object.keys(d).forEach((key) => { + if (!dataKeys.includes(key)) { + dataKeys.push(key); + } + }); + }); + return dataKeys; +}; + +const ChartOptionMap = { + bar: BarChartConfig, + line: LineChartConfig, + pie: PieChartConfig, + scatter: ScatterChartConfig, +}; + +const EchartsOptionMap = { + funnel: FunnelChartConfig, + gauge: GaugeChartConfig, +}; + +const ChartOptionComp = withType(ChartOptionMap, "line"); +const EchartsOptionComp = withType(EchartsOptionMap, "funnel"); +export type CharOptionCompType = keyof typeof ChartOptionMap; + +export const chartUiModeChildren = { + title: withDefault(StringControl, trans("echarts.defaultTitle")), + data: jsonControl(toJSONObjectArray, i18nObjs.defaultDataSource), + xAxisKey: valueComp<string>(""), // x-axis, key from data + xAxisDirection: dropdownControl(XAxisDirectionOptions, "horizontal"), + xAxisData: jsonControl(toArray, []), + series: SeriesListComp, + xConfig: XAxisConfig, + yConfig: YAxisConfig, + legendConfig: LegendConfig, + chartConfig: ChartOptionComp, + areaPieces: list(AreaPiecesTmpComp), + animationDuration: withDefault(NumberControl, 1000), + onUIEvent: eventHandlerControl(UIEventOptions), +}; + +let chartJsonModeChildren: any = { + echartsOption: jsonControl(toObject, i18nObjs.defaultEchartsJsonOption), + echartsTitle: withDefault(StringControl, trans("echarts.defaultTitle")), + echartsLegendConfig: EchartsLegendConfig, + echartsLabelConfig: EchartsLabelConfig, + echartsConfig: EchartsOptionComp, + echartsTitleVerticalConfig: EchartsTitleVerticalConfig, + echartsTitleConfig:EchartsTitleConfig, + + left:withDefault(NumberControl,trans('chart.defaultLeft')), + right:withDefault(NumberControl,trans('chart.defaultRight')), + top:withDefault(NumberControl,trans('chart.defaultTop')), + bottom:withDefault(NumberControl,trans('chart.defaultBottom')), + + tooltip: withDefault(BoolControl, true), + legendVisibility: withDefault(BoolControl, true), +} + +if (EchartDefaultChartStyle && EchartDefaultTextStyle) { + chartJsonModeChildren = { + ...chartJsonModeChildren, + chartStyle: styleControl(EchartDefaultChartStyle, 'chartStyle'), + titleStyle: styleControl(EchartDefaultTextStyle, 'titleStyle'), + xAxisStyle: styleControl(EchartDefaultTextStyle, 'xAxis'), + yAxisStyle: styleControl(EchartDefaultTextStyle, 'yAxisStyle'), + legendStyle: styleControl(EchartDefaultTextStyle, 'legendStyle'), + } +} + +export type UIChartDataType = { + seriesName: string; + // coordinate chart + x?: any; + y?: any; + // pie or funnel + itemName?: any; + value?: any; +}; + +export type NonUIChartDataType = { + name: string; + value: any; +} + +export const lineChartChildrenMap = { + selectedPoints: stateComp<Array<UIChartDataType>>([]), + lastInteractionData: stateComp<Array<UIChartDataType> | NonUIChartDataType>({}), + onEvent: eventHandlerControl([clickEvent] as const), + ...chartUiModeChildren, + ...chartJsonModeChildren, +}; + +const chartUiChildrenMap = uiChildren(lineChartChildrenMap); +export type ChartCompPropsType = RecordConstructorToView<typeof chartUiChildrenMap>; +export type ChartCompChildrenType = RecordConstructorToComp<typeof chartUiChildrenMap>; diff --git a/client/packages/lowcoder-comps/src/comps/lineChartComp/lineChartPropertyView.tsx b/client/packages/lowcoder-comps/src/comps/lineChartComp/lineChartPropertyView.tsx new file mode 100644 index 000000000..5a67d8ecf --- /dev/null +++ b/client/packages/lowcoder-comps/src/comps/lineChartComp/lineChartPropertyView.tsx @@ -0,0 +1,187 @@ +import { changeChildAction, CompAction } from "lowcoder-core"; +import { ChartCompChildrenType, ChartTypeOptions,getDataKeys } from "./lineChartConstants"; +import { newSeries } from "./seriesComp"; +import { + CustomModal, + Dropdown, + hiddenPropertyView, + Option, + RedButton, + Section, + sectionNames, + controlItem, +} from "lowcoder-sdk"; +import { trans } from "i18n/comps"; + +export function lineChartPropertyView( + children: ChartCompChildrenType, + dispatch: (action: CompAction) => void +) { + const series = children.series.getView(); + const columnOptions = getDataKeys(children.data.getView()).map((key) => ({ + label: key, + value: key, + })); + + const uiModePropertyView = ( + <> + <Section name={trans("chart.data")}> + {children.chartConfig.getPropertyView()} + {children.animationDuration.propertyView({label: trans("lineChart.animationDuration")})} + <Dropdown + value={children.xAxisKey.getView()} + options={columnOptions} + label={trans("chart.xAxis")} + onChange={(value) => { + dispatch(changeChildAction("xAxisKey", value)); + }} + /> + {children.chartConfig.getView().subtype === "waterfall" && children.xAxisData.propertyView({ + label: "X-Label-Data" + })} + <Option + items={series} + title={trans("chart.chartSeries")} + itemTitle={(s) => s.getView().seriesName} + popoverTitle={(s) => s.getView().columnName} + content={(s, index) => ( + <> + {s.getPropertyViewWithData(columnOptions)} + { + <RedButton + onClick={() => { + CustomModal.confirm({ + title: trans("chart.delete"), + content: trans("chart.confirmDelete") + `${s.getView().seriesName}?`, + onConfirm: () => + children.series.dispatch(children.series.deleteAction(index)), + confirmBtnType: "delete", + okText: trans("chart.delete"), + }); + }} + > + {trans("chart.delete")} + </RedButton> + } + </> + )} + onAdd={() => { + if (columnOptions.length <= 0) { + return; + } + children.series.dispatch( + children.series.pushAction( + newSeries(trans("chart.customSeries"), columnOptions[0].value) + ) + ); + }} + onMove={(fromIndex, toIndex) => { + const action = children.series.arrayMoveAction(fromIndex, toIndex); + children.series.dispatch(action); + }} + hide={(s) => s.getView().hide} + onHide={(s, hide) => s.children.hide.dispatchChangeValueAction(hide)} + dataIndex={(s) => s.getView().dataIndex} + /> + <Option + items={children.areaPieces.getView()} + title={trans("lineChart.areaPieces")} + itemTitle={(s) => `[${s.getView().from}-${s.getView().to}] ${s.getView().color}`} + popoverTitle={(s) => trans("lineChart.areaPiece")} + content={(s, index) => ( + <> + {s.getPropertyView({label: "Type"})} + { + <RedButton + onClick={() => { + children.areaPieces.dispatch(children.areaPieces.deleteAction(index)); + }} + > + {trans("chart.delete")} + </RedButton> + } + </> + )} + onAdd={() => { + children.areaPieces.dispatch( + children.areaPieces.pushAction( + {} + ) + ); + }} + onMove={(fromIndex, toIndex) => { + const action = children.areaPieces.arrayMoveAction(fromIndex, toIndex); + children.areaPieces.dispatch(action); + }} + hide={(s) => true} + onHide={(s, hide) => console.log("onHide")} + dataIndex={(s) => { + return s.getView().dataIndex; + }} + /> + </Section> + <Section name={sectionNames.interaction}> + <div style={{display: 'flex', flexDirection: 'column', gap: '8px'}}> + {children.onUIEvent.propertyView({title: trans("chart.chartEventHandlers")})} + </div> + <div style={{display: 'flex', flexDirection: 'column', gap: '8px'}}> + {children.onEvent.propertyView()} + </div> + </Section> + <Section name={sectionNames.layout}> + {children.echartsTitleConfig.getPropertyView()} + {children.echartsTitleVerticalConfig.getPropertyView()} + {children.legendConfig.getPropertyView()} + {children.title.propertyView({ label: trans("chart.title") })} + {children.left.propertyView({ label: trans("chart.left"), tooltip: trans("echarts.leftTooltip") })} + {children.right.propertyView({ label: trans("chart.right"), tooltip: trans("echarts.rightTooltip") })} + {children.top.propertyView({ label: trans("chart.top"), tooltip: trans("echarts.topTooltip") })} + {children.bottom.propertyView({ label: trans("chart.bottom"), tooltip: trans("echarts.bottomTooltip") })} + {children.chartConfig.children.compType.getView() !== "pie" && ( + <> + {children.xAxisDirection.propertyView({ + label: trans("chart.xAxisDirection"), + radioButton: true, + })} + {children.xConfig.getPropertyView()} + {children.yConfig.getPropertyView()} + </> + )} + {hiddenPropertyView(children)} + {children.tooltip.propertyView({label: trans("echarts.tooltip"), tooltip: trans("echarts.tooltipTooltip")})} + </Section> + <Section name={sectionNames.chartStyle}> + {children.chartStyle?.getPropertyView()} + </Section> + <Section name={sectionNames.titleStyle}> + {children.titleStyle?.getPropertyView()} + </Section> + <Section name={sectionNames.xAxisStyle}> + {children.xAxisStyle?.getPropertyView()} + </Section> + <Section name={sectionNames.yAxisStyle}> + {children.yAxisStyle?.getPropertyView()} + </Section> + <Section name={sectionNames.legendStyle}> + {children.legendStyle?.getPropertyView()} + </Section> + <Section name={sectionNames.advanced}> + {children.data.propertyView({ + label: trans("chart.data"), + })} + </Section> + </> + ); + + const getChatConfigByMode = (mode: string) => { + switch(mode) { + case "ui": + return uiModePropertyView; + } + } + return ( + <> + {getChatConfigByMode(children.mode.getView())} + </> + ); +} diff --git a/client/packages/lowcoder-comps/src/comps/lineChartComp/lineChartUtils.ts b/client/packages/lowcoder-comps/src/comps/lineChartComp/lineChartUtils.ts new file mode 100644 index 000000000..3dfb3769e --- /dev/null +++ b/client/packages/lowcoder-comps/src/comps/lineChartComp/lineChartUtils.ts @@ -0,0 +1,398 @@ +import { + CharOptionCompType, + ChartCompPropsType, + ChartSize, + noDataAxisConfig, + noDataPieChartConfig, +} from "comps/lineChartComp/lineChartConstants"; +import { getPieRadiusAndCenter } from "comps/basicChartComp/chartConfigs/pieChartConfig"; +import { EChartsOptionWithMap } from "../basicChartComp/reactEcharts/types"; +import _ from "lodash"; +import { chartColorPalette, isNumeric, JSONObject, loadScript } from "lowcoder-sdk"; +import { calcXYConfig } from "comps/basicChartComp/chartConfigs/cartesianAxisConfig"; +import Big from "big.js"; +import { googleMapsApiUrl } from "../basicChartComp/chartConfigs/chartUrls"; +import opacityToHex from "../../util/opacityToHex"; +import parseBackground from "../../util/gradientBackgroundColor"; +import {ba, s} from "@fullcalendar/core/internal-common"; +import {chartStyleWrapper, styleWrapper} from "../../util/styleWrapper"; + +export function transformData( + originData: JSONObject[], + xAxis: string, + seriesColumnNames: string[] +) { + // aggregate data by x-axis + const transformedData: JSONObject[] = []; + originData.reduce((prev, cur) => { + if (cur === null || cur === undefined) { + return prev; + } + const groupValue = cur[xAxis] as string; + if (!prev[groupValue]) { + // init as 0 + const initValue: any = {}; + seriesColumnNames.forEach((name) => { + initValue[name] = 0; + }); + prev[groupValue] = initValue; + transformedData.push(prev[groupValue]); + } + // remain the x-axis data + prev[groupValue][xAxis] = groupValue; + seriesColumnNames.forEach((key) => { + if (key === xAxis) { + return; + } else if (isNumeric(cur[key])) { + const bigNum = Big(cur[key]); + prev[groupValue][key] = bigNum.add(prev[groupValue][key]).toNumber(); + } else { + prev[groupValue][key] += 1; + } + }); + return prev; + }, {} as any); + return transformedData; +} + +const notAxisChartSet: Set<CharOptionCompType> = new Set(["pie"] as const); +const notAxisChartSubtypeSet: Set<string> = new Set(["polar"] as const); +export const echartsConfigOmitChildren = [ + "hidden", + "selectedPoints", + "onUIEvent", + "mapInstance" +] as const; +type EchartsConfigProps = Omit<ChartCompPropsType, typeof echartsConfigOmitChildren[number]>; + + +export function isAxisChart(type: CharOptionCompType, polar: boolean) { + return !notAxisChartSet.has(type) && !polar; +} + +export function getSeriesConfig(props: EchartsConfigProps) { + let visibleSeries = props.series.filter((s) => !s.getView().hide); + if(props.chartConfig.subtype === "waterfall") { + const seriesOn = visibleSeries[0]; + const seriesPlaceholder = visibleSeries[0]; + visibleSeries = [seriesPlaceholder, seriesOn]; + } + const seriesLength = visibleSeries.length; + return visibleSeries.map((s, index) => { + if (isAxisChart(props.chartConfig.type, props.chartConfig.polarData.polar)) { + let encodeX: string, encodeY: string; + const horizontalX = props.xAxisDirection === "horizontal"; + let itemStyle = props.chartConfig.itemStyle; + + if (horizontalX) { + encodeX = props.xAxisKey; + encodeY = s.getView().columnName; + } else { + encodeX = s.getView().columnName; + encodeY = props.xAxisKey; + } + const markLineData = s.getView().markLines.map(line => ({type: line.getView().type})); + const markAreaData = s.getView().markAreas.map(area => ([{name: area.getView().name, [horizontalX?"xAxis":"yAxis"]: area.getView().from, label: { + position: horizontalX?"top":"right", + }}, {[horizontalX?"xAxis":"yAxis"]: area.getView().to}])); + return { + name: s.getView().seriesName, + columnName: s.getView().columnName, + selectedMode: "single", + select: { + itemStyle: { + borderColor: "#000", + }, + }, + step: s.getView().step, + encode: { + x: encodeX, + y: encodeY, + }, + markLine: { + data: markLineData, + }, + markArea: { + itemStyle: { + color: 'rgba(255, 173, 177, 0.4)', + }, + data: markAreaData, + }, + // each type of chart's config + ...props.chartConfig, + itemStyle: itemStyle, + label: { + ...props.chartConfig.label, + ...(!horizontalX && { position: "outside" }), + }, + }; + } else { + const radiusAndCenter = getPieRadiusAndCenter(seriesLength, index, props.chartConfig); + return { + ...props.chartConfig, + columnName: s.getView().columnName, + radius: radiusAndCenter.radius, + center: radiusAndCenter.center, + name: s.getView().seriesName, + selectedMode: "single", + encode: { + itemName: props.xAxisKey, + value: s.getView().columnName, + }, + }; + } + }); +} + +// https://echarts.apache.org/en/option.html +export function getEchartsConfig( + props: EchartsConfigProps, + chartSize?: ChartSize, + theme?: any, +): EChartsOptionWithMap { + // axisChart + const axisChart = isAxisChart(props.chartConfig.type, props.chartConfig.polarData.polar); + const gridPos = { + left: `${props?.left}%`, + right: `${props?.right}%`, + bottom: `${props?.bottom}%`, + top: `${props?.top}%`, + }; + + let config: any = { + title: { + text: props.title, + top: props.echartsTitleVerticalConfig.top, + left:props.echartsTitleConfig.top, + textStyle: { + ...styleWrapper(props?.titleStyle, theme?.titleStyle) + } + }, + backgroundColor: parseBackground( props?.chartStyle?.background || theme?.chartStyle?.backgroundColor || "#FFFFFF"), + legend: { + ...props.legendConfig, + textStyle: { + ...styleWrapper(props?.legendStyle, theme?.legendStyle, 15) + } + }, + tooltip: props.tooltip && { + trigger: "axis", + axisPointer: { + type: "line", + lineStyle: { + color: "rgba(0,0,0,0.2)", + width: 2, + type: "solid" + } + } + }, + grid: { + ...gridPos, + containLabel: true, + }, + animationDuration: props.animationDuration, + }; + if (props.areaPieces.length > 0) { + config.visualMap = { + type: 'piecewise', + show: false, + dimension: 0, + seriesIndex: 0, + pieces: props.areaPieces?.filter(p => p.getView().from && p.getView().to && p.getView().color)?.map(p => ( + { + ...(p.getView().from?{min: parseInt(p.getView().from)}:{}), + ...(p.getView().to?{max: parseInt(p.getView().to)}:{}), + ...(p.getView().color?{color: p.getView().color}:{}), + } + )) + } + } + if(props.chartConfig.race) { + config = { + ...config, + // Disable init animation. + animationDuration: 0, + animationDurationUpdate: 2000, + animationEasing: 'linear', + animationEasingUpdate: 'linear', + } + } + if (props.data.length <= 0) { + // no data + return { + ...config, + ...(axisChart ? noDataAxisConfig : noDataPieChartConfig), + }; + } + const yAxisConfig = props.yConfig(); + const seriesColumnNames = props.series + .filter((s) => !s.getView().hide) + .map((s) => s.getView().columnName); + // y-axis is category and time, data doesn't need to aggregate + let transformedData = + yAxisConfig.type === "category" || yAxisConfig.type === "time" ? props.data : transformData(props.data, props.xAxisKey, seriesColumnNames); + + if(props.chartConfig.polarData.polar) { + config = { + ...config, + polar: { + radius: [props.chartConfig.polarData.polarRadiusStart, props.chartConfig.polarData.polarRadiusEnd], + }, + radiusAxis: { + type: props.chartConfig.polarData.polarIsTangent?'category':undefined, + data: props.chartConfig.polarData.polarIsTangent && props.chartConfig.polarData.labelData.length!==0?props.chartConfig.polarData.labelData:undefined, + max: props.chartConfig.polarData.polarIsTangent?undefined:props.chartConfig.polarData.radiusAxisMax || undefined, + }, + angleAxis: { + type: props.chartConfig.polarData.polarIsTangent?undefined:'category', + data: !props.chartConfig.polarData.polarIsTangent && props.chartConfig.polarData.labelData.length!==0?props.chartConfig.polarData.labelData:undefined, + max: props.chartConfig.polarData.polarIsTangent?props.chartConfig.polarData.radiusAxisMax || undefined:undefined, + startAngle: props.chartConfig.polarData.polarStartAngle, + endAngle: props.chartConfig.polarData.polarEndAngle, + }, + } + } + + config = { + ...config, + dataset: [ + { + source: transformedData, + sourceHeader: false, + }, + ], + series: getSeriesConfig(props).map(series => ({ + ...series, + encode: { + ...series.encode, + y: series.columnName, + }, + itemStyle: { + ...series.itemStyle, + // ...chartStyleWrapper(props?.chartStyle, theme?.chartStyle) + }, + lineStyle: { + ...chartStyleWrapper(props?.chartStyle, theme?.chartStyle) + }, + data: transformedData.map((i: any) => i[series.columnName]) + })), + }; + if (axisChart) { + // pure chart's size except the margin around + let chartRealSize; + if (chartSize) { + const rightSize = + typeof gridPos.right === "number" + ? gridPos.right + : (chartSize.w * parseFloat(gridPos.right)) / 100.0; + chartRealSize = { + // actually it's self-adaptive with the x-axis label on the left, not that accurate but work + w: chartSize.w - gridPos.left - rightSize, + // also self-adaptive on the bottom + h: chartSize.h - gridPos.top - gridPos.bottom, + right: rightSize, + }; + } + const finalXyConfig = calcXYConfig( + props.xConfig, + yAxisConfig, + props.xAxisDirection, + transformedData.map((d) => d[props.xAxisKey]), + chartRealSize + ); + config = { + ...config, + // @ts-ignore + xAxis: { + ...finalXyConfig.xConfig, + axisLabel: { + ...styleWrapper(props?.xAxisStyle, theme?.xAxisStyle, 11) + }, + data: finalXyConfig.xConfig.type === "category" && (props.xAxisData as []).length!==0?props?.xAxisData:transformedData.map((i: any) => i[props.xAxisKey]), + }, + // @ts-ignore + yAxis: { + ...finalXyConfig.yConfig, + axisLabel: { + ...styleWrapper(props?.yAxisStyle, theme?.yAxisStyle, 11) + }, + data: finalXyConfig.yConfig.type === "category" && (props.xAxisData as []).length!==0?props?.xAxisData:transformedData.map((i: any) => i[props.xAxisKey]), + }, + }; + + if(props.chartConfig.race) { + config = { + ...config, + xAxis: { + ...config.xAxis, + animationDuration: 300, + animationDurationUpdate: 300 + }, + yAxis: { + ...config.yAxis, + animationDuration: 300, + animationDurationUpdate: 300 + }, + } + } + } + + // console.log("Echarts transformedData and config", transformedData, config); + return config; +} + +export function getSelectedPoints(param: any, option: any) { + const series = option.series; + const dataSource = _.isArray(option.dataset) && option.dataset[0]?.source; + if (series && dataSource) { + return param.selected.flatMap((selectInfo: any) => { + const seriesInfo = series[selectInfo.seriesIndex]; + if (!seriesInfo || !seriesInfo.encode) { + return []; + } + return selectInfo.dataIndex.map((index: any) => { + const commonResult = { + seriesName: seriesInfo.name, + }; + if (seriesInfo.encode.itemName && seriesInfo.encode.value) { + return { + ...commonResult, + itemName: dataSource[index][seriesInfo.encode.itemName], + value: dataSource[index][seriesInfo.encode.value], + }; + } else { + return { + ...commonResult, + x: dataSource[index][seriesInfo.encode.x], + y: dataSource[index][seriesInfo.encode.y], + }; + } + }); + }); + } + return []; +} + +export function loadGoogleMapsScript(apiKey: string) { + const mapsUrl = `${googleMapsApiUrl}?key=${apiKey}`; + const scripts = document.getElementsByTagName('script'); + // is script already loaded + let scriptIndex = _.findIndex(scripts, (script) => script.src.endsWith(mapsUrl)); + if(scriptIndex > -1) { + return scripts[scriptIndex]; + } + // is script loaded with diff api_key, remove the script and load again + scriptIndex = _.findIndex(scripts, (script) => script.src.startsWith(googleMapsApiUrl)); + if(scriptIndex > -1) { + scripts[scriptIndex].remove(); + } + + const script = document.createElement("script"); + script.type = "text/javascript"; + script.src = mapsUrl; + script.async = true; + script.defer = true; + window.document.body.appendChild(script); + + return script; +} diff --git a/client/packages/lowcoder-comps/src/comps/lineChartComp/seriesComp.tsx b/client/packages/lowcoder-comps/src/comps/lineChartComp/seriesComp.tsx new file mode 100644 index 000000000..5a61774f5 --- /dev/null +++ b/client/packages/lowcoder-comps/src/comps/lineChartComp/seriesComp.tsx @@ -0,0 +1,280 @@ +import { + BoolControl, + StringControl, + list, + isNumeric, + genRandomKey, + Dropdown, + Option, + RedButton, + CustomModal, + MultiCompBuilder, + valueComp, + dropdownControl, +} from "lowcoder-sdk"; +import { trans } from "i18n/comps"; + +import { ConstructorToComp, ConstructorToDataType, ConstructorToView } from "lowcoder-core"; +import { CompAction, CustomAction, customAction, isMyCustomAction } from "lowcoder-core"; + +export type SeriesCompType = ConstructorToComp<typeof SeriesComp>; +export type RawSeriesCompType = ConstructorToView<typeof SeriesComp>; +type SeriesDataType = ConstructorToDataType<typeof SeriesComp>; +type MarkLineDataType = ConstructorToDataType<typeof MarkLinesTmpComp>; + +type ActionDataType = { + type: "chartDataChanged"; + chartData: Array<JSONObject>; +}; + +export function newSeries(name: string, columnName: string): SeriesDataType { + return { + seriesName: name, + columnName: columnName, + dataIndex: genRandomKey(), + }; +} + +export function newMarkLine(type: string): MarkLineDataType { + return { + type, + dataIndex: genRandomKey(), + }; +} + +export const MarkLineTypeOptions = [ + { + label: trans("lineChart.max"), + value: "max", + }, + { + label: trans("lineChart.average"), + value: "average", + }, + { + label: trans("lineChart.min"), + value: "min", + }, +] as const; + +export const StepOptions = [ + { + label: trans("lineChart.none"), + value: "", + }, + { + label: trans("lineChart.start"), + value: "start", + }, + { + label: trans("lineChart.middle"), + value: "middle", + }, + { + label: trans("lineChart.end"), + value: "end", + }, +] as const; + +const valToLabel = (val) => MarkLineTypeOptions.find(o => o.value === val)?.label || ""; +const markLinesChildrenMap = { + type: dropdownControl(MarkLineTypeOptions, "max"), + // unique key, for sort + dataIndex: valueComp<string>(""), +}; +const MarkLinesTmpComp = new MultiCompBuilder(markLinesChildrenMap, (props) => { + return props; +}) + .setPropertyViewFn((children: any) => { + return <>{children.type.propertyView({label: trans("lineChart.type")})}</>; + }) + .build(); +const markAreasChildrenMap = { + name: StringControl, + from: StringControl, + to: StringControl, + // unique key, for sort + dataIndex: valueComp<string>(""), +}; +const MarkAreasTmpComp = new MultiCompBuilder(markAreasChildrenMap, (props) => { + return props; +}) + .setPropertyViewFn((children: any) => + (<> + {children.name.propertyView({label: trans("lineChart.name")})} + {children.from.propertyView({label: trans("lineChart.from")})} + {children.to.propertyView({label: trans("lineChart.to")})} + </>) + ) + .build(); + + +export function newMarkArea(): MarkLineDataType { + return { + dataIndex: genRandomKey(), + }; +} + +const seriesChildrenMap = { + columnName: StringControl, + seriesName: StringControl, + markLines: list(MarkLinesTmpComp), + markAreas: list(MarkAreasTmpComp), + hide: BoolControl, + // unique key, for sort + dataIndex: valueComp<string>(""), + step: dropdownControl(StepOptions, ""), +}; + +const SeriesTmpComp = new MultiCompBuilder(seriesChildrenMap, (props) => { + return props; +}) + .setPropertyViewFn(() => { + return <></>; + }) + .build(); + +class SeriesComp extends SeriesTmpComp { + getPropertyViewWithData(columnOptions: OptionsType): React.ReactNode { + return ( + <> + {this.children.seriesName.propertyView({ + label: trans("chart.seriesName"), + })} + <Dropdown + value={this.children.columnName.getView()} + options={columnOptions} + label={trans("chart.dataColumns")} + onChange={(value) => { + this.children.columnName.dispatchChangeValueAction(value); + }} + /> + {this.children.step.propertyView({ + label: trans("lineChart.step"), + })} + <Option + items={this.children.markLines.getView()} + title={trans("lineChart.markLines")} + itemTitle={(s) => valToLabel(s.getView().type)} + popoverTitle={(s) => trans("lineChart.markLineType")} + content={(s, index) => ( + <> + {s.getPropertyView({label: "Type"})} + { + <RedButton + onClick={() => { + this.children.markLines.dispatch(this.children.markLines.deleteAction(index)); + }} + > + {trans("chart.delete")} + </RedButton> + } + </> + )} + onAdd={() => { + this.children.markLines.dispatch( + this.children.markLines.pushAction( + newMarkLine("max") + ) + ); + }} + onMove={(fromIndex, toIndex) => { + const action = this.children.markLines.arrayMoveAction(fromIndex, toIndex); + this.children.markLines.dispatch(action); + }} + hide={(s) => true} + onHide={(s, hide) => console.log("onHide")} + dataIndex={(s) => { + return s.getView().dataIndex; + }} + /> + <Option + items={this.children.markAreas.getView()} + title={trans("lineChart.markAreas")} + itemTitle={(s) => s.getView().name} + popoverTitle={(s) => trans("lineChart.markLineType")} + content={(s, index) => ( + <> + {s.getPropertyView({label: "Type"})} + { + <RedButton + onClick={() => { + this.children.markAreas.dispatch(this.children.markAreas.deleteAction(index)); + }} + > + {trans("chart.delete")} + </RedButton> + } + </> + )} + onAdd={() => { + this.children.markAreas.dispatch( + this.children.markAreas.pushAction( + newMarkArea() + ) + ); + }} + onMove={(fromIndex, toIndex) => { + const action = this.children.markAreas.arrayMoveAction(fromIndex, toIndex); + this.children.markAreas.dispatch(action); + }} + hide={(s) => true} + onHide={(s, hide) => console.log("onHide")} + dataIndex={(s) => { + return s.getView().dataIndex; + }} + /> + </> + ); + } +} + +const SeriesListTmpComp = list(SeriesComp); + +export class SeriesListComp extends SeriesListTmpComp { + override reduce(action: CompAction): this { + if (isMyCustomAction<ActionDataType>(action, "chartDataChanged")) { + // auto generate series + const actions = this.genExampleSeriesActions(action.value.chartData); + return this.reduce(this.multiAction(actions)); + } + return super.reduce(action); + } + + private genExampleSeriesActions(chartData: Array<JSONObject>) { + const actions: CustomAction[] = []; + if (!chartData || chartData.length <= 0 || !chartData[0]) { + return actions; + } + let delCnt = 0; + const existColumns = this.getView().map((s) => s.getView().columnName); + // delete series not in data + existColumns.forEach((columnName) => { + if (chartData[0]?.[columnName] === undefined) { + actions.push(this.deleteAction(0)); + delCnt++; + } + }); + if (existColumns.length > delCnt) { + // don't generate example if exists + return actions; + } + // generate example series + const exampleKeys = Object.keys(chartData[0]) + .filter((key) => { + return !existColumns.includes(key) && isNumeric(chartData[0][key]); + }) + .slice(0, 3); + exampleKeys.forEach((key) => actions.push(this.pushAction(newSeries(key, key)))); + return actions; + } + + dispatchDataChanged(chartData: Array<JSONObject>): void { + this.dispatch( + customAction<ActionDataType>({ + type: "chartDataChanged", + chartData: chartData, + }) + ); + } +} diff --git a/client/packages/lowcoder-comps/src/comps/parallelChartComp/parallelChartComp.tsx b/client/packages/lowcoder-comps/src/comps/parallelChartComp/parallelChartComp.tsx new file mode 100644 index 000000000..84bcf3280 --- /dev/null +++ b/client/packages/lowcoder-comps/src/comps/parallelChartComp/parallelChartComp.tsx @@ -0,0 +1,282 @@ +import { + changeChildAction, + changeValueAction, + CompAction, + CompActionTypes, + wrapChildAction, +} from "lowcoder-core"; +import { AxisFormatterComp, EchartsAxisType } from "../basicChartComp/chartConfigs/cartesianAxisConfig"; +import { parallelChartChildrenMap, ChartSize, getDataKeys } from "./parallelChartConstants"; +import { parallelChartPropertyView } from "./parallelChartPropertyView"; +import _ from "lodash"; +import { useContext, useEffect, useMemo, useRef, useState } from "react"; +import ReactResizeDetector from "react-resize-detector"; +import ReactECharts from "../basicChartComp/reactEcharts"; +import * as echarts from "echarts"; +import { + childrenToProps, + depsConfig, + genRandomKey, + NameConfig, + UICompBuilder, + withDefault, + withExposingConfigs, + withViewFn, + ThemeContext, + chartColorPalette, + getPromiseAfterDispatch, + dropdownControl, +} from "lowcoder-sdk"; +import { getEchartsLocale, i18nObjs, trans } from "i18n/comps"; +import { + echartsConfigOmitChildren, + getEchartsConfig, + getSelectedPoints, +} from "./parallelChartUtils"; +import 'echarts-extension-gmap'; +import log from "loglevel"; + +let clickEventCallback = () => {}; + +const chartModeOptions = [ + { + label: "UI", + value: "ui", + } +] as const; + +let ParallelChartTmpComp = (function () { + return new UICompBuilder({mode:dropdownControl(chartModeOptions,'ui'),...parallelChartChildrenMap}, () => null) + .setPropertyViewFn(parallelChartPropertyView) + .build(); +})(); + +ParallelChartTmpComp = withViewFn(ParallelChartTmpComp, (comp) => { + const mode = comp.children.mode.getView(); + const onUIEvent = comp.children.onUIEvent.getView(); + const onEvent = comp.children.onEvent.getView(); + const echartsCompRef = useRef<ReactECharts | null>(); + const [chartSize, setChartSize] = useState<ChartSize>(); + const firstResize = useRef(true); + const theme = useContext(ThemeContext); + const defaultChartTheme = { + color: chartColorPalette, + backgroundColor: "#fff", + }; + + let themeConfig = defaultChartTheme; + try { + themeConfig = theme?.theme.chart ? JSON.parse(theme?.theme.chart) : defaultChartTheme; + } catch (error) { + log.error('theme chart error: ', error); + } + + const triggerClickEvent = async (dispatch: any, action: CompAction<JSONValue>) => { + await getPromiseAfterDispatch( + dispatch, + action, + { autoHandleAfterReduce: true } + ); + onEvent('click'); + } + + useEffect(() => { + const echartsCompInstance = echartsCompRef?.current?.getEchartsInstance(); + if (!echartsCompInstance) { + return _.noop; + } + echartsCompInstance?.on("click", (param: any) => { + document.dispatchEvent(new CustomEvent("clickEvent", { + bubbles: true, + detail: { + action: 'click', + data: param.data, + } + })); + triggerClickEvent( + comp.dispatch, + changeChildAction("lastInteractionData", param.data, false) + ); + }); + return () => { + echartsCompInstance?.off("click"); + document.removeEventListener('clickEvent', clickEventCallback) + }; + }, []); + + useEffect(() => { + // bind events + const echartsCompInstance = echartsCompRef?.current?.getEchartsInstance(); + if (!echartsCompInstance) { + return _.noop; + } + echartsCompInstance?.on("selectchanged", (param: any) => { + const option: any = echartsCompInstance?.getOption(); + document.dispatchEvent(new CustomEvent("clickEvent", { + bubbles: true, + detail: { + action: param.fromAction, + data: getSelectedPoints(param, option) + } + })); + + if (param.fromAction === "select") { + comp.dispatch(changeChildAction("selectedPoints", getSelectedPoints(param, option), false)); + onUIEvent("select"); + } else if (param.fromAction === "unselect") { + comp.dispatch(changeChildAction("selectedPoints", getSelectedPoints(param, option), false)); + onUIEvent("unselect"); + } + + triggerClickEvent( + comp.dispatch, + changeChildAction("lastInteractionData", getSelectedPoints(param, option), false) + ); + }); + // unbind + return () => { + echartsCompInstance?.off("selectchanged"); + document.removeEventListener('clickEvent', clickEventCallback) + }; + }, [onUIEvent]); + + const echartsConfigChildren = _.omit(comp.children, echartsConfigOmitChildren); + const childrenProps = childrenToProps(echartsConfigChildren); + + const option = useMemo(() => { + return getEchartsConfig( + childrenProps as ToViewReturn<typeof echartsConfigChildren>, + chartSize, + themeConfig + ); + }, [theme, childrenProps, chartSize, ...Object.values(echartsConfigChildren)]); + + return ( + <ReactResizeDetector + onResize={(w, h) => { + if (w && h) { + setChartSize({ w: w, h: h }); + } + if (!firstResize.current) { + // ignore the first resize, which will impact the loading animation + echartsCompRef.current?.getEchartsInstance().resize(); + } else { + firstResize.current = false; + } + }} + > + <ReactECharts + ref={(e) => (echartsCompRef.current = e)} + style={{ height: "100%" }} + notMerge + lazyUpdate + opts={{ locale: getEchartsLocale() }} + option={option} + mode={mode} + /> + </ReactResizeDetector> + ); +}); + +function getYAxisFormatContextValue( + data: Array<JSONObject>, + yAxisType: EchartsAxisType, + yAxisName?: string +) { + const dataSample = yAxisName && data.length > 0 && data[0][yAxisName]; + let contextValue = dataSample; + if (yAxisType === "time") { + // to timestamp + const time = + typeof dataSample === "number" || typeof dataSample === "string" + ? new Date(dataSample).getTime() + : null; + if (time) contextValue = time; + } + return contextValue; +} + +ParallelChartTmpComp = class extends ParallelChartTmpComp { + private lastYAxisFormatContextVal?: JSONValue; + private lastColorContext?: JSONObject; + + updateContext(comp: this) { + // the context value of axis format + let resultComp = comp; + const data = comp.children.data.getView(); + const yAxisContextValue = getYAxisFormatContextValue( + data, + comp.children.yConfig.children.yAxisType.getView(), + ); + if (yAxisContextValue !== comp.lastYAxisFormatContextVal) { + comp.lastYAxisFormatContextVal = yAxisContextValue; + resultComp = comp.setChild( + "yConfig", + comp.children.yConfig.reduce( + wrapChildAction( + "formatter", + AxisFormatterComp.changeContextDataAction({ value: yAxisContextValue }) + ) + ) + ); + } + return resultComp; + } + + override reduce(action: CompAction): this { + const comp = super.reduce(action); + if (action.type === CompActionTypes.UPDATE_NODES_V2) { + const newData = comp.children.data.getView(); + // data changes + if (comp.children.data !== this.children.data) { + setTimeout(() => { + // update x-axis value + const keys = getDataKeys(newData); + if (keys.length > 0 && !keys.includes(comp.children.xAxisKey.getView())) { + comp.children.xAxisKey.dispatch(changeValueAction(keys[0] || "")); + } + if (keys.length > 0 && !keys.includes(comp.children.yAxisKey.getView())) { + comp.children.yAxisKey.dispatch(changeValueAction(keys[1] || "")); + } + }, 0); + } + return this.updateContext(comp); + } + return comp; + } + + override autoHeight(): boolean { + return false; + } +}; + +let ParallelChartComp = withExposingConfigs(ParallelChartTmpComp, [ + depsConfig({ + name: "selectedPoints", + desc: trans("chart.selectedPointsDesc"), + depKeys: ["selectedPoints"], + func: (input) => { + return input.selectedPoints; + }, + }), + depsConfig({ + name: "lastInteractionData", + desc: trans("chart.lastInteractionDataDesc"), + depKeys: ["lastInteractionData"], + func: (input) => { + return input.lastInteractionData; + }, + }), + depsConfig({ + name: "data", + desc: trans("chart.dataDesc"), + depKeys: ["data", "mode"], + func: (input) =>[] , + }), + new NameConfig("title", trans("chart.titleDesc")), +]); + + +export const ParallelChartCompWithDefault = withDefault(ParallelChartComp, { + xAxisKey: "date", +}); diff --git a/client/packages/lowcoder-comps/src/comps/parallelChartComp/parallelChartConstants.tsx b/client/packages/lowcoder-comps/src/comps/parallelChartComp/parallelChartConstants.tsx new file mode 100644 index 000000000..4b383d645 --- /dev/null +++ b/client/packages/lowcoder-comps/src/comps/parallelChartComp/parallelChartConstants.tsx @@ -0,0 +1,193 @@ +import { + jsonControl, + stateComp, + toJSONObjectArray, + toObject, + BoolControl, + ColorControl, + withDefault, + StringControl, + NumberControl, + dropdownControl, + list, + eventHandlerControl, + valueComp, + withType, + uiChildren, + clickEvent, + toArray, + styleControl, + EchartDefaultTextStyle, + EchartDefaultChartStyle, + MultiCompBuilder, +} from "lowcoder-sdk"; +import { RecordConstructorToComp, RecordConstructorToView } from "lowcoder-core"; +import { XAxisConfig, YAxisConfig } from "../basicChartComp/chartConfigs/cartesianAxisConfig"; +import { LegendConfig } from "../basicChartComp/chartConfigs/legendConfig"; +import { EchartsLegendConfig } from "../basicChartComp/chartConfigs/echartsLegendConfig"; +import { EchartsLabelConfig } from "../basicChartComp/chartConfigs/echartsLabelConfig"; +import { EChartsOption } from "echarts"; +import { i18nObjs, trans } from "i18n/comps"; +import {EchartsTitleVerticalConfig} from "../chartComp/chartConfigs/echartsTitleVerticalConfig"; +import {EchartsTitleConfig} from "../basicChartComp/chartConfigs/echartsTitleConfig"; + +export const UIEventOptions = [ + { + label: trans("chart.select"), + value: "select", + description: trans("chart.selectDesc"), + }, + { + label: trans("chart.unSelect"), + value: "unselect", + description: trans("chart.unselectDesc"), + }, +] as const; + +export const XAxisDirectionOptions = [ + { + label: trans("chart.horizontal"), + value: "horizontal", + }, + { + label: trans("chart.vertical"), + value: "vertical", + }, +] as const; + +export type XAxisDirectionType = ValueFromOption<typeof XAxisDirectionOptions>; + +export const noDataAxisConfig = { + animation: false, + xAxis: { + type: "category", + name: trans("chart.noData"), + nameLocation: "middle", + data: [], + axisLine: { + lineStyle: { + color: "#8B8FA3", + }, + }, + }, + yAxis: { + type: "value", + axisLabel: { + color: "#8B8FA3", + }, + splitLine: { + lineStyle: { + color: "#F0F0F0", + }, + }, + }, + tooltip: { + show: false, + }, + series: [ + { + data: [700], + type: "line", + itemStyle: { + opacity: 0, + }, + }, + ], +} as EChartsOption; + +export const noDataParallelChartConfig = { + animation: false, + tooltip: { + show: false, + }, + legend: { + formatter: trans("chart.unknown"), + top: "bottom", + selectedMode: false, + }, + color: ["#B8BBCC", "#CED0D9", "#DCDEE6", "#E6E6EB"], + series: [], +} as EChartsOption; + +export type ChartSize = { w: number; h: number }; + +export const getDataKeys = (data: Array<JSONObject>) => { + if (!data) { + return []; + } + const dataKeys: Array<string> = []; + data[0].forEach((key) => { + if (!dataKeys.includes(key)) { + dataKeys.push(key); + } + }); + return dataKeys; +}; + +export const chartUiModeChildren = { + title: withDefault(StringControl, trans("echarts.defaultTitle")), + data: jsonControl(toArray, i18nObjs.defaultDatasourceParallel), + xAxisKey: valueComp<string>(""), // x-axis, key from data + xAxisDirection: dropdownControl(XAxisDirectionOptions, "horizontal"), + xAxisData: jsonControl(toArray, []), + yAxisKey: valueComp<string>(""), // x-axis, key from data + xConfig: XAxisConfig, + yConfig: YAxisConfig, + legendConfig: LegendConfig, + onUIEvent: eventHandlerControl(UIEventOptions), +}; + +let chartJsonModeChildren: any = { + echartsOption: jsonControl(toObject, i18nObjs.defaultEchartsJsonOption), + echartsTitle: withDefault(StringControl, trans("echarts.defaultTitle")), + echartsLegendConfig: EchartsLegendConfig, + echartsLabelConfig: EchartsLabelConfig, + echartsTitleVerticalConfig: EchartsTitleVerticalConfig, + echartsTitleConfig:EchartsTitleConfig, + + left:withDefault(NumberControl,trans('chart.defaultLeft')), + right:withDefault(NumberControl,trans('chart.defaultRight')), + top:withDefault(NumberControl,trans('chart.defaultTop')), + bottom:withDefault(NumberControl,trans('chart.defaultBottom')), + + tooltip: withDefault(BoolControl, true), + legendVisibility: withDefault(BoolControl, true), +} + +if (EchartDefaultChartStyle && EchartDefaultTextStyle) { + chartJsonModeChildren = { + ...chartJsonModeChildren, + chartStyle: styleControl(EchartDefaultChartStyle, 'chartStyle'), + titleStyle: styleControl(EchartDefaultTextStyle, 'titleStyle'), + xAxisStyle: styleControl(EchartDefaultTextStyle, 'xAxis'), + yAxisStyle: styleControl(EchartDefaultTextStyle, 'yAxisStyle'), + legendStyle: styleControl(EchartDefaultTextStyle, 'legendStyle'), + } +} + +export type UIChartDataType = { + seriesName: string; + // coordinate chart + x?: any; + y?: any; + // parallel or funnel + itemName?: any; + value?: any; +}; + +export type NonUIChartDataType = { + name: string; + value: any; +} + +export const parallelChartChildrenMap = { + selectedPoints: stateComp<Array<UIChartDataType>>([]), + lastInteractionData: stateComp<Array<UIChartDataType> | NonUIChartDataType>({}), + onEvent: eventHandlerControl([clickEvent] as const), + ...chartUiModeChildren, + ...chartJsonModeChildren, +}; + +const chartUiChildrenMap = uiChildren(parallelChartChildrenMap); +export type ChartCompPropsType = RecordConstructorToView<typeof chartUiChildrenMap>; +export type ChartCompChildrenType = RecordConstructorToComp<typeof chartUiChildrenMap>; diff --git a/client/packages/lowcoder-comps/src/comps/parallelChartComp/parallelChartPropertyView.tsx b/client/packages/lowcoder-comps/src/comps/parallelChartComp/parallelChartPropertyView.tsx new file mode 100644 index 000000000..3106c44d7 --- /dev/null +++ b/client/packages/lowcoder-comps/src/comps/parallelChartComp/parallelChartPropertyView.tsx @@ -0,0 +1,70 @@ +import { changeChildAction, CompAction } from "lowcoder-core"; +import { ChartCompChildrenType, getDataKeys } from "./parallelChartConstants"; +import { + CustomModal, + Dropdown, + hiddenPropertyView, + Option, + RedButton, + Section, + sectionNames, + controlItem, +} from "lowcoder-sdk"; +import { trans } from "i18n/comps"; + +export function parallelChartPropertyView( + children: ChartCompChildrenType, + dispatch: (action: CompAction) => void +) { + const columnOptions = getDataKeys(children.data.getView()).map((key) => ({ + label: key, + value: key, + })); + + const uiModePropertyView = ( + <> + <Section name={sectionNames.interaction}> + <div style={{display: 'flex', flexDirection: 'column', gap: '8px'}}> + {children.onUIEvent.propertyView({title: trans("chart.chartEventHandlers")})} + </div> + <div style={{display: 'flex', flexDirection: 'column', gap: '8px'}}> + {children.onEvent.propertyView()} + </div> + </Section> + <Section name={sectionNames.layout}> + {children.echartsTitleConfig.getPropertyView()} + {children.echartsTitleVerticalConfig.getPropertyView()} + {children.title.propertyView({ label: trans("chart.title") })} + {children.left.propertyView({ label: trans("chart.left"), tooltip: trans("echarts.leftTooltip") })} + {children.right.propertyView({ label: trans("chart.right"), tooltip: trans("echarts.rightTooltip") })} + {children.top.propertyView({ label: trans("chart.top"), tooltip: trans("echarts.topTooltip") })} + {children.bottom.propertyView({ label: trans("chart.bottom"), tooltip: trans("echarts.bottomTooltip") })} + {hiddenPropertyView(children)} + {children.tooltip.propertyView({label: trans("echarts.tooltip"), tooltip: trans("echarts.tooltipTooltip")})} + </Section> + <Section name={sectionNames.chartStyle}> + {children.chartStyle?.getPropertyView()} + </Section> + <Section name={sectionNames.titleStyle}> + {children.titleStyle?.getPropertyView()} + </Section> + <Section name={sectionNames.advanced}> + {children.data.propertyView({ + label: trans("chart.data"), + })} + </Section> + </> + ); + + const getChatConfigByMode = (mode: string) => { + switch(mode) { + case "ui": + return uiModePropertyView; + } + } + return ( + <> + {getChatConfigByMode(children.mode.getView())} + </> + ); +} diff --git a/client/packages/lowcoder-comps/src/comps/parallelChartComp/parallelChartUtils.ts b/client/packages/lowcoder-comps/src/comps/parallelChartComp/parallelChartUtils.ts new file mode 100644 index 000000000..407a2df69 --- /dev/null +++ b/client/packages/lowcoder-comps/src/comps/parallelChartComp/parallelChartUtils.ts @@ -0,0 +1,241 @@ +import { + ChartCompPropsType, + ChartSize, + noDataParallelChartConfig, +} from "comps/parallelChartComp/parallelChartConstants"; +import { EChartsOptionWithMap } from "../basicChartComp/reactEcharts/types"; +import _ from "lodash"; +import { googleMapsApiUrl } from "../basicChartComp/chartConfigs/chartUrls"; +import parseBackground from "../../util/gradientBackgroundColor"; +import {chartStyleWrapper, styleWrapper} from "../../util/styleWrapper"; +// Define the configuration interface to match the original transform + +interface AggregateConfig { + resultDimensions: Array<{ + name: string; + from: string; + method?: string; // e.g., 'min', 'Q1', 'median', 'Q3', 'max' + }>; + groupBy: string; +} + +// Custom transform function +function customAggregateTransform(params: { + upstream: { source: any[] }; + config: AggregateConfig; +}): any[] { + const { upstream, config } = params; + const data = upstream.source; + + // Assume data is an array of arrays, with the first row as headers + const headers = data[0]; + const rows = data.slice(1); + + // Find the index of the groupBy column + const groupByIndex = headers.indexOf(config.groupBy); + if (groupByIndex === -1) { + return []; + } + + // Group rows by the groupBy column + const groups: { [key: string]: any[][] } = {}; + rows.forEach(row => { + const key = row[groupByIndex]; + if (!groups[key]) { + groups[key] = []; + } + groups[key].push(row); + }); + + // Define aggregation functions + const aggregators: { + [method: string]: (values: number[]) => number; + } = { + min: values => Math.min(...values), + max: values => Math.max(...values), + Q1: values => percentile(values, 25), + median: values => percentile(values, 50), + Q3: values => percentile(values, 75), + }; + + // Helper function to calculate percentiles (Q1, median, Q3) + function percentile(arr: number[], p: number): number { + const sorted = arr.slice().sort((a, b) => a - b); + const index = (p / 100) * (sorted.length - 1); + const i = Math.floor(index); + const f = index - i; + if (i === sorted.length - 1) { + return sorted[i]; + } + return sorted[i] + f * (sorted[i + 1] - sorted[i]); + } + + // Prepare output headers from resultDimensions + const outputHeaders = config.resultDimensions.map(dim => dim.name); + + // Compute aggregated data for each group + const aggregatedData: any[][] = []; + for (const key in groups) { + const groupRows = groups[key]; + const row: any[] = []; + + config.resultDimensions.forEach(dim => { + if (dim.from === config.groupBy) { + // Include the group key directly + row.push(key); + } else { + // Find the index of the 'from' column + const fromIndex = headers.indexOf(dim.from); + if (fromIndex === -1) { + return; + } + // Extract values for the 'from' column in this group + const values = groupRows + .map(r => parseFloat(r[fromIndex])) + .filter(v => !isNaN(v)); + if (dim.method && aggregators[dim.method]) { + // Apply the aggregation method + row.push(aggregators[dim.method](values)); + } else { + return; + } + } + }); + + aggregatedData.push(row); + } + + // Return the transformed data with headers + return [outputHeaders, ...aggregatedData]; +} + +export const echartsConfigOmitChildren = [ + "hidden", + "selectedPoints", + "onUIEvent", + "mapInstance" +] as const; +type EchartsConfigProps = Omit<ChartCompPropsType, typeof echartsConfigOmitChildren[number]>; + +// https://echarts.apache.org/en/option.html +export function getEchartsConfig( + props: EchartsConfigProps, + chartSize?: ChartSize, + theme?: any, +): EChartsOptionWithMap { + const gridPos = { + left: `${props?.left}%`, + right: `${props?.right}%`, + bottom: `${props?.bottom}%`, + top: `${props?.top}%`, + }; + + let config: any = { + title: { + text: props.title, + top: props.echartsTitleVerticalConfig.top, + left:props.echartsTitleConfig.top, + textStyle: { + ...styleWrapper(props?.titleStyle, theme?.titleStyle) + } + }, + backgroundColor: parseBackground( props?.chartStyle?.background || theme?.chartStyle?.backgroundColor || "#FFFFFF"), + tooltip: props.tooltip && { + trigger: "axis", + axisPointer: { + type: "line", + lineStyle: { + color: "rgba(0,0,0,0.2)", + width: 2, + type: "solid" + } + } + }, + grid: { + ...gridPos, + containLabel: true, + }, + }; + + if (props.data.length <= 0) { + // no data + return { + ...config, + ...noDataParallelChartConfig, + }; + } + // y-axis is category and time, data doesn't need to aggregate + let transformedData = props.data; + + config = { + ...config, + series: [{ + name: 'parallel', + type: 'parallel', + lineStyle: { + width: 4 + }, + data: props.data.slice(1) + }], + parallelAxis: props.data[0].map((c, i) => ({ dim: i, name: c, type: typeof props.data[1][i] === 'string'?'category':'value'})) + }; + + console.log("Echarts transformedData and config", transformedData, config); + return config; +} + +export function getSelectedPoints(param: any, option: any) { + const series = option.series; + const dataSource = _.isArray(option.dataset) && option.dataset[0]?.source; + if (series && dataSource) { + return param.selected.flatMap((selectInfo: any) => { + const seriesInfo = series[selectInfo.seriesIndex]; + if (!seriesInfo || !seriesInfo.encode) { + return []; + } + return selectInfo.dataIndex.map((index: any) => { + const commonResult = { + seriesName: seriesInfo.name, + }; + if (seriesInfo.encode.itemName && seriesInfo.encode.value) { + return { + ...commonResult, + itemName: dataSource[index][seriesInfo.encode.itemName], + value: dataSource[index][seriesInfo.encode.value], + }; + } else { + return { + ...commonResult, + x: dataSource[index][seriesInfo.encode.x], + y: dataSource[index][seriesInfo.encode.y], + }; + } + }); + }); + } + return []; +} + +export function loadGoogleMapsScript(apiKey: string) { + const mapsUrl = `${googleMapsApiUrl}?key=${apiKey}`; + const scripts = document.getElementsByTagName('script'); + // is script already loaded + let scriptIndex = _.findIndex(scripts, (script) => script.src.endsWith(mapsUrl)); + if(scriptIndex > -1) { + return scripts[scriptIndex]; + } + // is script loaded with diff api_key, remove the script and load again + scriptIndex = _.findIndex(scripts, (script) => script.src.startsWith(googleMapsApiUrl)); + if(scriptIndex > -1) { + scripts[scriptIndex].remove(); + } + + const script = document.createElement("script"); + script.type = "text/javascript"; + script.src = mapsUrl; + script.async = true; + script.defer = true; + window.document.body.appendChild(script); + + return script; +} diff --git a/client/packages/lowcoder-comps/src/comps/pieChartComp/pieChartComp.tsx b/client/packages/lowcoder-comps/src/comps/pieChartComp/pieChartComp.tsx new file mode 100644 index 000000000..d502a8090 --- /dev/null +++ b/client/packages/lowcoder-comps/src/comps/pieChartComp/pieChartComp.tsx @@ -0,0 +1,314 @@ +import { + changeChildAction, + changeValueAction, + CompAction, + CompActionTypes, + wrapChildAction, +} from "lowcoder-core"; +import { AxisFormatterComp, EchartsAxisType } from "../basicChartComp/chartConfigs/cartesianAxisConfig"; +import { pieChartChildrenMap, ChartSize, getDataKeys } from "./pieChartConstants"; +import { pieChartPropertyView } from "./pieChartPropertyView"; +import _ from "lodash"; +import { useContext, useEffect, useMemo, useRef, useState } from "react"; +import ReactResizeDetector from "react-resize-detector"; +import ReactECharts from "../basicChartComp/reactEcharts"; +import * as echarts from "echarts"; +import { + childrenToProps, + depsConfig, + genRandomKey, + NameConfig, + UICompBuilder, + withDefault, + withExposingConfigs, + withViewFn, + ThemeContext, + chartColorPalette, + getPromiseAfterDispatch, + dropdownControl, +} from "lowcoder-sdk"; +import { getEchartsLocale, i18nObjs, trans } from "i18n/comps"; +import { + echartsConfigOmitChildren, + getEchartsConfig, + getSelectedPoints, +} from "./pieChartUtils"; +import 'echarts-extension-gmap'; +import log from "loglevel"; + +let clickEventCallback = () => {}; + +const chartModeOptions = [ + { + label: "UI", + value: "ui", + } +] as const; + +let PieChartTmpComp = (function () { + return new UICompBuilder({mode:dropdownControl(chartModeOptions,'ui'),...pieChartChildrenMap}, () => null) + .setPropertyViewFn(pieChartPropertyView) + .build(); +})(); + +PieChartTmpComp = withViewFn(PieChartTmpComp, (comp) => { + const mode = comp.children.mode.getView(); + const onUIEvent = comp.children.onUIEvent.getView(); + const onEvent = comp.children.onEvent.getView(); + const echartsCompRef = useRef<ReactECharts | null>(); + const [chartSize, setChartSize] = useState<ChartSize>(); + const firstResize = useRef(true); + const theme = useContext(ThemeContext); + const defaultChartTheme = { + color: chartColorPalette, + backgroundColor: "#fff", + }; + + let themeConfig = defaultChartTheme; + try { + themeConfig = theme?.theme.chart ? JSON.parse(theme?.theme.chart) : defaultChartTheme; + } catch (error) { + log.error('theme chart error: ', error); + } + + const triggerClickEvent = async (dispatch: any, action: CompAction<JSONValue>) => { + await getPromiseAfterDispatch( + dispatch, + action, + { autoHandleAfterReduce: true } + ); + onEvent('click'); + } + + useEffect(() => { + const echartsCompInstance = echartsCompRef?.current?.getEchartsInstance(); + if (!echartsCompInstance) { + return _.noop; + } + echartsCompInstance?.on("click", (param: any) => { + document.dispatchEvent(new CustomEvent("clickEvent", { + bubbles: true, + detail: { + action: 'click', + data: param.data, + } + })); + triggerClickEvent( + comp.dispatch, + changeChildAction("lastInteractionData", param.data, false) + ); + }); + return () => { + echartsCompInstance?.off("click"); + document.removeEventListener('clickEvent', clickEventCallback) + }; + }, []); + + useEffect(() => { + // bind events + const echartsCompInstance = echartsCompRef?.current?.getEchartsInstance(); + if (!echartsCompInstance) { + return _.noop; + } + echartsCompInstance?.on("selectchanged", (param: any) => { + const option: any = echartsCompInstance?.getOption(); + document.dispatchEvent(new CustomEvent("clickEvent", { + bubbles: true, + detail: { + action: param.fromAction, + data: getSelectedPoints(param, option) + } + })); + + if (param.fromAction === "select") { + comp.dispatch(changeChildAction("selectedPoints", getSelectedPoints(param, option), false)); + onUIEvent("select"); + } else if (param.fromAction === "unselect") { + comp.dispatch(changeChildAction("selectedPoints", getSelectedPoints(param, option), false)); + onUIEvent("unselect"); + } + + triggerClickEvent( + comp.dispatch, + changeChildAction("lastInteractionData", getSelectedPoints(param, option), false) + ); + }); + // unbind + return () => { + echartsCompInstance?.off("selectchanged"); + document.removeEventListener('clickEvent', clickEventCallback) + }; + }, [onUIEvent]); + + const echartsConfigChildren = _.omit(comp.children, echartsConfigOmitChildren); + const childrenProps = childrenToProps(echartsConfigChildren); + const [mapJson, setMapJson] = useState(null); + useEffect(() => { + const fetchMapData = async () => { + if (childrenProps.chartConfig.subtype === 'geoPie') { + let fetchedMapJson = i18nObjs.usaMap; + try { + const response = await fetch(childrenProps.chartConfig.mapUrl, childrenProps.chartConfig.mapSpecial); + fetchedMapJson = await response.json(); + } catch {} + echarts.registerMap('jsonmap', fetchedMapJson); + setMapJson(fetchedMapJson); + } + }; + + fetchMapData(); + }, [childrenProps.chartConfig.subtype, childrenProps.chartConfig.mapUrl, childrenProps.chartConfig.mapSpecial]); + + const option = useMemo(() => { + if (!mapJson && childrenProps.chartConfig.subtype === 'geoPie') { + return {}; // Return an empty object or some default value until the map is loaded + } + return getEchartsConfig( + childrenProps as ToViewReturn<typeof echartsConfigChildren>, + chartSize, + themeConfig + ); + }, [mapJson, theme, childrenProps, chartSize, ...Object.values(echartsConfigChildren)]); + + return ( + <ReactResizeDetector + onResize={(w, h) => { + if (w && h) { + setChartSize({ w: w, h: h }); + } + if (!firstResize.current) { + // ignore the first resize, which will impact the loading animation + echartsCompRef.current?.getEchartsInstance().resize(); + } else { + firstResize.current = false; + } + }} + > + <ReactECharts + ref={(e) => (echartsCompRef.current = e)} + style={{ height: "100%" }} + notMerge + lazyUpdate + opts={{ locale: getEchartsLocale() }} + option={option} + mode={mode} + /> + </ReactResizeDetector> + ); +}); + +function getYAxisFormatContextValue( + data: Array<JSONObject>, + yAxisType: EchartsAxisType, + yAxisName?: string +) { + const dataSample = yAxisName && data.length > 0 && data[0][yAxisName]; + let contextValue = dataSample; + if (yAxisType === "time") { + // to timestamp + const time = + typeof dataSample === "number" || typeof dataSample === "string" + ? new Date(dataSample).getTime() + : null; + if (time) contextValue = time; + } + return contextValue; +} + +PieChartTmpComp = class extends PieChartTmpComp { + private lastYAxisFormatContextVal?: JSONValue; + private lastColorContext?: JSONObject; + + updateContext(comp: this) { + // the context value of axis format + let resultComp = comp; + const data = comp.children.data.getView(); + const sampleSeries = comp.children.series.getView().find((s) => !s.getView().hide); + const yAxisContextValue = getYAxisFormatContextValue( + data, + comp.children.yConfig.children.yAxisType.getView(), + sampleSeries?.children.columnName.getView() + ); + if (yAxisContextValue !== comp.lastYAxisFormatContextVal) { + comp.lastYAxisFormatContextVal = yAxisContextValue; + resultComp = comp.setChild( + "yConfig", + comp.children.yConfig.reduce( + wrapChildAction( + "formatter", + AxisFormatterComp.changeContextDataAction({ value: yAxisContextValue }) + ) + ) + ); + } + return resultComp; + } + + override reduce(action: CompAction): this { + const comp = super.reduce(action); + if (action.type === CompActionTypes.UPDATE_NODES_V2) { + const newData = comp.children.data.getView(); + // data changes + if (comp.children.data !== this.children.data) { + setTimeout(() => { + // update x-axis value + const keys = getDataKeys(newData); + if (keys.length > 0 && !keys.includes(comp.children.xAxisKey.getView())) { + comp.children.xAxisKey.dispatch(changeValueAction(keys[0] || "")); + } + // pass to child series comp + comp.children.series.dispatchDataChanged(newData); + }, 0); + } + return this.updateContext(comp); + } + return comp; + } + + override autoHeight(): boolean { + return false; + } +}; + +let PieChartComp = withExposingConfigs(PieChartTmpComp, [ + depsConfig({ + name: "selectedPoints", + desc: trans("chart.selectedPointsDesc"), + depKeys: ["selectedPoints"], + func: (input) => { + return input.selectedPoints; + }, + }), + depsConfig({ + name: "lastInteractionData", + desc: trans("chart.lastInteractionDataDesc"), + depKeys: ["lastInteractionData"], + func: (input) => { + return input.lastInteractionData; + }, + }), + depsConfig({ + name: "data", + desc: trans("chart.dataDesc"), + depKeys: ["data", "mode"], + func: (input) =>[] , + }), + new NameConfig("title", trans("chart.titleDesc")), +]); + + +export const PieChartCompWithDefault = withDefault(PieChartComp, { + xAxisKey: "date", + series: [ + { + dataIndex: genRandomKey(), + seriesName: trans("chart.spending"), + columnName: "spending", + }, + { + dataIndex: genRandomKey(), + seriesName: trans("chart.budget"), + columnName: "budget", + }, + ], +}); diff --git a/client/packages/lowcoder-comps/src/comps/pieChartComp/pieChartConstants.tsx b/client/packages/lowcoder-comps/src/comps/pieChartComp/pieChartConstants.tsx new file mode 100644 index 000000000..62e5be971 --- /dev/null +++ b/client/packages/lowcoder-comps/src/comps/pieChartComp/pieChartConstants.tsx @@ -0,0 +1,311 @@ +import { + jsonControl, + stateComp, + toJSONObjectArray, + toObject, + BoolControl, + ColorControl, + withDefault, + StringControl, + NumberControl, + dropdownControl, + list, + eventHandlerControl, + valueComp, + withType, + uiChildren, + clickEvent, + toArray, + styleControl, + EchartDefaultTextStyle, + EchartDefaultChartStyle, + MultiCompBuilder, +} from "lowcoder-sdk"; +import { RecordConstructorToComp, RecordConstructorToView } from "lowcoder-core"; +import { BarChartConfig } from "../basicChartComp/chartConfigs/barChartConfig"; +import { XAxisConfig, YAxisConfig } from "../basicChartComp/chartConfigs/cartesianAxisConfig"; +import { LegendConfig } from "../basicChartComp/chartConfigs/legendConfig"; +import { EchartsLegendConfig } from "../basicChartComp/chartConfigs/echartsLegendConfig"; +import { EchartsLabelConfig } from "../basicChartComp/chartConfigs/echartsLabelConfig"; +import { PieChartConfig } from "../basicChartComp/chartConfigs/pieChartConfig"; +import { ScatterChartConfig } from "../basicChartComp/chartConfigs/scatterChartConfig"; +import { SeriesListComp } from "./seriesComp"; +import { EChartsOption } from "echarts"; +import { i18nObjs, trans } from "i18n/comps"; +import { GaugeChartConfig } from "../basicChartComp/chartConfigs/gaugeChartConfig"; +import { FunnelChartConfig } from "../basicChartComp/chartConfigs/funnelChartConfig"; +import {EchartsTitleVerticalConfig} from "../chartComp/chartConfigs/echartsTitleVerticalConfig"; +import {EchartsTitleConfig} from "../basicChartComp/chartConfigs/echartsTitleConfig"; + +export const ChartTypeOptions = [ + { + label: trans("chart.bar"), + value: "bar", + }, + { + label: trans("chart.line"), + value: "line", + }, + { + label: trans("chart.scatter"), + value: "scatter", + }, + { + label: trans("chart.pie"), + value: "pie", + }, +] as const; + +export const UIEventOptions = [ + { + label: trans("chart.select"), + value: "select", + description: trans("chart.selectDesc"), + }, + { + label: trans("chart.unSelect"), + value: "unselect", + description: trans("chart.unselectDesc"), + }, +] as const; + +export const XAxisDirectionOptions = [ + { + label: trans("chart.horizontal"), + value: "horizontal", + }, + { + label: trans("chart.vertical"), + value: "vertical", + }, +] as const; + +export type XAxisDirectionType = ValueFromOption<typeof XAxisDirectionOptions>; + +export const noDataAxisConfig = { + animation: false, + xAxis: { + type: "category", + name: trans("chart.noData"), + nameLocation: "middle", + data: [], + axisLine: { + lineStyle: { + color: "#8B8FA3", + }, + }, + }, + yAxis: { + type: "value", + axisLabel: { + color: "#8B8FA3", + }, + splitLine: { + lineStyle: { + color: "#F0F0F0", + }, + }, + }, + tooltip: { + show: false, + }, + series: [ + { + data: [700], + type: "line", + itemStyle: { + opacity: 0, + }, + }, + ], +} as EChartsOption; + +export const noDataPieChartConfig = { + animation: false, + tooltip: { + show: false, + }, + legend: { + formatter: trans("chart.unknown"), + top: "bottom", + selectedMode: false, + }, + color: ["#B8BBCC", "#CED0D9", "#DCDEE6", "#E6E6EB"], + series: [ + { + type: "pie", + radius: "35%", + center: ["25%", "50%"], + silent: true, + label: { + show: false, + }, + data: [ + { + name: "1", + value: 70, + }, + { + name: "2", + value: 68, + }, + { + name: "3", + value: 48, + }, + { + name: "4", + value: 40, + }, + ], + }, + { + type: "pie", + radius: "35%", + center: ["75%", "50%"], + silent: true, + label: { + show: false, + }, + data: [ + { + name: "1", + value: 70, + }, + { + name: "2", + value: 68, + }, + { + name: "3", + value: 48, + }, + { + name: "4", + value: 40, + }, + ], + }, + ], +} as EChartsOption; + +const areaPiecesChildrenMap = { + color: ColorControl, + from: StringControl, + to: StringControl, + // unique key, for sort + dataIndex: valueComp<string>(""), +}; +const AreaPiecesTmpComp = new MultiCompBuilder(areaPiecesChildrenMap, (props) => { + return props; +}) + .setPropertyViewFn((children: any) => + (<> + {children.color.propertyView({label: trans("pieChart.color")})} + {children.from.propertyView({label: trans("pieChart.from")})} + {children.to.propertyView({label: trans("pieChart.to")})} + </>) + ) + .build(); + +export type ChartSize = { w: number; h: number }; + +export const getDataKeys = (data: Array<JSONObject>) => { + if (!data) { + return []; + } + const dataKeys: Array<string> = []; + data.slice(0, 50).forEach((d) => { + Object.keys(d).forEach((key) => { + if (!dataKeys.includes(key)) { + dataKeys.push(key); + } + }); + }); + return dataKeys; +}; + +const ChartOptionMap = { + pie: PieChartConfig, + scatter: ScatterChartConfig, +}; + +const EchartsOptionMap = { + funnel: FunnelChartConfig, + gauge: GaugeChartConfig, +}; + +const ChartOptionComp = withType(ChartOptionMap, "pie"); +const EchartsOptionComp = withType(EchartsOptionMap, "funnel"); +export type CharOptionCompType = keyof typeof ChartOptionMap; + +export const chartUiModeChildren = { + title: withDefault(StringControl, trans("echarts.defaultTitle")), + data: jsonControl(toJSONObjectArray, i18nObjs.defaultDataSource), + xAxisKey: valueComp<string>(""), // x-axis, key from data + xAxisDirection: dropdownControl(XAxisDirectionOptions, "horizontal"), + xAxisData: jsonControl(toArray, []), + series: SeriesListComp, + xConfig: XAxisConfig, + yConfig: YAxisConfig, + legendConfig: LegendConfig, + chartConfig: ChartOptionComp, + areaPieces: list(AreaPiecesTmpComp), + onUIEvent: eventHandlerControl(UIEventOptions), +}; + +let chartJsonModeChildren: any = { + echartsOption: jsonControl(toObject, i18nObjs.defaultEchartsJsonOption), + echartsTitle: withDefault(StringControl, trans("echarts.defaultTitle")), + echartsLegendConfig: EchartsLegendConfig, + echartsLabelConfig: EchartsLabelConfig, + echartsConfig: EchartsOptionComp, + echartsTitleVerticalConfig: EchartsTitleVerticalConfig, + echartsTitleConfig:EchartsTitleConfig, + + left:withDefault(NumberControl,trans('chart.defaultLeft')), + right:withDefault(NumberControl,trans('chart.defaultRight')), + top:withDefault(NumberControl,trans('chart.defaultTop')), + bottom:withDefault(NumberControl,trans('chart.defaultBottom')), + + tooltip: withDefault(BoolControl, true), + legendVisibility: withDefault(BoolControl, true), +} + +if (EchartDefaultChartStyle && EchartDefaultTextStyle) { + chartJsonModeChildren = { + ...chartJsonModeChildren, + chartStyle: styleControl(EchartDefaultChartStyle, 'chartStyle'), + titleStyle: styleControl(EchartDefaultTextStyle, 'titleStyle'), + xAxisStyle: styleControl(EchartDefaultTextStyle, 'xAxis'), + yAxisStyle: styleControl(EchartDefaultTextStyle, 'yAxisStyle'), + legendStyle: styleControl(EchartDefaultTextStyle, 'legendStyle'), + } +} + +export type UIChartDataType = { + seriesName: string; + // coordinate chart + x?: any; + y?: any; + // pie or funnel + itemName?: any; + value?: any; +}; + +export type NonUIChartDataType = { + name: string; + value: any; +} + +export const pieChartChildrenMap = { + selectedPoints: stateComp<Array<UIChartDataType>>([]), + lastInteractionData: stateComp<Array<UIChartDataType> | NonUIChartDataType>({}), + onEvent: eventHandlerControl([clickEvent] as const), + ...chartUiModeChildren, + ...chartJsonModeChildren, +}; + +const chartUiChildrenMap = uiChildren(pieChartChildrenMap); +export type ChartCompPropsType = RecordConstructorToView<typeof chartUiChildrenMap>; +export type ChartCompChildrenType = RecordConstructorToComp<typeof chartUiChildrenMap>; diff --git a/client/packages/lowcoder-comps/src/comps/pieChartComp/pieChartPropertyView.tsx b/client/packages/lowcoder-comps/src/comps/pieChartComp/pieChartPropertyView.tsx new file mode 100644 index 000000000..626a491c0 --- /dev/null +++ b/client/packages/lowcoder-comps/src/comps/pieChartComp/pieChartPropertyView.tsx @@ -0,0 +1,144 @@ +import { changeChildAction, CompAction } from "lowcoder-core"; +import { ChartCompChildrenType, ChartTypeOptions,getDataKeys } from "./pieChartConstants"; +import { newSeries } from "./seriesComp"; +import { + CustomModal, + Dropdown, + hiddenPropertyView, + Option, + RedButton, + Section, + sectionNames, + controlItem, +} from "lowcoder-sdk"; +import { trans } from "i18n/comps"; + +export function pieChartPropertyView( + children: ChartCompChildrenType, + dispatch: (action: CompAction) => void +) { + const series = children.series.getView(); + const columnOptions = getDataKeys(children.data.getView()).map((key) => ({ + label: key, + value: key, + })); + + const uiModePropertyView = ( + <> + <Section name={trans("chart.data")}> + {children.chartConfig.getPropertyView()} + <Dropdown + value={children.xAxisKey.getView()} + options={columnOptions} + label={trans("chart.xAxis")} + onChange={(value) => { + dispatch(changeChildAction("xAxisKey", value)); + }} + /> + {children.chartConfig.getView().subtype === "waterfall" && children.xAxisData.propertyView({ + label: "X-Label-Data" + })} + <Option + items={series} + title={trans("chart.chartSeries")} + itemTitle={(s) => s.getView().seriesName} + popoverTitle={(s) => s.getView().columnName} + content={(s, index) => ( + <> + {s.getPropertyViewWithData(columnOptions)} + { + <RedButton + onClick={() => { + CustomModal.confirm({ + title: trans("chart.delete"), + content: trans("chart.confirmDelete") + `${s.getView().seriesName}?`, + onConfirm: () => + children.series.dispatch(children.series.deleteAction(index)), + confirmBtnType: "delete", + okText: trans("chart.delete"), + }); + }} + > + {trans("chart.delete")} + </RedButton> + } + </> + )} + onAdd={() => { + if (columnOptions.length <= 0) { + return; + } + children.series.dispatch( + children.series.pushAction( + newSeries(trans("chart.customSeries"), columnOptions[0].value) + ) + ); + }} + onMove={(fromIndex, toIndex) => { + const action = children.series.arrayMoveAction(fromIndex, toIndex); + children.series.dispatch(action); + }} + hide={(s) => s.getView().hide} + onHide={(s, hide) => s.children.hide.dispatchChangeValueAction(hide)} + dataIndex={(s) => s.getView().dataIndex} + /> + </Section> + <Section name={sectionNames.interaction}> + <div style={{display: 'flex', flexDirection: 'column', gap: '8px'}}> + {children.onUIEvent.propertyView({title: trans("chart.chartEventHandlers")})} + </div> + <div style={{display: 'flex', flexDirection: 'column', gap: '8px'}}> + {children.onEvent.propertyView()} + </div> + </Section> + <Section name={sectionNames.layout}> + {children.echartsTitleConfig.getPropertyView()} + {children.echartsTitleVerticalConfig.getPropertyView()} + {children.legendConfig.getPropertyView()} + {children.title.propertyView({ label: trans("chart.title") })} + {children.left.propertyView({ label: trans("chart.left"), tooltip: trans("echarts.leftTooltip") })} + {children.right.propertyView({ label: trans("chart.right"), tooltip: trans("echarts.rightTooltip") })} + {children.top.propertyView({ label: trans("chart.top"), tooltip: trans("echarts.topTooltip") })} + {children.bottom.propertyView({ label: trans("chart.bottom"), tooltip: trans("echarts.bottomTooltip") })} + {children.chartConfig.children.compType.getView() !== "pie" && ( + <> + {children.xAxisDirection.propertyView({ + label: trans("chart.xAxisDirection"), + radioButton: true, + })} + {children.xConfig.getPropertyView()} + {children.yConfig.getPropertyView()} + </> + )} + {hiddenPropertyView(children)} + {children.tooltip.propertyView({label: trans("echarts.tooltip"), tooltip: trans("echarts.tooltipTooltip")})} + </Section> + <Section name={sectionNames.chartStyle}> + {children.chartStyle?.getPropertyView()} + </Section> + <Section name={sectionNames.titleStyle}> + {children.titleStyle?.getPropertyView()} + </Section> + <Section name={sectionNames.legendStyle}> + {children.legendStyle?.getPropertyView()} + </Section> + <Section name={sectionNames.advanced}> + {children.data.propertyView({ + label: trans("chart.data"), + })} + </Section> + </> + ); + + const getChatConfigByMode = (mode: string) => { + switch(mode) { + case "ui": + return uiModePropertyView; + } + } + return ( + <> + {getChatConfigByMode(children.mode.getView())} + </> + ); +} diff --git a/client/packages/lowcoder-comps/src/comps/pieChartComp/pieChartUtils.ts b/client/packages/lowcoder-comps/src/comps/pieChartComp/pieChartUtils.ts new file mode 100644 index 000000000..cf3b6a664 --- /dev/null +++ b/client/packages/lowcoder-comps/src/comps/pieChartComp/pieChartUtils.ts @@ -0,0 +1,341 @@ +import { + CharOptionCompType, + ChartCompPropsType, + ChartSize, + noDataAxisConfig, + noDataPieChartConfig, +} from "comps/pieChartComp/pieChartConstants"; +import { getPieRadiusAndCenter } from "comps/basicChartComp/chartConfigs/pieChartConfig"; +import { EChartsOptionWithMap } from "../basicChartComp/reactEcharts/types"; +import _ from "lodash"; +import { chartColorPalette, isNumeric, JSONObject, loadScript } from "lowcoder-sdk"; +import { calcXYConfig } from "comps/basicChartComp/chartConfigs/cartesianAxisConfig"; +import Big from "big.js"; +import { googleMapsApiUrl } from "../basicChartComp/chartConfigs/chartUrls"; +import opacityToHex from "../../util/opacityToHex"; +import parseBackground from "../../util/gradientBackgroundColor"; +import {ba, s} from "@fullcalendar/core/internal-common"; +import {chartStyleWrapper, styleWrapper} from "../../util/styleWrapper"; + +export function transformData( + originData: JSONObject[], + xAxis: string, + seriesColumnNames: string[] +) { + // aggregate data by x-axis + const transformedData: JSONObject[] = []; + originData.reduce((prev, cur) => { + if (cur === null || cur === undefined) { + return prev; + } + const groupValue = cur[xAxis] as string; + if (!prev[groupValue]) { + // init as 0 + const initValue: any = {}; + seriesColumnNames.forEach((name) => { + initValue[name] = 0; + }); + prev[groupValue] = initValue; + transformedData.push(prev[groupValue]); + } + // remain the x-axis data + prev[groupValue][xAxis] = groupValue; + seriesColumnNames.forEach((key) => { + if (key === xAxis) { + return; + } else if (isNumeric(cur[key])) { + const bigNum = Big(cur[key]); + prev[groupValue][key] = bigNum.add(prev[groupValue][key]).toNumber(); + } else { + prev[groupValue][key] += 1; + } + }); + return prev; + }, {} as any); + return transformedData; +} + +export const echartsConfigOmitChildren = [ + "hidden", + "selectedPoints", + "onUIEvent", + "mapInstance" +] as const; +type EchartsConfigProps = Omit<ChartCompPropsType, typeof echartsConfigOmitChildren[number]>; + +export function getSeriesConfig(props: EchartsConfigProps) { + let visibleSeries = props.series.filter((s) => !s.getView().hide).map(s => s.toJsonValue()); + let newVisibleSeries; + if(props.chartConfig.subtype === "calendarPie") { + const dataInRange = props.data.filter(item => item[props.xAxisKey].substr(0, 7) === props.chartConfig.range); + newVisibleSeries = dataInRange.map(data => { + return { + data: visibleSeries.map(s => ({name: s.seriesName, value: data[s.columnName]})), + date: data[props.xAxisKey], + } + }); + visibleSeries = newVisibleSeries; + } + const seriesLength = visibleSeries.length; + return visibleSeries.map((s, index) => { + // pie + const radiusAndCenter = getPieRadiusAndCenter(seriesLength, index, props.chartConfig); + let config = { + ...props.chartConfig, + radius: radiusAndCenter.radius, + center: radiusAndCenter.center, + selectedMode: "single", + }; + if(props.chartConfig.subtype !== "calendarPie") { + config = { + ...config, + startAngle: s.startAngle, + endAngle: s.endAngle, + padAngle: s.padAngle, + name: s.seriesName, + label: { + show: s.showLabel, + position: s.labelPosition, + alignTo: s.labelAlignTo, + bleedMargin: s.labelBleedMargin, + }, + labelLine: { + length: s.labelLineLength, + length2: s.labelLineLength2, + }, + encode: { + itemName: props.xAxisKey, + value: s.columnName, + }, + itemStyle: { + borderRadius: s.borderRadius, + color: s.itemColor, + shadowColor: s.itemShadowColor, + shadowBlur: s.itemShadowBlur, + }, + } + if(s.labelAlignTo === 'edge') { + config.label.edgeDistance = s.labelEdgeDistance; + } + if(s.roseType !== "none") { + config.roseType = s.roseType; + } + if(s.itemBg) { + config.itemStyle = { + color: { + image: s.itemBg, + repeat: 'repeat', + } + } + } + if(props.chartConfig.subtype !== 'doughnutPie') config.radius = s.radius; + if(s.left!="" && s.top!="") { + config.center = [s.left, s.top]; + } + if(props.chartConfig.subtype === 'geoPie') config.coordinateSystem = 'geo'; + } else { + config.data = s.data; + config.center = s.date; + config.radius = props.chartConfig.cellSize[0]*0.4; + } + return config; + }); +} + +// https://echarts.apache.org/en/option.html +export function getEchartsConfig( + props: EchartsConfigProps, + chartSize?: ChartSize, + theme?: any, +): EChartsOptionWithMap { + const gridPos = { + left: `${props?.left}%`, + right: `${props?.right}%`, + bottom: `${props?.bottom}%`, + top: `${props?.top}%`, + }; + + let config: any = { + title: { + text: props.title, + top: props.echartsTitleVerticalConfig.top, + left:props.echartsTitleConfig.top, + textStyle: { + ...styleWrapper(props?.titleStyle, theme?.titleStyle) + } + }, + backgroundColor: parseBackground( props?.chartStyle?.background || theme?.chartStyle?.backgroundColor || "#FFFFFF"), + legend: { + ...props.legendConfig, + textStyle: { + ...styleWrapper(props?.legendStyle, theme?.legendStyle, 15) + } + }, + tooltip: props.tooltip && { + trigger: "axis", + axisPointer: { + type: "line", + lineStyle: { + color: "rgba(0,0,0,0.2)", + width: 2, + type: "solid" + } + } + }, + grid: { + ...gridPos, + containLabel: true, + }, + }; + if(props.chartConfig.subtype === "geoPie") { + config.geo = { + map: 'jsonmap', + roam: true, + itemStyle: { + areaColor: '#e7e8ea' + } + }; + } + + //calendar pie + if(props.chartConfig.subtype === "calendarPie") { + config.calendar = { + top: 'middle', + left: 'center', + orient: 'vertical', + cellSize: props.chartConfig.cellSize, + yearLabel: { + show: false, + fontSize: 30 + }, + dayLabel: { + margin: 20, + firstDay: 1, + nameMap: ['Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun'] + }, + monthLabel: { + show: false + }, + range: [props.chartConfig.range] + } + } + // + + if (props.data.length <= 0) { + // no data + return { + ...config, + ...noDataPieChartConfig, + }; + } + const yAxisConfig = props.yConfig(); + const seriesColumnNames = props.series + .filter((s) => !s.getView().hide) + .map((s) => s.getView().columnName); + // y-axis is category and time, data doesn't need to aggregate + let transformedData = + yAxisConfig.type === "category" || yAxisConfig.type === "time" ? props.data : transformData(props.data, props.xAxisKey, seriesColumnNames); + + config = { + ...config, + dataset: [ + { + source: transformedData, + sourceHeader: false, + }, + ], + series: getSeriesConfig(props).map(series => ({ + ...series, + encode: { + ...series.encode, + y: series.name, + }, + itemStyle: { + ...series.itemStyle, + ...chartStyleWrapper(props?.chartStyle, theme?.chartStyle) + }, + lineStyle: { + ...chartStyleWrapper(props?.chartStyle, theme?.chartStyle) + }, + })), + }; + if(props.chartConfig.subtype === "calendarPie") { + config.series = [ + { + id: 'label', + type: 'scatter', + coordinateSystem: 'calendar', + symbolSize: 0, + label: { + show: true, + formatter: function (params) { + return params.value[1]; + }, + offset: [-props.chartConfig.cellSize[0] / 2 + 10, -props.chartConfig.cellSize[1] / 2 + 10], + fontSize: 14 + }, + data: Array.from({ length: 31 }, (_, index) => index + 1).map(d => ([props.chartConfig.range + "-" + (d<10?`0${d}`:d), d])) + }, + ...config.series, + ] + } + + console.log("Echarts transformedData and config", transformedData, config); + return config; +} + +export function getSelectedPoints(param: any, option: any) { + const series = option.series; + const dataSource = _.isArray(option.dataset) && option.dataset[0]?.source; + if (series && dataSource) { + return param.selected.flatMap((selectInfo: any) => { + const seriesInfo = series[selectInfo.seriesIndex]; + if (!seriesInfo || !seriesInfo.encode) { + return []; + } + return selectInfo.dataIndex.map((index: any) => { + const commonResult = { + seriesName: seriesInfo.name, + }; + if (seriesInfo.encode.itemName && seriesInfo.encode.value) { + return { + ...commonResult, + itemName: dataSource[index][seriesInfo.encode.itemName], + value: dataSource[index][seriesInfo.encode.value], + }; + } else { + return { + ...commonResult, + x: dataSource[index][seriesInfo.encode.x], + y: dataSource[index][seriesInfo.encode.y], + }; + } + }); + }); + } + return []; +} + +export function loadGoogleMapsScript(apiKey: string) { + const mapsUrl = `${googleMapsApiUrl}?key=${apiKey}`; + const scripts = document.getElementsByTagName('script'); + // is script already loaded + let scriptIndex = _.findIndex(scripts, (script) => script.src.endsWith(mapsUrl)); + if(scriptIndex > -1) { + return scripts[scriptIndex]; + } + // is script loaded with diff api_key, remove the script and load again + scriptIndex = _.findIndex(scripts, (script) => script.src.startsWith(googleMapsApiUrl)); + if(scriptIndex > -1) { + scripts[scriptIndex].remove(); + } + + const script = document.createElement("script"); + script.type = "text/javascript"; + script.src = mapsUrl; + script.async = true; + script.defer = true; + window.document.body.appendChild(script); + + return script; +} diff --git a/client/packages/lowcoder-comps/src/comps/pieChartComp/seriesComp.tsx b/client/packages/lowcoder-comps/src/comps/pieChartComp/seriesComp.tsx new file mode 100644 index 000000000..bf71aa6b1 --- /dev/null +++ b/client/packages/lowcoder-comps/src/comps/pieChartComp/seriesComp.tsx @@ -0,0 +1,244 @@ +import { + BoolControl, + StringControl, + ColorControl, + list, + dropdownControl, + withDefault, + NumberControl, + isNumeric, + genRandomKey, + Dropdown, + MultiCompBuilder, + valueComp, +} from "lowcoder-sdk"; +import { i18nObjs, trans } from "i18n/comps"; + +import { ConstructorToComp, ConstructorToDataType, ConstructorToView } from "lowcoder-core"; +import { CompAction, CustomAction, customAction, isMyCustomAction } from "lowcoder-core"; +import { x } from "@fullcalendar/resource/internal-common"; + +export type SeriesCompType = ConstructorToComp<typeof SeriesComp>; +export type RawSeriesCompType = ConstructorToView<typeof SeriesComp>; +type SeriesDataType = ConstructorToDataType<typeof SeriesComp>; + +type ActionDataType = { + type: "chartDataChanged"; + chartData: Array<JSONObject>; +}; + +export function newSeries(name: string, columnName: string): SeriesDataType { + return { + seriesName: name, + columnName: columnName, + dataIndex: genRandomKey(), + }; +} + +export const RoseTypeOptions = [ + { + label: trans("pieChart.radius"), + value: "radius", + }, + { + label: trans("pieChart.area"), + value: "area", + }, + { + label: trans("pieChart.none"), + value: "none", + }, +] as const; + +export const LabelAlignToOptions = [ + { + label: trans("pieChart.none"), + value: "none", + }, + { + label: trans("pieChart.labelLine"), + value: "labelLine", + }, + { + label: trans("pieChart.edge"), + value: "edge", + }, +] as const; + +export const LabelPositionOptions = [ + { + label: trans("pieChart.outer"), + value: "outer", + }, + { + label: trans("pieChart.inner"), + value: "inner", + }, + { + label: trans("pieChart.center"), + value: "center", + }, +] as const; + +const seriesChildrenMap = { + columnName: StringControl, + seriesName: StringControl, + showLabel: withDefault(BoolControl, true), + radius: withDefault(StringControl, 30), + left: withDefault(StringControl, ""), + top: withDefault(StringControl, ""), + startAngle: withDefault(NumberControl, 0), + endAngle: withDefault(NumberControl, 360), + roseType: dropdownControl(RoseTypeOptions, "none"), + labelAlignTo: dropdownControl(LabelAlignToOptions, "none"), + labelPosition: dropdownControl(LabelPositionOptions, "outer"), + labelBleedMargin: withDefault(NumberControl, 5), + labelEdgeDistance: withDefault(StringControl, '25%'), + labelLineLength: withDefault(NumberControl, 10), + labelLineLength2: withDefault(NumberControl, 10), + padAngle: withDefault(NumberControl, 0), + borderRadius: withDefault(NumberControl, 0), + itemColor: ColorControl, + itemBg: StringControl, + itemShadowBlur: NumberControl, + itemShadowColor: ColorControl, + hide: BoolControl, + // unique key, for sort + dataIndex: valueComp<string>(""), +}; + +const SeriesTmpComp = new MultiCompBuilder(seriesChildrenMap, (props) => { + return props; +}) + .setPropertyViewFn(() => { + return <></>; + }) + .build(); + +class SeriesComp extends SeriesTmpComp { + getPropertyViewWithData(columnOptions: OptionsType): React.ReactNode { + return ( + <> + {this.children.seriesName.propertyView({ + label: trans("chart.seriesName"), + })} + <Dropdown + value={this.children.columnName.getView()} + options={columnOptions} + label={trans("chart.dataColumns")} + onChange={(value) => { + this.children.columnName.dispatchChangeValueAction(value); + }} + /> + {this.children.radius.propertyView({ + label: trans("pieChart.radius"), + })} + {this.children.left.propertyView({ + label: trans("pieChart.left"), + })} + {this.children.top.propertyView({ + label: trans("pieChart.top"), + })} + {this.children.startAngle.propertyView({ + label: trans("pieChart.startAngle"), + })} + {this.children.endAngle.propertyView({ + label: trans("pieChart.endAngle"), + })} + {this.children.roseType.propertyView({ + label: trans("pieChart.roseType"), + })} + {this.children.showLabel.propertyView({ + label: trans("pieChart.showLabel"), + })} + {this.children.showLabel.getView() && this.children.labelPosition.propertyView({ + label: trans("pieChart.labelPosition"), + })} + {this.children.showLabel.getView() && this.children.labelAlignTo.propertyView({ + label: trans("pieChart.labelAlignTo"), + })} + {this.children.showLabel.getView() && this.children.labelBleedMargin.propertyView({ + label: trans("pieChart.labelBleedMargin"), + })} + {this.children.showLabel.getView() && this.children.labelAlignTo.getView() === "edge" && this.children.labelEdgeDistance.propertyView({ + label: trans("pieChart.labelEdgeDistance"), + })} + {this.children.showLabel.getView() && this.children.labelLineLength.propertyView({ + label: trans("pieChart.labelLineLength"), + })} + {this.children.showLabel.getView() && this.children.labelAlignTo.getView() === "labelLine" && this.children.labelLineLength2.propertyView({ + label: trans("pieChart.labelLineLength2"), + })} + {this.children.padAngle.propertyView({ + label: trans("pieChart.padAngle"), + })} + {this.children.borderRadius.propertyView({ + label: trans("pieChart.borderRadius"), + })} + {this.children.itemColor.propertyView({ + label: trans("pieChart.itemColor"), + })} + {this.children.itemShadowBlur.propertyView({ + label: trans("pieChart.itemShadowBlur"), + })} + {this.children.itemShadowColor.propertyView({ + label: trans("pieChart.itemShadowColor"), + })} + {this.children.itemBg.propertyView({ + label: trans("pieChart.itemBg"), + placeholder: i18nObjs.defaultPieBg, + })} + </> + ); + } +} + +const SeriesListTmpComp = list(SeriesComp); + +export class SeriesListComp extends SeriesListTmpComp { + override reduce(action: CompAction): this { + if (isMyCustomAction<ActionDataType>(action, "chartDataChanged")) { + // auto generate series + const actions = this.genExampleSeriesActions(action.value.chartData); + return this.reduce(this.multiAction(actions)); + } + return super.reduce(action); + } + + private genExampleSeriesActions(chartData: Array<JSONObject>) { + const actions: CustomAction[] = []; + if (!chartData || chartData.length <= 0 || !chartData[0]) { + return actions; + } + let delCnt = 0; + const existColumns = this.getView().map((s) => s.getView().columnName); + // delete series not in data + existColumns.forEach((columnName) => { + if (chartData[0]?.[columnName] === undefined) { + actions.push(this.deleteAction(0)); + delCnt++; + } + }); + if (existColumns.length > delCnt) { + // don't generate example if exists + return actions; + } + // generate example series + const exampleKeys = Object.keys(chartData[0]) + .filter((key) => { + return !existColumns.includes(key) && isNumeric(chartData[0][key]); + }) + .slice(0, 3); + exampleKeys.forEach((key) => actions.push(this.pushAction(newSeries(key, key)))); + return actions; + } + + dispatchDataChanged(chartData: Array<JSONObject>): void { + this.dispatch( + customAction<ActionDataType>({ + type: "chartDataChanged", + chartData: chartData, + }) + ); + } +} diff --git a/client/packages/lowcoder-comps/src/comps/scatterChartComp/scatterChartComp.tsx b/client/packages/lowcoder-comps/src/comps/scatterChartComp/scatterChartComp.tsx new file mode 100644 index 000000000..003fadf1d --- /dev/null +++ b/client/packages/lowcoder-comps/src/comps/scatterChartComp/scatterChartComp.tsx @@ -0,0 +1,295 @@ +import { + changeChildAction, + changeValueAction, + CompAction, + CompActionTypes, + wrapChildAction, +} from "lowcoder-core"; +import { AxisFormatterComp, EchartsAxisType } from "../basicChartComp/chartConfigs/cartesianAxisConfig"; +import { scatterChartChildrenMap, ChartSize, getDataKeys } from "./scatterChartConstants"; +import { scatterChartPropertyView } from "./scatterChartPropertyView"; +import _ from "lodash"; +import { useContext, useEffect, useMemo, useRef, useState } from "react"; +import ReactResizeDetector from "react-resize-detector"; +import ReactECharts from "../basicChartComp/reactEcharts"; +import * as echarts from "echarts"; +import { + childrenToProps, + depsConfig, + genRandomKey, + NameConfig, + UICompBuilder, + withDefault, + withExposingConfigs, + withViewFn, + ThemeContext, + chartColorPalette, + getPromiseAfterDispatch, + dropdownControl, +} from "lowcoder-sdk"; +import { getEchartsLocale, i18nObjs, trans } from "i18n/comps"; +import { + echartsConfigOmitChildren, + getEchartsConfig, + getSelectedPoints, +} from "./scatterChartUtils"; +import 'echarts-extension-gmap'; +import log from "loglevel"; + +let clickEventCallback = () => {}; + +const chartModeOptions = [ + { + label: "UI", + value: "ui", + } +] as const; + +let ScatterChartTmpComp = (function () { + return new UICompBuilder({mode:dropdownControl(chartModeOptions,'ui'),...scatterChartChildrenMap}, () => null) + .setPropertyViewFn(scatterChartPropertyView) + .build(); +})(); + +ScatterChartTmpComp = withViewFn(ScatterChartTmpComp, (comp) => { + const mode = comp.children.mode.getView(); + const onUIEvent = comp.children.onUIEvent.getView(); + const onEvent = comp.children.onEvent.getView(); + const echartsCompRef = useRef<ReactECharts | null>(); + const [chartSize, setChartSize] = useState<ChartSize>(); + const firstResize = useRef(true); + const theme = useContext(ThemeContext); + const defaultChartTheme = { + color: chartColorPalette, + backgroundColor: "#fff", + }; + + let themeConfig = defaultChartTheme; + try { + themeConfig = theme?.theme.chart ? JSON.parse(theme?.theme.chart) : defaultChartTheme; + } catch (error) { + log.error('theme chart error: ', error); + } + + const triggerClickEvent = async (dispatch: any, action: CompAction<JSONValue>) => { + await getPromiseAfterDispatch( + dispatch, + action, + { autoHandleAfterReduce: true } + ); + onEvent('click'); + } + + useEffect(() => { + const echartsCompInstance = echartsCompRef?.current?.getEchartsInstance(); + if (!echartsCompInstance) { + return _.noop; + } + echartsCompInstance?.on("click", (param: any) => { + document.dispatchEvent(new CustomEvent("clickEvent", { + bubbles: true, + detail: { + action: 'click', + data: param.data, + } + })); + triggerClickEvent( + comp.dispatch, + changeChildAction("lastInteractionData", param.data, false) + ); + }); + return () => { + echartsCompInstance?.off("click"); + document.removeEventListener('clickEvent', clickEventCallback) + }; + }, []); + + useEffect(() => { + // bind events + const echartsCompInstance = echartsCompRef?.current?.getEchartsInstance(); + if (!echartsCompInstance) { + return _.noop; + } + echartsCompInstance?.on("selectchanged", (param: any) => { + const option: any = echartsCompInstance?.getOption(); + document.dispatchEvent(new CustomEvent("clickEvent", { + bubbles: true, + detail: { + action: param.fromAction, + data: getSelectedPoints(param, option) + } + })); + + if (param.fromAction === "select") { + comp.dispatch(changeChildAction("selectedPoints", getSelectedPoints(param, option), false)); + onUIEvent("select"); + } else if (param.fromAction === "unselect") { + comp.dispatch(changeChildAction("selectedPoints", getSelectedPoints(param, option), false)); + onUIEvent("unselect"); + } + + triggerClickEvent( + comp.dispatch, + changeChildAction("lastInteractionData", getSelectedPoints(param, option), false) + ); + }); + // unbind + return () => { + echartsCompInstance?.off("selectchanged"); + document.removeEventListener('clickEvent', clickEventCallback) + }; + }, [onUIEvent]); + + const echartsConfigChildren = _.omit(comp.children, echartsConfigOmitChildren); + const childrenProps = childrenToProps(echartsConfigChildren); + + const option = useMemo(() => { + return getEchartsConfig( + childrenProps as ToViewReturn<typeof echartsConfigChildren>, + chartSize, + themeConfig + ); + }, [theme, childrenProps, chartSize, ...Object.values(echartsConfigChildren)]); + + return ( + <ReactResizeDetector + onResize={(w, h) => { + if (w && h) { + setChartSize({ w: w, h: h }); + } + if (!firstResize.current) { + // ignore the first resize, which will impact the loading animation + echartsCompRef.current?.getEchartsInstance().resize(); + } else { + firstResize.current = false; + } + }} + > + <ReactECharts + ref={(e) => (echartsCompRef.current = e)} + style={{ height: "100%" }} + notMerge + lazyUpdate + opts={{ locale: getEchartsLocale() }} + option={option} + mode={mode} + /> + </ReactResizeDetector> + ); +}); + +function getYAxisFormatContextValue( + data: Array<JSONObject>, + yAxisType: EchartsAxisType, + yAxisName?: string +) { + const dataSample = yAxisName && data.length > 0 && data[0][yAxisName]; + let contextValue = dataSample; + if (yAxisType === "time") { + // to timestamp + const time = + typeof dataSample === "number" || typeof dataSample === "string" + ? new Date(dataSample).getTime() + : null; + if (time) contextValue = time; + } + return contextValue; +} + +ScatterChartTmpComp = class extends ScatterChartTmpComp { + private lastYAxisFormatContextVal?: JSONValue; + private lastColorContext?: JSONObject; + + updateContext(comp: this) { + // the context value of axis format + let resultComp = comp; + const data = comp.children.data.getView(); + const sampleSeries = comp.children.series.getView().find((s) => !s.getView().hide); + const yAxisContextValue = getYAxisFormatContextValue( + data, + comp.children.yConfig.children.yAxisType.getView(), + sampleSeries?.children.columnName.getView() + ); + if (yAxisContextValue !== comp.lastYAxisFormatContextVal) { + comp.lastYAxisFormatContextVal = yAxisContextValue; + resultComp = comp.setChild( + "yConfig", + comp.children.yConfig.reduce( + wrapChildAction( + "formatter", + AxisFormatterComp.changeContextDataAction({ value: yAxisContextValue }) + ) + ) + ); + } + return resultComp; + } + + override reduce(action: CompAction): this { + const comp = super.reduce(action); + if (action.type === CompActionTypes.UPDATE_NODES_V2) { + const newData = comp.children.data.getView(); + // data changes + if (comp.children.data !== this.children.data) { + setTimeout(() => { + // update x-axis value + const keys = getDataKeys(newData); + if (keys.length > 0 && !keys.includes(comp.children.xAxisKey.getView())) { + comp.children.xAxisKey.dispatch(changeValueAction(keys[0] || "")); + } + // pass to child series comp + comp.children.series.dispatchDataChanged(newData); + }, 0); + } + return this.updateContext(comp); + } + return comp; + } + + override autoHeight(): boolean { + return false; + } +}; + +let ScatterChartComp = withExposingConfigs(ScatterChartTmpComp, [ + depsConfig({ + name: "selectedPoints", + desc: trans("chart.selectedPointsDesc"), + depKeys: ["selectedPoints"], + func: (input) => { + return input.selectedPoints; + }, + }), + depsConfig({ + name: "lastInteractionData", + desc: trans("chart.lastInteractionDataDesc"), + depKeys: ["lastInteractionData"], + func: (input) => { + return input.lastInteractionData; + }, + }), + depsConfig({ + name: "data", + desc: trans("chart.dataDesc"), + depKeys: ["data", "mode"], + func: (input) =>[] , + }), + new NameConfig("title", trans("chart.titleDesc")), +]); + + +export const ScatterChartCompWithDefault = withDefault(ScatterChartComp, { + xAxisKey: "date", + series: [ + { + dataIndex: genRandomKey(), + seriesName: trans("chart.spending"), + columnName: "spending", + }, + { + dataIndex: genRandomKey(), + seriesName: trans("chart.budget"), + columnName: "budget", + }, + ], +}); diff --git a/client/packages/lowcoder-comps/src/comps/scatterChartComp/scatterChartConstants.tsx b/client/packages/lowcoder-comps/src/comps/scatterChartComp/scatterChartConstants.tsx new file mode 100644 index 000000000..02c8f803f --- /dev/null +++ b/client/packages/lowcoder-comps/src/comps/scatterChartComp/scatterChartConstants.tsx @@ -0,0 +1,288 @@ +import { + jsonControl, + stateComp, + toJSONObjectArray, + toObject, + BoolControl, + ColorControl, + withDefault, + StringControl, + NumberControl, + dropdownControl, + list, + eventHandlerControl, + valueComp, + withType, + uiChildren, + clickEvent, + toArray, + styleControl, + EchartDefaultTextStyle, + EchartDefaultChartStyle, + MultiCompBuilder, +} from "lowcoder-sdk"; +import { RecordConstructorToComp, RecordConstructorToView } from "lowcoder-core"; +import { XAxisConfig, YAxisConfig } from "../basicChartComp/chartConfigs/cartesianAxisConfig"; +import { LegendConfig } from "../basicChartComp/chartConfigs/legendConfig"; +import { EchartsLegendConfig } from "../basicChartComp/chartConfigs/echartsLegendConfig"; +import { EchartsLabelConfig } from "../basicChartComp/chartConfigs/echartsLabelConfig"; +import { ScatterChartConfig } from "../basicChartComp/chartConfigs/scatterChartConfig"; +import { SeriesListComp } from "./seriesComp"; +import { EChartsOption } from "echarts"; +import { i18nObjs, trans } from "i18n/comps"; +import { GaugeChartConfig } from "../basicChartComp/chartConfigs/gaugeChartConfig"; +import { FunnelChartConfig } from "../basicChartComp/chartConfigs/funnelChartConfig"; +import {EchartsTitleVerticalConfig} from "../chartComp/chartConfigs/echartsTitleVerticalConfig"; +import {EchartsTitleConfig} from "../basicChartComp/chartConfigs/echartsTitleConfig"; + +export const ChartTypeOptions = [ + { + label: trans("chart.bar"), + value: "bar", + }, + { + label: trans("chart.line"), + value: "line", + }, + { + label: trans("chart.scatter"), + value: "scatter", + }, + { + label: trans("chart.scatter"), + value: "scatter", + }, +] as const; + +export const UIEventOptions = [ + { + label: trans("chart.select"), + value: "select", + description: trans("chart.selectDesc"), + }, + { + label: trans("chart.unSelect"), + value: "unselect", + description: trans("chart.unselectDesc"), + }, +] as const; + +export const XAxisDirectionOptions = [ + { + label: trans("chart.horizontal"), + value: "horizontal", + }, + { + label: trans("chart.vertical"), + value: "vertical", + }, +] as const; + +export type XAxisDirectionType = ValueFromOption<typeof XAxisDirectionOptions>; + +export const noDataAxisConfig = { + animation: false, + xAxis: { + type: "category", + name: trans("chart.noData"), + nameLocation: "middle", + data: [], + axisLine: { + lineStyle: { + color: "#8B8FA3", + }, + }, + }, + yAxis: { + type: "value", + axisLabel: { + color: "#8B8FA3", + }, + splitLine: { + lineStyle: { + color: "#F0F0F0", + }, + }, + }, + tooltip: { + show: false, + }, + series: [ + { + data: [700], + type: "line", + itemStyle: { + opacity: 0, + }, + }, + ], +} as EChartsOption; + +export const noDataScatterChartConfig = { + animation: false, + tooltip: { + show: false, + }, + legend: { + formatter: trans("chart.unknown"), + top: "bottom", + selectedMode: false, + }, + color: ["#B8BBCC", "#CED0D9", "#DCDEE6", "#E6E6EB"], + series: [ + { + type: "scatter", + radius: "35%", + center: ["25%", "50%"], + silent: true, + label: { + show: false, + }, + data: [ + { + name: "1", + value: 70, + }, + { + name: "2", + value: 68, + }, + { + name: "3", + value: 48, + }, + { + name: "4", + value: 40, + }, + ], + }, + { + type: "scatter", + radius: "35%", + center: ["75%", "50%"], + silent: true, + label: { + show: false, + }, + data: [ + { + name: "1", + value: 70, + }, + { + name: "2", + value: 68, + }, + { + name: "3", + value: 48, + }, + { + name: "4", + value: 40, + }, + ], + }, + ], +} as EChartsOption; + +export type ChartSize = { w: number; h: number }; + +export const getDataKeys = (data: Array<JSONObject>) => { + if (!data) { + return []; + } + const dataKeys: Array<string> = []; + data.slice(0, 50).forEach((d) => { + Object.keys(d).forEach((key) => { + if (!dataKeys.includes(key)) { + dataKeys.push(key); + } + }); + }); + return dataKeys; +}; + +const ChartOptionMap = { + scatter: ScatterChartConfig, +}; + +const EchartsOptionMap = { + funnel: FunnelChartConfig, + gauge: GaugeChartConfig, +}; + +const ChartOptionComp = withType(ChartOptionMap, "scatter"); +const EchartsOptionComp = withType(EchartsOptionMap, "funnel"); +export type CharOptionCompType = keyof typeof ChartOptionMap; + +export const chartUiModeChildren = { + title: withDefault(StringControl, trans("echarts.defaultTitle")), + data: jsonControl(toJSONObjectArray, i18nObjs.defaultDataSource), + xAxisKey: valueComp<string>(""), // x-axis, key from data + xAxisDirection: dropdownControl(XAxisDirectionOptions, "horizontal"), + xAxisData: jsonControl(toArray, []), + series: SeriesListComp, + xConfig: XAxisConfig, + yConfig: YAxisConfig, + legendConfig: LegendConfig, + chartConfig: ChartOptionComp, + onUIEvent: eventHandlerControl(UIEventOptions), +}; + +let chartJsonModeChildren: any = { + echartsOption: jsonControl(toObject, i18nObjs.defaultEchartsJsonOption), + echartsTitle: withDefault(StringControl, trans("echarts.defaultTitle")), + echartsLegendConfig: EchartsLegendConfig, + echartsLabelConfig: EchartsLabelConfig, + echartsConfig: EchartsOptionComp, + echartsTitleVerticalConfig: EchartsTitleVerticalConfig, + echartsTitleConfig:EchartsTitleConfig, + + left:withDefault(NumberControl,trans('chart.defaultLeft')), + right:withDefault(NumberControl,trans('chart.defaultRight')), + top:withDefault(NumberControl,trans('chart.defaultTop')), + bottom:withDefault(NumberControl,trans('chart.defaultBottom')), + + tooltip: withDefault(BoolControl, true), + legendVisibility: withDefault(BoolControl, true), +} + +if (EchartDefaultChartStyle && EchartDefaultTextStyle) { + chartJsonModeChildren = { + ...chartJsonModeChildren, + chartStyle: styleControl(EchartDefaultChartStyle, 'chartStyle'), + titleStyle: styleControl(EchartDefaultTextStyle, 'titleStyle'), + xAxisStyle: styleControl(EchartDefaultTextStyle, 'xAxis'), + yAxisStyle: styleControl(EchartDefaultTextStyle, 'yAxisStyle'), + legendStyle: styleControl(EchartDefaultTextStyle, 'legendStyle'), + } +} + +export type UIChartDataType = { + seriesName: string; + // coordinate chart + x?: any; + y?: any; + // scatter or funnel + itemName?: any; + value?: any; +}; + +export type NonUIChartDataType = { + name: string; + value: any; +} + +export const scatterChartChildrenMap = { + selectedPoints: stateComp<Array<UIChartDataType>>([]), + lastInteractionData: stateComp<Array<UIChartDataType> | NonUIChartDataType>({}), + onEvent: eventHandlerControl([clickEvent] as const), + ...chartUiModeChildren, + ...chartJsonModeChildren, +}; + +const chartUiChildrenMap = uiChildren(scatterChartChildrenMap); +export type ChartCompPropsType = RecordConstructorToView<typeof chartUiChildrenMap>; +export type ChartCompChildrenType = RecordConstructorToComp<typeof chartUiChildrenMap>; diff --git a/client/packages/lowcoder-comps/src/comps/scatterChartComp/scatterChartPropertyView.tsx b/client/packages/lowcoder-comps/src/comps/scatterChartComp/scatterChartPropertyView.tsx new file mode 100644 index 000000000..77ac49eb0 --- /dev/null +++ b/client/packages/lowcoder-comps/src/comps/scatterChartComp/scatterChartPropertyView.tsx @@ -0,0 +1,140 @@ +import { changeChildAction, CompAction } from "lowcoder-core"; +import { ChartCompChildrenType, ChartTypeOptions,getDataKeys } from "./scatterChartConstants"; +import { newSeries } from "./seriesComp"; +import { + CustomModal, + Dropdown, + hiddenPropertyView, + Option, + RedButton, + Section, + sectionNames, + controlItem, +} from "lowcoder-sdk"; +import { trans } from "i18n/comps"; + +export function scatterChartPropertyView( + children: ChartCompChildrenType, + dispatch: (action: CompAction) => void +) { + const series = children.series.getView(); + const columnOptions = getDataKeys(children.data.getView()).map((key) => ({ + label: key, + value: key, + })); + + const uiModePropertyView = ( + <> + <Section name={trans("chart.data")}> + {children.chartConfig.getPropertyView()} + <Dropdown + value={children.xAxisKey.getView()} + options={columnOptions} + label={trans("chart.xAxis")} + onChange={(value) => { + dispatch(changeChildAction("xAxisKey", value)); + }} + /> + {children.chartConfig.getView().subtype === "waterfall" && children.xAxisData.propertyView({ + label: "X-Label-Data" + })} + <Option + items={series} + title={trans("chart.chartSeries")} + itemTitle={(s) => s.getView().seriesName} + popoverTitle={(s) => s.getView().columnName} + content={(s, index) => ( + <> + {s.getPropertyViewWithData(columnOptions)} + { + <RedButton + onClick={() => { + CustomModal.confirm({ + title: trans("chart.delete"), + content: trans("chart.confirmDelete") + `${s.getView().seriesName}?`, + onConfirm: () => + children.series.dispatch(children.series.deleteAction(index)), + confirmBtnType: "delete", + okText: trans("chart.delete"), + }); + }} + > + {trans("chart.delete")} + </RedButton> + } + </> + )} + onAdd={() => { + if (columnOptions.length <= 0) { + return; + } + children.series.dispatch( + children.series.pushAction( + newSeries(trans("chart.customSeries"), columnOptions[0].value) + ) + ); + }} + onMove={(fromIndex, toIndex) => { + const action = children.series.arrayMoveAction(fromIndex, toIndex); + children.series.dispatch(action); + }} + hide={(s) => s.getView().hide} + onHide={(s, hide) => s.children.hide.dispatchChangeValueAction(hide)} + dataIndex={(s) => s.getView().dataIndex} + /> + </Section> + <Section name={sectionNames.interaction}> + <div style={{display: 'flex', flexDirection: 'column', gap: '8px'}}> + {children.onUIEvent.propertyView({title: trans("chart.chartEventHandlers")})} + </div> + <div style={{display: 'flex', flexDirection: 'column', gap: '8px'}}> + {children.onEvent.propertyView()} + </div> + </Section> + <Section name={sectionNames.layout}> + {children.echartsTitleConfig.getPropertyView()} + {children.echartsTitleVerticalConfig.getPropertyView()} + {children.legendConfig.getPropertyView()} + {children.title.propertyView({ label: trans("chart.title") })} + {children.left.propertyView({ label: trans("chart.left"), tooltip: trans("echarts.leftTooltip") })} + {children.right.propertyView({ label: trans("chart.right"), tooltip: trans("echarts.rightTooltip") })} + {children.top.propertyView({ label: trans("chart.top"), tooltip: trans("echarts.topTooltip") })} + {children.bottom.propertyView({ label: trans("chart.bottom"), tooltip: trans("echarts.bottomTooltip") })} + {hiddenPropertyView(children)} + {children.tooltip.propertyView({label: trans("echarts.tooltip"), tooltip: trans("echarts.tooltipTooltip")})} + </Section> + <Section name={sectionNames.chartStyle}> + {children.chartStyle?.getPropertyView()} + </Section> + <Section name={sectionNames.titleStyle}> + {children.titleStyle?.getPropertyView()} + </Section> + <Section name={sectionNames.xAxisStyle}> + {children.xAxisStyle?.getPropertyView()} + </Section> + <Section name={sectionNames.yAxisStyle}> + {children.yAxisStyle?.getPropertyView()} + </Section> + <Section name={sectionNames.legendStyle}> + {children.legendStyle?.getPropertyView()} + </Section> + <Section name={sectionNames.advanced}> + {children.data.propertyView({ + label: trans("chart.data"), + })} + </Section> + </> + ); + + const getChatConfigByMode = (mode: string) => { + switch(mode) { + case "ui": + return uiModePropertyView; + } + } + return ( + <> + {getChatConfigByMode(children.mode.getView())} + </> + ); +} diff --git a/client/packages/lowcoder-comps/src/comps/scatterChartComp/scatterChartUtils.ts b/client/packages/lowcoder-comps/src/comps/scatterChartComp/scatterChartUtils.ts new file mode 100644 index 000000000..67b2a4a53 --- /dev/null +++ b/client/packages/lowcoder-comps/src/comps/scatterChartComp/scatterChartUtils.ts @@ -0,0 +1,354 @@ +import { + CharOptionCompType, + ChartCompPropsType, + ChartSize, + noDataAxisConfig, + noDataScatterChartConfig, +} from "comps/scatterChartComp/scatterChartConstants"; +import { EChartsOptionWithMap } from "../basicChartComp/reactEcharts/types"; +import _ from "lodash"; +import { chartColorPalette, isNumeric, JSONObject, loadScript } from "lowcoder-sdk"; +import { calcXYConfig } from "comps/basicChartComp/chartConfigs/cartesianAxisConfig"; +import Big from "big.js"; +import { googleMapsApiUrl } from "../basicChartComp/chartConfigs/chartUrls"; +import opacityToHex from "../../util/opacityToHex"; +import parseBackground from "../../util/gradientBackgroundColor"; +import {ba, s} from "@fullcalendar/core/internal-common"; +import {chartStyleWrapper, styleWrapper} from "../../util/styleWrapper"; + +export function transformData( + originData: JSONObject[], + xAxis: string, + seriesColumnNames: string[] +) { + // aggregate data by x-axis + const transformedData: JSONObject[] = []; + originData.reduce((prev, cur) => { + if (cur === null || cur === undefined) { + return prev; + } + const groupValue = cur[xAxis] as string; + if (!prev[groupValue]) { + // init as 0 + const initValue: any = {}; + seriesColumnNames.forEach((name) => { + initValue[name] = 0; + }); + prev[groupValue] = initValue; + transformedData.push(prev[groupValue]); + } + // remain the x-axis data + prev[groupValue][xAxis] = groupValue; + seriesColumnNames.forEach((key) => { + if (key === xAxis) { + return; + } else if (isNumeric(cur[key])) { + const bigNum = Big(cur[key]); + prev[groupValue][key] = bigNum.add(prev[groupValue][key]).toNumber(); + } else { + prev[groupValue][key] += 1; + } + }); + return prev; + }, {} as any); + return transformedData; +} + +export const echartsConfigOmitChildren = [ + "hidden", + "selectedPoints", + "onUIEvent", + "mapInstance" +] as const; +type EchartsConfigProps = Omit<ChartCompPropsType, typeof echartsConfigOmitChildren[number]>; + +export function getSeriesConfig(props: EchartsConfigProps) { + let visibleSeries = props.series.filter((s) => !s.getView().hide).map(s => s.toJsonValue()); + return visibleSeries.map((s, index) => { + let config = { + ...props.chartConfig, + name: s.seriesName, + encode: { + itemName: props.xAxisKey, + value: s.columnName, + }, + itemStyle: { + borderRadius: s.borderRadius, + color: s.itemColor, + shadowColor: s.itemShadowColor, + shadowBlur: s.itemShadowBlur, + }, + } + let fromArr = [0,0]; + let toArr = [0,0]; + try { + fromArr = JSON.parse(s.markLineFrom); + } catch {} + try { + toArr = JSON.parse(s.markLineTo); + } catch {} + if(s.showMarkLine) { + config.markLine = { + animation: false, + label: { + formatter: s.markLineDesc, + align: 'right' + }, + lineStyle: { + type: 'solid' + }, + tooltip: { + formatter: s.markLineDesc + }, + data: [ + [ + { + coord: fromArr, + symbol: 'none' + }, + { + coord: toArr, + symbol: 'none' + } + ] + ] + }; + } + if(props.chartConfig.singleAxis) { + config.coordinateSystem = 'singleAxis'; + config.singleAxisIndex = index; + config.data = []; + } + if(props.chartConfig.polar) { + config.coordinateSystem = 'polar'; + } + if(props.chartConfig.heatmap) { + config.coordinateSystem = 'calendar'; + config.type = 'heatmap'; + } + if(s.effect) config.type = "effectScatter"; + if(s.symbolSize) config.symbolSize = s.symbolSize; + if(s.dynamicSize) config.symbolSize = function(dataItem) { + return dataItem[s.dynamicIndex] / s.divider; + } + return config; + }); +} + +// https://echarts.apache.org/en/option.html +export function getEchartsConfig( + props: EchartsConfigProps, + chartSize?: ChartSize, + theme?: any, +): EChartsOptionWithMap { + const gridPos = { + left: `${props?.left}%`, + right: `${props?.right}%`, + bottom: `${props?.bottom}%`, + top: `${props?.top}%`, + }; + + let config: any = { + title: { + text: props.title, + top: props.echartsTitleVerticalConfig.top, + left:props.echartsTitleConfig.top, + textStyle: { + ...styleWrapper(props?.titleStyle, theme?.titleStyle) + } + }, + backgroundColor: parseBackground( props?.chartStyle?.background || theme?.chartStyle?.backgroundColor || "#FFFFFF"), + legend: { + ...props.legendConfig, + textStyle: { + ...styleWrapper(props?.legendStyle, theme?.legendStyle, 15) + } + }, + tooltip: props.tooltip && { + trigger: "axis", + axisPointer: { + type: "line", + lineStyle: { + color: "rgba(0,0,0,0.2)", + width: 2, + type: "solid" + } + } + }, + grid: { + ...gridPos, + containLabel: true, + }, + xAxis: { + type: "category", + boundaryGap: props.chartConfig.boundaryGap, + splitLine: { + show: !props.chartConfig.boundaryGap, + }, + axisLine: { + show: props.chartConfig.boundaryGap, + }, + axisLabel: { + ...styleWrapper(props?.xAxisStyle, theme?.xAxisStyle, 11) + } + }, + yAxis: { + type: "category", + axisLabel: { + ...styleWrapper(props?.yAxisStyle, theme?.yAxisStyle, 11) + } + }, + }; + + if (props.data.length <= 0) { + // no data + return { + ...config, + ...noDataScatterChartConfig, + }; + } + const yAxisConfig = props.yConfig(); + const seriesColumnNames = props.series + .filter((s) => !s.getView().hide) + .map((s) => s.getView().columnName); + // y-axis is category and time, data doesn't need to aggregate + let transformedData = props.data; + const seriesConfig = getSeriesConfig(props); + const singleAxis = seriesConfig.map((series, idx) => ({ + left: 100, + type: 'category', + boundaryGap: false, + top: (idx * 100) / seriesConfig.length + (100/seriesConfig.length/2) + '%', + height: - 100 / seriesConfig.length / 4 + '%', + })); + + config = { + ...config, + series: seriesConfig.map(series => ({ + ...series, + itemStyle: { + ...series.itemStyle, + ...chartStyleWrapper(props?.chartStyle, theme?.chartStyle) + }, + lineStyle: { + ...chartStyleWrapper(props?.chartStyle, theme?.chartStyle) + }, + data: transformedData.map(d => [d[props.xAxisKey], d[series.encode.value], ...Object.values(d)]), + })), + }; + + if(props.chartConfig.singleAxis) { + config.singleAxis = singleAxis; + delete config.xAxis; + delete config.yAxis; + + config.title = seriesConfig.map((series, idx) => ({ + textBaseline: 'middle', + top: ((idx + 0.5) * 100) / seriesConfig.length + '%', + text: series.name, + })); + } + + if(props.chartConfig.visualMapData.visualMap) { + config.visualMap = { + min: props.chartConfig.visualMapData.visualMapMin, + max: props.chartConfig.visualMapData.visualMapMax, + dimension: props.chartConfig.visualMapData.visualMapDimension, + orient: 'vertical', + right: 10, + top: 'center', + text: ['HIGH', 'LOW'], + calculable: true, + inRange: { + color: [props.chartConfig.visualMapData.visualMapColorMin, props.chartConfig.visualMapData.visualMapColorMax] + } + } + } + if(props.chartConfig.polar) { + config.angleAxis = config.xAxis; + config.radiusAxis = config.yAxis; + config.polar = {}; + delete config.xAxis; + delete config.yAxis; + } + + if(props.chartConfig.heatmap) { + config.calendar = { + orient: 'vertical', + yearLabel: { + margin: 40 + }, + monthLabel: { + nameMap: 'cn', + margin: 20 + }, + dayLabel: { + firstDay: 1, + nameMap: 'cn' + }, + cellSize: 40, + range: props.chartConfig.heatmapMonth, + } + delete config.xAxis; + delete config.yAxis; + } + + console.log("Echarts transformedData and config", transformedData, config); + return config; +} + +export function getSelectedPoints(param: any, option: any) { + const series = option.series; + const dataSource = _.isArray(option.dataset) && option.dataset[0]?.source; + if (series && dataSource) { + return param.selected.flatMap((selectInfo: any) => { + const seriesInfo = series[selectInfo.seriesIndex]; + if (!seriesInfo || !seriesInfo.encode) { + return []; + } + return selectInfo.dataIndex.map((index: any) => { + const commonResult = { + seriesName: seriesInfo.name, + }; + if (seriesInfo.encode.itemName && seriesInfo.encode.value) { + return { + ...commonResult, + itemName: dataSource[index][seriesInfo.encode.itemName], + value: dataSource[index][seriesInfo.encode.value], + }; + } else { + return { + ...commonResult, + x: dataSource[index][seriesInfo.encode.x], + y: dataSource[index][seriesInfo.encode.y], + }; + } + }); + }); + } + return []; +} + +export function loadGoogleMapsScript(apiKey: string) { + const mapsUrl = `${googleMapsApiUrl}?key=${apiKey}`; + const scripts = document.getElementsByTagName('script'); + // is script already loaded + let scriptIndex = _.findIndex(scripts, (script) => script.src.endsWith(mapsUrl)); + if(scriptIndex > -1) { + return scripts[scriptIndex]; + } + // is script loaded with diff api_key, remove the script and load again + scriptIndex = _.findIndex(scripts, (script) => script.src.startsWith(googleMapsApiUrl)); + if(scriptIndex > -1) { + scripts[scriptIndex].remove(); + } + + const script = document.createElement("script"); + script.type = "text/javascript"; + script.src = mapsUrl; + script.async = true; + script.defer = true; + window.document.body.appendChild(script); + + return script; +} diff --git a/client/packages/lowcoder-comps/src/comps/scatterChartComp/seriesComp.tsx b/client/packages/lowcoder-comps/src/comps/scatterChartComp/seriesComp.tsx new file mode 100644 index 000000000..0f423da20 --- /dev/null +++ b/client/packages/lowcoder-comps/src/comps/scatterChartComp/seriesComp.tsx @@ -0,0 +1,159 @@ +import { + BoolControl, + StringControl, + ColorControl, + list, + dropdownControl, + withDefault, + jsonControl, + toArray, + NumberControl, + isNumeric, + genRandomKey, + Dropdown, + MultiCompBuilder, + valueComp, +} from "lowcoder-sdk"; +import { i18nObjs, trans } from "i18n/comps"; + +import { ConstructorToComp, ConstructorToDataType, ConstructorToView } from "lowcoder-core"; +import { CompAction, CustomAction, customAction, isMyCustomAction } from "lowcoder-core"; + +export type SeriesCompType = ConstructorToComp<typeof SeriesComp>; +export type RawSeriesCompType = ConstructorToView<typeof SeriesComp>; +type SeriesDataType = ConstructorToDataType<typeof SeriesComp>; + +type ActionDataType = { + type: "chartDataChanged"; + chartData: Array<JSONObject>; +}; + +export function newSeries(name: string, columnName: string): SeriesDataType { + return { + seriesName: name, + columnName: columnName, + dataIndex: genRandomKey(), + }; +} + +const seriesChildrenMap = { + columnName: StringControl, + seriesName: StringControl, + dynamicSize: BoolControl, + symbolSize: NumberControl, + dynamicIndex: withDefault(NumberControl, "1"), + divider: withDefault(NumberControl, 1000), + effect: BoolControl, + showMarkLine: BoolControl, + markLineFrom: withDefault(StringControl, "[0,0]"), + markLineTo: withDefault(StringControl, "[1000,1000]"), + markLineDesc: StringControl, + hide: BoolControl, + // unique key, for sort + dataIndex: valueComp<string>(""), +}; + +const SeriesTmpComp = new MultiCompBuilder(seriesChildrenMap, (props) => { + return props; +}) + .setPropertyViewFn(() => { + return <></>; + }) + .build(); + +class SeriesComp extends SeriesTmpComp { + getPropertyViewWithData(columnOptions: OptionsType): React.ReactNode { + return ( + <> + {this.children.seriesName.propertyView({ + label: trans("chart.seriesName"), + })} + <Dropdown + value={this.children.columnName.getView()} + options={columnOptions} + label={trans("chart.dataColumns")} + onChange={(value) => { + this.children.columnName.dispatchChangeValueAction(value); + }} + /> + {this.children.effect.propertyView({ + label: trans("scatterChart.effect"), + })} + {this.children.dynamicSize.propertyView({ + label: trans("scatterChart.dynamicSize"), + })} + {this.children.dynamicSize.getView() && this.children.dynamicIndex.propertyView({ + label: trans("scatterChart.dynamicIndex"), + })} + {this.children.dynamicSize.getView() && this.children.divider.propertyView({ + label: trans("scatterChart.divider"), + })} + {!this.children.dynamicSize.getView() && this.children.symbolSize.propertyView({ + label: trans("scatterChart.symbolSize"), + })} + {this.children.showMarkLine.propertyView({ + label: trans("scatterChart.showMarkLine"), + })} + {this.children.showMarkLine.getView() && this.children.markLineFrom.propertyView({ + label: trans("scatterChart.from"), + })} + {this.children.showMarkLine.getView() && this.children.markLineTo.propertyView({ + label: trans("scatterChart.to"), + })} + {this.children.showMarkLine.getView() && this.children.markLineDesc.propertyView({ + label: trans("scatterChart.desc"), + })} + </> + ); + } +} + +const SeriesListTmpComp = list(SeriesComp); + +export class SeriesListComp extends SeriesListTmpComp { + override reduce(action: CompAction): this { + if (isMyCustomAction<ActionDataType>(action, "chartDataChanged")) { + // auto generate series + const actions = this.genExampleSeriesActions(action.value.chartData); + return this.reduce(this.multiAction(actions)); + } + return super.reduce(action); + } + + private genExampleSeriesActions(chartData: Array<JSONObject>) { + const actions: CustomAction[] = []; + if (!chartData || chartData.length <= 0 || !chartData[0]) { + return actions; + } + let delCnt = 0; + const existColumns = this.getView().map((s) => s.getView().columnName); + // delete series not in data + existColumns.forEach((columnName) => { + if (chartData[0]?.[columnName] === undefined) { + actions.push(this.deleteAction(0)); + delCnt++; + } + }); + if (existColumns.length > delCnt) { + // don't generate example if exists + return actions; + } + // generate example series + const exampleKeys = Object.keys(chartData[0]) + .filter((key) => { + return !existColumns.includes(key) && isNumeric(chartData[0][key]); + }) + .slice(0, 3); + exampleKeys.forEach((key) => actions.push(this.pushAction(newSeries(key, key)))); + return actions; + } + + dispatchDataChanged(chartData: Array<JSONObject>): void { + this.dispatch( + customAction<ActionDataType>({ + type: "chartDataChanged", + chartData: chartData, + }) + ); + } +} diff --git a/client/packages/lowcoder-comps/src/i18n/comps/locales/en.ts b/client/packages/lowcoder-comps/src/i18n/comps/locales/en.ts index c2861b8ca..73c3d7d21 100644 --- a/client/packages/lowcoder-comps/src/i18n/comps/locales/en.ts +++ b/client/packages/lowcoder-comps/src/i18n/comps/locales/en.ts @@ -1,3 +1,7 @@ +import {default as defaultBaseTexture} from '../../../comps/line3dChartComp/images/default_base_texture.jpg'; +import {default as defaultHeightTexture} from '../../../comps/line3dChartComp/images/default_height_texture.jpg'; +import {default as defaultEnvironment} from '../../../comps/line3dChartComp/images/default_environment.jpg'; + export const en = { calendarChart: { calendarType: 'Calendar Chart Type', @@ -311,6 +315,183 @@ export const en = { defaultBarometerPointerLength: "125", defaultBarometerPointer_Y: "-10" + }, + lineChart: { + cellSize: "Cell Size", + range: "Range", + markLines: "Mark Lines", + markAreas: "Mark Areas", + stacked: "Stacked Chart", + area: "Area Chart", + max: "Max", + min: "Min", + average: "Average", + markLineType: "Marker Type", + type: "Type", + name: "Name", + from: "From", + to: "To", + color: "Color", + areaPieces: "Area Pieces", + areaPiece: "Area Piece", + showEndLabel: "End Label", + symbol: "Symbol", + symbolSize: "Symbol Size", + animationDuration: "Animation Duration", + none: "None", + start: "Start", + middle: "Middle", + end: "End", + step: "Step", + polar: "Polar Chart", + solid: "Solid", + dashed: "Dashed", + dotted: "Dotted", + borderColor: "Border Color", + borderWidth: "Border Width", + borderType: "Border Type", + }, + pieChart: { + showLabel: "Show Label", + mapUrl: "Map URL", + left: "Left", + top: "Top", + itemBg: "Background Image", + itemColor: "Color", + itemShadowColor: "Shadow Color", + itemShadowBlur: "Shadow Blur", + padAngle: "Pad Angle", + borderRadius: "Border Radius", + startAngle: "Start Angle", + endAngle: "End Angle", + roseType: "Rose Type", + area: "Area", + radius: "Radius", + none: "None", + labelPosition: "Position", + labelAlignTo: "AlignTo", + labelBleedMargin: "Bleed Margin", + labelEdgeDistance: "Edge Distance", + labelLine: "Label Line", + edge: "Edge", + outside: "Outside", + outer: "Outer", + inside: "Inside", + inner: "Inner", + center: "Center", + labelLineLength: "Label Line Length", + labelLineLength2: "Label Line Length2", + }, + scatterChart: { + heatmap: "Heat Map", + heatmapMonth: "Heat Map Month", + polar: "Polar Chart", + visualMap: "Visual Map", + visualMapMin: "Visual Map Min", + visualMapMax: "Visual Map Max", + visualMapDimension: "Visual Map Dimension", + visualMapColorMin: "Visual Map Color Min", + visualMapColorMax: "Visual Map Color Max", + boundaryGap: "Boundary Gap", + labelIndex: "Label Column Index", + dynamicSize: "Dynamic Size", + dynamicIndex: "Size Column Index", + divider: "Divider", + singleAxis: "Single Axis", + effect: "Effect", + symbolSize: "Symbol Size", + from: "From", + to: "To", + showMarkLine: "Show Mark Line", + desc: "Description", + }, + barChart: { + title: 'Title', + barWidth: 'Bar Width(%)', + race: 'Race', + stack: 'Stacked', + showBg: 'Show Bar Background', + bgColor: 'Background Color', + polarIsTangent: 'Tangential Chart', + radiusAxisMax: 'Max', + polarRadiusStart: 'Start Radius', + polarRadiusEnd: 'End Radius', + polarLabelData: 'Label Data', + polarStartAngle: 'Start Angle', + polarEndAngle: 'End Angle', + defaultTitle: 'Bar Chart', + barType: 'Bar Chart Type', + tooltip: 'Tooltip', + left: 'Left', + defaultLeft:'35', + top: 'Top', + defaultTop:'60', + bottom: 'Bottom', + defaultBottom:'60', + width: 'Width', + defaultWidth:'80', + min: 'Min', + defaultMin:'0', + max: 'Max', + defaultMax:'100', + gap: 'Gap', + defaultGap: '2', + defaultStartAngle: '210', + startAngle: 'Start Angle', + defaultEndAngle: '-30', + endAngle: 'End Angle', + defaultSplitNumber: '10', + splitNumber: 'Split Number', + radius: 'Radius', + defaultRadius: '80', + defaultTemperatureRadius: '60', + defaultPointerLength: '50', + pointerLength: 'Pointer Length', + pointerWidth: 'Pointer Width', + defaultPointerWidth: '5', + label:'Label', + position_x: 'Position-X', + defaultPosition_X: '50', + position_y: 'Position-Y', + defaultPosition_Y: '60', + progressBarWidth: 'Progress Bar Width', + defaultProgressBarWidth: '10', + defaultStageProgressBarWidth: '15', + defaultTemperatureProgressBarWidth: '35', + defaultRingProgressBarWidth: '20', + progressBar: 'Progress Bar', + roundCap: "Round Cap", + chartType: "Chart Type", + chartTypeTooltip: "Select the types of Charts.", + defaultPointer_Y: "0", + gradeDefaultPointerIcon: "path://M12.8,0.7l12,40.1H0.7L12.8,0.7z", + clockDefaultPointerIcon: "path://M2.9,0.7L2.9,0.7c1.4,0,2.6,1.2,2.6,2.6v115c0,1.4-1.2,2.6-2.6,2.6l0,0c-1.4,0-2.6-1.2-2.6-2.6V3.3C0.3,1.9,1.4,0.7,2.9,0.7z", + defaultBarometerPointerIcon: 'path://M2090.36389,615.30999 L2090.36389,615.30999 C2091.48372,615.30999 2092.40383,616.194028 2092.44859,617.312956 L2096.90698,728.755929 C2097.05155,732.369577 2094.2393,735.416212 2090.62566,735.56078 C2090.53845,735.564269 2090.45117,735.566014 2090.36389,735.566014 L2090.36389,735.566014 C2086.74736,735.566014 2083.81557,732.63423 2083.81557,729.017692 C2083.81557,728.930412 2083.81732,728.84314 2083.82081,728.755929 L2088.2792,617.312956 C2088.32396,616.194028 2089.24407,615.30999 2090.36389,615.30999 Z', + defaultMultiTitlePointerIcon: 'path://M2.9,0.7L2.9,0.7c1.4,0,2.6,1.2,2.6,2.6v115c0,1.4-1.2,2.6-2.6,2.6l0,0c-1.4,0-2.6-1.2-2.6-2.6V3.3C0.3,1.9,1.4,0.7,2.9,0.7z', + pointer_Y: "Pointer-Y", + pointer_Y_Tooltip: "Select the Y-value of the pointer.", + pointerIcon: "Pointer Icon", + pointerIconTooltip: "Select the Pointer Icon", + defaultGradeBarPointerLength: "25", + defaultGradeBarPointerWidth: "10", + defaultGradeBarPointer_Y: "45", + defaultAxisLabelDistance: "10", + defaultTemperatureAxisLabelDistance: "30", + axisLabelDistance: "Axis Label Distance", + progressBarColor: "Progress Bar Color", + gradeProgressBarString: "Progress Bar String", + defaultAxisTickLength: "7", + defaultAxisTickWidth: "2", + defaultAxisTickColor: "#444444", + defaultStageAxisTickColor: "#ffffff", + axisTickLength: "axisTick Length", + axisTickWidth: "axisTick Width", + axisTickWidthStage: "axisTick Width", + axisTickColor: "AxisTick Color", + defaultBarometerPointerWidth: "3", + defaultBarometerPointerLength: "125", + defaultBarometerPointer_Y: "-10" + }, echarts: { legendVisibility: 'Legend', @@ -367,6 +548,24 @@ export const en = { tooltipTooltip: "Show or hide the Tooltip of the Chart.", labelVisibility: "Label", }, + line3dchart: { + background: "Background", + lineStyleWidth: "Line Style Width", + lineStyleColor: "Line Style Color", + lineStyleOpacity: "Line Style Opacity", + effectShow: "Show Effects", + effectTrailWidth: "Trail Width", + effectTrailLength: "Trail Length", + effectTrailOpacity: "Trail Opacity", + effectTrailColor: "Trail Color", + environment: "Environment", + baseTexture: "Base Texture", + heightTexture: "Height Texture", + ambientCubemapTexture: "Ambient Cubemap Texture", + defaultBaseTexture: defaultBaseTexture, + defaultEnvironment: defaultEnvironment, + defaultHeightTexture: defaultHeightTexture, + }, chart: { delete: "Delete", data: "Data", @@ -376,6 +575,7 @@ export const en = { UIMode: "UI Mode", chartType: "Chart Type", xAxis: "X-axis", + yAxis: "Y-axis", chartSeries: "Chart Series", customSeries: "Custom Series", add: "Add", @@ -399,6 +599,8 @@ export const en = { "Indicates the value of each coordinate. Example: '{{value * 100 + \"%\"}}'", basicBar: "Basic Bar", stackedBar: "Stacked Bar", + waterfallBar: "Waterfall Chart", + polar: "Polar", barType: "Bar Chart Type", categoryAxis: "Category Axis", valueAxis: "Value Axis", @@ -409,11 +611,14 @@ export const en = { basicLine: "Basic Line", stackedLine: "Stacked Line", areaLine: "Area Line", + stackedAreaLine: "Stacked Area Line", smooth: "Smooth Curve", lineType: "Line Chart Type", basicPie: "Basic Pie", doughnutPie: "Doughnut Pie", rosePie: "Rose Pie", + calendarPie: "Calendar Pie", + geoPie: "Geo Map Pie", pieType: "Pie Chart Type", spending: "Spending", budget: "Budget", @@ -446,6 +651,9 @@ export const en = { diamond: "Diamond", pin: "Pin", arrow: "Arrow", + emptyCircle: "Empty Circle", + none: "None", + roundRect: "Round Rectangle", pointColorLabel: "Point Color", pointColorTooltip: 'Set point color based on series name and value. Variables: seriesName, value. Example: \'{{value < 25000 ? "red" : "green"}}\'', diff --git a/client/packages/lowcoder-comps/src/i18n/comps/locales/enObj.tsx b/client/packages/lowcoder-comps/src/i18n/comps/locales/enObj.tsx index 408e50bf5..b9d17e3c2 100644 --- a/client/packages/lowcoder-comps/src/i18n/comps/locales/enObj.tsx +++ b/client/packages/lowcoder-comps/src/i18n/comps/locales/enObj.tsx @@ -80,78 +80,95 @@ const defaultMapData = { export const enObj: I18nObjects = { defaultDataSource: [ { - date: "2021-09", + date: "2021-09-01", department: "Administration", spending: 9003, - budget: 8000, + budget: 8000 }, { - date: "2021-09", + date: "2021-09-02", department: "Finance", spending: 3033, - budget: 4000, + budget: 4000 }, { - date: "2021-09", + date: "2021-09-03", department: "Sales", spending: 9230, - budget: 8000, + budget: 8000 }, { - date: "2021-10", + date: "2021-09-04", department: "Administration", spending: 13032, - budget: 15000, + budget: 15000 }, { - date: "2021-10", + date: "2021-09-05", department: "Finance", spending: 2300, - budget: 5000, + budget: 5000 }, { - date: "2021-10", + date: "2021-09-05", department: "Sales", spending: 7323.5, - budget: 8000, + budget: 8000 }, { - date: "2021-11", + date: "2021-09-06", department: "Administration", spending: 13000, - budget: 16023, + budget: 16023 }, { - date: "2021-11", + date: "2021-09-06", department: "Finance", spending: 3569.5, - budget: 3000, + budget: 3000 }, { - date: "2021-11", + date: "2021-09-07", department: "Sales", spending: 10000, - budget: 9932, + budget: 9932 }, { - date: "2021-12", + date: "2021-09-07", department: "Administration", spending: 18033, - budget: 20000, + budget: 20000 }, { - date: "2021-12", + date: "2021-09-08", department: "Finance", spending: 4890, - budget: 4500, + budget: 4500 }, { - date: "2021-12", + date: "2021-09-09", department: "Sales", spending: 9322, - budget: 8000, - }, + budget: 8000 + } ], + defaultBarChartOption: { + xAxis: { + type: 'category', + data: ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun'] + }, + yAxis: { + type: 'value' + }, + series: [ + { + data: [120, 200, 150, 80, 70, 110, 130], + type: 'bar' + } + ], + barWidth: 30, + barBg: "#aaaaaa" + }, defaultEchartsJsonOption: { data: [ @@ -544,4 +561,1446 @@ export const enObj: I18nObjects = { }, defaultMapJsonOption: defaultMapData, + defaultPieBg: 'data:image/jpeg;base64,/9j/4AAQS...', + usaMap: {"type":"FeatureCollection","features":[ + {"type":"Feature","id":"01","properties":{"name":"Alabama"},"geometry":{"type":"Polygon","coordinates":[[[-87.359296,35.00118],[-85.606675,34.984749],[-85.431413,34.124869],[-85.184951,32.859696],[-85.069935,32.580372],[-84.960397,32.421541],[-85.004212,32.322956],[-84.889196,32.262709],[-85.058981,32.13674],[-85.053504,32.01077],[-85.141136,31.840985],[-85.042551,31.539753],[-85.113751,31.27686],[-85.004212,31.003013],[-85.497137,30.997536],[-87.600282,30.997536],[-87.633143,30.86609],[-87.408589,30.674397],[-87.446927,30.510088],[-87.37025,30.427934],[-87.518128,30.280057],[-87.655051,30.247195],[-87.90699,30.411504],[-87.934375,30.657966],[-88.011052,30.685351],[-88.10416,30.499135],[-88.137022,30.318396],[-88.394438,30.367688],[-88.471115,31.895754],[-88.241084,33.796253],[-88.098683,34.891641],[-88.202745,34.995703],[-87.359296,35.00118]]]}}, + {"type":"Feature","id":"02","properties":{"name":"Alaska"},"geometry":{"type":"MultiPolygon","coordinates":[[[[-131.602021,55.117982],[-131.569159,55.28229],[-131.355558,55.183705],[-131.38842,55.01392],[-131.645836,55.035827],[-131.602021,55.117982]]],[[[-131.832052,55.42469],[-131.645836,55.304197],[-131.749898,55.128935],[-131.832052,55.189182],[-131.832052,55.42469]]],[[[-132.976733,56.437924],[-132.735747,56.459832],[-132.631685,56.421493],[-132.664547,56.273616],[-132.878148,56.240754],[-133.069841,56.333862],[-132.976733,56.437924]]],[[[-133.595627,56.350293],[-133.162949,56.317431],[-133.05341,56.125739],[-132.620732,55.912138],[-132.472854,55.780691],[-132.4619,55.671152],[-132.357838,55.649245],[-132.341408,55.506844],[-132.166146,55.364444],[-132.144238,55.238474],[-132.029222,55.276813],[-131.97993,55.178228],[-131.958022,54.789365],[-132.029222,54.701734],[-132.308546,54.718165],[-132.385223,54.915335],[-132.483808,54.898904],[-132.686455,55.046781],[-132.746701,54.997489],[-132.916486,55.046781],[-132.889102,54.898904],[-132.73027,54.937242],[-132.626209,54.882473],[-132.675501,54.679826],[-132.867194,54.701734],[-133.157472,54.95915],[-133.239626,55.090597],[-133.223195,55.22752],[-133.453227,55.216566],[-133.453227,55.320628],[-133.277964,55.331582],[-133.102702,55.42469],[-133.17938,55.588998],[-133.387503,55.62186],[-133.420365,55.884753],[-133.497042,56.0162],[-133.639442,55.923092],[-133.694212,56.070969],[-133.546335,56.142169],[-133.666827,56.311955],[-133.595627,56.350293]]],[[[-133.738027,55.556137],[-133.546335,55.490413],[-133.414888,55.572568],[-133.283441,55.534229],[-133.420365,55.386352],[-133.633966,55.430167],[-133.738027,55.556137]]],[[[-133.907813,56.930849],[-134.050213,57.029434],[-133.885905,57.095157],[-133.343688,57.002049],[-133.102702,57.007526],[-132.932917,56.82131],[-132.620732,56.667956],[-132.653593,56.55294],[-132.817901,56.492694],[-133.042456,56.520078],[-133.201287,56.448878],[-133.420365,56.492694],[-133.66135,56.448878],[-133.710643,56.684386],[-133.688735,56.837741],[-133.869474,56.843218],[-133.907813,56.930849]]],[[[-134.115936,56.48174],[-134.25286,56.558417],[-134.400737,56.722725],[-134.417168,56.848695],[-134.296675,56.908941],[-134.170706,56.848695],[-134.143321,56.952757],[-133.748981,56.772017],[-133.710643,56.596755],[-133.847566,56.574848],[-133.935197,56.377678],[-133.836612,56.322908],[-133.957105,56.092877],[-134.110459,56.142169],[-134.132367,55.999769],[-134.230952,56.070969],[-134.291198,56.350293],[-134.115936,56.48174]]],[[[-134.636246,56.28457],[-134.669107,56.169554],[-134.806031,56.235277],[-135.178463,56.67891],[-135.413971,56.810356],[-135.331817,56.914418],[-135.424925,57.166357],[-135.687818,57.369004],[-135.419448,57.566174],[-135.298955,57.48402],[-135.063447,57.418296],[-134.849846,57.407343],[-134.844369,57.248511],[-134.636246,56.728202],[-134.636246,56.28457]]],[[[-134.712923,58.223407],[-134.373353,58.14673],[-134.176183,58.157683],[-134.187137,58.081006],[-133.902336,57.807159],[-134.099505,57.850975],[-134.148798,57.757867],[-133.935197,57.615466],[-133.869474,57.363527],[-134.083075,57.297804],[-134.154275,57.210173],[-134.499322,57.029434],[-134.603384,57.034911],[-134.6472,57.226604],[-134.575999,57.341619],[-134.608861,57.511404],[-134.729354,57.719528],[-134.707446,57.829067],[-134.784123,58.097437],[-134.91557,58.212453],[-134.953908,58.409623],[-134.712923,58.223407]]],[[[-135.857603,57.330665],[-135.715203,57.330665],[-135.567326,57.149926],[-135.633049,57.023957],[-135.857603,56.996572],[-135.824742,57.193742],[-135.857603,57.330665]]],[[[-136.279328,58.206976],[-135.978096,58.201499],[-135.780926,58.28913],[-135.496125,58.168637],[-135.64948,58.037191],[-135.59471,57.987898],[-135.45231,58.135776],[-135.107263,58.086483],[-134.91557,57.976944],[-135.025108,57.779775],[-134.937477,57.763344],[-134.822462,57.500451],[-135.085355,57.462112],[-135.572802,57.675713],[-135.556372,57.456635],[-135.709726,57.369004],[-135.890465,57.407343],[-136.000004,57.544266],[-136.208128,57.637374],[-136.366959,57.829067],[-136.569606,57.916698],[-136.558652,58.075529],[-136.421728,58.130299],[-136.377913,58.267222],[-136.279328,58.206976]]],[[[-147.079854,60.200582],[-147.501579,59.948643],[-147.53444,59.850058],[-147.874011,59.784335],[-147.80281,59.937689],[-147.435855,60.09652],[-147.205824,60.271782],[-147.079854,60.200582]]],[[[-147.561825,60.578491],[-147.616594,60.370367],[-147.758995,60.156767],[-147.956165,60.227967],[-147.791856,60.474429],[-147.561825,60.578491]]],[[[-147.786379,70.245291],[-147.682318,70.201475],[-147.162008,70.15766],[-146.888161,70.185044],[-146.510252,70.185044],[-146.099482,70.146706],[-145.858496,70.168614],[-145.622988,70.08646],[-145.195787,69.993352],[-144.620708,69.971444],[-144.461877,70.026213],[-144.078491,70.059075],[-143.914183,70.130275],[-143.497935,70.141229],[-143.503412,70.091936],[-143.25695,70.119321],[-142.747594,70.042644],[-142.402547,69.916674],[-142.079408,69.856428],[-142.008207,69.801659],[-141.712453,69.790705],[-141.433129,69.697597],[-141.378359,69.63735],[-141.208574,69.686643],[-141.00045,69.648304],[-141.00045,60.304644],[-140.53491,60.22249],[-140.474664,60.310121],[-139.987216,60.184151],[-139.696939,60.342983],[-139.088998,60.359413],[-139.198537,60.091043],[-139.045183,59.997935],[-138.700135,59.910304],[-138.623458,59.767904],[-137.604747,59.242118],[-137.445916,58.908024],[-137.265177,59.001132],[-136.827022,59.159963],[-136.580559,59.16544],[-136.465544,59.285933],[-136.476498,59.466672],[-136.301236,59.466672],[-136.25742,59.625503],[-135.945234,59.663842],[-135.479694,59.800766],[-135.025108,59.565257],[-135.068924,59.422857],[-134.959385,59.280456],[-134.701969,59.247595],[-134.378829,59.033994],[-134.400737,58.973748],[-134.25286,58.858732],[-133.842089,58.727285],[-133.173903,58.152206],[-133.075318,57.998852],[-132.867194,57.845498],[-132.560485,57.505928],[-132.253777,57.21565],[-132.368792,57.095157],[-132.05113,57.051341],[-132.127807,56.876079],[-131.870391,56.804879],[-131.837529,56.602232],[-131.580113,56.613186],[-131.087188,56.405062],[-130.78048,56.366724],[-130.621648,56.268139],[-130.468294,56.240754],[-130.424478,56.142169],[-130.101339,56.114785],[-130.002754,55.994292],[-130.150631,55.769737],[-130.128724,55.583521],[-129.986323,55.276813],[-130.095862,55.200136],[-130.336847,54.920812],[-130.687372,54.718165],[-130.785957,54.822227],[-130.917403,54.789365],[-131.010511,54.997489],[-130.983126,55.08512],[-131.092665,55.189182],[-130.862634,55.298721],[-130.928357,55.337059],[-131.158389,55.200136],[-131.284358,55.287767],[-131.426759,55.238474],[-131.843006,55.457552],[-131.700606,55.698537],[-131.963499,55.616383],[-131.974453,55.49589],[-132.182576,55.588998],[-132.226392,55.704014],[-132.083991,55.829984],[-132.127807,55.955953],[-132.324977,55.851892],[-132.522147,56.076446],[-132.642639,56.032631],[-132.719317,56.218847],[-132.527624,56.339339],[-132.341408,56.339339],[-132.396177,56.487217],[-132.297592,56.67891],[-132.450946,56.673433],[-132.768609,56.837741],[-132.993164,57.034911],[-133.51895,57.177311],[-133.507996,57.577128],[-133.677781,57.62642],[-133.639442,57.790728],[-133.814705,57.834544],[-134.072121,58.053622],[-134.143321,58.168637],[-134.586953,58.206976],[-135.074401,58.502731],[-135.282525,59.192825],[-135.38111,59.033994],[-135.337294,58.891593],[-135.140124,58.617746],[-135.189417,58.573931],[-135.05797,58.349376],[-135.085355,58.201499],[-135.277048,58.234361],[-135.430402,58.398669],[-135.633049,58.426053],[-135.91785,58.382238],[-135.912373,58.617746],[-136.087635,58.814916],[-136.246466,58.75467],[-136.876314,58.962794],[-136.931084,58.902547],[-136.586036,58.836824],[-136.317666,58.672516],[-136.213604,58.667039],[-136.180743,58.535592],[-136.043819,58.382238],[-136.388867,58.294607],[-136.591513,58.349376],[-136.59699,58.212453],[-136.859883,58.316515],[-136.947514,58.393192],[-137.111823,58.393192],[-137.566409,58.590362],[-137.900502,58.765624],[-137.933364,58.869686],[-138.11958,59.02304],[-138.634412,59.132579],[-138.919213,59.247595],[-139.417615,59.379041],[-139.746231,59.505011],[-139.718846,59.641934],[-139.625738,59.598119],[-139.5162,59.68575],[-139.625738,59.88292],[-139.488815,59.992458],[-139.554538,60.041751],[-139.801,59.833627],[-140.315833,59.696704],[-140.92925,59.745996],[-141.444083,59.871966],[-141.46599,59.970551],[-141.706976,59.948643],[-141.964392,60.019843],[-142.539471,60.085566],[-142.873564,60.091043],[-143.623905,60.036274],[-143.892275,59.997935],[-144.231845,60.140336],[-144.65357,60.206059],[-144.785016,60.29369],[-144.834309,60.441568],[-145.124586,60.430614],[-145.223171,60.299167],[-145.738004,60.474429],[-145.820158,60.551106],[-146.351421,60.408706],[-146.608837,60.238921],[-146.718376,60.397752],[-146.608837,60.485383],[-146.455483,60.463475],[-145.951604,60.578491],[-146.017328,60.666122],[-146.252836,60.622307],[-146.345944,60.737322],[-146.565022,60.753753],[-146.784099,61.044031],[-146.866253,60.972831],[-147.172962,60.934492],[-147.271547,60.972831],[-147.375609,60.879723],[-147.758995,60.912584],[-147.775426,60.808523],[-148.032842,60.781138],[-148.153334,60.819476],[-148.065703,61.005692],[-148.175242,61.000215],[-148.350504,60.803046],[-148.109519,60.737322],[-148.087611,60.594922],[-147.939734,60.441568],[-148.027365,60.277259],[-148.219058,60.332029],[-148.273827,60.249875],[-148.087611,60.217013],[-147.983549,59.997935],[-148.251919,59.95412],[-148.399797,59.997935],[-148.635305,59.937689],[-148.755798,59.986981],[-149.067984,59.981505],[-149.05703,60.063659],[-149.204907,60.008889],[-149.287061,59.904827],[-149.418508,59.997935],[-149.582816,59.866489],[-149.511616,59.806242],[-149.741647,59.729565],[-149.949771,59.718611],[-150.031925,59.61455],[-150.25648,59.521442],[-150.409834,59.554303],[-150.579619,59.444764],[-150.716543,59.450241],[-151.001343,59.225687],[-151.308052,59.209256],[-151.406637,59.280456],[-151.592853,59.159963],[-151.976239,59.253071],[-151.888608,59.422857],[-151.636669,59.483103],[-151.47236,59.472149],[-151.423068,59.537872],[-151.127313,59.669319],[-151.116359,59.778858],[-151.505222,59.63098],[-151.828361,59.718611],[-151.8667,59.778858],[-151.702392,60.030797],[-151.423068,60.211536],[-151.379252,60.359413],[-151.297098,60.386798],[-151.264237,60.545629],[-151.406637,60.720892],[-151.06159,60.786615],[-150.404357,61.038554],[-150.245526,60.939969],[-150.042879,60.912584],[-149.741647,61.016646],[-150.075741,61.15357],[-150.207187,61.257632],[-150.47008,61.246678],[-150.656296,61.29597],[-150.711066,61.252155],[-151.023251,61.180954],[-151.165652,61.044031],[-151.477837,61.011169],[-151.800977,60.852338],[-151.833838,60.748276],[-152.080301,60.693507],[-152.13507,60.578491],[-152.310332,60.507291],[-152.392486,60.304644],[-152.732057,60.173197],[-152.567748,60.069136],[-152.704672,59.915781],[-153.022334,59.888397],[-153.049719,59.691227],[-153.345474,59.620026],[-153.438582,59.702181],[-153.586459,59.548826],[-153.761721,59.543349],[-153.72886,59.433811],[-154.117723,59.368087],[-154.1944,59.066856],[-153.750768,59.050425],[-153.400243,58.968271],[-153.301658,58.869686],[-153.444059,58.710854],[-153.679567,58.612269],[-153.898645,58.606793],[-153.920553,58.519161],[-154.062953,58.4863],[-153.99723,58.376761],[-154.145107,58.212453],[-154.46277,58.059098],[-154.643509,58.059098],[-154.818771,58.004329],[-154.988556,58.015283],[-155.120003,57.955037],[-155.081664,57.872883],[-155.328126,57.829067],[-155.377419,57.708574],[-155.547204,57.785251],[-155.73342,57.549743],[-156.045606,57.566174],[-156.023698,57.440204],[-156.209914,57.473066],[-156.34136,57.418296],[-156.34136,57.248511],[-156.549484,56.985618],[-156.883577,56.952757],[-157.157424,56.832264],[-157.20124,56.766541],[-157.376502,56.859649],[-157.672257,56.607709],[-157.754411,56.67891],[-157.918719,56.657002],[-157.957058,56.514601],[-158.126843,56.459832],[-158.32949,56.48174],[-158.488321,56.339339],[-158.208997,56.295524],[-158.510229,55.977861],[-159.375585,55.873799],[-159.616571,55.594475],[-159.676817,55.654722],[-159.643955,55.829984],[-159.813741,55.857368],[-160.027341,55.791645],[-160.060203,55.720445],[-160.394296,55.605429],[-160.536697,55.473983],[-160.580512,55.567091],[-160.668143,55.457552],[-160.865313,55.528752],[-161.232268,55.358967],[-161.506115,55.364444],[-161.467776,55.49589],[-161.588269,55.62186],[-161.697808,55.517798],[-161.686854,55.408259],[-162.053809,55.074166],[-162.179779,55.15632],[-162.218117,55.03035],[-162.470057,55.052258],[-162.508395,55.249428],[-162.661749,55.293244],[-162.716519,55.222043],[-162.579595,55.134412],[-162.645319,54.997489],[-162.847965,54.926289],[-163.00132,55.079643],[-163.187536,55.090597],[-163.220397,55.03035],[-163.034181,54.942719],[-163.373752,54.800319],[-163.14372,54.76198],[-163.138243,54.696257],[-163.329936,54.74555],[-163.587352,54.614103],[-164.085754,54.61958],[-164.332216,54.531949],[-164.354124,54.466226],[-164.638925,54.389548],[-164.847049,54.416933],[-164.918249,54.603149],[-164.710125,54.663395],[-164.551294,54.88795],[-164.34317,54.893427],[-163.894061,55.041304],[-163.532583,55.046781],[-163.39566,54.904381],[-163.291598,55.008443],[-163.313505,55.128935],[-163.105382,55.183705],[-162.880827,55.183705],[-162.579595,55.446598],[-162.245502,55.682106],[-161.807347,55.89023],[-161.292514,55.983338],[-161.078914,55.939523],[-160.87079,55.999769],[-160.816021,55.912138],[-160.931036,55.813553],[-160.805067,55.736876],[-160.766728,55.857368],[-160.509312,55.868322],[-160.438112,55.791645],[-160.27928,55.76426],[-160.273803,55.857368],[-160.536697,55.939523],[-160.558604,55.994292],[-160.383342,56.251708],[-160.147834,56.399586],[-159.830171,56.541986],[-159.326293,56.667956],[-158.959338,56.848695],[-158.784076,56.782971],[-158.641675,56.810356],[-158.701922,56.925372],[-158.658106,57.034911],[-158.378782,57.264942],[-157.995396,57.41282],[-157.688688,57.609989],[-157.705118,57.719528],[-157.458656,58.497254],[-157.07527,58.705377],[-157.119086,58.869686],[-158.039212,58.634177],[-158.32949,58.661562],[-158.40069,58.760147],[-158.564998,58.803962],[-158.619768,58.913501],[-158.767645,58.864209],[-158.860753,58.694424],[-158.701922,58.480823],[-158.893615,58.387715],[-159.0634,58.420577],[-159.392016,58.760147],[-159.616571,58.929932],[-159.731586,58.929932],[-159.808264,58.803962],[-159.906848,58.782055],[-160.054726,58.886116],[-160.235465,58.902547],[-160.317619,59.072332],[-160.854359,58.88064],[-161.33633,58.743716],[-161.374669,58.667039],[-161.752577,58.552023],[-161.938793,58.656085],[-161.769008,58.776578],[-161.829255,59.061379],[-161.955224,59.36261],[-161.703285,59.48858],[-161.911409,59.740519],[-162.092148,59.88292],[-162.234548,60.091043],[-162.448149,60.178674],[-162.502918,59.997935],[-162.760334,59.959597],[-163.171105,59.844581],[-163.66403,59.795289],[-163.9324,59.806242],[-164.162431,59.866489],[-164.189816,60.02532],[-164.386986,60.074613],[-164.699171,60.29369],[-164.962064,60.337506],[-165.268773,60.578491],[-165.060649,60.68803],[-165.016834,60.890677],[-165.175665,60.846861],[-165.197573,60.972831],[-165.120896,61.076893],[-165.323543,61.170001],[-165.34545,61.071416],[-165.591913,61.109754],[-165.624774,61.279539],[-165.816467,61.301447],[-165.920529,61.416463],[-165.915052,61.558863],[-166.106745,61.49314],[-166.139607,61.630064],[-165.904098,61.662925],[-166.095791,61.81628],[-165.756221,61.827233],[-165.756221,62.013449],[-165.674067,62.139419],[-165.044219,62.539236],[-164.912772,62.659728],[-164.819664,62.637821],[-164.874433,62.807606],[-164.633448,63.097884],[-164.425324,63.212899],[-164.036462,63.262192],[-163.73523,63.212899],[-163.313505,63.037637],[-163.039658,63.059545],[-162.661749,63.22933],[-162.272887,63.486746],[-162.075717,63.514131],[-162.026424,63.448408],[-161.555408,63.448408],[-161.13916,63.503177],[-160.766728,63.771547],[-160.766728,63.837271],[-160.952944,64.08921],[-160.974852,64.237087],[-161.26513,64.395918],[-161.374669,64.532842],[-161.078914,64.494503],[-160.79959,64.609519],[-160.783159,64.719058],[-161.144637,64.921705],[-161.413007,64.762873],[-161.664946,64.790258],[-161.900455,64.702627],[-162.168825,64.680719],[-162.234548,64.620473],[-162.541257,64.532842],[-162.634365,64.384965],[-162.787719,64.324718],[-162.858919,64.49998],[-163.045135,64.538319],[-163.176582,64.401395],[-163.253259,64.467119],[-163.598306,64.565704],[-164.304832,64.560227],[-164.80871,64.450688],[-165.000403,64.434257],[-165.411174,64.49998],[-166.188899,64.576658],[-166.391546,64.636904],[-166.484654,64.735489],[-166.413454,64.872412],[-166.692778,64.987428],[-166.638008,65.113398],[-166.462746,65.179121],[-166.517516,65.337952],[-166.796839,65.337952],[-167.026871,65.381768],[-167.47598,65.414629],[-167.711489,65.496784],[-168.072967,65.578938],[-168.105828,65.682999],[-167.541703,65.819923],[-166.829701,66.049954],[-166.3313,66.186878],[-166.046499,66.110201],[-165.756221,66.09377],[-165.690498,66.203309],[-165.86576,66.21974],[-165.88219,66.312848],[-165.186619,66.466202],[-164.403417,66.581218],[-163.981692,66.592172],[-163.751661,66.553833],[-163.872153,66.389525],[-163.828338,66.274509],[-163.915969,66.192355],[-163.768091,66.060908],[-163.494244,66.082816],[-163.149197,66.060908],[-162.749381,66.088293],[-162.634365,66.039001],[-162.371472,66.028047],[-162.14144,66.077339],[-161.840208,66.02257],[-161.549931,66.241647],[-161.341807,66.252601],[-161.199406,66.208786],[-161.128206,66.334755],[-161.528023,66.395002],[-161.911409,66.345709],[-161.87307,66.510017],[-162.174302,66.68528],[-162.502918,66.740049],[-162.601503,66.89888],[-162.344087,66.937219],[-162.015471,66.778388],[-162.075717,66.652418],[-161.916886,66.553833],[-161.571838,66.438817],[-161.489684,66.55931],[-161.884024,66.718141],[-161.714239,67.002942],[-161.851162,67.052235],[-162.240025,66.991988],[-162.639842,67.008419],[-162.700088,67.057712],[-162.902735,67.008419],[-163.740707,67.128912],[-163.757138,67.254881],[-164.009077,67.534205],[-164.211724,67.638267],[-164.534863,67.725898],[-165.192096,67.966884],[-165.493328,68.059992],[-165.794559,68.081899],[-166.243668,68.246208],[-166.681824,68.339316],[-166.703731,68.372177],[-166.375115,68.42147],[-166.227238,68.574824],[-166.216284,68.881533],[-165.329019,68.859625],[-164.255539,68.930825],[-163.976215,68.985595],[-163.532583,69.138949],[-163.110859,69.374457],[-163.023228,69.609966],[-162.842489,69.812613],[-162.470057,69.982398],[-162.311225,70.108367],[-161.851162,70.311014],[-161.779962,70.256245],[-161.396576,70.239814],[-160.837928,70.343876],[-160.487404,70.453415],[-159.649432,70.792985],[-159.33177,70.809416],[-159.298908,70.760123],[-158.975769,70.798462],[-158.658106,70.787508],[-158.033735,70.831323],[-157.420318,70.979201],[-156.812377,71.285909],[-156.565915,71.351633],[-156.522099,71.296863],[-155.585543,71.170894],[-155.508865,71.083263],[-155.832005,70.968247],[-155.979882,70.96277],[-155.974405,70.809416],[-155.503388,70.858708],[-155.476004,70.940862],[-155.262403,71.017539],[-155.191203,70.973724],[-155.032372,71.148986],[-154.566832,70.990155],[-154.643509,70.869662],[-154.353231,70.8368],[-154.183446,70.7656],[-153.931507,70.880616],[-153.487874,70.886093],[-153.235935,70.924431],[-152.589656,70.886093],[-152.26104,70.842277],[-152.419871,70.606769],[-151.817408,70.546523],[-151.773592,70.486276],[-151.187559,70.382214],[-151.182082,70.431507],[-150.760358,70.49723],[-150.355064,70.491753],[-150.349588,70.436984],[-150.114079,70.431507],[-149.867617,70.508184],[-149.462323,70.519138],[-149.177522,70.486276],[-148.78866,70.404122],[-148.607921,70.420553],[-148.350504,70.305537],[-148.202627,70.349353],[-147.961642,70.316491],[-147.786379,70.245291]]],[[[-152.94018,58.026237],[-152.945657,57.982421],[-153.290705,58.048145],[-153.044242,58.305561],[-152.819688,58.327469],[-152.666333,58.562977],[-152.496548,58.354853],[-152.354148,58.426053],[-152.080301,58.311038],[-152.080301,58.152206],[-152.480117,58.130299],[-152.655379,58.059098],[-152.94018,58.026237]]],[[[-153.958891,57.538789],[-153.67409,57.670236],[-153.931507,57.69762],[-153.936983,57.812636],[-153.723383,57.889313],[-153.570028,57.834544],[-153.548121,57.719528],[-153.46049,57.796205],[-153.455013,57.96599],[-153.268797,57.889313],[-153.235935,57.998852],[-153.071627,57.933129],[-152.874457,57.933129],[-152.721103,57.993375],[-152.469163,57.889313],[-152.469163,57.599035],[-152.151501,57.620943],[-152.359625,57.42925],[-152.74301,57.505928],[-152.60061,57.379958],[-152.710149,57.275896],[-152.907319,57.325188],[-152.912796,57.128019],[-153.214027,57.073249],[-153.312612,56.991095],[-153.498828,57.067772],[-153.695998,56.859649],[-153.849352,56.837741],[-154.013661,56.744633],[-154.073907,56.969187],[-154.303938,56.848695],[-154.314892,56.919895],[-154.523016,56.991095],[-154.539447,57.193742],[-154.742094,57.275896],[-154.627078,57.511404],[-154.227261,57.659282],[-153.980799,57.648328],[-153.958891,57.538789]]],[[[-154.53397,56.602232],[-154.742094,56.399586],[-154.807817,56.432447],[-154.53397,56.602232]]],[[[-155.634835,55.923092],[-155.476004,55.912138],[-155.530773,55.704014],[-155.793666,55.731399],[-155.837482,55.802599],[-155.634835,55.923092]]],[[[-159.890418,55.28229],[-159.950664,55.068689],[-160.257373,54.893427],[-160.109495,55.161797],[-160.005433,55.134412],[-159.890418,55.28229]]],[[[-160.520266,55.358967],[-160.33405,55.358967],[-160.339527,55.249428],[-160.525743,55.128935],[-160.690051,55.211089],[-160.794113,55.134412],[-160.854359,55.320628],[-160.79959,55.380875],[-160.520266,55.358967]]],[[[-162.256456,54.981058],[-162.234548,54.893427],[-162.349564,54.838658],[-162.437195,54.931766],[-162.256456,54.981058]]],[[[-162.415287,63.634624],[-162.563165,63.536039],[-162.612457,63.62367],[-162.415287,63.634624]]],[[[-162.80415,54.488133],[-162.590549,54.449795],[-162.612457,54.367641],[-162.782242,54.373118],[-162.80415,54.488133]]],[[[-165.548097,54.29644],[-165.476897,54.181425],[-165.630251,54.132132],[-165.685021,54.252625],[-165.548097,54.29644]]],[[[-165.73979,54.15404],[-166.046499,54.044501],[-166.112222,54.121178],[-165.980775,54.219763],[-165.73979,54.15404]]],[[[-166.364161,60.359413],[-166.13413,60.397752],[-166.084837,60.326552],[-165.88219,60.342983],[-165.685021,60.277259],[-165.646682,59.992458],[-165.750744,59.89935],[-166.00816,59.844581],[-166.062929,59.745996],[-166.440838,59.855535],[-166.6161,59.850058],[-166.994009,59.992458],[-167.125456,59.992458],[-167.344534,60.074613],[-167.421211,60.206059],[-167.311672,60.238921],[-166.93924,60.206059],[-166.763978,60.310121],[-166.577762,60.321075],[-166.495608,60.392275],[-166.364161,60.359413]]],[[[-166.375115,54.01164],[-166.210807,53.934962],[-166.5449,53.748746],[-166.539423,53.715885],[-166.117699,53.852808],[-166.112222,53.776131],[-166.282007,53.683023],[-166.555854,53.622777],[-166.583239,53.529669],[-166.878994,53.431084],[-167.13641,53.425607],[-167.306195,53.332499],[-167.623857,53.250345],[-167.793643,53.337976],[-167.459549,53.442038],[-167.355487,53.425607],[-167.103548,53.513238],[-167.163794,53.611823],[-167.021394,53.715885],[-166.807793,53.666592],[-166.785886,53.732316],[-167.015917,53.754223],[-167.141887,53.825424],[-167.032348,53.945916],[-166.643485,54.017116],[-166.561331,53.880193],[-166.375115,54.01164]]],[[[-168.790446,53.157237],[-168.40706,53.34893],[-168.385152,53.431084],[-168.237275,53.524192],[-168.007243,53.568007],[-167.886751,53.518715],[-167.842935,53.387268],[-168.270136,53.244868],[-168.500168,53.036744],[-168.686384,52.965544],[-168.790446,53.157237]]],[[[-169.74891,52.894344],[-169.705095,52.795759],[-169.962511,52.790282],[-169.989896,52.856005],[-169.74891,52.894344]]],[[[-170.148727,57.221127],[-170.28565,57.128019],[-170.313035,57.221127],[-170.148727,57.221127]]],[[[-170.669036,52.697174],[-170.603313,52.604066],[-170.789529,52.538343],[-170.816914,52.636928],[-170.669036,52.697174]]],[[[-171.742517,63.716778],[-170.94836,63.5689],[-170.488297,63.69487],[-170.280174,63.683916],[-170.093958,63.612716],[-170.044665,63.492223],[-169.644848,63.4265],[-169.518879,63.366254],[-168.99857,63.338869],[-168.686384,63.295053],[-168.856169,63.147176],[-169.108108,63.180038],[-169.376478,63.152653],[-169.513402,63.08693],[-169.639372,62.939052],[-169.831064,63.075976],[-170.055619,63.169084],[-170.263743,63.180038],[-170.362328,63.2841],[-170.866206,63.415546],[-171.101715,63.421023],[-171.463193,63.306007],[-171.73704,63.366254],[-171.852055,63.486746],[-171.742517,63.716778]]],[[[-172.432611,52.390465],[-172.41618,52.275449],[-172.607873,52.253542],[-172.569535,52.352127],[-172.432611,52.390465]]],[[[-173.626584,52.14948],[-173.495138,52.105664],[-173.122706,52.111141],[-173.106275,52.07828],[-173.549907,52.028987],[-173.626584,52.14948]]],[[[-174.322156,52.280926],[-174.327632,52.379511],[-174.185232,52.41785],[-173.982585,52.319265],[-174.059262,52.226157],[-174.179755,52.231634],[-174.141417,52.127572],[-174.333109,52.116618],[-174.738403,52.007079],[-174.968435,52.039941],[-174.902711,52.116618],[-174.656249,52.105664],[-174.322156,52.280926]]],[[[-176.469116,51.853725],[-176.288377,51.870156],[-176.288377,51.744186],[-176.518409,51.760617],[-176.80321,51.61274],[-176.912748,51.80991],[-176.792256,51.815386],[-176.775825,51.963264],[-176.627947,51.968741],[-176.627947,51.859202],[-176.469116,51.853725]]],[[[-177.153734,51.946833],[-177.044195,51.897541],[-177.120872,51.727755],[-177.274226,51.678463],[-177.279703,51.782525],[-177.153734,51.946833]]],[[[-178.123152,51.919448],[-177.953367,51.913971],[-177.800013,51.793479],[-177.964321,51.651078],[-178.123152,51.919448]]],[[[-186.892443, 52.992929],[-186.706227, 52.927205],[-186.695274, 52.823143],[-187.09509, 52.762897],[-187.357983, 52.927205],[-187.357983, 53.003883],[-186.892443, 52.992929]]]]}}, + {"type":"Feature","id":"04","properties":{"name":"Arizona"},"geometry":{"type":"Polygon","coordinates":[[[-109.042503,37.000263],[-109.04798,31.331629],[-111.074448,31.331629],[-112.246513,31.704061],[-114.815198,32.492741],[-114.72209,32.717295],[-114.524921,32.755634],[-114.470151,32.843265],[-114.524921,33.029481],[-114.661844,33.034958],[-114.727567,33.40739],[-114.524921,33.54979],[-114.497536,33.697668],[-114.535874,33.933176],[-114.415382,34.108438],[-114.256551,34.174162],[-114.136058,34.305608],[-114.333228,34.448009],[-114.470151,34.710902],[-114.634459,34.87521],[-114.634459,35.00118],[-114.574213,35.138103],[-114.596121,35.324319],[-114.678275,35.516012],[-114.738521,36.102045],[-114.371566,36.140383],[-114.251074,36.01989],[-114.152489,36.025367],[-114.048427,36.195153],[-114.048427,37.000263],[-110.499369,37.00574],[-109.042503,37.000263]]]}}, + {"type":"Feature","id":"05","properties":{"name":"Arkansas"},"geometry":{"type":"Polygon","coordinates":[[[-94.473842,36.501861],[-90.152536,36.496384],[-90.064905,36.304691],[-90.218259,36.184199],[-90.377091,35.997983],[-89.730812,35.997983],[-89.763673,35.811767],[-89.911551,35.756997],[-89.944412,35.603643],[-90.130628,35.439335],[-90.114197,35.198349],[-90.212782,35.023087],[-90.311367,34.995703],[-90.251121,34.908072],[-90.409952,34.831394],[-90.481152,34.661609],[-90.585214,34.617794],[-90.568783,34.420624],[-90.749522,34.365854],[-90.744046,34.300131],[-90.952169,34.135823],[-90.891923,34.026284],[-91.072662,33.867453],[-91.231493,33.560744],[-91.056231,33.429298],[-91.143862,33.347144],[-91.089093,33.13902],[-91.16577,33.002096],[-93.608485,33.018527],[-94.041164,33.018527],[-94.041164,33.54979],[-94.183564,33.593606],[-94.380734,33.544313],[-94.484796,33.637421],[-94.430026,35.395519],[-94.616242,36.501861],[-94.473842,36.501861]]]}}, + {"type":"Feature","id":"06","properties":{"name":"California"},"geometry":{"type":"Polygon","coordinates":[[[-123.233256,42.006186],[-122.378853,42.011663],[-121.037003,41.995232],[-120.001861,41.995232],[-119.996384,40.264519],[-120.001861,38.999346],[-118.71478,38.101128],[-117.498899,37.21934],[-116.540435,36.501861],[-115.85034,35.970598],[-114.634459,35.00118],[-114.634459,34.87521],[-114.470151,34.710902],[-114.333228,34.448009],[-114.136058,34.305608],[-114.256551,34.174162],[-114.415382,34.108438],[-114.535874,33.933176],[-114.497536,33.697668],[-114.524921,33.54979],[-114.727567,33.40739],[-114.661844,33.034958],[-114.524921,33.029481],[-114.470151,32.843265],[-114.524921,32.755634],[-114.72209,32.717295],[-116.04751,32.624187],[-117.126467,32.536556],[-117.24696,32.668003],[-117.252437,32.876127],[-117.329114,33.122589],[-117.471515,33.297851],[-117.7837,33.538836],[-118.183517,33.763391],[-118.260194,33.703145],[-118.413548,33.741483],[-118.391641,33.840068],[-118.566903,34.042715],[-118.802411,33.998899],[-119.218659,34.146777],[-119.278905,34.26727],[-119.558229,34.415147],[-119.875891,34.40967],[-120.138784,34.475393],[-120.472878,34.448009],[-120.64814,34.579455],[-120.609801,34.858779],[-120.670048,34.902595],[-120.631709,35.099764],[-120.894602,35.247642],[-120.905556,35.450289],[-121.004141,35.461243],[-121.168449,35.636505],[-121.283465,35.674843],[-121.332757,35.784382],[-121.716143,36.195153],[-121.896882,36.315645],[-121.935221,36.638785],[-121.858544,36.6114],[-121.787344,36.803093],[-121.929744,36.978355],[-122.105006,36.956447],[-122.335038,37.115279],[-122.417192,37.241248],[-122.400761,37.361741],[-122.515777,37.520572],[-122.515777,37.783465],[-122.329561,37.783465],[-122.406238,38.15042],[-122.488392,38.112082],[-122.504823,37.931343],[-122.701993,37.893004],[-122.937501,38.029928],[-122.97584,38.265436],[-123.129194,38.451652],[-123.331841,38.566668],[-123.44138,38.698114],[-123.737134,38.95553],[-123.687842,39.032208],[-123.824765,39.366301],[-123.764519,39.552517],[-123.85215,39.831841],[-124.109566,40.105688],[-124.361506,40.259042],[-124.410798,40.439781],[-124.158859,40.877937],[-124.109566,41.025814],[-124.158859,41.14083],[-124.065751,41.442061],[-124.147905,41.715908],[-124.257444,41.781632],[-124.213628,42.000709],[-123.233256,42.006186]]]}}, + {"type":"Feature","id":"08","properties":{"name":"Colorado"},"geometry":{"type":"Polygon","coordinates":[[[-107.919731,41.003906],[-105.728954,40.998429],[-104.053011,41.003906],[-102.053927,41.003906],[-102.053927,40.001626],[-102.042974,36.994786],[-103.001438,37.000263],[-104.337812,36.994786],[-106.868158,36.994786],[-107.421329,37.000263],[-109.042503,37.000263],[-109.042503,38.166851],[-109.058934,38.27639],[-109.053457,39.125316],[-109.04798,40.998429],[-107.919731,41.003906]]]}}, + {"type":"Feature","id":"09","properties":{"name":"Connecticut"},"geometry":{"type":"Polygon","coordinates":[[[-73.053528,42.039048],[-71.799309,42.022617],[-71.799309,42.006186],[-71.799309,41.414677],[-71.859555,41.321569],[-71.947186,41.338],[-72.385341,41.261322],[-72.905651,41.28323],[-73.130205,41.146307],[-73.371191,41.102491],[-73.655992,40.987475],[-73.727192,41.102491],[-73.48073,41.21203],[-73.55193,41.294184],[-73.486206,42.050002],[-73.053528,42.039048]]]}}, + {"type":"Feature","id":"10","properties":{"name":"Delaware"},"geometry":{"type":"Polygon","coordinates":[[[-75.414089,39.804456],[-75.507197,39.683964],[-75.611259,39.61824],[-75.589352,39.459409],[-75.441474,39.311532],[-75.403136,39.065069],[-75.189535,38.807653],[-75.09095,38.796699],[-75.047134,38.451652],[-75.693413,38.462606],[-75.786521,39.722302],[-75.616736,39.831841],[-75.414089,39.804456]]]}}, + {"type":"Feature","id":"11","properties":{"name":"District of Columbia"},"geometry":{"type":"Polygon","coordinates":[[[-77.035264,38.993869],[-76.909294,38.895284],[-77.040741,38.791222],[-77.117418,38.933623],[-77.035264,38.993869]]]}}, + {"type":"Feature","id":"12","properties":{"name":"Florida"},"geometry":{"type":"Polygon","coordinates":[[[-85.497137,30.997536],[-85.004212,31.003013],[-84.867289,30.712735],[-83.498053,30.647012],[-82.216449,30.570335],[-82.167157,30.356734],[-82.046664,30.362211],[-82.002849,30.564858],[-82.041187,30.751074],[-81.948079,30.827751],[-81.718048,30.745597],[-81.444201,30.707258],[-81.383954,30.27458],[-81.257985,29.787132],[-80.967707,29.14633],[-80.524075,28.461713],[-80.589798,28.41242],[-80.56789,28.094758],[-80.381674,27.738757],[-80.091397,27.021277],[-80.03115,26.796723],[-80.036627,26.566691],[-80.146166,25.739673],[-80.239274,25.723243],[-80.337859,25.465826],[-80.304997,25.383672],[-80.49669,25.197456],[-80.573367,25.241272],[-80.759583,25.164595],[-81.077246,25.120779],[-81.170354,25.224841],[-81.126538,25.378195],[-81.351093,25.821827],[-81.526355,25.903982],[-81.679709,25.843735],[-81.800202,26.090198],[-81.833064,26.292844],[-82.041187,26.517399],[-82.09048,26.665276],[-82.057618,26.878877],[-82.172634,26.917216],[-82.145249,26.791246],[-82.249311,26.758384],[-82.566974,27.300601],[-82.692943,27.437525],[-82.391711,27.837342],[-82.588881,27.815434],[-82.720328,27.689464],[-82.851774,27.886634],[-82.676512,28.434328],[-82.643651,28.888914],[-82.764143,28.998453],[-82.802482,29.14633],[-82.994175,29.179192],[-83.218729,29.420177],[-83.399469,29.518762],[-83.410422,29.66664],[-83.536392,29.721409],[-83.640454,29.885717],[-84.02384,30.104795],[-84.357933,30.055502],[-84.341502,29.902148],[-84.451041,29.929533],[-84.867289,29.743317],[-85.310921,29.699501],[-85.299967,29.80904],[-85.404029,29.940487],[-85.924338,30.236241],[-86.29677,30.362211],[-86.630863,30.395073],[-86.910187,30.373165],[-87.518128,30.280057],[-87.37025,30.427934],[-87.446927,30.510088],[-87.408589,30.674397],[-87.633143,30.86609],[-87.600282,30.997536],[-85.497137,30.997536]]]}}, + {"type":"Feature","id":"13","properties":{"name":"Georgia"},"geometry":{"type":"Polygon","coordinates":[[[-83.109191,35.00118],[-83.322791,34.787579],[-83.339222,34.683517],[-83.005129,34.469916],[-82.901067,34.486347],[-82.747713,34.26727],[-82.714851,34.152254],[-82.55602,33.94413],[-82.325988,33.81816],[-82.194542,33.631944],[-81.926172,33.462159],[-81.937125,33.347144],[-81.761863,33.160928],[-81.493493,33.007573],[-81.42777,32.843265],[-81.416816,32.629664],[-81.279893,32.558464],[-81.121061,32.290094],[-81.115584,32.120309],[-80.885553,32.032678],[-81.132015,31.693108],[-81.175831,31.517845],[-81.279893,31.364491],[-81.290846,31.20566],[-81.400385,31.13446],[-81.444201,30.707258],[-81.718048,30.745597],[-81.948079,30.827751],[-82.041187,30.751074],[-82.002849,30.564858],[-82.046664,30.362211],[-82.167157,30.356734],[-82.216449,30.570335],[-83.498053,30.647012],[-84.867289,30.712735],[-85.004212,31.003013],[-85.113751,31.27686],[-85.042551,31.539753],[-85.141136,31.840985],[-85.053504,32.01077],[-85.058981,32.13674],[-84.889196,32.262709],[-85.004212,32.322956],[-84.960397,32.421541],[-85.069935,32.580372],[-85.184951,32.859696],[-85.431413,34.124869],[-85.606675,34.984749],[-84.319594,34.990226],[-83.618546,34.984749],[-83.109191,35.00118]]]}}, + {"type":"Feature","id":"15","properties":{"name":"Hawaii"},"geometry":{"type":"MultiPolygon","coordinates":[[[[-155.634835,18.948267],[-155.881297,19.035898],[-155.919636,19.123529],[-155.886774,19.348084],[-156.062036,19.73147],[-155.925113,19.857439],[-155.826528,20.032702],[-155.897728,20.147717],[-155.87582,20.26821],[-155.596496,20.12581],[-155.284311,20.021748],[-155.092618,19.868393],[-155.092618,19.736947],[-154.807817,19.523346],[-154.983079,19.348084],[-155.295265,19.26593],[-155.514342,19.134483],[-155.634835,18.948267]]],[[[-156.587823,21.029505],[-156.472807,20.892581],[-156.324929,20.952827],[-156.00179,20.793996],[-156.051082,20.651596],[-156.379699,20.580396],[-156.445422,20.60778],[-156.461853,20.783042],[-156.631638,20.821381],[-156.697361,20.919966],[-156.587823,21.029505]]],[[[-156.982162,21.210244],[-157.080747,21.106182],[-157.310779,21.106182],[-157.239579,21.221198],[-156.982162,21.210244]]],[[[-157.951581,21.697691],[-157.842042,21.462183],[-157.896811,21.325259],[-158.110412,21.303352],[-158.252813,21.582676],[-158.126843,21.588153],[-157.951581,21.697691]]],[[[-159.468693,22.228955],[-159.353678,22.218001],[-159.298908,22.113939],[-159.33177,21.966061],[-159.446786,21.872953],[-159.764448,21.987969],[-159.726109,22.152277],[-159.468693,22.228955]]]]}}, + {"type":"Feature","id":"16","properties":{"name":"Idaho"},"geometry":{"type":"Polygon","coordinates":[[[-116.04751,49.000239],[-116.04751,47.976051],[-115.724371,47.696727],[-115.718894,47.42288],[-115.527201,47.302388],[-115.324554,47.258572],[-115.302646,47.187372],[-114.930214,46.919002],[-114.886399,46.809463],[-114.623506,46.705401],[-114.612552,46.639678],[-114.322274,46.645155],[-114.464674,46.272723],[-114.492059,46.037214],[-114.387997,45.88386],[-114.568736,45.774321],[-114.497536,45.670259],[-114.546828,45.560721],[-114.333228,45.456659],[-114.086765,45.593582],[-113.98818,45.703121],[-113.807441,45.604536],[-113.834826,45.522382],[-113.736241,45.330689],[-113.571933,45.128042],[-113.45144,45.056842],[-113.456917,44.865149],[-113.341901,44.782995],[-113.133778,44.772041],[-113.002331,44.448902],[-112.887315,44.394132],[-112.783254,44.48724],[-112.471068,44.481763],[-112.241036,44.569394],[-112.104113,44.520102],[-111.868605,44.563917],[-111.819312,44.509148],[-111.616665,44.547487],[-111.386634,44.75561],[-111.227803,44.580348],[-111.047063,44.476286],[-111.047063,42.000709],[-112.164359,41.995232],[-114.04295,41.995232],[-117.027882,42.000709],[-117.027882,43.830007],[-116.896436,44.158624],[-116.97859,44.240778],[-117.170283,44.257209],[-117.241483,44.394132],[-117.038836,44.750133],[-116.934774,44.782995],[-116.830713,44.930872],[-116.847143,45.02398],[-116.732128,45.144473],[-116.671881,45.319735],[-116.463758,45.61549],[-116.545912,45.752413],[-116.78142,45.823614],[-116.918344,45.993399],[-116.92382,46.168661],[-117.055267,46.343923],[-117.038836,46.426077],[-117.044313,47.762451],[-117.033359,49.000239],[-116.04751,49.000239]]]}}, + {"type":"Feature","id":"17","properties":{"name":"Illinois"},"geometry":{"type":"Polygon","coordinates":[[[-90.639984,42.510065],[-88.788778,42.493634],[-87.802929,42.493634],[-87.83579,42.301941],[-87.682436,42.077386],[-87.523605,41.710431],[-87.529082,39.34987],[-87.63862,39.169131],[-87.512651,38.95553],[-87.49622,38.780268],[-87.62219,38.637868],[-87.655051,38.506421],[-87.83579,38.292821],[-87.950806,38.27639],[-87.923421,38.15042],[-88.000098,38.101128],[-88.060345,37.865619],[-88.027483,37.799896],[-88.15893,37.657496],[-88.065822,37.482234],[-88.476592,37.389126],[-88.514931,37.285064],[-88.421823,37.153617],[-88.547792,37.071463],[-88.914747,37.224817],[-89.029763,37.213863],[-89.183118,37.038601],[-89.133825,36.983832],[-89.292656,36.994786],[-89.517211,37.279587],[-89.435057,37.34531],[-89.517211,37.537003],[-89.517211,37.690357],[-89.84035,37.903958],[-89.949889,37.88205],[-90.059428,38.013497],[-90.355183,38.216144],[-90.349706,38.374975],[-90.179921,38.632391],[-90.207305,38.725499],[-90.10872,38.845992],[-90.251121,38.917192],[-90.470199,38.961007],[-90.585214,38.867899],[-90.661891,38.928146],[-90.727615,39.256762],[-91.061708,39.470363],[-91.368417,39.727779],[-91.494386,40.034488],[-91.50534,40.237135],[-91.417709,40.379535],[-91.401278,40.560274],[-91.121954,40.669813],[-91.09457,40.823167],[-90.963123,40.921752],[-90.946692,41.097014],[-91.111001,41.239415],[-91.045277,41.414677],[-90.656414,41.463969],[-90.344229,41.589939],[-90.311367,41.743293],[-90.179921,41.809016],[-90.141582,42.000709],[-90.168967,42.126679],[-90.393521,42.225264],[-90.420906,42.329326],[-90.639984,42.510065]]]}}, + {"type":"Feature","id":"18","properties":{"name":"Indiana"},"geometry":{"type":"Polygon","coordinates":[[[-85.990061,41.759724],[-84.807042,41.759724],[-84.807042,41.694001],[-84.801565,40.500028],[-84.817996,39.103408],[-84.894673,39.059592],[-84.812519,38.785745],[-84.987781,38.780268],[-85.173997,38.68716],[-85.431413,38.730976],[-85.42046,38.533806],[-85.590245,38.451652],[-85.655968,38.325682],[-85.83123,38.27639],[-85.924338,38.024451],[-86.039354,37.958727],[-86.263908,38.051835],[-86.302247,38.166851],[-86.521325,38.040881],[-86.504894,37.931343],[-86.729448,37.893004],[-86.795172,37.991589],[-87.047111,37.893004],[-87.129265,37.788942],[-87.381204,37.93682],[-87.512651,37.903958],[-87.600282,37.975158],[-87.682436,37.903958],[-87.934375,37.893004],[-88.027483,37.799896],[-88.060345,37.865619],[-88.000098,38.101128],[-87.923421,38.15042],[-87.950806,38.27639],[-87.83579,38.292821],[-87.655051,38.506421],[-87.62219,38.637868],[-87.49622,38.780268],[-87.512651,38.95553],[-87.63862,39.169131],[-87.529082,39.34987],[-87.523605,41.710431],[-87.42502,41.644708],[-87.118311,41.644708],[-86.822556,41.759724],[-85.990061,41.759724]]]}}, + {"type":"Feature","id":"19","properties":{"name":"Iowa"},"geometry":{"type":"Polygon","coordinates":[[[-91.368417,43.501391],[-91.215062,43.501391],[-91.204109,43.353514],[-91.056231,43.254929],[-91.176724,43.134436],[-91.143862,42.909881],[-91.067185,42.75105],[-90.711184,42.636034],[-90.639984,42.510065],[-90.420906,42.329326],[-90.393521,42.225264],[-90.168967,42.126679],[-90.141582,42.000709],[-90.179921,41.809016],[-90.311367,41.743293],[-90.344229,41.589939],[-90.656414,41.463969],[-91.045277,41.414677],[-91.111001,41.239415],[-90.946692,41.097014],[-90.963123,40.921752],[-91.09457,40.823167],[-91.121954,40.669813],[-91.401278,40.560274],[-91.417709,40.379535],[-91.527248,40.412397],[-91.729895,40.615043],[-91.833957,40.609566],[-93.257961,40.582182],[-94.632673,40.571228],[-95.7664,40.587659],[-95.881416,40.719105],[-95.826646,40.976521],[-95.925231,41.201076],[-95.919754,41.453015],[-96.095016,41.540646],[-96.122401,41.67757],[-96.062155,41.798063],[-96.127878,41.973325],[-96.264801,42.039048],[-96.44554,42.488157],[-96.631756,42.707235],[-96.544125,42.855112],[-96.511264,43.052282],[-96.434587,43.123482],[-96.560556,43.222067],[-96.527695,43.397329],[-96.582464,43.479483],[-96.451017,43.501391],[-91.368417,43.501391]]]}}, + {"type":"Feature","id":"20","properties":{"name":"Kansas"},"geometry":{"type":"Polygon","coordinates":[[[-101.90605,40.001626],[-95.306337,40.001626],[-95.207752,39.908518],[-94.884612,39.831841],[-95.109167,39.541563],[-94.983197,39.442978],[-94.824366,39.20747],[-94.610765,39.158177],[-94.616242,37.000263],[-100.087706,37.000263],[-102.042974,36.994786],[-102.053927,40.001626],[-101.90605,40.001626]]]}}, + {"type":"Feature","id":"21","properties":{"name":"Kentucky"},"geometry":{"type":"Polygon","coordinates":[[[-83.903347,38.769315],[-83.678792,38.632391],[-83.519961,38.703591],[-83.142052,38.626914],[-83.032514,38.725499],[-82.890113,38.758361],[-82.846298,38.588575],[-82.731282,38.561191],[-82.594358,38.424267],[-82.621743,38.123036],[-82.50125,37.931343],[-82.342419,37.783465],[-82.293127,37.668449],[-82.101434,37.553434],[-81.969987,37.537003],[-82.353373,37.268633],[-82.720328,37.120755],[-82.720328,37.044078],[-82.868205,36.978355],[-82.879159,36.890724],[-83.070852,36.852385],[-83.136575,36.742847],[-83.673316,36.600446],[-83.689746,36.584015],[-84.544149,36.594969],[-85.289013,36.627831],[-85.486183,36.616877],[-86.592525,36.655216],[-87.852221,36.633308],[-88.071299,36.677123],[-88.054868,36.496384],[-89.298133,36.507338],[-89.418626,36.496384],[-89.363857,36.622354],[-89.215979,36.578538],[-89.133825,36.983832],[-89.183118,37.038601],[-89.029763,37.213863],[-88.914747,37.224817],[-88.547792,37.071463],[-88.421823,37.153617],[-88.514931,37.285064],[-88.476592,37.389126],[-88.065822,37.482234],[-88.15893,37.657496],[-88.027483,37.799896],[-87.934375,37.893004],[-87.682436,37.903958],[-87.600282,37.975158],[-87.512651,37.903958],[-87.381204,37.93682],[-87.129265,37.788942],[-87.047111,37.893004],[-86.795172,37.991589],[-86.729448,37.893004],[-86.504894,37.931343],[-86.521325,38.040881],[-86.302247,38.166851],[-86.263908,38.051835],[-86.039354,37.958727],[-85.924338,38.024451],[-85.83123,38.27639],[-85.655968,38.325682],[-85.590245,38.451652],[-85.42046,38.533806],[-85.431413,38.730976],[-85.173997,38.68716],[-84.987781,38.780268],[-84.812519,38.785745],[-84.894673,39.059592],[-84.817996,39.103408],[-84.43461,39.103408],[-84.231963,38.895284],[-84.215533,38.807653],[-83.903347,38.769315]]]}}, + {"type":"Feature","id":"22","properties":{"name":"Louisiana"},"geometry":{"type":"Polygon","coordinates":[[[-93.608485,33.018527],[-91.16577,33.002096],[-91.072662,32.887081],[-91.143862,32.843265],[-91.154816,32.640618],[-91.006939,32.514649],[-90.985031,32.218894],[-91.105524,31.988862],[-91.341032,31.846462],[-91.401278,31.621907],[-91.499863,31.643815],[-91.516294,31.27686],[-91.636787,31.265906],[-91.565587,31.068736],[-91.636787,30.997536],[-89.747242,30.997536],[-89.845827,30.66892],[-89.681519,30.449842],[-89.643181,30.285534],[-89.522688,30.181472],[-89.818443,30.044549],[-89.84035,29.945964],[-89.599365,29.88024],[-89.495303,30.039072],[-89.287179,29.88024],[-89.30361,29.754271],[-89.424103,29.699501],[-89.648657,29.748794],[-89.621273,29.655686],[-89.69795,29.513285],[-89.506257,29.387316],[-89.199548,29.348977],[-89.09001,29.2011],[-89.002379,29.179192],[-89.16121,29.009407],[-89.336472,29.042268],[-89.484349,29.217531],[-89.851304,29.310638],[-89.851304,29.480424],[-90.032043,29.425654],[-90.021089,29.283254],[-90.103244,29.151807],[-90.23469,29.129899],[-90.333275,29.277777],[-90.563307,29.283254],[-90.645461,29.129899],[-90.798815,29.086084],[-90.963123,29.179192],[-91.09457,29.190146],[-91.220539,29.436608],[-91.445094,29.546147],[-91.532725,29.529716],[-91.620356,29.73784],[-91.883249,29.710455],[-91.888726,29.836425],[-92.146142,29.715932],[-92.113281,29.622824],[-92.31045,29.535193],[-92.617159,29.579009],[-92.97316,29.715932],[-93.2251,29.776178],[-93.767317,29.726886],[-93.838517,29.688547],[-93.926148,29.787132],[-93.690639,30.143133],[-93.767317,30.334826],[-93.696116,30.438888],[-93.728978,30.575812],[-93.630393,30.679874],[-93.526331,30.93729],[-93.542762,31.15089],[-93.816609,31.556184],[-93.822086,31.775262],[-94.041164,31.994339],[-94.041164,33.018527],[-93.608485,33.018527]]]}}, + {"type":"Feature","id":"23","properties":{"name":"Maine"},"geometry":{"type":"Polygon","coordinates":[[[-70.703921,43.057759],[-70.824413,43.128959],[-70.807983,43.227544],[-70.966814,43.34256],[-71.032537,44.657025],[-71.08183,45.303304],[-70.649151,45.440228],[-70.720352,45.511428],[-70.556043,45.664782],[-70.386258,45.735983],[-70.41912,45.796229],[-70.260289,45.889337],[-70.309581,46.064599],[-70.210996,46.327492],[-70.057642,46.415123],[-69.997395,46.694447],[-69.225147,47.461219],[-69.044408,47.428357],[-69.033454,47.242141],[-68.902007,47.176418],[-68.578868,47.285957],[-68.376221,47.285957],[-68.233821,47.357157],[-67.954497,47.198326],[-67.790188,47.066879],[-67.779235,45.944106],[-67.801142,45.675736],[-67.456095,45.604536],[-67.505388,45.48952],[-67.417757,45.379982],[-67.488957,45.281397],[-67.346556,45.128042],[-67.16034,45.160904],[-66.979601,44.804903],[-67.187725,44.646072],[-67.308218,44.706318],[-67.406803,44.596779],[-67.549203,44.624164],[-67.565634,44.531056],[-67.75185,44.54201],[-68.047605,44.328409],[-68.118805,44.476286],[-68.222867,44.48724],[-68.173574,44.328409],[-68.403606,44.251732],[-68.458375,44.377701],[-68.567914,44.311978],[-68.82533,44.311978],[-68.830807,44.459856],[-68.984161,44.426994],[-68.956777,44.322932],[-69.099177,44.103854],[-69.071793,44.043608],[-69.258008,43.923115],[-69.444224,43.966931],[-69.553763,43.840961],[-69.707118,43.82453],[-69.833087,43.720469],[-69.986442,43.742376],[-70.030257,43.851915],[-70.254812,43.676653],[-70.194565,43.567114],[-70.358873,43.528776],[-70.369827,43.435668],[-70.556043,43.320652],[-70.703921,43.057759]]]}}, + {"type":"Feature","id":"24","properties":{"name":"Maryland"},"geometry":{"type":"MultiPolygon","coordinates":[[[[-75.994645,37.95325],[-76.016553,37.95325],[-76.043938,37.95325],[-75.994645,37.95325]]],[[[-79.477979,39.722302],[-75.786521,39.722302],[-75.693413,38.462606],[-75.047134,38.451652],[-75.244304,38.029928],[-75.397659,38.013497],[-75.671506,37.95325],[-75.885106,37.909435],[-75.879629,38.073743],[-75.961783,38.139466],[-75.846768,38.210667],[-76.000122,38.374975],[-76.049415,38.303775],[-76.257538,38.320205],[-76.328738,38.500944],[-76.263015,38.500944],[-76.257538,38.736453],[-76.191815,38.829561],[-76.279446,39.147223],[-76.169907,39.333439],[-76.000122,39.366301],[-75.972737,39.557994],[-76.098707,39.536086],[-76.104184,39.437501],[-76.367077,39.311532],[-76.443754,39.196516],[-76.460185,38.906238],[-76.55877,38.769315],[-76.514954,38.539283],[-76.383508,38.380452],[-76.399939,38.259959],[-76.317785,38.139466],[-76.3616,38.057312],[-76.591632,38.216144],[-76.920248,38.292821],[-77.018833,38.446175],[-77.205049,38.358544],[-77.276249,38.479037],[-77.128372,38.632391],[-77.040741,38.791222],[-76.909294,38.895284],[-77.035264,38.993869],[-77.117418,38.933623],[-77.248864,39.026731],[-77.456988,39.076023],[-77.456988,39.223901],[-77.566527,39.306055],[-77.719881,39.322485],[-77.834897,39.601809],[-78.004682,39.601809],[-78.174467,39.694917],[-78.267575,39.61824],[-78.431884,39.623717],[-78.470222,39.514178],[-78.765977,39.585379],[-78.963147,39.437501],[-79.094593,39.470363],[-79.291763,39.300578],[-79.488933,39.20747],[-79.477979,39.722302]]]]}}, + {"type":"Feature","id":"25","properties":{"name":"Massachusetts"},"geometry":{"type":"Polygon","coordinates":[[[-70.917521,42.887974],[-70.818936,42.871543],[-70.780598,42.696281],[-70.824413,42.55388],[-70.983245,42.422434],[-70.988722,42.269079],[-70.769644,42.247172],[-70.638197,42.08834],[-70.660105,41.962371],[-70.550566,41.929509],[-70.539613,41.814493],[-70.260289,41.715908],[-69.937149,41.809016],[-70.008349,41.672093],[-70.484843,41.5516],[-70.660105,41.546123],[-70.764167,41.639231],[-70.928475,41.611847],[-70.933952,41.540646],[-71.120168,41.496831],[-71.196845,41.67757],[-71.22423,41.710431],[-71.328292,41.781632],[-71.383061,42.01714],[-71.530939,42.01714],[-71.799309,42.006186],[-71.799309,42.022617],[-73.053528,42.039048],[-73.486206,42.050002],[-73.508114,42.08834],[-73.267129,42.745573],[-72.456542,42.729142],[-71.29543,42.696281],[-71.185891,42.789389],[-70.917521,42.887974]]]}}, + {"type":"Feature","id":"26","properties":{"name":"Michigan"},"geometry":{"type":"MultiPolygon","coordinates":[[[[-83.454238,41.732339],[-84.807042,41.694001],[-84.807042,41.759724],[-85.990061,41.759724],[-86.822556,41.759724],[-86.619909,41.891171],[-86.482986,42.115725],[-86.357016,42.252649],[-86.263908,42.444341],[-86.209139,42.718189],[-86.231047,43.013943],[-86.526801,43.594499],[-86.433693,43.813577],[-86.499417,44.07647],[-86.269385,44.34484],[-86.220093,44.569394],[-86.252954,44.689887],[-86.088646,44.73918],[-86.066738,44.903488],[-85.809322,44.947303],[-85.612152,45.128042],[-85.628583,44.766564],[-85.524521,44.750133],[-85.393075,44.930872],[-85.387598,45.237581],[-85.305444,45.314258],[-85.031597,45.363551],[-85.119228,45.577151],[-84.938489,45.75789],[-84.713934,45.768844],[-84.461995,45.653829],[-84.215533,45.637398],[-84.09504,45.494997],[-83.908824,45.484043],[-83.596638,45.352597],[-83.4871,45.358074],[-83.317314,45.144473],[-83.454238,45.029457],[-83.322791,44.88158],[-83.273499,44.711795],[-83.333745,44.339363],[-83.536392,44.246255],[-83.585684,44.054562],[-83.82667,43.988839],[-83.958116,43.758807],[-83.908824,43.671176],[-83.667839,43.589022],[-83.481623,43.714992],[-83.262545,43.972408],[-82.917498,44.070993],[-82.747713,43.994316],[-82.643651,43.851915],[-82.539589,43.435668],[-82.523158,43.227544],[-82.413619,42.975605],[-82.517681,42.614127],[-82.681989,42.559357],[-82.687466,42.690804],[-82.797005,42.652465],[-82.922975,42.351234],[-83.125621,42.236218],[-83.185868,42.006186],[-83.437807,41.814493],[-83.454238,41.732339]]],[[[-85.508091,45.730506],[-85.49166,45.610013],[-85.623106,45.588105],[-85.568337,45.75789],[-85.508091,45.730506]]],[[[-87.589328,45.095181],[-87.742682,45.199243],[-87.649574,45.341643],[-87.885083,45.363551],[-87.791975,45.500474],[-87.781021,45.675736],[-87.989145,45.796229],[-88.10416,45.922199],[-88.531362,46.020784],[-88.662808,45.987922],[-89.09001,46.135799],[-90.119674,46.338446],[-90.229213,46.508231],[-90.415429,46.568478],[-90.026566,46.672539],[-89.851304,46.793032],[-89.413149,46.842325],[-89.128348,46.990202],[-88.996902,46.995679],[-88.887363,47.099741],[-88.575177,47.247618],[-88.416346,47.373588],[-88.180837,47.455742],[-87.956283,47.384542],[-88.350623,47.077833],[-88.443731,46.973771],[-88.438254,46.787555],[-88.246561,46.929956],[-87.901513,46.908048],[-87.633143,46.809463],[-87.392158,46.535616],[-87.260711,46.486323],[-87.008772,46.530139],[-86.948526,46.469893],[-86.696587,46.437031],[-86.159846,46.667063],[-85.880522,46.68897],[-85.508091,46.678016],[-85.256151,46.754694],[-85.064458,46.760171],[-85.02612,46.480847],[-84.82895,46.442508],[-84.63178,46.486323],[-84.549626,46.4206],[-84.418179,46.502754],[-84.127902,46.530139],[-84.122425,46.179615],[-83.990978,46.031737],[-83.793808,45.993399],[-83.7719,46.091984],[-83.580208,46.091984],[-83.476146,45.987922],[-83.563777,45.911245],[-84.111471,45.976968],[-84.374364,45.933153],[-84.659165,46.053645],[-84.741319,45.944106],[-84.70298,45.850998],[-84.82895,45.872906],[-85.015166,46.00983],[-85.338305,46.091984],[-85.502614,46.097461],[-85.661445,45.966014],[-85.924338,45.933153],[-86.209139,45.960537],[-86.324155,45.905768],[-86.351539,45.796229],[-86.663725,45.703121],[-86.647294,45.834568],[-86.784218,45.861952],[-86.838987,45.725029],[-87.069019,45.719552],[-87.17308,45.659305],[-87.326435,45.423797],[-87.611236,45.122565],[-87.589328,45.095181]]],[[[-88.805209,47.976051],[-89.057148,47.850082],[-89.188594,47.833651],[-89.177641,47.937713],[-88.547792,48.173221],[-88.668285,48.008913],[-88.805209,47.976051]]]]}}, + {"type":"Feature","id":"27","properties":{"name":"Minnesota"},"geometry":{"type":"Polygon","coordinates":[[[-92.014696,46.705401],[-92.091373,46.749217],[-92.29402,46.667063],[-92.29402,46.075553],[-92.354266,46.015307],[-92.639067,45.933153],[-92.869098,45.719552],[-92.885529,45.577151],[-92.770513,45.566198],[-92.644544,45.440228],[-92.75956,45.286874],[-92.737652,45.117088],[-92.808852,44.750133],[-92.545959,44.569394],[-92.337835,44.552964],[-92.233773,44.443425],[-91.927065,44.333886],[-91.877772,44.202439],[-91.592971,44.032654],[-91.43414,43.994316],[-91.242447,43.775238],[-91.269832,43.616407],[-91.215062,43.501391],[-91.368417,43.501391],[-96.451017,43.501391],[-96.451017,45.297827],[-96.681049,45.412843],[-96.856311,45.604536],[-96.582464,45.818137],[-96.560556,45.933153],[-96.598895,46.332969],[-96.719387,46.437031],[-96.801542,46.656109],[-96.785111,46.924479],[-96.823449,46.968294],[-96.856311,47.609096],[-97.053481,47.948667],[-97.130158,48.140359],[-97.16302,48.545653],[-97.097296,48.682577],[-97.228743,49.000239],[-95.152983,49.000239],[-95.152983,49.383625],[-94.955813,49.372671],[-94.824366,49.295994],[-94.69292,48.775685],[-94.588858,48.715438],[-94.260241,48.699007],[-94.221903,48.649715],[-93.838517,48.627807],[-93.794701,48.518268],[-93.466085,48.545653],[-93.466085,48.589469],[-93.208669,48.644238],[-92.984114,48.62233],[-92.726698,48.540176],[-92.655498,48.436114],[-92.50762,48.447068],[-92.370697,48.222514],[-92.304974,48.315622],[-92.053034,48.359437],[-92.009219,48.266329],[-91.713464,48.200606],[-91.713464,48.112975],[-91.565587,48.041775],[-91.264355,48.080113],[-91.083616,48.178698],[-90.837154,48.238944],[-90.749522,48.091067],[-90.579737,48.123929],[-90.377091,48.091067],[-90.141582,48.112975],[-89.873212,47.987005],[-89.615796,48.008913],[-89.637704,47.954144],[-89.971797,47.828174],[-90.437337,47.729589],[-90.738569,47.625527],[-91.171247,47.368111],[-91.357463,47.20928],[-91.642264,47.028541],[-92.091373,46.787555],[-92.014696,46.705401]]]}}, + {"type":"Feature","id":"28","properties":{"name":"Mississippi"},"geometry":{"type":"Polygon","coordinates":[[[-88.471115,34.995703],[-88.202745,34.995703],[-88.098683,34.891641],[-88.241084,33.796253],[-88.471115,31.895754],[-88.394438,30.367688],[-88.503977,30.323872],[-88.744962,30.34578],[-88.843547,30.411504],[-89.084533,30.367688],[-89.418626,30.252672],[-89.522688,30.181472],[-89.643181,30.285534],[-89.681519,30.449842],[-89.845827,30.66892],[-89.747242,30.997536],[-91.636787,30.997536],[-91.565587,31.068736],[-91.636787,31.265906],[-91.516294,31.27686],[-91.499863,31.643815],[-91.401278,31.621907],[-91.341032,31.846462],[-91.105524,31.988862],[-90.985031,32.218894],[-91.006939,32.514649],[-91.154816,32.640618],[-91.143862,32.843265],[-91.072662,32.887081],[-91.16577,33.002096],[-91.089093,33.13902],[-91.143862,33.347144],[-91.056231,33.429298],[-91.231493,33.560744],[-91.072662,33.867453],[-90.891923,34.026284],[-90.952169,34.135823],[-90.744046,34.300131],[-90.749522,34.365854],[-90.568783,34.420624],[-90.585214,34.617794],[-90.481152,34.661609],[-90.409952,34.831394],[-90.251121,34.908072],[-90.311367,34.995703],[-88.471115,34.995703]]]}}, + {"type":"Feature","id":"29","properties":{"name":"Missouri"},"geometry":{"type":"Polygon","coordinates":[[[-91.833957,40.609566],[-91.729895,40.615043],[-91.527248,40.412397],[-91.417709,40.379535],[-91.50534,40.237135],[-91.494386,40.034488],[-91.368417,39.727779],[-91.061708,39.470363],[-90.727615,39.256762],[-90.661891,38.928146],[-90.585214,38.867899],[-90.470199,38.961007],[-90.251121,38.917192],[-90.10872,38.845992],[-90.207305,38.725499],[-90.179921,38.632391],[-90.349706,38.374975],[-90.355183,38.216144],[-90.059428,38.013497],[-89.949889,37.88205],[-89.84035,37.903958],[-89.517211,37.690357],[-89.517211,37.537003],[-89.435057,37.34531],[-89.517211,37.279587],[-89.292656,36.994786],[-89.133825,36.983832],[-89.215979,36.578538],[-89.363857,36.622354],[-89.418626,36.496384],[-89.484349,36.496384],[-89.539119,36.496384],[-89.533642,36.249922],[-89.730812,35.997983],[-90.377091,35.997983],[-90.218259,36.184199],[-90.064905,36.304691],[-90.152536,36.496384],[-94.473842,36.501861],[-94.616242,36.501861],[-94.616242,37.000263],[-94.610765,39.158177],[-94.824366,39.20747],[-94.983197,39.442978],[-95.109167,39.541563],[-94.884612,39.831841],[-95.207752,39.908518],[-95.306337,40.001626],[-95.552799,40.264519],[-95.7664,40.587659],[-94.632673,40.571228],[-93.257961,40.582182],[-91.833957,40.609566]]]}}, + {"type":"Feature","id":"30","properties":{"name":"Montana"},"geometry":{"type":"Polygon","coordinates":[[[-104.047534,49.000239],[-104.042057,47.861036],[-104.047534,45.944106],[-104.042057,44.996596],[-104.058488,44.996596],[-105.91517,45.002073],[-109.080842,45.002073],[-111.05254,45.002073],[-111.047063,44.476286],[-111.227803,44.580348],[-111.386634,44.75561],[-111.616665,44.547487],[-111.819312,44.509148],[-111.868605,44.563917],[-112.104113,44.520102],[-112.241036,44.569394],[-112.471068,44.481763],[-112.783254,44.48724],[-112.887315,44.394132],[-113.002331,44.448902],[-113.133778,44.772041],[-113.341901,44.782995],[-113.456917,44.865149],[-113.45144,45.056842],[-113.571933,45.128042],[-113.736241,45.330689],[-113.834826,45.522382],[-113.807441,45.604536],[-113.98818,45.703121],[-114.086765,45.593582],[-114.333228,45.456659],[-114.546828,45.560721],[-114.497536,45.670259],[-114.568736,45.774321],[-114.387997,45.88386],[-114.492059,46.037214],[-114.464674,46.272723],[-114.322274,46.645155],[-114.612552,46.639678],[-114.623506,46.705401],[-114.886399,46.809463],[-114.930214,46.919002],[-115.302646,47.187372],[-115.324554,47.258572],[-115.527201,47.302388],[-115.718894,47.42288],[-115.724371,47.696727],[-116.04751,47.976051],[-116.04751,49.000239],[-111.50165,48.994762],[-109.453274,49.000239],[-104.047534,49.000239]]]}}, + {"type":"Feature","id":"31","properties":{"name":"Nebraska"},"geometry":{"type":"Polygon","coordinates":[[[-103.324578,43.002989],[-101.626726,42.997512],[-98.499393,42.997512],[-98.466531,42.94822],[-97.951699,42.767481],[-97.831206,42.866066],[-97.688806,42.844158],[-97.217789,42.844158],[-96.692003,42.657942],[-96.626279,42.515542],[-96.44554,42.488157],[-96.264801,42.039048],[-96.127878,41.973325],[-96.062155,41.798063],[-96.122401,41.67757],[-96.095016,41.540646],[-95.919754,41.453015],[-95.925231,41.201076],[-95.826646,40.976521],[-95.881416,40.719105],[-95.7664,40.587659],[-95.552799,40.264519],[-95.306337,40.001626],[-101.90605,40.001626],[-102.053927,40.001626],[-102.053927,41.003906],[-104.053011,41.003906],[-104.053011,43.002989],[-103.324578,43.002989]]]}}, + {"type":"Feature","id":"32","properties":{"name":"Nevada"},"geometry":{"type":"Polygon","coordinates":[[[-117.027882,42.000709],[-114.04295,41.995232],[-114.048427,37.000263],[-114.048427,36.195153],[-114.152489,36.025367],[-114.251074,36.01989],[-114.371566,36.140383],[-114.738521,36.102045],[-114.678275,35.516012],[-114.596121,35.324319],[-114.574213,35.138103],[-114.634459,35.00118],[-115.85034,35.970598],[-116.540435,36.501861],[-117.498899,37.21934],[-118.71478,38.101128],[-120.001861,38.999346],[-119.996384,40.264519],[-120.001861,41.995232],[-118.698349,41.989755],[-117.027882,42.000709]]]}}, + {"type":"Feature","id":"33","properties":{"name":"New Hampshire"},"geometry":{"type":"Polygon","coordinates":[[[-71.08183,45.303304],[-71.032537,44.657025],[-70.966814,43.34256],[-70.807983,43.227544],[-70.824413,43.128959],[-70.703921,43.057759],[-70.818936,42.871543],[-70.917521,42.887974],[-71.185891,42.789389],[-71.29543,42.696281],[-72.456542,42.729142],[-72.544173,42.80582],[-72.533219,42.953697],[-72.445588,43.008466],[-72.456542,43.150867],[-72.379864,43.572591],[-72.204602,43.769761],[-72.116971,43.994316],[-72.02934,44.07647],[-72.034817,44.322932],[-71.700724,44.41604],[-71.536416,44.585825],[-71.629524,44.750133],[-71.4926,44.914442],[-71.503554,45.013027],[-71.361154,45.270443],[-71.131122,45.243058],[-71.08183,45.303304]]]}}, + {"type":"Feature","id":"34","properties":{"name":"New Jersey"},"geometry":{"type":"Polygon","coordinates":[[[-74.236547,41.14083],[-73.902454,40.998429],[-74.022947,40.708151],[-74.187255,40.642428],[-74.274886,40.489074],[-74.001039,40.412397],[-73.979131,40.297381],[-74.099624,39.760641],[-74.411809,39.360824],[-74.614456,39.245808],[-74.795195,38.993869],[-74.888303,39.158177],[-75.178581,39.240331],[-75.534582,39.459409],[-75.55649,39.607286],[-75.561967,39.629194],[-75.507197,39.683964],[-75.414089,39.804456],[-75.145719,39.88661],[-75.129289,39.963288],[-74.82258,40.127596],[-74.773287,40.215227],[-75.058088,40.417874],[-75.069042,40.543843],[-75.195012,40.576705],[-75.205966,40.691721],[-75.052611,40.866983],[-75.134765,40.971045],[-74.882826,41.179168],[-74.828057,41.288707],[-74.69661,41.359907],[-74.236547,41.14083]]]}}, + {"type":"Feature","id":"35","properties":{"name":"New Mexico"},"geometry":{"type":"Polygon","coordinates":[[[-107.421329,37.000263],[-106.868158,36.994786],[-104.337812,36.994786],[-103.001438,37.000263],[-103.001438,36.501861],[-103.039777,36.501861],[-103.045254,34.01533],[-103.067161,33.002096],[-103.067161,31.999816],[-106.616219,31.999816],[-106.643603,31.901231],[-106.528588,31.786216],[-108.210008,31.786216],[-108.210008,31.331629],[-109.04798,31.331629],[-109.042503,37.000263],[-107.421329,37.000263]]]}}, + {"type":"Feature","id":"36","properties":{"name":"New York"},"geometry":{"type":"Polygon","coordinates":[[[-73.343806,45.013027],[-73.332852,44.804903],[-73.387622,44.618687],[-73.294514,44.437948],[-73.321898,44.246255],[-73.436914,44.043608],[-73.349283,43.769761],[-73.404052,43.687607],[-73.245221,43.523299],[-73.278083,42.833204],[-73.267129,42.745573],[-73.508114,42.08834],[-73.486206,42.050002],[-73.55193,41.294184],[-73.48073,41.21203],[-73.727192,41.102491],[-73.655992,40.987475],[-73.22879,40.905321],[-73.141159,40.965568],[-72.774204,40.965568],[-72.587988,40.998429],[-72.28128,41.157261],[-72.259372,41.042245],[-72.100541,40.992952],[-72.467496,40.845075],[-73.239744,40.625997],[-73.562884,40.582182],[-73.776484,40.593136],[-73.935316,40.543843],[-74.022947,40.708151],[-73.902454,40.998429],[-74.236547,41.14083],[-74.69661,41.359907],[-74.740426,41.431108],[-74.89378,41.436584],[-75.074519,41.60637],[-75.052611,41.754247],[-75.173104,41.869263],[-75.249781,41.863786],[-75.35932,42.000709],[-79.76278,42.000709],[-79.76278,42.252649],[-79.76278,42.269079],[-79.149363,42.55388],[-79.050778,42.690804],[-78.853608,42.783912],[-78.930285,42.953697],[-79.012439,42.986559],[-79.072686,43.260406],[-78.486653,43.375421],[-77.966344,43.369944],[-77.75822,43.34256],[-77.533665,43.233021],[-77.391265,43.276836],[-76.958587,43.271359],[-76.695693,43.34256],[-76.41637,43.523299],[-76.235631,43.528776],[-76.230154,43.802623],[-76.137046,43.961454],[-76.3616,44.070993],[-76.312308,44.196962],[-75.912491,44.366748],[-75.764614,44.514625],[-75.282643,44.848718],[-74.828057,45.018503],[-74.148916,44.991119],[-73.343806,45.013027]]]}}, + {"type":"Feature","id":"37","properties":{"name":"North Carolina"},"geometry":{"type":"Polygon","coordinates":[[[-80.978661,36.562108],[-80.294043,36.545677],[-79.510841,36.5402],[-75.868676,36.551154],[-75.75366,36.151337],[-76.032984,36.189676],[-76.071322,36.140383],[-76.410893,36.080137],[-76.460185,36.025367],[-76.68474,36.008937],[-76.673786,35.937736],[-76.399939,35.987029],[-76.3616,35.943213],[-76.060368,35.992506],[-75.961783,35.899398],[-75.781044,35.937736],[-75.715321,35.696751],[-75.775568,35.581735],[-75.89606,35.570781],[-76.147999,35.324319],[-76.482093,35.313365],[-76.536862,35.14358],[-76.394462,34.973795],[-76.279446,34.940933],[-76.493047,34.661609],[-76.673786,34.694471],[-76.991448,34.667086],[-77.210526,34.60684],[-77.555573,34.415147],[-77.82942,34.163208],[-77.971821,33.845545],[-78.179944,33.916745],[-78.541422,33.851022],[-79.675149,34.80401],[-80.797922,34.820441],[-80.781491,34.935456],[-80.934845,35.105241],[-81.038907,35.044995],[-81.044384,35.149057],[-82.276696,35.198349],[-82.550543,35.160011],[-82.764143,35.066903],[-83.109191,35.00118],[-83.618546,34.984749],[-84.319594,34.990226],[-84.29221,35.225734],[-84.09504,35.247642],[-84.018363,35.41195],[-83.7719,35.559827],[-83.498053,35.565304],[-83.251591,35.718659],[-82.994175,35.773428],[-82.775097,35.997983],[-82.638174,36.063706],[-82.610789,35.965121],[-82.216449,36.156814],[-82.03571,36.118475],[-81.909741,36.304691],[-81.723525,36.353984],[-81.679709,36.589492],[-80.978661,36.562108]]]}}, + {"type":"Feature","id":"38","properties":{"name":"North Dakota"},"geometry":{"type":"Polygon","coordinates":[[[-97.228743,49.000239],[-97.097296,48.682577],[-97.16302,48.545653],[-97.130158,48.140359],[-97.053481,47.948667],[-96.856311,47.609096],[-96.823449,46.968294],[-96.785111,46.924479],[-96.801542,46.656109],[-96.719387,46.437031],[-96.598895,46.332969],[-96.560556,45.933153],[-104.047534,45.944106],[-104.042057,47.861036],[-104.047534,49.000239],[-97.228743,49.000239]]]}}, + {"type":"Feature","id":"39","properties":{"name":"Ohio"},"geometry":{"type":"Polygon","coordinates":[[[-80.518598,41.978802],[-80.518598,40.636951],[-80.666475,40.582182],[-80.595275,40.472643],[-80.600752,40.319289],[-80.737675,40.078303],[-80.830783,39.711348],[-81.219646,39.388209],[-81.345616,39.344393],[-81.455155,39.410117],[-81.57017,39.267716],[-81.685186,39.273193],[-81.811156,39.0815],[-81.783771,38.966484],[-81.887833,38.873376],[-82.03571,39.026731],[-82.221926,38.785745],[-82.172634,38.632391],[-82.293127,38.577622],[-82.331465,38.446175],[-82.594358,38.424267],[-82.731282,38.561191],[-82.846298,38.588575],[-82.890113,38.758361],[-83.032514,38.725499],[-83.142052,38.626914],[-83.519961,38.703591],[-83.678792,38.632391],[-83.903347,38.769315],[-84.215533,38.807653],[-84.231963,38.895284],[-84.43461,39.103408],[-84.817996,39.103408],[-84.801565,40.500028],[-84.807042,41.694001],[-83.454238,41.732339],[-83.065375,41.595416],[-82.933929,41.513262],[-82.835344,41.589939],[-82.616266,41.431108],[-82.479343,41.381815],[-82.013803,41.513262],[-81.739956,41.485877],[-81.444201,41.672093],[-81.011523,41.852832],[-80.518598,41.978802],[-80.518598,41.978802]]]}}, + {"type":"Feature","id":"40","properties":{"name":"Oklahoma"},"geometry":{"type":"Polygon","coordinates":[[[-100.087706,37.000263],[-94.616242,37.000263],[-94.616242,36.501861],[-94.430026,35.395519],[-94.484796,33.637421],[-94.868182,33.74696],[-94.966767,33.861976],[-95.224183,33.960561],[-95.289906,33.87293],[-95.547322,33.878407],[-95.602092,33.933176],[-95.8376,33.834591],[-95.936185,33.889361],[-96.149786,33.840068],[-96.346956,33.686714],[-96.423633,33.774345],[-96.631756,33.845545],[-96.850834,33.845545],[-96.922034,33.960561],[-97.173974,33.736006],[-97.256128,33.861976],[-97.371143,33.823637],[-97.458774,33.905791],[-97.694283,33.982469],[-97.869545,33.851022],[-97.946222,33.987946],[-98.088623,34.004376],[-98.170777,34.113915],[-98.36247,34.157731],[-98.488439,34.064623],[-98.570593,34.146777],[-98.767763,34.135823],[-98.986841,34.223454],[-99.189488,34.2125],[-99.260688,34.404193],[-99.57835,34.415147],[-99.698843,34.382285],[-99.923398,34.573978],[-100.000075,34.563024],[-100.000075,36.501861],[-101.812942,36.501861],[-103.001438,36.501861],[-103.001438,37.000263],[-102.042974,36.994786],[-100.087706,37.000263]]]}}, + {"type":"Feature","id":"41","properties":{"name":"Oregon"},"geometry":{"type":"Polygon","coordinates":[[[-123.211348,46.174138],[-123.11824,46.185092],[-122.904639,46.08103],[-122.811531,45.960537],[-122.762239,45.659305],[-122.247407,45.549767],[-121.809251,45.708598],[-121.535404,45.725029],[-121.217742,45.670259],[-121.18488,45.604536],[-120.637186,45.746937],[-120.505739,45.697644],[-120.209985,45.725029],[-119.963522,45.823614],[-119.525367,45.911245],[-119.125551,45.933153],[-118.988627,45.998876],[-116.918344,45.993399],[-116.78142,45.823614],[-116.545912,45.752413],[-116.463758,45.61549],[-116.671881,45.319735],[-116.732128,45.144473],[-116.847143,45.02398],[-116.830713,44.930872],[-116.934774,44.782995],[-117.038836,44.750133],[-117.241483,44.394132],[-117.170283,44.257209],[-116.97859,44.240778],[-116.896436,44.158624],[-117.027882,43.830007],[-117.027882,42.000709],[-118.698349,41.989755],[-120.001861,41.995232],[-121.037003,41.995232],[-122.378853,42.011663],[-123.233256,42.006186],[-124.213628,42.000709],[-124.356029,42.115725],[-124.432706,42.438865],[-124.416275,42.663419],[-124.553198,42.838681],[-124.454613,43.002989],[-124.383413,43.271359],[-124.235536,43.55616],[-124.169813,43.8081],[-124.060274,44.657025],[-124.076705,44.772041],[-123.97812,45.144473],[-123.939781,45.659305],[-123.994551,45.944106],[-123.945258,46.113892],[-123.545441,46.261769],[-123.370179,46.146753],[-123.211348,46.174138]]]}}, + {"type":"Feature","id":"42","properties":{"name":"Pennsylvania"},"geometry":{"type":"Polygon","coordinates":[[[-79.76278,42.252649],[-79.76278,42.000709],[-75.35932,42.000709],[-75.249781,41.863786],[-75.173104,41.869263],[-75.052611,41.754247],[-75.074519,41.60637],[-74.89378,41.436584],[-74.740426,41.431108],[-74.69661,41.359907],[-74.828057,41.288707],[-74.882826,41.179168],[-75.134765,40.971045],[-75.052611,40.866983],[-75.205966,40.691721],[-75.195012,40.576705],[-75.069042,40.543843],[-75.058088,40.417874],[-74.773287,40.215227],[-74.82258,40.127596],[-75.129289,39.963288],[-75.145719,39.88661],[-75.414089,39.804456],[-75.616736,39.831841],[-75.786521,39.722302],[-79.477979,39.722302],[-80.518598,39.722302],[-80.518598,40.636951],[-80.518598,41.978802],[-80.518598,41.978802],[-80.332382,42.033571],[-79.76278,42.269079],[-79.76278,42.252649]]]}}, + {"type":"Feature","id":"44","properties":{"name":"Rhode Island"},"geometry":{"type":"MultiPolygon","coordinates":[[[[-71.196845,41.67757],[-71.120168,41.496831],[-71.317338,41.474923],[-71.196845,41.67757]]],[[[-71.530939,42.01714],[-71.383061,42.01714],[-71.328292,41.781632],[-71.22423,41.710431],[-71.344723,41.726862],[-71.448785,41.578985],[-71.481646,41.370861],[-71.859555,41.321569],[-71.799309,41.414677],[-71.799309,42.006186],[-71.530939,42.01714]]]]}}, + {"type":"Feature","id":"45","properties":{"name":"South Carolina"},"geometry":{"type":"Polygon","coordinates":[[[-82.764143,35.066903],[-82.550543,35.160011],[-82.276696,35.198349],[-81.044384,35.149057],[-81.038907,35.044995],[-80.934845,35.105241],[-80.781491,34.935456],[-80.797922,34.820441],[-79.675149,34.80401],[-78.541422,33.851022],[-78.716684,33.80173],[-78.935762,33.637421],[-79.149363,33.380005],[-79.187701,33.171881],[-79.357487,33.007573],[-79.582041,33.007573],[-79.631334,32.887081],[-79.866842,32.755634],[-79.998289,32.613234],[-80.206412,32.552987],[-80.430967,32.399633],[-80.452875,32.328433],[-80.660998,32.246279],[-80.885553,32.032678],[-81.115584,32.120309],[-81.121061,32.290094],[-81.279893,32.558464],[-81.416816,32.629664],[-81.42777,32.843265],[-81.493493,33.007573],[-81.761863,33.160928],[-81.937125,33.347144],[-81.926172,33.462159],[-82.194542,33.631944],[-82.325988,33.81816],[-82.55602,33.94413],[-82.714851,34.152254],[-82.747713,34.26727],[-82.901067,34.486347],[-83.005129,34.469916],[-83.339222,34.683517],[-83.322791,34.787579],[-83.109191,35.00118],[-82.764143,35.066903]]]}}, + {"type":"Feature","id":"46","properties":{"name":"South Dakota"},"geometry":{"type":"Polygon","coordinates":[[[-104.047534,45.944106],[-96.560556,45.933153],[-96.582464,45.818137],[-96.856311,45.604536],[-96.681049,45.412843],[-96.451017,45.297827],[-96.451017,43.501391],[-96.582464,43.479483],[-96.527695,43.397329],[-96.560556,43.222067],[-96.434587,43.123482],[-96.511264,43.052282],[-96.544125,42.855112],[-96.631756,42.707235],[-96.44554,42.488157],[-96.626279,42.515542],[-96.692003,42.657942],[-97.217789,42.844158],[-97.688806,42.844158],[-97.831206,42.866066],[-97.951699,42.767481],[-98.466531,42.94822],[-98.499393,42.997512],[-101.626726,42.997512],[-103.324578,43.002989],[-104.053011,43.002989],[-104.058488,44.996596],[-104.042057,44.996596],[-104.047534,45.944106]]]}}, + {"type":"Feature","id":"47","properties":{"name":"Tennessee"},"geometry":{"type":"Polygon","coordinates":[[[-88.054868,36.496384],[-88.071299,36.677123],[-87.852221,36.633308],[-86.592525,36.655216],[-85.486183,36.616877],[-85.289013,36.627831],[-84.544149,36.594969],[-83.689746,36.584015],[-83.673316,36.600446],[-81.679709,36.589492],[-81.723525,36.353984],[-81.909741,36.304691],[-82.03571,36.118475],[-82.216449,36.156814],[-82.610789,35.965121],[-82.638174,36.063706],[-82.775097,35.997983],[-82.994175,35.773428],[-83.251591,35.718659],[-83.498053,35.565304],[-83.7719,35.559827],[-84.018363,35.41195],[-84.09504,35.247642],[-84.29221,35.225734],[-84.319594,34.990226],[-85.606675,34.984749],[-87.359296,35.00118],[-88.202745,34.995703],[-88.471115,34.995703],[-90.311367,34.995703],[-90.212782,35.023087],[-90.114197,35.198349],[-90.130628,35.439335],[-89.944412,35.603643],[-89.911551,35.756997],[-89.763673,35.811767],[-89.730812,35.997983],[-89.533642,36.249922],[-89.539119,36.496384],[-89.484349,36.496384],[-89.418626,36.496384],[-89.298133,36.507338],[-88.054868,36.496384]]]}}, + {"type":"Feature","id":"48","properties":{"name":"Texas"},"geometry":{"type":"Polygon","coordinates":[[[-101.812942,36.501861],[-100.000075,36.501861],[-100.000075,34.563024],[-99.923398,34.573978],[-99.698843,34.382285],[-99.57835,34.415147],[-99.260688,34.404193],[-99.189488,34.2125],[-98.986841,34.223454],[-98.767763,34.135823],[-98.570593,34.146777],[-98.488439,34.064623],[-98.36247,34.157731],[-98.170777,34.113915],[-98.088623,34.004376],[-97.946222,33.987946],[-97.869545,33.851022],[-97.694283,33.982469],[-97.458774,33.905791],[-97.371143,33.823637],[-97.256128,33.861976],[-97.173974,33.736006],[-96.922034,33.960561],[-96.850834,33.845545],[-96.631756,33.845545],[-96.423633,33.774345],[-96.346956,33.686714],[-96.149786,33.840068],[-95.936185,33.889361],[-95.8376,33.834591],[-95.602092,33.933176],[-95.547322,33.878407],[-95.289906,33.87293],[-95.224183,33.960561],[-94.966767,33.861976],[-94.868182,33.74696],[-94.484796,33.637421],[-94.380734,33.544313],[-94.183564,33.593606],[-94.041164,33.54979],[-94.041164,33.018527],[-94.041164,31.994339],[-93.822086,31.775262],[-93.816609,31.556184],[-93.542762,31.15089],[-93.526331,30.93729],[-93.630393,30.679874],[-93.728978,30.575812],[-93.696116,30.438888],[-93.767317,30.334826],[-93.690639,30.143133],[-93.926148,29.787132],[-93.838517,29.688547],[-94.002825,29.68307],[-94.523134,29.546147],[-94.70935,29.622824],[-94.742212,29.787132],[-94.873659,29.672117],[-94.966767,29.699501],[-95.016059,29.557101],[-94.911997,29.496854],[-94.895566,29.310638],[-95.081782,29.113469],[-95.383014,28.867006],[-95.985477,28.604113],[-96.045724,28.647929],[-96.226463,28.582205],[-96.23194,28.642452],[-96.478402,28.598636],[-96.593418,28.724606],[-96.664618,28.697221],[-96.401725,28.439805],[-96.593418,28.357651],[-96.774157,28.406943],[-96.801542,28.226204],[-97.026096,28.039988],[-97.256128,27.694941],[-97.404005,27.333463],[-97.513544,27.360848],[-97.540929,27.229401],[-97.425913,27.262263],[-97.480682,26.99937],[-97.557359,26.988416],[-97.562836,26.840538],[-97.469728,26.758384],[-97.442344,26.457153],[-97.332805,26.353091],[-97.30542,26.161398],[-97.217789,25.991613],[-97.524498,25.887551],[-97.650467,26.018997],[-97.885976,26.06829],[-98.198161,26.057336],[-98.466531,26.221644],[-98.669178,26.238075],[-98.822533,26.369522],[-99.030656,26.413337],[-99.173057,26.539307],[-99.266165,26.840538],[-99.446904,27.021277],[-99.424996,27.174632],[-99.50715,27.33894],[-99.479765,27.48134],[-99.605735,27.640172],[-99.709797,27.656603],[-99.879582,27.799003],[-99.934351,27.979742],[-100.082229,28.14405],[-100.29583,28.280974],[-100.399891,28.582205],[-100.498476,28.66436],[-100.629923,28.905345],[-100.673738,29.102515],[-100.799708,29.244915],[-101.013309,29.370885],[-101.062601,29.458516],[-101.259771,29.535193],[-101.413125,29.754271],[-101.851281,29.803563],[-102.114174,29.792609],[-102.338728,29.869286],[-102.388021,29.765225],[-102.629006,29.732363],[-102.809745,29.524239],[-102.919284,29.190146],[-102.97953,29.184669],[-103.116454,28.987499],[-103.280762,28.982022],[-103.527224,29.135376],[-104.146119,29.381839],[-104.266611,29.513285],[-104.507597,29.639255],[-104.677382,29.924056],[-104.688336,30.181472],[-104.858121,30.389596],[-104.896459,30.570335],[-105.005998,30.685351],[-105.394861,30.855136],[-105.602985,31.085167],[-105.77277,31.167321],[-105.953509,31.364491],[-106.205448,31.468553],[-106.38071,31.731446],[-106.528588,31.786216],[-106.643603,31.901231],[-106.616219,31.999816],[-103.067161,31.999816],[-103.067161,33.002096],[-103.045254,34.01533],[-103.039777,36.501861],[-103.001438,36.501861],[-101.812942,36.501861]]]}}, + {"type":"Feature","id":"49","properties":{"name":"Utah"},"geometry":{"type":"Polygon","coordinates":[[[-112.164359,41.995232],[-111.047063,42.000709],[-111.047063,40.998429],[-109.04798,40.998429],[-109.053457,39.125316],[-109.058934,38.27639],[-109.042503,38.166851],[-109.042503,37.000263],[-110.499369,37.00574],[-114.048427,37.000263],[-114.04295,41.995232],[-112.164359,41.995232]]]}}, + {"type":"Feature","id":"50","properties":{"name":"Vermont"},"geometry":{"type":"Polygon","coordinates":[[[-71.503554,45.013027],[-71.4926,44.914442],[-71.629524,44.750133],[-71.536416,44.585825],[-71.700724,44.41604],[-72.034817,44.322932],[-72.02934,44.07647],[-72.116971,43.994316],[-72.204602,43.769761],[-72.379864,43.572591],[-72.456542,43.150867],[-72.445588,43.008466],[-72.533219,42.953697],[-72.544173,42.80582],[-72.456542,42.729142],[-73.267129,42.745573],[-73.278083,42.833204],[-73.245221,43.523299],[-73.404052,43.687607],[-73.349283,43.769761],[-73.436914,44.043608],[-73.321898,44.246255],[-73.294514,44.437948],[-73.387622,44.618687],[-73.332852,44.804903],[-73.343806,45.013027],[-72.308664,45.002073],[-71.503554,45.013027]]]}}, + {"type":"Feature","id":"51","properties":{"name":"Virginia"},"geometry":{"type":"MultiPolygon","coordinates":[[[[-75.397659,38.013497],[-75.244304,38.029928],[-75.375751,37.860142],[-75.512674,37.799896],[-75.594828,37.569865],[-75.802952,37.197433],[-75.972737,37.120755],[-76.027507,37.257679],[-75.939876,37.564388],[-75.671506,37.95325],[-75.397659,38.013497]]],[[[-76.016553,37.95325],[-75.994645,37.95325],[-76.043938,37.95325],[-76.016553,37.95325]]],[[[-78.349729,39.464886],[-77.82942,39.130793],[-77.719881,39.322485],[-77.566527,39.306055],[-77.456988,39.223901],[-77.456988,39.076023],[-77.248864,39.026731],[-77.117418,38.933623],[-77.040741,38.791222],[-77.128372,38.632391],[-77.248864,38.588575],[-77.325542,38.446175],[-77.281726,38.342113],[-77.013356,38.374975],[-76.964064,38.216144],[-76.613539,38.15042],[-76.514954,38.024451],[-76.235631,37.887527],[-76.3616,37.608203],[-76.246584,37.389126],[-76.383508,37.285064],[-76.399939,37.159094],[-76.273969,37.082417],[-76.410893,36.961924],[-76.619016,37.120755],[-76.668309,37.065986],[-76.48757,36.95097],[-75.994645,36.923586],[-75.868676,36.551154],[-79.510841,36.5402],[-80.294043,36.545677],[-80.978661,36.562108],[-81.679709,36.589492],[-83.673316,36.600446],[-83.136575,36.742847],[-83.070852,36.852385],[-82.879159,36.890724],[-82.868205,36.978355],[-82.720328,37.044078],[-82.720328,37.120755],[-82.353373,37.268633],[-81.969987,37.537003],[-81.986418,37.454849],[-81.849494,37.285064],[-81.679709,37.20291],[-81.55374,37.208387],[-81.362047,37.339833],[-81.225123,37.235771],[-80.967707,37.290541],[-80.513121,37.482234],[-80.474782,37.421987],[-80.29952,37.509618],[-80.294043,37.690357],[-80.184505,37.849189],[-79.998289,37.997066],[-79.921611,38.177805],[-79.724442,38.364021],[-79.647764,38.594052],[-79.477979,38.457129],[-79.313671,38.413313],[-79.209609,38.495467],[-78.996008,38.851469],[-78.870039,38.763838],[-78.404499,39.169131],[-78.349729,39.464886]]]]}}, + {"type":"Feature","id":"53","properties":{"name":"Washington"},"geometry":{"type":"MultiPolygon","coordinates":[[[[-117.033359,49.000239],[-117.044313,47.762451],[-117.038836,46.426077],[-117.055267,46.343923],[-116.92382,46.168661],[-116.918344,45.993399],[-118.988627,45.998876],[-119.125551,45.933153],[-119.525367,45.911245],[-119.963522,45.823614],[-120.209985,45.725029],[-120.505739,45.697644],[-120.637186,45.746937],[-121.18488,45.604536],[-121.217742,45.670259],[-121.535404,45.725029],[-121.809251,45.708598],[-122.247407,45.549767],[-122.762239,45.659305],[-122.811531,45.960537],[-122.904639,46.08103],[-123.11824,46.185092],[-123.211348,46.174138],[-123.370179,46.146753],[-123.545441,46.261769],[-123.72618,46.300108],[-123.874058,46.239861],[-124.065751,46.327492],[-124.027412,46.464416],[-123.895966,46.535616],[-124.098612,46.74374],[-124.235536,47.285957],[-124.31769,47.357157],[-124.427229,47.740543],[-124.624399,47.88842],[-124.706553,48.184175],[-124.597014,48.381345],[-124.394367,48.288237],[-123.983597,48.162267],[-123.704273,48.167744],[-123.424949,48.118452],[-123.162056,48.167744],[-123.036086,48.080113],[-122.800578,48.08559],[-122.636269,47.866512],[-122.515777,47.882943],[-122.493869,47.587189],[-122.422669,47.318818],[-122.324084,47.346203],[-122.422669,47.576235],[-122.395284,47.800789],[-122.230976,48.030821],[-122.362422,48.123929],[-122.373376,48.288237],[-122.471961,48.468976],[-122.422669,48.600422],[-122.488392,48.753777],[-122.647223,48.775685],[-122.795101,48.8907],[-122.756762,49.000239],[-117.033359,49.000239]]],[[[-122.718423,48.310145],[-122.586977,48.35396],[-122.608885,48.151313],[-122.767716,48.227991],[-122.718423,48.310145]]],[[[-123.025132,48.583992],[-122.915593,48.715438],[-122.767716,48.556607],[-122.811531,48.419683],[-123.041563,48.458022],[-123.025132,48.583992]]]]}}, + {"type":"Feature","id":"54","properties":{"name":"West Virginia"},"geometry":{"type":"Polygon","coordinates":[[[-80.518598,40.636951],[-80.518598,39.722302],[-79.477979,39.722302],[-79.488933,39.20747],[-79.291763,39.300578],[-79.094593,39.470363],[-78.963147,39.437501],[-78.765977,39.585379],[-78.470222,39.514178],[-78.431884,39.623717],[-78.267575,39.61824],[-78.174467,39.694917],[-78.004682,39.601809],[-77.834897,39.601809],[-77.719881,39.322485],[-77.82942,39.130793],[-78.349729,39.464886],[-78.404499,39.169131],[-78.870039,38.763838],[-78.996008,38.851469],[-79.209609,38.495467],[-79.313671,38.413313],[-79.477979,38.457129],[-79.647764,38.594052],[-79.724442,38.364021],[-79.921611,38.177805],[-79.998289,37.997066],[-80.184505,37.849189],[-80.294043,37.690357],[-80.29952,37.509618],[-80.474782,37.421987],[-80.513121,37.482234],[-80.967707,37.290541],[-81.225123,37.235771],[-81.362047,37.339833],[-81.55374,37.208387],[-81.679709,37.20291],[-81.849494,37.285064],[-81.986418,37.454849],[-81.969987,37.537003],[-82.101434,37.553434],[-82.293127,37.668449],[-82.342419,37.783465],[-82.50125,37.931343],[-82.621743,38.123036],[-82.594358,38.424267],[-82.331465,38.446175],[-82.293127,38.577622],[-82.172634,38.632391],[-82.221926,38.785745],[-82.03571,39.026731],[-81.887833,38.873376],[-81.783771,38.966484],[-81.811156,39.0815],[-81.685186,39.273193],[-81.57017,39.267716],[-81.455155,39.410117],[-81.345616,39.344393],[-81.219646,39.388209],[-80.830783,39.711348],[-80.737675,40.078303],[-80.600752,40.319289],[-80.595275,40.472643],[-80.666475,40.582182],[-80.518598,40.636951]]]}}, + {"type":"Feature","id":"55","properties":{"name":"Wisconsin"},"geometry":{"type":"Polygon","coordinates":[[[-90.415429,46.568478],[-90.229213,46.508231],[-90.119674,46.338446],[-89.09001,46.135799],[-88.662808,45.987922],[-88.531362,46.020784],[-88.10416,45.922199],[-87.989145,45.796229],[-87.781021,45.675736],[-87.791975,45.500474],[-87.885083,45.363551],[-87.649574,45.341643],[-87.742682,45.199243],[-87.589328,45.095181],[-87.627666,44.974688],[-87.819359,44.95278],[-87.983668,44.722749],[-88.043914,44.563917],[-87.928898,44.536533],[-87.775544,44.640595],[-87.611236,44.837764],[-87.403112,44.914442],[-87.238804,45.166381],[-87.03068,45.22115],[-87.047111,45.089704],[-87.189511,44.969211],[-87.468835,44.552964],[-87.545512,44.322932],[-87.540035,44.158624],[-87.644097,44.103854],[-87.737205,43.8793],[-87.704344,43.687607],[-87.791975,43.561637],[-87.912467,43.249452],[-87.885083,43.002989],[-87.76459,42.783912],[-87.802929,42.493634],[-88.788778,42.493634],[-90.639984,42.510065],[-90.711184,42.636034],[-91.067185,42.75105],[-91.143862,42.909881],[-91.176724,43.134436],[-91.056231,43.254929],[-91.204109,43.353514],[-91.215062,43.501391],[-91.269832,43.616407],[-91.242447,43.775238],[-91.43414,43.994316],[-91.592971,44.032654],[-91.877772,44.202439],[-91.927065,44.333886],[-92.233773,44.443425],[-92.337835,44.552964],[-92.545959,44.569394],[-92.808852,44.750133],[-92.737652,45.117088],[-92.75956,45.286874],[-92.644544,45.440228],[-92.770513,45.566198],[-92.885529,45.577151],[-92.869098,45.719552],[-92.639067,45.933153],[-92.354266,46.015307],[-92.29402,46.075553],[-92.29402,46.667063],[-92.091373,46.749217],[-92.014696,46.705401],[-91.790141,46.694447],[-91.09457,46.864232],[-90.837154,46.95734],[-90.749522,46.88614],[-90.886446,46.754694],[-90.55783,46.584908],[-90.415429,46.568478]]]}}, + {"type":"Feature","id":"56","properties":{"name":"Wyoming"},"geometry":{"type":"Polygon","coordinates":[[[-109.080842,45.002073],[-105.91517,45.002073],[-104.058488,44.996596],[-104.053011,43.002989],[-104.053011,41.003906],[-105.728954,40.998429],[-107.919731,41.003906],[-109.04798,40.998429],[-111.047063,40.998429],[-111.047063,42.000709],[-111.047063,44.476286],[-111.05254,45.002073],[-109.080842,45.002073]]]}}, + {"type":"Feature","id":"72","properties":{"name":"Puerto Rico"},"geometry":{"type":"Polygon","coordinates":[[[-66.448338,17.984326],[-66.771478,18.006234],[-66.924832,17.929556],[-66.985078,17.973372],[-67.209633,17.956941],[-67.154863,18.19245],[-67.269879,18.362235],[-67.094617,18.515589],[-66.957694,18.488204],[-66.409999,18.488204],[-65.840398,18.433435],[-65.632274,18.367712],[-65.626797,18.203403],[-65.730859,18.186973],[-65.834921,18.017187],[-66.234737,17.929556],[-66.448338,17.984326]]]}} + ]}, + defaultDatasourceBoxplot: [ + ["Income", "Life Expectancy", "Population", "Country", "Year"], + [815, 34.05, 351014, "Australia", 1800], + [1314, 39, 645526, "Canada", 1800], + [985, 32, 321675013, "China", 1800], + [864, 32.2, 345043, "Cuba", 1800], + [1244, 36.5731262, 977662, "Finland", 1800], + [1803, 33.96717024, 29355111, "France", 1800], + [1639, 38.37, 22886919, "Germany", 1800], + [926, 42.84559912, 61428, "Iceland", 1800], + [1052, 25.4424, 168574895, "India", 1800], + [1050, 36.4, 30294378, "Japan", 1800], + [658, 34.05, 100000, "New Zealand", 1800], + [1278, 37.91620899, 868570, "Norway", 1800], + [1213, 35.9, 9508747, "Poland", 1800], + [1430, 29.5734572, 31088398, "Russia", 1800], + [1221, 35, 9773456, "Turkey", 1800], + [3431, 38.6497603, 12327466, "United Kingdom", 1800], + [2128, 39.41, 6801854, "United States", 1800], + [834, 34.05, 342440, "Australia", 1810], + [1400, 39.01496774, 727603, "Canada", 1810], + [985, 32, 350542958, "China", 1810], + [970, 33.64, 470176, "Cuba", 1810], + [1267, 36.9473378, 1070625, "Finland", 1810], + [1839, 37.4, 30293172, "France", 1810], + [1759, 38.37, 23882461, "Germany", 1810], + [928, 43.13915533, 61428, "Iceland", 1810], + [1051, 25.4424, 171940819, "India", 1810], + [1064, 36.40397538, 30645903, "Japan", 1810], + [659, 34.05, 100000, "New Zealand", 1810], + [1299, 36.47500606, 918398, "Norway", 1810], + [1260, 35.9, 9960687, "Poland", 1810], + [1447, 29.5734572, 31088398, "Russia", 1810], + [1223, 35, 9923007, "Turkey", 1810], + [3575, 38.34738144, 14106058, "United Kingdom", 1810], + [2283, 39.41, 8294928, "United States", 1810], + [853, 34.05, 334002, "Australia", 1820], + [1491, 39.02993548, 879432, "Canada", 1820], + [985, 32, 380055273, "China", 1820], + [1090, 35.04, 607664, "Cuba", 1820], + [1290, 37.29122269, 1190807, "Finland", 1820], + [1876, 39.21, 31549988, "France", 1820], + [1887, 38.37, 25507768, "Germany", 1820], + [929, 36.56365268, 62498, "Iceland", 1820], + [1050, 25.4424, 176225709, "India", 1820], + [1079, 36.40795077, 30993147, "Japan", 1820], + [660, 34.05, 100000, "New Zealand", 1820], + [1320, 46.96239815, 995904, "Norway", 1820], + [1309, 35.9, 10508375, "Poland", 1820], + [1464, 29.5734572, 31861526, "Russia", 1820], + [1225, 35, 10118315, "Turkey", 1820], + [3403, 41.31247671, 16221883, "United Kingdom", 1820], + [2242, 39.41, 10361646, "United States", 1820], + [1399, 34.05, 348143, "Australia", 1830], + [1651, 39.04490323, 1202146, "Canada", 1830], + [986, 32, 402373519, "China", 1830], + [1224, 35.74, 772812, "Cuba", 1830], + [1360, 36.29644969, 1327905, "Finland", 1830], + [1799, 39.56, 33174810, "France", 1830], + [2024, 38.37, 28016571, "Germany", 1830], + [1036, 40.5022162, 65604, "Iceland", 1830], + [1052, 25.4424, 182214537, "India", 1830], + [1094, 36.41192615, 31330455, "Japan", 1830], + [661, 34.05, 91723, "New Zealand", 1830], + [1403, 45.75400094, 1115667, "Norway", 1830], + [1360, 35.9, 11232857, "Poland", 1830], + [1562, 29.5734572, 34134430, "Russia", 1830], + [1292, 35, 10398375, "Turkey", 1830], + [3661, 43.01830917, 18533999, "United Kingdom", 1830], + [2552, 39.41, 13480460, "United States", 1830], + [2269, 34.05, 434095, "Australia", 1840], + [1922, 40.19012, 1745604, "Canada", 1840], + [986, 32, 411213424, "China", 1840], + [1374, 36.48, 975565, "Cuba", 1840], + [1434, 41.46900965, 1467238, "Finland", 1840], + [2184, 40.37, 34854476, "France", 1840], + [2102, 38.37, 31016143, "Germany", 1840], + [1155, 31.97, 70010, "Iceland", 1840], + [1053, 25.4424, 189298397, "India", 1840], + [1110, 36.41590154, 31663783, "Japan", 1840], + [662, 34.05, 82479, "New Zealand", 1840], + [1604, 45.61661054, 1252476, "Norway", 1840], + [1413, 35.9, 12090161, "Poland", 1840], + [1666, 29.5734572, 37420913, "Russia", 1840], + [1362, 35, 10731241, "Turkey", 1840], + [4149, 39.92715263, 20737251, "United Kingdom", 1840], + [2792, 39.41, 17942443, "United States", 1840], + [3267, 34.05, 742619, "Australia", 1850], + [2202, 40.985432, 2487811, "Canada", 1850], + [985, 32, 402711280, "China", 1850], + [1543, 36.26, 1181650, "Cuba", 1850], + [1512, 37.35415172, 1607810, "Finland", 1850], + [2146, 43.28, 36277905, "France", 1850], + [2182, 38.37, 33663143, "Germany", 1850], + [1287, 36.61, 74711, "Iceland", 1850], + [1055, 25.4424, 196657653, "India", 1850], + [1125, 36.41987692, 32223184, "Japan", 1850], + [1898, 34.05, 94934, "New Zealand", 1850], + [1675, 49.53, 1401619, "Norway", 1850], + [1468, 35.9, 13219914, "Poland", 1850], + [1778, 29.5734572, 41023821, "Russia", 1850], + [1436, 35, 11074762, "Turkey", 1850], + [4480, 42.8, 22623571, "United Kingdom", 1850], + [3059, 39.41, 24136293, "United States", 1850], + [4795, 34.05, 1256048, "Australia", 1860], + [2406, 41.541504, 3231465, "Canada", 1860], + [1023, 28.85, 380047548, "China", 1860], + [1733, 36.24, 1324000, "Cuba", 1860], + [1594, 38.15099864, 1734254, "Finland", 1860], + [3086, 43.33, 37461341, "France", 1860], + [2509, 38.37, 36383150, "Germany", 1860], + [1435, 19.76, 79662, "Iceland", 1860], + [1056, 23, 204966302, "India", 1860], + [1168, 36.42385231, 33176900, "Japan", 1860], + [3674, 34.05, 157114, "New Zealand", 1860], + [2033, 50, 1580366, "Norway", 1860], + [1525, 35.9, 14848599, "Poland", 1860], + [1896, 29.5734572, 44966686, "Russia", 1860], + [1514, 35, 11428718, "Turkey", 1860], + [5268, 43.01, 24783522, "United Kingdom", 1860], + [3714, 39.41, 31936643, "United States", 1860], + [5431, 34.05, 1724213, "Australia", 1870], + [2815, 42.460624, 3817167, "Canada", 1870], + [1099, 31.95714286, 363661158, "China", 1870], + [1946, 29.66, 1424672, "Cuba", 1870], + [1897, 45.66140699, 1847468, "Finland", 1870], + [3297, 36.41, 38170355, "France", 1870], + [2819, 38.37, 39702235, "Germany", 1870], + [1599, 38.37, 84941, "Iceland", 1870], + [1058, 25.4424, 213725049, "India", 1870], + [1213, 36.59264, 34638021, "Japan", 1870], + [5156, 34.05, 301045, "New Zealand", 1870], + [2483, 50.86, 1746718, "Norway", 1870], + [1584, 35.9, 17013787, "Poland", 1870], + [2023, 31.12082604, 49288504, "Russia", 1870], + [1597, 35, 11871788, "Turkey", 1870], + [6046, 40.95, 27651628, "United Kingdom", 1870], + [4058, 39.41, 40821569, "United States", 1870], + [7120, 39.34215686, 2253007, "Australia", 1880], + [3021, 44.512464, 4360348, "Canada", 1880], + [1015, 32, 365544192, "China", 1880], + [2185, 36.84, 1555081, "Cuba", 1880], + [1925, 39.67, 2047577, "Finland", 1880], + [3555, 42.73, 39014053, "France", 1880], + [3057, 38.905, 43577358, "Germany", 1880], + [2035, 42.32, 90546, "Iceland", 1880], + [1084, 25.4424, 223020377, "India", 1880], + [1395, 37.03648, 36826469, "Japan", 1880], + [6241, 38.51282051, 505065, "New Zealand", 1880], + [2827, 51.91, 1883716, "Norway", 1880], + [1848, 35.9, 19669587, "Poland", 1880], + [2158, 30.20106663, 53996807, "Russia", 1880], + [1535, 35, 12474351, "Turkey", 1880], + [6553, 43.78, 30849957, "United Kingdom", 1880], + [5292, 39.41, 51256498, "United States", 1880], + [7418, 44.63431373, 3088808, "Australia", 1890], + [3963, 45.12972, 4908078, "Canada", 1890], + [918, 32, 377135349, "China", 1890], + [2454, 39.54, 1658274, "Cuba", 1890], + [2305, 44.61, 2358344, "Finland", 1890], + [3639, 43.36, 40015501, "France", 1890], + [3733, 40.91, 48211294, "Germany", 1890], + [2009, 36.58, 96517, "Iceland", 1890], + [1163, 24.384, 232819584, "India", 1890], + [1606, 37.67568, 39878734, "Japan", 1890], + [6265, 42.97564103, 669985, "New Zealand", 1890], + [3251, 48.6, 2003954, "Norway", 1890], + [2156, 37.41086957, 22618933, "Poland", 1890], + [2233, 29.93047652, 59151534, "Russia", 1890], + [1838, 35, 13188522, "Turkey", 1890], + [7169, 44.75, 34215580, "United Kingdom", 1890], + [5646, 45.21, 63810074, "United States", 1890], + [6688, 49.92647059, 3743708, "Australia", 1900], + [4858, 48.288448, 5530806, "Canada", 1900], + [894, 32, 395184556, "China", 1900], + [2756, 33.11248, 1762227, "Cuba", 1900], + [2789, 41.8, 2633389, "Finland", 1900], + [4314, 45.08, 40628638, "France", 1900], + [4596, 43.915, 55293434, "Germany", 1900], + [2352, 46.64, 102913, "Iceland", 1900], + [1194, 18.35, 243073946, "India", 1900], + [1840, 38.6, 44040263, "Japan", 1900], + [7181, 47.43846154, 815519, "New Zealand", 1900], + [3643, 53.47, 2214923, "Norway", 1900], + [2583, 40.4326087, 24700965, "Poland", 1900], + [3087, 30.74960789, 64836675, "Russia", 1900], + [1985, 35, 13946634, "Turkey", 1900], + [8013, 46.32, 37995759, "United Kingdom", 1900], + [6819, 48.92818182, 77415610, "United States", 1900], + [8695, 55.21862745, 4408209, "Australia", 1910], + [6794, 52.123024, 7181200, "Canada", 1910], + [991, 32, 417830774, "China", 1910], + [3095, 35.21936, 2268558, "Cuba", 1910], + [3192, 48.53, 2930441, "Finland", 1910], + [4542, 51.37, 41294572, "France", 1910], + [5162, 48.40833333, 64064129, "Germany", 1910], + [3012, 52.67, 109714, "Iceland", 1910], + [1391, 23.18032, 253761202, "India", 1910], + [1998, 39.9736, 49314848, "Japan", 1910], + [8896, 51.90128205, 1044340, "New Zealand", 1910], + [4332, 57.99, 2383631, "Norway", 1910], + [2846, 43.45434783, 26493422, "Poland", 1910], + [3487, 31.40217766, 71044207, "Russia", 1910], + [2144, 35, 14746479, "Turkey", 1910], + [8305, 53.99, 41804912, "United Kingdom", 1910], + [8287, 51.8, 93559186, "United States", 1910], + [7867, 60.51078431, 5345428, "Australia", 1920], + [6430, 56.569064, 8764205, "Canada", 1920], + [1012, 32, 462750597, "China", 1920], + [4042, 37.38208, 3067116, "Cuba", 1920], + [3097, 47.55, 3140763, "Finland", 1920], + [4550, 51.6, 39069937, "France", 1920], + [4482, 53.5, 62277173, "Germany", 1920], + [2514, 54.58, 117013, "Iceland", 1920], + [1197, 24.71866667, 267795301, "India", 1920], + [2496, 42.04432, 55545937, "Japan", 1920], + [9453, 56.36410256, 1236395, "New Zealand", 1920], + [5483, 58.89, 2634635, "Norway", 1920], + [3276, 46.47608696, 24166006, "Poland", 1920], + [1489, 20.5, 77871987, "Russia", 1920], + [1525, 29, 14200404, "Turkey", 1920], + [8316, 56.6, 43825720, "United Kingdom", 1920], + [9181, 55.4, 108441644, "United States", 1920], + [7714, 64.998, 6473803, "Australia", 1930], + [7976, 58.94, 10450983, "Canada", 1930], + [1055, 33.26984, 481222579, "China", 1930], + [5027, 42.03308, 3918827, "Cuba", 1930], + [4489, 54.438, 3450505, "Finland", 1930], + [6835, 56.938, 41662571, "France", 1930], + [6791, 59.4991686, 66439556, "Germany", 1930], + [4444, 60.228, 124871, "Iceland", 1930], + [1244, 28.8016, 285470839, "India", 1930], + [2592, 46.65403, 63863524, "Japan", 1930], + [8359, 60.86092308, 1491937, "New Zealand", 1930], + [7369, 64.074, 2807922, "Norway", 1930], + [3591, 49.52382609, 28169922, "Poland", 1930], + [3779, 36.428, 85369549, "Russia", 1930], + [2323, 35.7818, 14930772, "Turkey", 1930], + [8722, 60.85, 45957969, "United Kingdom", 1930], + [10139, 59.556, 125055606, "United States", 1930], + [10057, 66.336, 7052012, "Australia", 1940], + [8871, 63.99, 11655920, "Canada", 1940], + [841, 33.30311174, 509858820, "China", 1940], + [4631, 48.5472, 4672303, "Cuba", 1940], + [5439, 46.586, 3696232, "Finland", 1940], + [4821, 49.586, 40927546, "France", 1940], + [9711, 60.73821096, 71244059, "Germany", 1940], + [5373, 65.786, 133257, "Iceland", 1940], + [1081, 32.13056, 324372335, "India", 1940], + [3888, 49.052, 72709185, "Japan", 1940], + [10673, 65.35774359, 1629869, "New Zealand", 1940], + [8349, 65.818, 2971546, "Norway", 1940], + [3696, 44.752, 30041062, "Poland", 1940], + [5632, 41.056, 93588981, "Russia", 1940], + [3163, 34.5396, 17777172, "Turkey", 1940], + [10935, 60.89, 48235963, "United Kingdom", 1940], + [11320, 63.192, 134354133, "United States", 1940], + [12073, 69.134, 8177344, "Australia", 1950], + [12022, 68.25, 13736997, "Canada", 1950], + [535, 39.9994, 544112923, "China", 1950], + [8630, 59.8384, 5919997, "Cuba", 1950], + [7198, 64.144, 4008299, "Finland", 1950], + [7914, 66.594, 41879607, "France", 1950], + [7251, 67.0215058, 69786246, "Germany", 1950], + [8670, 71.004, 142656, "Iceland", 1950], + [908, 34.6284, 376325205, "India", 1950], + [2549, 59.378, 82199470, "Japan", 1950], + [14391, 69.392, 1908001, "New Zealand", 1950], + [11452, 71.492, 3265278, "Norway", 1950], + [4670, 59.123, 24824013, "Poland", 1950], + [7514, 57.084, 102798657, "Russia", 1950], + [3103, 42.5164, 21238496, "Turkey", 1950], + [11135, 68.58, 50616012, "United Kingdom", 1950], + [15319, 67.988, 157813040, "United States", 1950], + [12229, 68.8378, 8417640, "Australia", 1951], + [12419, 68.519, 14099994, "Canada", 1951], + [582, 40.936264, 558820362, "China", 1951], + [9245, 60.18618, 6051290, "Cuba", 1951], + [7738, 65.5708, 4049689, "Finland", 1951], + [8301, 66.3308, 42071027, "France", 1951], + [7884, 67.18742266, 70111671, "Germany", 1951], + [8350, 71.0438, 144928, "Iceland", 1951], + [908, 34.95868, 382231042, "India", 1951], + [2728, 61.0706, 83794452, "Japan", 1951], + [13032, 69.2654, 1947802, "New Zealand", 1951], + [11986, 72.4284, 3300422, "Norway", 1951], + [4801, 59.7336, 25264029, "Poland", 1951], + [7424, 57.5768, 104306354, "Russia", 1951], + [3701, 42.78358, 21806355, "Turkey", 1951], + [11416, 68.176, 50620538, "United Kingdom", 1951], + [16198, 68.0836, 159880756, "United States", 1951], + [12084, 69.2416, 8627052, "Australia", 1952], + [12911, 68.718, 14481497, "Canada", 1952], + [631, 41.873128, 570764965, "China", 1952], + [9446, 60.82796, 6180031, "Cuba", 1952], + [7914, 66.4476, 4095130, "Finland", 1952], + [8446, 67.6276, 42365756, "France", 1952], + [8561, 67.51033952, 70421462, "Germany", 1952], + [8120, 72.4836, 147681, "Iceland", 1952], + [912, 35.62796, 388515758, "India", 1952], + [3015, 63.1132, 85174909, "Japan", 1952], + [13281, 69.4988, 1992619, "New Zealand", 1952], + [12316, 72.5548, 3333895, "Norway", 1952], + [4832, 60.9112, 25738253, "Poland", 1952], + [7775, 57.9696, 105969442, "Russia", 1952], + [3963, 43.25976, 22393931, "Turkey", 1952], + [11367, 69.472, 50683596, "United Kingdom", 1952], + [16508, 68.2992, 162280405, "United States", 1952], + [12228, 69.8254, 8821938, "Australia", 1953], + [13158, 69.097, 14882050, "Canada", 1953], + [692, 42.809992, 580886559, "China", 1953], + [8192, 61.46974, 6304524, "Cuba", 1953], + [7877, 66.5044, 4142353, "Finland", 1953], + [8622, 67.5644, 42724452, "France", 1953], + [9252, 67.82125638, 70720721, "Germany", 1953], + [9169, 72.3034, 150779, "Iceland", 1953], + [947, 36.30024, 395137696, "India", 1953], + [3168, 63.4558, 86378004, "Japan", 1953], + [13388, 70.3522, 2040015, "New Zealand", 1953], + [12707, 73.0312, 3366281, "Norway", 1953], + [5027, 62.0038, 26236679, "Poland", 1953], + [7981, 58.7624, 107729541, "Russia", 1953], + [4361, 43.77694, 22999018, "Turkey", 1953], + [11751, 69.738, 50792671, "United Kingdom", 1953], + [16974, 68.6448, 164941716, "United States", 1953], + [12694, 69.9792, 9014508, "Australia", 1954], + [12687, 69.956, 15300472, "Canada", 1954], + [694, 44.663056, 589955812, "China", 1954], + [8492, 62.11152, 6424173, "Cuba", 1954], + [8470, 67.4612, 4189559, "Finland", 1954], + [9006, 68.4412, 43118110, "France", 1954], + [9926, 68.12117324, 71015688, "Germany", 1954], + [9821, 73.3532, 154110, "Iceland", 1954], + [962, 36.97552, 402065915, "India", 1954], + [3280, 64.6984, 87438747, "Japan", 1954], + [14907, 70.4656, 2088194, "New Zealand", 1954], + [13247, 73.1076, 3398028, "Norway", 1954], + [5224, 63.0134, 26750026, "Poland", 1954], + [8234, 60.7552, 109537868, "Russia", 1954], + [3892, 44.33512, 23619469, "Turkey", 1954], + [12173, 70.104, 50938227, "United Kingdom", 1954], + [16558, 69.4304, 167800046, "United States", 1954], + [13082, 70.303, 9212824, "Australia", 1955], + [13513, 70.015, 15733858, "Canada", 1955], + [706, 46.1666, 598574241, "China", 1955], + [8757, 62.7523, 6539470, "Cuba", 1955], + [8802, 67.258, 4235423, "Finland", 1955], + [9453, 68.708, 43528065, "France", 1955], + [10998, 68.4080901, 71313740, "Germany", 1955], + [10548, 73.293, 157584, "Iceland", 1955], + [963, 37.6538, 409280196, "India", 1955], + [3464, 65.861, 88389994, "Japan", 1955], + [14883, 70.599, 2136000, "New Zealand", 1955], + [13438, 73.314, 3429431, "Norway", 1955], + [5386, 63.939, 27269745, "Poland", 1955], + [8787, 63.148, 111355224, "Russia", 1955], + [4156, 44.9343, 24253200, "Turkey", 1955], + [12531, 70.07, 51113711, "United Kingdom", 1955], + [17409, 69.476, 170796378, "United States", 1955], + [13217, 70.1868, 9420602, "Australia", 1956], + [14253, 70.004, 16177451, "Canada", 1956], + [736, 48.536704, 607167524, "China", 1956], + [9424, 63.39308, 6652086, "Cuba", 1956], + [8971, 67.8748, 4279108, "Finland", 1956], + [9907, 68.7448, 43946534, "France", 1956], + [11751, 68.70345102, 71623569, "Germany", 1956], + [10575, 72.9728, 161136, "Iceland", 1956], + [993, 38.33608, 416771502, "India", 1956], + [3646, 65.7236, 89262489, "Japan", 1956], + [15358, 70.8624, 2182943, "New Zealand", 1956], + [14054, 73.3604, 3460640, "Norway", 1956], + [5530, 64.7816, 27787997, "Poland", 1956], + [9465, 64.6408, 113152347, "Russia", 1956], + [4122, 45.57448, 24898170, "Turkey", 1956], + [12572, 70.336, 51315724, "United Kingdom", 1956], + [17428, 69.5516, 173877321, "United States", 1956], + [13191, 70.4706, 9637408, "Australia", 1957], + [14177, 69.923, 16624767, "Canada", 1957], + [780, 48.587368, 615992182, "China", 1957], + [10636, 64.03586, 6764787, "Cuba", 1957], + [9302, 67.3716, 4320250, "Finland", 1957], + [10442, 69.1816, 44376073, "France", 1957], + [12385, 68.62532856, 71955005, "Germany", 1957], + [10295, 73.4626, 164721, "Iceland", 1957], + [959, 39.02236, 424541513, "India", 1957], + [3843, 65.5962, 90084818, "Japan", 1957], + [15441, 70.3858, 2229176, "New Zealand", 1957], + [14379, 73.3068, 3491657, "Norway", 1957], + [5730, 65.5442, 28297669, "Poland", 1957], + [9496, 63.7336, 114909562, "Russia", 1957], + [4943, 46.25466, 25552398, "Turkey", 1957], + [12702, 70.452, 51543847, "United Kingdom", 1957], + [17430, 69.3272, 176995108, "United States", 1957], + [13545, 71.0244, 9859257, "Australia", 1958], + [14056, 70.582, 17067983, "Canada", 1958], + [889, 48.143792, 625155626, "China", 1958], + [10501, 64.67964, 6881209, "Cuba", 1958], + [9276, 68.5084, 4358901, "Finland", 1958], + [10681, 70.4184, 44827950, "France", 1958], + [12884, 69.36929231, 72318498, "Germany", 1958], + [10896, 73.4224, 168318, "Iceland", 1958], + [1005, 39.71364, 432601236, "India", 1958], + [3996, 67.2188, 90883290, "Japan", 1958], + [15688, 71.0192, 2275392, "New Zealand", 1958], + [14285, 73.2932, 3522361, "Norway", 1958], + [5923, 66.0188, 28792427, "Poland", 1958], + [10037, 66.6264, 116615781, "Russia", 1958], + [5252, 46.97084, 26214022, "Turkey", 1958], + [12672, 70.628, 51800117, "United Kingdom", 1958], + [16961, 69.5928, 180107612, "United States", 1958], + [14076, 70.5982, 10079604, "Australia", 1959], + [14289, 70.621, 17498573, "Canada", 1959], + [958, 36.336856, 634649557, "China", 1959], + [9234, 65.32842, 7005486, "Cuba", 1959], + [9751, 68.6852, 4395427, "Finland", 1959], + [10911, 70.4552, 45319442, "France", 1959], + [13759, 69.48021979, 72724260, "Germany", 1959], + [10865, 72.6522, 171919, "Iceland", 1959], + [1002, 40.41292, 440968677, "India", 1959], + [4288, 67.6114, 91681713, "Japan", 1959], + [16454, 70.9326, 2322669, "New Zealand", 1959], + [14797, 73.4196, 3552545, "Norway", 1959], + [6009, 65.6314, 29266789, "Poland", 1959], + [9755, 67.3692, 118266807, "Russia", 1959], + [4869, 47.72102, 26881379, "Turkey", 1959], + [13122, 70.724, 52088147, "United Kingdom", 1959], + [17909, 69.8084, 183178348, "United States", 1959], + [14346, 71.042, 10292328, "Australia", 1960], + [14414, 71, 17909232, "Canada", 1960], + [889, 29.51112, 644450173, "China", 1960], + [9213, 65.9852, 7141129, "Cuba", 1960], + [10560, 68.882, 4430228, "Finland", 1960], + [11642, 70.672, 45865699, "France", 1960], + [14808, 69.40190727, 73179665, "Germany", 1960], + [10993, 74.082, 175520, "Iceland", 1960], + [1048, 41.1222, 449661874, "India", 1960], + [4756, 67.904, 92500754, "Japan", 1960], + [16179, 71.396, 2371999, "New Zealand", 1960], + [15542, 73.436, 3582016, "Norway", 1960], + [6248, 67.964, 29716363, "Poland", 1960], + [10496, 68.382, 119860289, "Russia", 1960], + [4735, 48.4992, 27553280, "Turkey", 1960], + [13697, 70.94, 52410496, "United Kingdom", 1960], + [18059, 69.734, 186176524, "United States", 1960], + [14126, 71.3158, 10494911, "Australia", 1961], + [14545, 71.229, 18295922, "Canada", 1961], + [558, 31.930824, 654625069, "China", 1961], + [9248, 66.64998, 7289828, "Cuba", 1961], + [11286, 68.9088, 4463432, "Finland", 1961], + [12168, 71.2588, 46471083, "France", 1961], + [15317, 69.99702797, 73686490, "Germany", 1961], + [10801, 73.4618, 179106, "Iceland", 1961], + [1051, 41.84348, 458691457, "India", 1961], + [5276, 68.5566, 93357259, "Japan", 1961], + [16664, 71.1194, 2423769, "New Zealand", 1961], + [16425, 73.4424, 3610710, "Norway", 1961], + [6669, 68.0866, 30138099, "Poland", 1961], + [10908, 68.6248, 121390327, "Russia", 1961], + [4691, 49.30038, 28229291, "Turkey", 1961], + [13887, 70.686, 52765864, "United Kingdom", 1961], + [18170, 70.1396, 189077076, "United States", 1961], + [14742, 71.0896, 10691220, "Australia", 1962], + [15276, 71.258, 18659663, "Canada", 1962], + [567, 42.274688, 665426760, "China", 1962], + [9273, 67.32476, 7450404, "Cuba", 1962], + [11560, 68.6156, 4494623, "Finland", 1962], + [12767, 70.7956, 47121575, "France", 1962], + [15872, 70.16889372, 74238494, "Germany", 1962], + [11489, 73.6716, 182640, "Iceland", 1962], + [1046, 42.57776, 468054145, "India", 1962], + [5686, 68.8392, 94263646, "Japan", 1962], + [16646, 71.3828, 2477328, "New Zealand", 1962], + [16793, 73.3188, 3638791, "Norway", 1962], + [6511, 67.7492, 30530513, "Poland", 1962], + [11027, 68.2776, 122842753, "Russia", 1962], + [4849, 50.11556, 28909985, "Turkey", 1962], + [13897, 70.752, 53146634, "United Kingdom", 1962], + [18966, 70.0252, 191860710, "United States", 1962], + [15357, 71.1534, 10892700, "Australia", 1963], + [15752, 71.267, 19007305, "Canada", 1963], + [635, 49.619432, 677332765, "China", 1963], + [9244, 68.00654, 7618359, "Cuba", 1963], + [11858, 69.0224, 4522727, "Finland", 1963], + [13235, 70.6524, 47781535, "France", 1963], + [16221, 70.26131586, 74820389, "Germany", 1963], + [12447, 72.9714, 186056, "Iceland", 1963], + [1071, 43.32404, 477729958, "India", 1963], + [6106, 69.9218, 95227653, "Japan", 1963], + [17340, 71.4562, 2530791, "New Zealand", 1963], + [17347, 72.9552, 3666690, "Norway", 1963], + [6836, 68.6818, 30893775, "Poland", 1963], + [10620, 68.7404, 124193114, "Russia", 1963], + [5188, 50.93674, 29597047, "Turkey", 1963], + [14393, 70.658, 53537821, "United Kingdom", 1963], + [19497, 69.8508, 194513911, "United States", 1963], + [16098, 70.8172, 11114995, "Australia", 1964], + [16464, 71.646, 19349346, "Canada", 1964], + [713, 50.988016, 690932043, "China", 1964], + [9179, 68.69332, 7787149, "Cuba", 1964], + [12389, 69.2292, 4546343, "Finland", 1964], + [13969, 71.6192, 48402900, "France", 1964], + [17100, 70.82344196, 75410766, "Germany", 1964], + [13450, 73.5612, 189276, "Iceland", 1964], + [1125, 44.07932, 487690114, "India", 1964], + [6741, 70.3944, 96253064, "Japan", 1964], + [17837, 71.4996, 2581578, "New Zealand", 1964], + [18118, 73.4516, 3694987, "Norway", 1964], + [7078, 68.9144, 31229448, "Poland", 1964], + [11836, 69.5332, 125412397, "Russia", 1964], + [5296, 51.75292, 30292969, "Turkey", 1964], + [15067, 71.444, 53920055, "United Kingdom", 1964], + [20338, 70.1364, 197028908, "United States", 1964], + [16601, 71.151, 11368011, "Australia", 1965], + [17243, 71.745, 19693538, "Canada", 1965], + [772, 53.26108, 706590947, "China", 1965], + [9116, 69.3761, 7951928, "Cuba", 1965], + [13006, 68.986, 4564690, "Finland", 1965], + [14514, 71.456, 48952283, "France", 1965], + [17838, 70.81075623, 75990737, "Germany", 1965], + [14173, 73.831, 192251, "Iceland", 1965], + [1053, 44.8386, 497920270, "India", 1965], + [7048, 70.447, 97341852, "Japan", 1965], + [18632, 71.433, 2628003, "New Zealand", 1965], + [18980, 73.568, 3724065, "Norway", 1965], + [7409, 69.617, 31539695, "Poland", 1965], + [12363, 69.116, 126483874, "Russia", 1965], + [5309, 52.5551, 31000167, "Turkey", 1965], + [15292, 71.43, 54278349, "United Kingdom", 1965], + [21361, 70.212, 199403532, "United States", 1965], + [16756, 70.9948, 11657281, "Australia", 1966], + [18022, 71.874, 20041006, "Canada", 1966], + [826, 54.364464, 724490033, "China", 1966], + [9436, 70.04688, 8110428, "Cuba", 1966], + [13269, 69.5028, 4577033, "Finland", 1966], + [15158, 71.8728, 49411342, "France", 1966], + [18262, 70.92828395, 76558016, "Germany", 1966], + [15166, 73.2208, 194935, "Iceland", 1966], + [1037, 45.59388, 508402908, "India", 1966], + [7724, 71.2596, 98494630, "Japan", 1966], + [19467, 71.2964, 2668590, "New Zealand", 1966], + [19588, 73.8444, 3754010, "Norway", 1966], + [7818, 70.0296, 31824145, "Poland", 1966], + [12823, 69.1788, 127396324, "Russia", 1966], + [5906, 53.33228, 31718266, "Turkey", 1966], + [15494, 71.346, 54606608, "United Kingdom", 1966], + [22495, 70.2276, 201629471, "United States", 1966], + [17570, 71.2786, 11975795, "Australia", 1967], + [18240, 72.083, 20389445, "Canada", 1967], + [719, 55.889368, 744365635, "China", 1967], + [10372, 70.69866, 8263547, "Cuba", 1967], + [13477, 69.6796, 4584264, "Finland", 1967], + [15759, 71.8696, 49791771, "France", 1967], + [18311, 71.15404398, 77106876, "Germany", 1967], + [14734, 73.7206, 197356, "Iceland", 1967], + [1096, 46.33916, 519162069, "India", 1967], + [8454, 71.5522, 99711082, "Japan", 1967], + [18309, 71.6798, 2704205, "New Zealand", 1967], + [20686, 73.9108, 3784579, "Norway", 1967], + [8044, 69.7322, 32085011, "Poland", 1967], + [13256, 68.9616, 128165823, "Russia", 1967], + [6020, 54.08346, 32448404, "Turkey", 1967], + [15777, 71.972, 54904680, "United Kingdom", 1967], + [22803, 70.5532, 203713082, "United States", 1967], + [18261, 70.9124, 12305530, "Australia", 1968], + [18900, 72.242, 20739031, "Canada", 1968], + [669, 56.860432, 765570668, "China", 1968], + [9626, 71.32644, 8413329, "Cuba", 1968], + [13726, 69.6364, 4589226, "Finland", 1968], + [16321, 71.8664, 50126895, "France", 1968], + [19254, 70.80345367, 77611000, "Germany", 1968], + [13752, 73.9304, 199634, "Iceland", 1968], + [1095, 47.07144, 530274729, "India", 1968], + [9439, 71.8748, 100988866, "Japan", 1968], + [18082, 71.3432, 2738283, "New Zealand", 1968], + [21022, 73.7872, 3815399, "Norway", 1968], + [8473, 70.3748, 32330582, "Poland", 1968], + [13902, 68.9144, 128837792, "Russia", 1968], + [6295, 54.80964, 33196289, "Turkey", 1968], + [16357, 71.598, 55171084, "United Kingdom", 1968], + [23647, 70.2088, 205687611, "United States", 1968], + [18949, 71.3262, 12621240, "Australia", 1969], + [19614, 72.401, 21089228, "Canada", 1969], + [732, 58.367416, 787191243, "China", 1969], + [9377, 71.92622, 8563191, "Cuba", 1969], + [15058, 69.5132, 4595807, "Finland", 1969], + [17339, 71.6032, 50466183, "France", 1969], + [20409, 70.65682236, 78038271, "Germany", 1969], + [13983, 73.7002, 201941, "Iceland", 1969], + [1141, 47.78972, 541844848, "India", 1969], + [10548, 72.1074, 102323674, "Japan", 1969], + [19745, 71.7166, 2775684, "New Zealand", 1969], + [21845, 73.4936, 3845932, "Norway", 1969], + [8331, 69.8674, 32571673, "Poland", 1969], + [13972, 68.3872, 129475269, "Russia", 1969], + [6470, 55.51382, 33969201, "Turkey", 1969], + [16616, 71.554, 55406435, "United Kingdom", 1969], + [24147, 70.4444, 207599308, "United States", 1969], + [19719, 71, 12904760, "Australia", 1970], + [19842, 72.6, 21439200, "Canada", 1970], + [848, 60, 808510713, "China", 1970], + [8918, 72.5, 8715123, "Cuba", 1970], + [16245, 70.2, 4606740, "Finland", 1970], + [18185, 72.5, 50843830, "France", 1970], + [21218, 70.9, 78366605, "Germany", 1970], + [14937, 73.8, 204392, "Iceland", 1970], + [1170, 48.5, 553943226, "India", 1970], + [14203, 72.2, 103707537, "Japan", 1970], + [19200, 71.5, 2819548, "New Zealand", 1970], + [22186, 73.9, 3875719, "Norway", 1970], + [8705, 70, 32816751, "Poland", 1970], + [14915, 68.5, 130126383, "Russia", 1970], + [6740, 56.2, 34772031, "Turkey", 1970], + [16933, 71.8, 55611401, "United Kingdom", 1970], + [23908, 70.7, 209485807, "United States", 1970], + [20176, 71.3, 13150591, "Australia", 1971], + [20688, 72.9, 21790338, "Canada", 1971], + [876, 60.6, 829367784, "China", 1971], + [9471, 73.2, 8869961, "Cuba", 1971], + [16564, 70.5, 4623389, "Finland", 1971], + [18891, 72.6, 51273975, "France", 1971], + [21695, 71, 78584779, "Germany", 1971], + [16687, 73.8, 207050, "Iceland", 1971], + [1154, 48.9, 566605402, "India", 1971], + [14673, 72.8, 105142875, "Japan", 1971], + [19871, 71.6, 2871810, "New Zealand", 1971], + [23239, 74.1, 3904750, "Norway", 1971], + [9256, 70.2, 33068997, "Poland", 1971], + [15170, 68.6, 130808492, "Russia", 1971], + [6765, 56.9, 35608079, "Turkey", 1971], + [17207, 72, 55785325, "United Kingdom", 1971], + [24350, 71, 211357912, "United States", 1971], + [20385, 71.7, 13364238, "Australia", 1972], + [21532, 72.9, 22141998, "Canada", 1972], + [843, 61.1, 849787991, "China", 1972], + [9745, 73.9, 9025299, "Cuba", 1972], + [17722, 70.9, 4644847, "Finland", 1972], + [19570, 72.8, 51741044, "France", 1972], + [22497, 71.2, 78700104, "Germany", 1972], + [17413, 73.9, 209868, "Iceland", 1972], + [1125, 49.3, 579800632, "India", 1972], + [15694, 73.2, 106616535, "Japan", 1972], + [20349, 71.8, 2930469, "New Zealand", 1972], + [24308, 74.3, 3932945, "Norway", 1972], + [9854, 70.6, 33328713, "Poland", 1972], + [15113, 68.7, 131517584, "Russia", 1972], + [7186, 57.7, 36475356, "Turkey", 1972], + [17793, 72, 55927492, "United Kingdom", 1972], + [25374, 71.3, 213219515, "United States", 1972], + [21185, 72, 13552190, "Australia", 1973], + [22797, 73.1, 22488744, "Canada", 1973], + [894, 61.7, 869474823, "China", 1973], + [10439, 74.1, 9176051, "Cuba", 1973], + [18804, 71.3, 4668813, "Finland", 1973], + [20486, 73.1, 52214014, "France", 1973], + [23461, 71.5, 78732884, "Germany", 1973], + [18360, 74.1, 212731, "Iceland", 1973], + [1151, 49.9, 593451889, "India", 1973], + [16731, 73.5, 108085729, "Japan", 1973], + [21342, 71.8, 2989985, "New Zealand", 1973], + [25278, 74.5, 3959705, "Norway", 1973], + [10504, 70.9, 33597810, "Poland", 1973], + [16236, 68.7, 132254362, "Russia", 1973], + [7442, 58.3, 37366922, "Turkey", 1973], + [19043, 72, 56039166, "United Kingdom", 1973], + [26567, 71.6, 215092900, "United States", 1973], + [21383, 72.1, 13725400, "Australia", 1974], + [23405, 73.2, 22823272, "Canada", 1974], + [888, 62.1, 888132761, "China", 1974], + [10805, 74.3, 9315371, "Cuba", 1974], + [19273, 71.4, 4691818, "Finland", 1974], + [20997, 73.3, 52647616, "France", 1974], + [23662, 71.8, 78713928, "Germany", 1974], + [19123, 74.3, 215465, "Iceland", 1974], + [1139, 50.4, 607446519, "India", 1974], + [16320, 73.9, 109495053, "Japan", 1974], + [22131, 72, 3042573, "New Zealand", 1974], + [26252, 74.7, 3984291, "Norway", 1974], + [11020, 71.2, 33877397, "Poland", 1974], + [16594, 68.6, 133012558, "Russia", 1974], + [7991, 58.9, 38272701, "Turkey", 1974], + [18801, 72.3, 56122405, "United Kingdom", 1974], + [26258, 72.1, 217001865, "United States", 1974], + [21708, 72.5, 13892674, "Australia", 1975], + [23593, 73.6, 23140609, "Canada", 1975], + [920, 62.6, 905580445, "China", 1975], + [11176, 74.6, 9438445, "Cuba", 1975], + [19409, 71.6, 4711459, "Finland", 1975], + [20851, 73.2, 53010727, "France", 1975], + [23630, 71.9, 78667327, "Germany", 1975], + [19023, 74.7, 217958, "Iceland", 1975], + [1212, 50.9, 621703641, "India", 1975], + [16632, 74.4, 110804519, "Japan", 1975], + [21467, 72.1, 3082883, "New Zealand", 1975], + [27553, 74.8, 4006221, "Norway", 1975], + [11430, 70.9, 34168112, "Poland", 1975], + [16530, 68.2, 133788113, "Russia", 1975], + [8381, 59.5, 39185637, "Turkey", 1975], + [18699, 72.6, 56179925, "United Kingdom", 1975], + [25934, 72.6, 218963561, "United States", 1975], + [22372, 73, 14054956, "Australia", 1976], + [24563, 73.9, 23439940, "Canada", 1976], + [891, 62.4, 921688199, "China", 1976], + [11334, 74.6, 9544268, "Cuba", 1976], + [19268, 72, 4726803, "Finland", 1976], + [21661, 73.4, 53293030, "France", 1976], + [24904, 72.3, 78604473, "Germany", 1976], + [19978, 75.2, 220162, "Iceland", 1976], + [1201, 51.4, 636182810, "India", 1976], + [17117, 74.9, 111992858, "Japan", 1976], + [21749, 72.3, 3108745, "New Zealand", 1976], + [29117, 75, 4025297, "Norway", 1976], + [11605, 70.8, 34468877, "Poland", 1976], + [17192, 68, 134583945, "Russia", 1976], + [9142, 60, 40100696, "Turkey", 1976], + [19207, 72.9, 56212943, "United Kingdom", 1976], + [27041, 72.9, 220993166, "United States", 1976], + [22373, 73.4, 14211657, "Australia", 1977], + [25095, 74.2, 23723801, "Canada", 1977], + [904, 63.3, 936554514, "China", 1977], + [11712, 74.4, 9634677, "Cuba", 1977], + [19261, 72.4, 4738949, "Finland", 1977], + [22270, 73.8, 53509578, "France", 1977], + [25678, 72.6, 78524727, "Germany", 1977], + [21583, 75.6, 222142, "Iceland", 1977], + [1266, 52, 650907559, "India", 1977], + [17705, 75.3, 113067848, "Japan", 1977], + [20623, 72.4, 3122551, "New Zealand", 1977], + [30319, 75.2, 4041789, "Norway", 1977], + [11713, 70.6, 34779313, "Poland", 1977], + [17487, 67.8, 135406786, "Russia", 1977], + [8863, 60.9, 41020211, "Turkey", 1977], + [19684, 73.1, 56224944, "United Kingdom", 1977], + [27990, 73.2, 223090871, "United States", 1977], + [22763, 73.8, 14368543, "Australia", 1978], + [25853, 74.4, 23994948, "Canada", 1978], + [1016, 63.7, 950537317, "China", 1978], + [12312, 74.5, 9711393, "Cuba", 1978], + [19608, 72.9, 4749940, "Finland", 1978], + [22928, 74.1, 53685486, "France", 1978], + [26444, 72.7, 78426715, "Germany", 1978], + [22659, 76, 224019, "Iceland", 1978], + [1305, 52.6, 665936435, "India", 1978], + [18484, 75.7, 114054587, "Japan", 1978], + [20707, 72.7, 3129098, "New Zealand", 1978], + [31348, 75.3, 4056280, "Norway", 1978], + [12033, 70.7, 35100942, "Poland", 1978], + [17818, 67.7, 136259517, "Russia", 1978], + [8400, 61.4, 41953105, "Turkey", 1978], + [20337, 73, 56223974, "United Kingdom", 1978], + [29281, 73.5, 225239456, "United States", 1978], + [23697, 74.2, 14532401, "Australia", 1979], + [26665, 74.7, 24257594, "Canada", 1979], + [1059, 64, 964155176, "China", 1979], + [12519, 74.6, 9777287, "Cuba", 1979], + [20918, 73.3, 4762758, "Finland", 1979], + [23647, 74.3, 53857610, "France", 1979], + [27515, 72.9, 78305017, "Germany", 1979], + [23523, 76.4, 225972, "Iceland", 1979], + [1211, 53.1, 681358553, "India", 1979], + [19346, 76.1, 114993274, "Japan", 1979], + [21144, 73, 3135453, "New Zealand", 1979], + [32737, 75.5, 4069626, "Norway", 1979], + [11703, 70.7, 35435627, "Poland", 1979], + [17632, 67.4, 137144808, "Russia", 1979], + [8160, 62, 42912350, "Turkey", 1979], + [20871, 73.1, 56220089, "United Kingdom", 1979], + [29951, 73.7, 227411604, "United States", 1979], + [23872, 74.5, 14708323, "Australia", 1980], + [26678, 75, 24515788, "Canada", 1980], + [1073, 64.5, 977837433, "China", 1980], + [12284, 74.6, 9835177, "Cuba", 1980], + [21965, 73.7, 4779454, "Finland", 1980], + [23962, 74.5, 54053224, "France", 1980], + [27765, 73.1, 78159527, "Germany", 1980], + [24580, 76.7, 228127, "Iceland", 1980], + [1270, 53.6, 697229745, "India", 1980], + [19741, 76.3, 115912104, "Japan", 1980], + [21259, 73.2, 3146771, "New Zealand", 1980], + [34346, 75.7, 4082525, "Norway", 1980], + [11307, 70.6, 35782855, "Poland", 1980], + [17557, 67.3, 138063062, "Russia", 1980], + [7828, 62.7, 43905790, "Turkey", 1980], + [20417, 73.4, 56221513, "United Kingdom", 1980], + [29619, 73.8, 229588208, "United States", 1980], + [24308, 74.8, 14898019, "Australia", 1981], + [27171, 75.4, 24768525, "Canada", 1981], + [1099, 64.8, 991553829, "China", 1981], + [13224, 74.6, 9884219, "Cuba", 1981], + [22279, 74, 4800899, "Finland", 1981], + [24186, 74.8, 54279038, "France", 1981], + [27846, 73.4, 77990369, "Germany", 1981], + [25312, 76.9, 230525, "Iceland", 1981], + [1322, 54.2, 713561406, "India", 1981], + [20413, 76.7, 116821569, "Japan", 1981], + [22191, 73.5, 3164965, "New Zealand", 1981], + [34659, 75.8, 4095177, "Norway", 1981], + [10610, 71, 36145211, "Poland", 1981], + [17619, 67.5, 139006739, "Russia", 1981], + [8518, 63.2, 44936836, "Turkey", 1981], + [20149, 73.8, 56231020, "United Kingdom", 1981], + [30070, 74, 231765783, "United States", 1981], + [23884, 75, 15101227, "Australia", 1982], + [26031, 75.8, 25017501, "Canada", 1982], + [1175, 65.2, 1005328574, "China", 1982], + [13421, 74.7, 9925618, "Cuba", 1982], + [22873, 74.3, 4826135, "Finland", 1982], + [24753, 75, 54528408, "France", 1982], + [27645, 73.6, 77812348, "Germany", 1982], + [25455, 77.1, 233121, "Iceland", 1982], + [1334, 54.6, 730303461, "India", 1982], + [20951, 77, 117708919, "Japan", 1982], + [22436, 73.7, 3188664, "New Zealand", 1982], + [34704, 75.9, 4107655, "Norway", 1982], + [10420, 71.2, 36517072, "Poland", 1982], + [17951, 67.9, 139969243, "Russia", 1982], + [8323, 63.7, 45997940, "Turkey", 1982], + [20607, 74.1, 56250124, "United Kingdom", 1982], + [29230, 74.4, 233953874, "United States", 1982], + [23584, 75.3, 15318254, "Australia", 1983], + [26525, 76.1, 25272656, "Canada", 1983], + [1229, 65.6, 1019698475, "China", 1983], + [13669, 74.6, 9966733, "Cuba", 1983], + [23351, 74.5, 4853196, "Finland", 1983], + [25188, 75.2, 54799049, "France", 1983], + [28227, 74, 77657451, "Germany", 1983], + [24594, 77.3, 235860, "Iceland", 1983], + [1412, 55.1, 747374856, "India", 1983], + [21446, 77.1, 118552097, "Japan", 1983], + [22808, 73.9, 3215826, "New Zealand", 1983], + [35932, 76, 4120386, "Norway", 1983], + [10835, 71.1, 36879742, "Poland", 1983], + [18417, 67.7, 140951400, "Russia", 1983], + [8535, 64.2, 47072603, "Turkey", 1983], + [21357, 74.3, 56283959, "United Kingdom", 1983], + [30185, 74.6, 236161961, "United States", 1983], + [24934, 75.5, 15548591, "Australia", 1984], + [27781, 76.4, 25546736, "Canada", 1984], + [1456, 66, 1035328572, "China", 1984], + [14019, 74.4, 10017061, "Cuba", 1984], + [23926, 74.6, 4879222, "Finland", 1984], + [25497, 75.5, 55084677, "France", 1984], + [29135, 74.4, 77566776, "Germany", 1984], + [25356, 77.4, 238647, "Iceland", 1984], + [1436, 55.5, 764664278, "India", 1984], + [22268, 77.4, 119318921, "Japan", 1984], + [23698, 74.1, 3243078, "New Zealand", 1984], + [38057, 76.1, 4133833, "Norway", 1984], + [11138, 70.8, 37208529, "Poland", 1984], + [18527, 67.4, 141955200, "Russia", 1984], + [8798, 64.8, 48138191, "Turkey", 1984], + [21904, 74.6, 56337848, "United Kingdom", 1984], + [32110, 74.8, 238404223, "United States", 1984], + [25875, 75.7, 15791043, "Australia", 1985], + [29016, 76.5, 25848173, "Canada", 1985], + [1557, 66.4, 1052622410, "China", 1985], + [14135, 74.3, 10082990, "Cuba", 1985], + [24630, 74.7, 4902219, "Finland", 1985], + [25917, 75.7, 55379923, "France", 1985], + [29851, 74.6, 77570009, "Germany", 1985], + [25997, 77.6, 241411, "Iceland", 1985], + [1462, 55.9, 782085127, "India", 1985], + [23554, 77.8, 119988663, "Japan", 1985], + [23750, 74.2, 3268192, "New Zealand", 1985], + [40031, 76.1, 4148355, "Norway", 1985], + [11159, 70.7, 37486105, "Poland", 1985], + [18576, 68.2, 142975753, "Russia", 1985], + [9163, 65.2, 49178079, "Turkey", 1985], + [22648, 74.7, 56415196, "United Kingdom", 1985], + [33065, 74.8, 240691557, "United States", 1985], + [26057, 76, 16047026, "Australia", 1986], + [29482, 76.6, 26181342, "Canada", 1986], + [1604, 66.8, 1071834975, "China", 1986], + [14025, 74.5, 10167998, "Cuba", 1986], + [25133, 74.7, 4921293, "Finland", 1986], + [26453, 76, 55686610, "France", 1986], + [30514, 74.8, 77671877, "Germany", 1986], + [27379, 77.6, 244145, "Iceland", 1986], + [1493, 56.3, 799607235, "India", 1986], + [24116, 78.1, 120551455, "Japan", 1986], + [24180, 74.2, 3290132, "New Zealand", 1986], + [41450, 76.1, 4164166, "Norway", 1986], + [11429, 70.9, 37703942, "Poland", 1986], + [19221, 69.8, 144016095, "Russia", 1986], + [9556, 65.7, 50187091, "Turkey", 1986], + [23516, 74.9, 56519444, "United Kingdom", 1986], + [33899, 74.9, 243032017, "United States", 1986], + [26969, 76.2, 16314778, "Australia", 1987], + [30288, 76.8, 26541981, "Canada", 1987], + [1652, 67.2, 1092646739, "China", 1987], + [13805, 74.6, 10269276, "Cuba", 1987], + [26086, 74.7, 4937259, "Finland", 1987], + [26963, 76.4, 56005443, "France", 1987], + [30986, 75.1, 77864381, "Germany", 1987], + [29335, 77.7, 246867, "Iceland", 1987], + [1525, 56.6, 817232241, "India", 1987], + [25018, 78.4, 121021830, "Japan", 1987], + [24222, 74.4, 3310408, "New Zealand", 1987], + [42225, 76.1, 4181326, "Norway", 1987], + [11207, 71.1, 37867481, "Poland", 1987], + [19355, 70.1, 145056221, "Russia", 1987], + [10351, 66.1, 51168841, "Turkey", 1987], + [24551, 75.1, 56649375, "United Kingdom", 1987], + [34787, 75, 245425409, "United States", 1987], + [27757, 76.4, 16585905, "Australia", 1988], + [31356, 77.1, 26919036, "Canada", 1988], + [1597, 67.5, 1114162025, "China", 1988], + [13925, 74.6, 10379080, "Cuba", 1988], + [27282, 74.8, 4951886, "Finland", 1988], + [28101, 76.6, 56328053, "France", 1988], + [31906, 75.3, 78146938, "Germany", 1988], + [28780, 77.8, 249563, "Iceland", 1988], + [1649, 57, 834944397, "India", 1988], + [26724, 78.6, 121432942, "Japan", 1988], + [24060, 74.6, 3332297, "New Zealand", 1988], + [42101, 76.3, 4199817, "Norway", 1988], + [11418, 71.2, 37990683, "Poland", 1988], + [19660, 70, 146040116, "Russia", 1988], + [10421, 66.5, 52126497, "Turkey", 1988], + [25750, 75.3, 56797704, "United Kingdom", 1988], + [35929, 75, 247865202, "United States", 1988], + [28556, 76.6, 16849253, "Australia", 1989], + [31550, 77.2, 27296517, "Canada", 1989], + [1474, 67.7, 1135128009, "China", 1989], + [13829, 74.7, 10486110, "Cuba", 1989], + [28735, 74.8, 4967776, "Finland", 1989], + [28942, 76.9, 56643349, "France", 1989], + [32706, 75.4, 78514790, "Germany", 1989], + [28629, 78, 252219, "Iceland", 1989], + [1723, 57.3, 852736160, "India", 1989], + [28077, 78.9, 121831143, "Japan", 1989], + [24206, 75, 3360350, "New Zealand", 1989], + [42449, 76.5, 4219532, "Norway", 1989], + [11212, 71.1, 38094812, "Poland", 1989], + [19906, 69.8, 146895053, "Russia", 1989], + [10103, 66.9, 53066569, "Turkey", 1989], + [26279, 75.5, 56953861, "United Kingdom", 1989], + [36830, 75.2, 250340795, "United States", 1989], + [28604, 77, 17096869, "Australia", 1990], + [31163, 77.4, 27662440, "Canada", 1990], + [1516, 68, 1154605773, "China", 1990], + [13670, 74.7, 10582082, "Cuba", 1990], + [28599, 75, 4986705, "Finland", 1990], + [29476, 77.1, 56943299, "France", 1990], + [31476, 75.4, 78958237, "Germany", 1990], + [28666, 78.1, 254830, "Iceland", 1990], + [1777, 57.7, 870601776, "India", 1990], + [29550, 79.1, 122249285, "Japan", 1990], + [24021, 75.4, 3397534, "New Zealand", 1990], + [43296, 76.8, 4240375, "Norway", 1990], + [10088, 70.8, 38195258, "Poland", 1990], + [19349, 69.6, 147568552, "Russia", 1990], + [10670, 67.3, 53994605, "Turkey", 1990], + [26424, 75.7, 57110117, "United Kingdom", 1990], + [37062, 75.4, 252847810, "United States", 1990], + [28122, 77.4, 17325818, "Australia", 1991], + [30090, 77.6, 28014102, "Canada", 1991], + [1634, 68.3, 1172327831, "China", 1991], + [12113, 74.7, 10664577, "Cuba", 1991], + [26761, 75.4, 5009381, "Finland", 1991], + [29707, 77.3, 57226524, "France", 1991], + [32844, 75.6, 79483739, "Germany", 1991], + [28272, 78.3, 257387, "Iceland", 1991], + [1760, 58, 888513869, "India", 1991], + [30437, 79.2, 122702527, "Japan", 1991], + [22636, 75.8, 3445596, "New Zealand", 1991], + [44419, 77.1, 4262367, "Norway", 1991], + [9347, 70.7, 38297549, "Poland", 1991], + [18332, 69.4, 148040354, "Russia", 1991], + [10568, 67.6, 54909508, "Turkey", 1991], + [26017, 76, 57264600, "United Kingdom", 1991], + [36543, 75.6, 255367160, "United States", 1991], + [27895, 77.7, 17538387, "Australia", 1992], + [29977, 77.7, 28353843, "Canada", 1992], + [1845, 68.6, 1188450231, "China", 1992], + [10637, 74.8, 10735775, "Cuba", 1992], + [25726, 75.8, 5034898, "Finland", 1992], + [30033, 77.5, 57495252, "France", 1992], + [33221, 75.9, 80075940, "Germany", 1992], + [26977, 78.5, 259895, "Iceland", 1992], + [1821, 58.3, 906461358, "India", 1992], + [30610, 79.4, 123180357, "Japan", 1992], + [22651, 76.1, 3502765, "New Zealand", 1992], + [45742, 77.3, 4285504, "Norway", 1992], + [9553, 71.1, 38396826, "Poland", 1992], + [15661, 68, 148322473, "Russia", 1992], + [10920, 67.9, 55811134, "Turkey", 1992], + [26062, 76.3, 57419469, "United Kingdom", 1992], + [37321, 75.8, 257908206, "United States", 1992], + [28732, 78, 17738428, "Australia", 1993], + [30424, 77.8, 28680921, "Canada", 1993], + [2078, 68.9, 1202982955, "China", 1993], + [9001, 74.8, 10797556, "Cuba", 1993], + [25414, 76.2, 5061465, "Finland", 1993], + [29719, 77.7, 57749881, "France", 1993], + [32689, 76.2, 80675999, "Germany", 1993], + [27055, 78.7, 262383, "Iceland", 1993], + [1871, 58.6, 924475633, "India", 1993], + [30587, 79.6, 123658854, "Japan", 1993], + [23830, 76.5, 3564227, "New Zealand", 1993], + [46765, 77.6, 4309606, "Norway", 1993], + [9884, 71.7, 38485892, "Poland", 1993], + [14320, 65.2, 148435811, "Russia", 1993], + [11569, 68.3, 56707454, "Turkey", 1993], + [26688, 76.5, 57575969, "United Kingdom", 1993], + [37844, 75.7, 260527420, "United States", 1993], + [29580, 78.2, 17932214, "Australia", 1994], + [31505, 77.9, 28995822, "Canada", 1994], + [2323, 69.3, 1216067023, "China", 1994], + [9018, 74.8, 10853435, "Cuba", 1994], + [26301, 76.5, 5086499, "Finland", 1994], + [30303, 77.9, 57991973, "France", 1994], + [33375, 76.4, 81206786, "Germany", 1994], + [27789, 78.8, 264893, "Iceland", 1994], + [1959, 59, 942604211, "India", 1994], + [30746, 79.8, 124101546, "Japan", 1994], + [24716, 76.7, 3623181, "New Zealand", 1994], + [48850, 77.8, 4334434, "Norway", 1994], + [10386, 71.8, 38553355, "Poland", 1994], + [12535, 63.6, 148416292, "Russia", 1994], + [10857, 68.6, 57608769, "Turkey", 1994], + [27691, 76.7, 57736667, "United Kingdom", 1994], + [38892, 75.8, 263301323, "United States", 1994], + [30359, 78.4, 18124770, "Australia", 1995], + [32101, 78, 29299478, "Canada", 1995], + [2551, 69.6, 1227841281, "China", 1995], + [9195, 74.9, 10906048, "Cuba", 1995], + [27303, 76.7, 5108176, "Finland", 1995], + [30823, 78.1, 58224051, "France", 1995], + [33843, 76.6, 81612900, "Germany", 1995], + [27671, 78.9, 267454, "Iceland", 1995], + [2069, 59.3, 960874982, "India", 1995], + [31224, 79.9, 124483305, "Japan", 1995], + [25476, 76.9, 3674886, "New Zealand", 1995], + [50616, 78, 4359788, "Norway", 1995], + [11093, 72, 38591860, "Poland", 1995], + [12013, 64.2, 148293265, "Russia", 1995], + [11530, 69, 58522320, "Turkey", 1995], + [28317, 76.8, 57903790, "United Kingdom", 1995], + [39476, 75.9, 266275528, "United States", 1995], + [31145, 78.6, 18318340, "Australia", 1996], + [32290, 78.3, 29590952, "Canada", 1996], + [2775, 69.9, 1238234851, "China", 1996], + [9871, 75.2, 10955372, "Cuba", 1996], + [28210, 76.9, 5126021, "Finland", 1996], + [31141, 78.4, 58443318, "France", 1996], + [34008, 76.9, 81870772, "Germany", 1996], + [28839, 79.1, 270089, "Iceland", 1996], + [2186, 59.6, 979290432, "India", 1996], + [31958, 80.3, 124794817, "Japan", 1996], + [25984, 77.1, 3717239, "New Zealand", 1996], + [52892, 78.1, 4385951, "Norway", 1996], + [11776, 72.4, 38599825, "Poland", 1996], + [11597, 65.9, 148078355, "Russia", 1996], + [12190, 69.4, 59451488, "Turkey", 1996], + [28998, 76.9, 58079322, "United Kingdom", 1996], + [40501, 76.3, 269483224, "United States", 1996], + [32013, 78.9, 18512971, "Australia", 1997], + [33310, 78.7, 29871092, "Canada", 1997], + [3000, 70.3, 1247259143, "China", 1997], + [10106, 75.3, 11000431, "Cuba", 1997], + [29884, 77.1, 5140755, "Finland", 1997], + [31756, 78.7, 58652709, "France", 1997], + [34578, 77.3, 81993831, "Germany", 1997], + [30009, 79.3, 272798, "Iceland", 1997], + [2235, 60, 997817250, "India", 1997], + [32391, 80.6, 125048424, "Japan", 1997], + [26152, 77.4, 3752102, "New Zealand", 1997], + [55386, 78.2, 4412958, "Norway", 1997], + [12602, 72.7, 38583109, "Poland", 1997], + [11779, 67.4, 147772805, "Russia", 1997], + [12911, 69.8, 60394104, "Turkey", 1997], + [29662, 77.2, 58263858, "United Kingdom", 1997], + [41812, 76.8, 272882865, "United States", 1997], + [33085, 79.1, 18709175, "Australia", 1998], + [34389, 78.9, 30145148, "Canada", 1998], + [3205, 70.7, 1255262566, "China", 1998], + [10086, 75.4, 11041893, "Cuba", 1998], + [31423, 77.3, 5153229, "Finland", 1998], + [32764, 78.8, 58867465, "France", 1998], + [35254, 77.7, 82010184, "Germany", 1998], + [31601, 79.5, 275568, "Iceland", 1998], + [2332, 60.3, 1016402907, "India", 1998], + [31656, 80.6, 125266403, "Japan", 1998], + [26077, 77.8, 3783516, "New Zealand", 1998], + [56502, 78.3, 4440109, "Norway", 1998], + [13225, 73, 38550777, "Poland", 1998], + [11173, 67.6, 147385440, "Russia", 1998], + [13008, 70.4, 61344874, "Turkey", 1998], + [30614, 77.4, 58456989, "United Kingdom", 1998], + [43166, 77, 276354096, "United States", 1998], + [34346, 79.3, 18906936, "Australia", 1999], + [35810, 79.1, 30420216, "Canada", 1999], + [3419, 71.1, 1262713651, "China", 1999], + [10674, 75.6, 11080506, "Cuba", 1999], + [32743, 77.5, 5164780, "Finland", 1999], + [33707, 78.9, 59107738, "France", 1999], + [35931, 77.9, 81965830, "Germany", 1999], + [32521, 79.7, 278376, "Iceland", 1999], + [2496, 60.7, 1034976626, "India", 1999], + [31535, 80.7, 125481050, "Japan", 1999], + [27371, 78.1, 3817489, "New Zealand", 1999], + [57246, 78.5, 4466468, "Norway", 1999], + [13824, 73.2, 38515359, "Poland", 1999], + [11925, 66.2, 146924174, "Russia", 1999], + [12381, 70.3, 62295617, "Turkey", 1999], + [31474, 77.6, 58657794, "United Kingdom", 1999], + [44673, 77.1, 279730801, "United States", 1999], + [35253, 79.7, 19107251, "Australia", 2000], + [37314, 79.3, 30701903, "Canada", 2000], + [3678, 71.5, 1269974572, "China", 2000], + [11268, 75.9, 11116787, "Cuba", 2000], + [34517, 77.8, 5176482, "Finland", 2000], + [34774, 79.1, 59387183, "France", 2000], + [36953, 78.1, 81895925, "Germany", 2000], + [33599, 79.9, 281214, "Iceland", 2000], + [2548, 61.1, 1053481072, "India", 2000], + [32193, 81.1, 125714674, "Japan", 2000], + [27963, 78.5, 3858234, "New Zealand", 2000], + [58699, 78.7, 4491572, "Norway", 2000], + [14565, 73.8, 38486305, "Poland", 2000], + [13173, 65.4, 146400951, "Russia", 2000], + [13025, 71.5, 63240157, "Turkey", 2000], + [32543, 77.8, 58867004, "United Kingdom", 2000], + [45986, 77.1, 282895741, "United States", 2000], + [35452, 80.1, 19308681, "Australia", 2001], + [37563, 79.5, 30991344, "Canada", 2001], + [3955, 71.9, 1277188787, "China", 2001], + [11588, 76.2, 11151472, "Cuba", 2001], + [35327, 78.2, 5188446, "Finland", 2001], + [35197, 79.2, 59711914, "France", 2001], + [37517, 78.3, 81809438, "Germany", 2001], + [34403, 80.2, 284037, "Iceland", 2001], + [2628, 61.5, 1071888190, "India", 2001], + [32230, 81.4, 125974298, "Japan", 2001], + [28752, 78.8, 3906911, "New Zealand", 2001], + [59620, 78.9, 4514907, "Norway", 2001], + [14744, 74.3, 38466543, "Poland", 2001], + [13902, 65.1, 145818121, "Russia", 2001], + [12106, 72, 64182694, "Turkey", 2001], + [33282, 78, 59080221, "United Kingdom", 2001], + [45978, 77.1, 285796198, "United States", 2001], + [36375, 80.4, 19514385, "Australia", 2002], + [38270, 79.7, 31288572, "Canada", 2002], + [4285, 72.4, 1284349938, "China", 2002], + [11715, 76.6, 11184540, "Cuba", 2002], + [35834, 78.5, 5200632, "Finland", 2002], + [35333, 79.4, 60075783, "France", 2002], + [37458, 78.5, 81699829, "Germany", 2002], + [34252, 80.5, 286865, "Iceland", 2002], + [2684, 61.9, 1090189358, "India", 2002], + [32248, 81.7, 126249509, "Japan", 2002], + [29637, 79, 3961695, "New Zealand", 2002], + [60152, 79.2, 4537240, "Norway", 2002], + [14964, 74.6, 38454823, "Poland", 2002], + [14629, 64.9, 145195521, "Russia", 2002], + [12669, 72.5, 65125766, "Turkey", 2002], + [33954, 78.2, 59301235, "United Kingdom", 2002], + [46367, 77.2, 288470847, "United States", 2002], + [37035, 80.7, 19735255, "Australia", 2003], + [38621, 79.9, 31596593, "Canada", 2003], + [4685, 72.9, 1291485488, "China", 2003], + [12123, 76.8, 11214837, "Cuba", 2003], + [36461, 78.6, 5213800, "Finland", 2003], + [35371, 79.7, 60464857, "France", 2003], + [37167, 78.8, 81569481, "Germany", 2003], + [34938, 80.8, 289824, "Iceland", 2003], + [2850, 62.4, 1108369577, "India", 2003], + [32721, 81.8, 126523884, "Japan", 2003], + [30404, 79.3, 4020195, "New Zealand", 2003], + [60351, 79.5, 4560947, "Norway", 2003], + [15508, 74.9, 38451227, "Poland", 2003], + [15768, 64.8, 144583147, "Russia", 2003], + [13151, 72.9, 66060121, "Turkey", 2003], + [35250, 78.5, 59548421, "United Kingdom", 2003], + [47260, 77.3, 291005482, "United States", 2003], + [38130, 81, 19985475, "Australia", 2004], + [39436, 80.1, 31918582, "Canada", 2004], + [5127, 73.4, 1298573031, "China", 2004], + [12791, 76.9, 11240680, "Cuba", 2004], + [37783, 78.6, 5228842, "Finland", 2004], + [36090, 80.1, 60858654, "France", 2004], + [37614, 79.1, 81417791, "Germany", 2004], + [37482, 81.1, 293084, "Iceland", 2004], + [3029, 62.8, 1126419321, "India", 2004], + [33483, 82, 126773081, "Japan", 2004], + [31098, 79.5, 4078779, "New Zealand", 2004], + [62370, 79.7, 4589241, "Norway", 2004], + [16314, 75, 38454520, "Poland", 2004], + [16967, 65, 144043914, "Russia", 2004], + [14187, 73.4, 66973561, "Turkey", 2004], + [35910, 78.8, 59846226, "United Kingdom", 2004], + [48597, 77.6, 293530886, "United States", 2004], + [38840, 81.2, 20274282, "Australia", 2005], + [40284, 80.3, 32256333, "Canada", 2005], + [5675, 73.9, 1305600630, "China", 2005], + [14200, 77.1, 11261052, "Cuba", 2005], + [38700, 78.8, 5246368, "Finland", 2005], + [36395, 80.4, 61241700, "France", 2005], + [37901, 79.4, 81246801, "Germany", 2005], + [39108, 81.3, 296745, "Iceland", 2005], + [3262, 63.2, 1144326293, "India", 2005], + [33916, 82.2, 126978754, "Japan", 2005], + [31798, 79.8, 4134699, "New Zealand", 2005], + [63573, 80.1, 4624388, "Norway", 2005], + [16900, 75, 38463514, "Poland", 2005], + [18118, 64.8, 143622566, "Russia", 2005], + [15176, 73.8, 67860617, "Turkey", 2005], + [36665, 79.1, 60210012, "United Kingdom", 2005], + [49762, 77.7, 296139635, "United States", 2005], + [39416, 81.4, 20606228, "Australia", 2006], + [41012, 80.5, 32611436, "Canada", 2006], + [6360, 74.4, 1312600877, "China", 2006], + [15901, 77.4, 11275199, "Cuba", 2006], + [40115, 79, 5266600, "Finland", 2006], + [37001, 80.7, 61609991, "France", 2006], + [39352, 79.7, 81055904, "Germany", 2006], + [39818, 81.5, 300887, "Iceland", 2006], + [3514, 63.6, 1162088305, "India", 2006], + [34468, 82.3, 127136576, "Japan", 2006], + [32281, 80, 4187584, "New Zealand", 2006], + [64573, 80.4, 4667105, "Norway", 2006], + [17959, 75, 38478763, "Poland", 2006], + [19660, 66.1, 143338407, "Russia", 2006], + [16013, 74.3, 68704721, "Turkey", 2006], + [37504, 79.3, 60648850, "United Kingdom", 2006], + [50599, 77.8, 298860519, "United States", 2006], + [40643, 81.5, 20975949, "Australia", 2007], + [41432, 80.6, 32982275, "Canada", 2007], + [7225, 74.9, 1319625197, "China", 2007], + [17055, 77.6, 11284043, "Cuba", 2007], + [42016, 79.2, 5289333, "Finland", 2007], + [37641, 80.9, 61966193, "France", 2007], + [40693, 79.8, 80854515, "Germany", 2007], + [42598, 81.8, 305415, "Iceland", 2007], + [3806, 64, 1179685631, "India", 2007], + [35183, 82.5, 127250015, "Japan", 2007], + [32928, 80.1, 4238021, "New Zealand", 2007], + [65781, 80.6, 4716584, "Norway", 2007], + [19254, 75.1, 38500356, "Poland", 2007], + [21374, 67.2, 143180249, "Russia", 2007], + [16551, 74.7, 69515492, "Turkey", 2007], + [38164, 79.4, 61151820, "United Kingdom", 2007], + [51011, 78.1, 301655953, "United States", 2007], + [41312, 81.5, 21370348, "Australia", 2008], + [41468, 80.7, 33363256, "Canada", 2008], + [7880, 75.1, 1326690636, "China", 2008], + [17765, 77.8, 11290239, "Cuba", 2008], + [42122, 79.4, 5314170, "Finland", 2008], + [37505, 81, 62309529, "France", 2008], + [41199, 80, 80665906, "Germany", 2008], + [42294, 82, 310033, "Iceland", 2008], + [3901, 64.4, 1197070109, "India", 2008], + [34800, 82.6, 127317900, "Japan", 2008], + [32122, 80.2, 4285380, "New Zealand", 2008], + [65216, 80.7, 4771633, "Norway", 2008], + [19996, 75.3, 38525752, "Poland", 2008], + [22506, 67.6, 143123163, "Russia", 2008], + [16454, 75.1, 70344357, "Turkey", 2008], + [37739, 79.5, 61689620, "United Kingdom", 2008], + [50384, 78.2, 304473143, "United States", 2008], + [41170, 81.6, 21770690, "Australia", 2009], + [39884, 80.9, 33746559, "Canada", 2009], + [8565, 75.6, 1333807063, "China", 2009], + [18035, 77.9, 11297442, "Cuba", 2009], + [38455, 79.7, 5340485, "Finland", 2009], + [36215, 81, 62640901, "France", 2009], + [38975, 80, 80519685, "Germany", 2009], + [39979, 82.2, 314336, "Iceland", 2009], + [4177, 64.7, 1214182182, "India", 2009], + [32880, 82.8, 127340884, "Japan", 2009], + [31723, 80.3, 4329124, "New Zealand", 2009], + [63354, 80.8, 4830371, "Norway", 2009], + [20507, 75.6, 38551489, "Poland", 2009], + [20739, 68.3, 143126660, "Russia", 2009], + [15467, 75.4, 71261307, "Turkey", 2009], + [35840, 79.7, 62221164, "United Kingdom", 2009], + [48558, 78.3, 307231961, "United States", 2009], + [41330, 81.7, 22162863, "Australia", 2010], + [40773, 81.1, 34126173, "Canada", 2010], + [9430, 75.9, 1340968737, "China", 2010], + [18477, 78, 11308133, "Cuba", 2010], + [39425, 80, 5367693, "Finland", 2010], + [36745, 81.2, 62961136, "France", 2010], + [40632, 80.2, 80435307, "Germany", 2010], + [38809, 82.5, 318042, "Iceland", 2010], + [4547, 65.1, 1230984504, "India", 2010], + [34404, 83, 127319802, "Japan", 2010], + [31824, 80.5, 4369027, "New Zealand", 2010], + [62946, 80.9, 4891251, "Norway", 2010], + [21328, 76.1, 38574682, "Poland", 2010], + [21664, 68.7, 143158099, "Russia", 2010], + [16674, 75.7, 72310416, "Turkey", 2010], + [36240, 80, 62716684, "United Kingdom", 2010], + [49373, 78.5, 309876170, "United States", 2010], + [41706, 81.8, 22542371, "Australia", 2011], + [41567, 81.3, 34499905, "Canada", 2011], + [10274, 76.1, 1348174478, "China", 2011], + [19005, 78.1, 11323570, "Cuba", 2011], + [40251, 80.3, 5395816, "Finland", 2011], + [37328, 81.4, 63268405, "France", 2011], + [42080, 80.3, 80424665, "Germany", 2011], + [39619, 82.7, 321030, "Iceland", 2011], + [4787, 65.5, 1247446011, "India", 2011], + [34316, 82.8, 127252900, "Japan", 2011], + [32283, 80.6, 4404483, "New Zealand", 2011], + [62737, 81.1, 4953945, "Norway", 2011], + [22333, 76.5, 38594217, "Poland", 2011], + [22570, 69.4, 143211476, "Russia", 2011], + [17908, 76, 73517002, "Turkey", 2011], + [36549, 80.4, 63164949, "United Kingdom", 2011], + [49781, 78.7, 312390368, "United States", 2011], + [42522, 81.8, 22911375, "Australia", 2012], + [41865, 81.4, 34868151, "Canada", 2012], + [11017, 76.3, 1355386952, "China", 2012], + [19586, 78.2, 11342631, "Cuba", 2012], + [39489, 80.5, 5424644, "Finland", 2012], + [37227, 81.6, 63561798, "France", 2012], + [42959, 80.5, 80477952, "Germany", 2012], + [39925, 82.8, 323407, "Iceland", 2012], + [4967, 65.9, 1263589639, "India", 2012], + [34988, 83.2, 127139821, "Japan", 2012], + [32806, 80.6, 4435883, "New Zealand", 2012], + [63620, 81.3, 5018367, "Norway", 2012], + [22740, 76.7, 38609486, "Poland", 2012], + [23299, 70.4, 143287536, "Russia", 2012], + [18057, 76.2, 74849187, "Turkey", 2012], + [36535, 80.8, 63573766, "United Kingdom", 2012], + [50549, 78.8, 314799465, "United States", 2012], + [42840, 81.8, 23270465, "Australia", 2013], + [42213, 81.5, 35230612, "Canada", 2013], + [11805, 76.5, 1362514260, "China", 2013], + [20122, 78.3, 11362505, "Cuba", 2013], + [38788, 80.6, 5453061, "Finland", 2013], + [37309, 81.7, 63844529, "France", 2013], + [42887, 80.7, 80565861, "Germany", 2013], + [40958, 82.8, 325392, "Iceland", 2013], + [5244, 66.2, 1279498874, "India", 2013], + [35614, 83.3, 126984964, "Japan", 2013], + [33360, 80.6, 4465276, "New Zealand", 2013], + [63322, 81.4, 5083450, "Norway", 2013], + [23144, 76.9, 38618698, "Poland", 2013], + [23561, 71.3, 143367341, "Russia", 2013], + [18579, 76.3, 76223639, "Turkey", 2013], + [36908, 81, 63955654, "United Kingdom", 2013], + [51282, 78.9, 317135919, "United States", 2013], + [43219, 81.8, 23622353, "Australia", 2014], + [42817, 81.6, 35587793, "Canada", 2014], + [12609, 76.7, 1369435670, "China", 2014], + [20704, 78.4, 11379111, "Cuba", 2014], + [38569, 80.7, 5479660, "Finland", 2014], + [37218, 81.8, 64121249, "France", 2014], + [43444, 80.9, 80646262, "Germany", 2014], + [41237, 82.8, 327318, "Iceland", 2014], + [5565, 66.5, 1295291543, "India", 2014], + [35635, 83.4, 126794564, "Japan", 2014], + [33538, 80.6, 4495482, "New Zealand", 2014], + [64020, 81.5, 5147970, "Norway", 2014], + [23952, 77.1, 38619974, "Poland", 2014], + [23293, 72.21, 143429435, "Russia", 2014], + [18884, 76.4, 77523788, "Turkey", 2014], + [37614, 81.2, 64331348, "United Kingdom", 2014], + [52118, 79, 319448634, "United States", 2014], + [44056, 81.8, 23968973, "Australia", 2015], + [43294, 81.7, 35939927, "Canada", 2015], + [13334, 76.9, 1376048943, "China", 2015], + [21291, 78.5, 11389562, "Cuba", 2015], + [38923, 80.8, 5503457, "Finland", 2015], + [37599, 81.9, 64395345, "France", 2015], + [44053, 81.1, 80688545, "Germany", 2015], + [42182, 82.8, 329425, "Iceland", 2015], + [5903, 66.8, 1311050527, "India", 2015], + [36162, 83.5, 126573481, "Japan", 2015], + [34186, 80.6, 4528526, "New Zealand", 2015], + [64304, 81.6, 5210967, "Norway", 2015], + [24787, 77.3, 38611794, "Poland", 2015], + [23038, 73.13, 143456918, "Russia", 2015], + [19360, 76.5, 78665830, "Turkey", 2015], + [38225, 81.4, 64715810, "United Kingdom", 2015], + [53354, 79.1, 321773631, "United States", 2015] + ], + defaultDatasourceParallel: [ + ['Price', 'Net Weight', 'Amount', 'Score'], + [12.99, 100, 82, 'Good'], + [9.99, 80, 77, 'OK'], + [20, 120, 60, 'Excellent'] + ], + defaultDatasource3DGlobe: [[[-75.440806,40.652083],[-80.943139,35.214]],[[-75.440806,40.652083],[-75.241139,39.871944]],[[-99.681897,32.411319],[-97.037997,32.896828]],[[-106.6091944,35.0402222],[-97.037997,32.896828]],[[-106.6091944,35.0402222],[-118.408075,33.942536]],[[-106.6091944,35.0402222],[-87.904842,41.978603]],[[-106.6091944,35.0402222],[-112.011583,33.434278]],[[-2.197778,57.201944],[-0.461389,51.4775]],[[-0.166786,5.605186],[-0.461389,51.4775]],[[-97.230519,31.611289],[-97.037997,32.896828]],[[138.530556,-34.945],[153.1175,-27.384167]],[[138.530556,-34.945],[151.177222,-33.946111]],[[-92.549833,31.3274],[-97.037997,32.896828]],[[-4.499106,36.6749],[-0.461389,51.4775]],[[-81.9645,33.369944],[-80.943139,35.214]],[[-81.9645,33.369944],[-77.037722,38.852083]],[[-102.317858,21.705558],[-97.037997,32.896828]],[[174.791667,-37.008056],[153.1175,-27.384167]],[[174.791667,-37.008056],[-149.611389,-17.556667]],[[174.791667,-37.008056],[151.177222,-33.946111]],[[-73.801692,42.748267],[-80.943139,35.214]],[[-73.801692,42.748267],[-77.037722,38.852083]],[[-73.801692,42.748267],[-75.241139,39.871944]],[[-92.4003,42.5571],[-87.904842,41.978603]],[[-101.705931,35.219369],[-97.037997,32.896828]],[[35.993214,31.722556],[-73.778925,40.639751]],[[35.993214,31.722556],[-87.904842,41.978603]],[[35.993214,31.722556],[-73.740833,45.470556]],[[4.763889,52.308613],[-0.461389,51.4775]],[[4.763889,52.308613],[-75.241139,39.871944]],[[-149.996361,61.174361],[-118.408075,33.942536]],[[-149.996361,61.174361],[-112.011583,33.434278]],[[-61.792667,17.136749],[-80.943139,35.214]],[[-61.792667,17.136749],[-73.778925,40.639751]],[[-61.792667,17.136749],[-80.290556,25.79325]],[[-71.583083,-16.341072],[-77.114319,-12.021889]],[[17.918611,59.651944],[-0.461389,51.4775]],[[-76.021739,43.991922],[-87.904842,41.978603]],[[-76.021739,43.991922],[-75.241139,39.871944]],[[133.902222,-23.806667],[151.177222,-33.946111]],[[-57.519133,-25.23985],[-80.290556,25.79325]],[[23.944467,37.936358],[-0.461389,51.4775]],[[23.944467,37.936358],[-75.241139,39.871944]],[[-84.428067,33.636719],[-80.943139,35.214]],[[-84.428067,33.636719],[-97.037997,32.896828]],[[-84.428067,33.636719],[-0.461389,51.4775]],[[-84.428067,33.636719],[-80.290556,25.79325]],[[-84.428067,33.636719],[-87.904842,41.978603]],[[-84.428067,33.636719],[-75.241139,39.871944]],[[-84.428067,33.636719],[-112.011583,33.434278]],[[-70.015221,12.501389],[-80.943139,35.214]],[[-70.015221,12.501389],[-80.290556,25.79325]],[[-70.015221,12.501389],[-75.241139,39.871944]],[[54.651138,24.432972],[79.884117,7.180756]],[[54.651138,24.432972],[6.766775,51.289453]],[[54.651138,24.432972],[-77.455811,38.944533]],[[54.651138,24.432972],[73.099233,33.616653]],[[54.651138,24.432972],[-73.778925,40.639751]],[[54.651138,24.432972],[74.403594,31.521564]],[[54.651138,24.432972],[-0.461389,51.4775]],[[54.651138,24.432972],[58.284444,23.593278]],[[54.651138,24.432972],[-87.904842,41.978603]],[[-97.669889,30.194528],[-80.943139,35.214]],[[-97.669889,30.194528],[-97.037997,32.896828]],[[-97.669889,30.194528],[-73.778925,40.639751]],[[-97.669889,30.194528],[-118.408075,33.942536]],[[-97.669889,30.194528],[-0.461389,51.4775]],[[-97.669889,30.194528],[-90.258028,29.993389]],[[-97.669889,30.194528],[-87.904842,41.978603]],[[-97.669889,30.194528],[-75.241139,39.871944]],[[-97.669889,30.194528],[-112.011583,33.434278]],[[-82.541806,35.436194],[-80.943139,35.214]],[[-75.723403,41.338478],[-80.943139,35.214]],[[-75.723403,41.338478],[-75.241139,39.871944]],[[-85.552058,42.234875],[-87.904842,41.978603]],[[50.63361,26.270834],[51.565056,25.261125]],[[50.63361,26.270834],[-0.461389,51.4775]],[[2.078464,41.297078],[-73.778925,40.639751]],[[2.078464,41.297078],[-0.461389,51.4775]],[[2.078464,41.297078],[-80.290556,25.79325]],[[2.078464,41.297078],[-75.241139,39.871944]],[[-64.678703,32.364042],[-73.778925,40.639751]],[[-64.678703,32.364042],[-80.290556,25.79325]],[[-64.678703,32.364042],[-75.241139,39.871944]],[[-72.683222,41.938889],[-80.943139,35.214]],[[-72.683222,41.938889],[-77.037722,38.852083]],[[-72.683222,41.938889],[-97.037997,32.896828]],[[-72.683222,41.938889],[-118.408075,33.942536]],[[-72.683222,41.938889],[-80.290556,25.79325]],[[-72.683222,41.938889],[-87.904842,41.978603]],[[-72.683222,41.938889],[-75.241139,39.871944]],[[-72.683222,41.938889],[-80.232872,40.491467]],[[-119.05677,35.433598],[-112.011583,33.434278]],[[-59.492456,13.074603],[-80.290556,25.79325]],[[-75.979839,42.208689],[-75.241139,39.871944]],[[5.218142,60.293386],[-0.461389,51.4775]],[[-68.828139,44.807444],[-77.037722,38.852083]],[[-68.828139,44.807444],[-75.241139,39.871944]],[[-5.8725,54.618056],[-0.461389,51.4775]],[[-86.75355,33.562942],[-80.943139,35.214]],[[-86.75355,33.562942],[-77.037722,38.852083]],[[-86.75355,33.562942],[-97.037997,32.896828]],[[-86.75355,33.562942],[-80.290556,25.79325]],[[-86.75355,33.562942],[-75.241139,39.871944]],[[-16.652206,13.337961],[-17.490225,14.739708]],[[-101.480847,20.993464],[-97.037997,32.896828]],[[100.747283,13.681108],[101.709917,2.745578]]], }; diff --git a/client/packages/lowcoder-comps/src/i18n/comps/locales/types.tsx b/client/packages/lowcoder-comps/src/i18n/comps/locales/types.tsx index 674e7fc8a..1276360a0 100644 --- a/client/packages/lowcoder-comps/src/i18n/comps/locales/types.tsx +++ b/client/packages/lowcoder-comps/src/i18n/comps/locales/types.tsx @@ -2,6 +2,7 @@ import { JSONObject } from "lowcoder-sdk"; import { XAXisComponentOption } from "echarts"; export type I18nObjects = { + defaultBarChartOption: Record<string, unknown>; defaultDataSource: JSONObject[]; defaultEchartsJsonOption: Record<string, unknown>; defaultGaugeChartOption: Record<string, unknown>; @@ -26,4 +27,8 @@ export type I18nObjects = { defaultMapJsonOption: Record<string, unknown>; timeXAxisLabel?: XAXisComponentOption["axisLabel"]; imageEditorLocale?: Record<string, string>; + defaultPieBg: string; + usaMap: Record<string, unknown>; + defaultDatasourceBoxplot: unknown[]; + defaultDatasourceParallel: unknown[]; }; diff --git a/client/packages/lowcoder-comps/src/index.ts b/client/packages/lowcoder-comps/src/index.ts index acdc6c784..4d621f71b 100644 --- a/client/packages/lowcoder-comps/src/index.ts +++ b/client/packages/lowcoder-comps/src/index.ts @@ -19,10 +19,24 @@ import { MeetingControllerComp } from "./comps/agoraMeetingComp/meetingControlle import { VideoMeetingStreamComp } from "./comps/agoraMeetingComp/videoMeetingStreamComp"; import { VideoSharingStreamComp } from "./comps/agoraMeetingComp/videoSharingStreamComp"; import { BasicChartCompWithDefault } from "comps/basicChartComp/chartComp"; +import { BarChartCompWithDefault } from "comps/barChartComp/barChartComp"; +import { LineChartCompWithDefault } from "comps/lineChartComp/lineChartComp"; +import { PieChartCompWithDefault } from "comps/pieChartComp/pieChartComp"; +import { ScatterChartCompWithDefault } from "comps/scatterChartComp/scatterChartComp"; +import { BoxplotChartCompWithDefault } from "comps/boxplotChartComp/boxplotChartComp"; +import { ParallelChartCompWithDefault } from "comps/parallelChartComp/parallelChartComp"; +import { Line3DChartCompWithDefault } from "comps/line3dChartComp/line3dChartComp"; export default { chart: ChartCompWithDefault, basicChart: BasicChartCompWithDefault, + barChart: BarChartCompWithDefault, + lineChart: LineChartCompWithDefault, + pieChart: PieChartCompWithDefault, + scatterChart: ScatterChartCompWithDefault, + boxplotChart: BoxplotChartCompWithDefault, + parallelChart: ParallelChartCompWithDefault, + line3dChart: Line3DChartCompWithDefault, chartsGeoMap: ChartsGeoMapComp, funnelChart: FunnelChartCompWithDefault, gaugeChart: GaugeChartCompWithDefault, diff --git a/client/packages/lowcoder-core/lib/index.js b/client/packages/lowcoder-core/lib/index.js index 66045110c..32166ca50 100644 --- a/client/packages/lowcoder-core/lib/index.js +++ b/client/packages/lowcoder-core/lib/index.js @@ -3331,7 +3331,7 @@ function styleNamespace(id) { function evalStyle(id, css, globalStyle) { var _a; var styleId = styleNamespace(id); - var prefixId = globalStyle ? id : "#".concat(id); + var prefixId = globalStyle ? id : ".".concat(id); var compiledCSS = ""; css.forEach(function (i) { if (!i.trim()) { diff --git a/client/packages/lowcoder-core/src/eval/utils/evalStyle.ts b/client/packages/lowcoder-core/src/eval/utils/evalStyle.ts index b54322727..a7956a5d9 100644 --- a/client/packages/lowcoder-core/src/eval/utils/evalStyle.ts +++ b/client/packages/lowcoder-core/src/eval/utils/evalStyle.ts @@ -6,7 +6,7 @@ function styleNamespace(id: string) { export function evalStyle(id: string, css: string[], globalStyle?: boolean) { const styleId = styleNamespace(id); - const prefixId = globalStyle ? id : `#${id}` + const prefixId = globalStyle ? id : `.${id}`; let compiledCSS = ""; css.forEach((i) => { if (!i.trim()) { diff --git a/client/packages/lowcoder-design/src/components/Loading.tsx b/client/packages/lowcoder-design/src/components/Loading.tsx index 414096e33..d5ffc6710 100644 --- a/client/packages/lowcoder-design/src/components/Loading.tsx +++ b/client/packages/lowcoder-design/src/components/Loading.tsx @@ -74,6 +74,7 @@ type LoadingProps = { size?: number; // circle's size className?: string; style?: CSSProperties; + compHeight?: number; }; export const Loading = (props: LoadingProps) => { @@ -92,7 +93,11 @@ export const Loading = (props: LoadingProps) => { <Load2 {...loadingProps} /> </Container> </ContainerX> */} - <StyledSkeleton active style={{height: '100%', animationDuration: '2s'}} /> + <StyledSkeleton + active + paragraph={{rows: props.compHeight ? Math.floor((props.compHeight * 8) / 35) : 4}} + style={{height: '100%', animationDuration: '2s'}} + /> </LoadingWrapper> ); }; diff --git a/client/packages/lowcoder-design/src/components/control.tsx b/client/packages/lowcoder-design/src/components/control.tsx index a25f9df8b..cae47a3f3 100644 --- a/client/packages/lowcoder-design/src/components/control.tsx +++ b/client/packages/lowcoder-design/src/components/control.tsx @@ -159,7 +159,9 @@ export const ControlPropertyViewWrapper = ( <ToolTipLabel title={tooltip} label={label} - overlayInnerStyle={labelTooltipOverlayInnerStyle} + styles={{ + body: labelTooltipOverlayInnerStyle, + }} /> </LabelWrapper> )} diff --git a/client/packages/lowcoder-design/src/components/iconSelect/index.tsx b/client/packages/lowcoder-design/src/components/iconSelect/index.tsx index 6eac2f7b6..23c73b200 100644 --- a/client/packages/lowcoder-design/src/components/iconSelect/index.tsx +++ b/client/packages/lowcoder-design/src/components/iconSelect/index.tsx @@ -363,10 +363,12 @@ export const IconSelectBase = (props: { onOpenChange={setVisible} getPopupContainer={parent ? () => parent : undefined} // hide the original background when dragging the popover is allowed - overlayInnerStyle={{ - border: "none", - boxShadow: "none", - background: "transparent", + styles={{ + body: { + border: "none", + boxShadow: "none", + background: "transparent", + } }} // when dragging is allowed, always re-location to avoid the popover exceeds the screen destroyTooltipOnHide diff --git a/client/packages/lowcoder-design/src/components/popover.tsx b/client/packages/lowcoder-design/src/components/popover.tsx index c7e745d06..4a6d0cbb5 100644 --- a/client/packages/lowcoder-design/src/components/popover.tsx +++ b/client/packages/lowcoder-design/src/components/popover.tsx @@ -64,7 +64,6 @@ const SimplePopover = (props: { ); return ( <Popover - overlayInnerStyle={{padding: 0}} align={{ offset: [-12, 0, 0, 0], }} @@ -74,7 +73,10 @@ const SimplePopover = (props: { open={visible} onOpenChange={setVisible} placement="left" - overlayStyle={{ width: "310px" }} + styles={{ + root: { width: "310px" }, + body: { padding: 0 } + }} > {props.children} </Popover> @@ -101,16 +103,18 @@ const CustomPopover = (props: { ); return ( <Popover - overlayInnerStyle={{padding: 0}} content={contentWithBox} trigger="click" open={visible} onOpenChange={setVisible} placement={props.type === "query" ? "top" : "left"} - overlayStyle={{ width: "310px" }} align={{ offset: [-12, 0, 0, 0], }} + styles={{ + root: { width: "310px" }, + body: { padding: 0 } + }} > {props.children} </Popover> @@ -167,8 +171,10 @@ const EditPopover = (props: EditPopoverProps) => { return ( <Popover arrow={false} - overlayStyle={{paddingTop: '15px'}} - overlayInnerStyle={{padding: 0}} + styles={{ + root: { paddingTop: '15px' }, + body: { padding: 0 } + }} content={() => ( <> <Wedge /> diff --git a/client/packages/lowcoder-design/src/components/shapeSelect/index.tsx b/client/packages/lowcoder-design/src/components/shapeSelect/index.tsx index a4a71964b..060945977 100644 --- a/client/packages/lowcoder-design/src/components/shapeSelect/index.tsx +++ b/client/packages/lowcoder-design/src/components/shapeSelect/index.tsx @@ -444,10 +444,12 @@ export const ShapeSelectBase = (props: { onOpenChange={setVisible} getPopupContainer={parent ? () => parent : undefined} // hide the original background when dragging the popover is allowed - overlayInnerStyle={{ - border: "none", - boxShadow: "none", - background: "transparent", + styles={{ + body: { + border: "none", + boxShadow: "none", + background: "transparent", + } }} // when dragging is allowed, always re-location to avoid the popover exceeds the screen destroyTooltipOnHide diff --git a/client/packages/lowcoder-design/src/components/toolTip.tsx b/client/packages/lowcoder-design/src/components/toolTip.tsx index 9b5a624c2..3a6b53843 100644 --- a/client/packages/lowcoder-design/src/components/toolTip.tsx +++ b/client/packages/lowcoder-design/src/components/toolTip.tsx @@ -155,7 +155,7 @@ export const UnderlineCss = css` `; function Tooltip(props: TooltipProps) { - return <AntdTooltip color="#2c2c2c2" overlayInnerStyle={overlayInnerCss} {...props} />; + return <AntdTooltip color="#2c2c2c2" styles={{ body: overlayInnerCss }} {...props} />; } const Label = styled.div<{ $border?: boolean }>` @@ -181,7 +181,9 @@ function ToolTipLabel( <AntdTooltip color="#2c2c2c" title={title && <TooltipTitleWrapper><>{title}</></TooltipTitleWrapper>} - overlayInnerStyle={{ maxWidth: "232px", whiteSpace: "break-spaces" }} + styles={{ + body: { maxWidth: "232px", whiteSpace: "break-spaces" } + }} arrow={{ pointAtCenter: true }} diff --git a/client/packages/lowcoder-design/src/icons/index.tsx b/client/packages/lowcoder-design/src/icons/index.tsx index 12b14d6b5..02b0898f3 100644 --- a/client/packages/lowcoder-design/src/icons/index.tsx +++ b/client/packages/lowcoder-design/src/icons/index.tsx @@ -345,6 +345,7 @@ export { ReactComponent as VideoScreenshareCompIconSmall } from "./v2/screen-sha export { ReactComponent as SignatureCompIconSmall } from "./v2/signature-s.svg"; export { ReactComponent as StepCompIconSmall } from "./v2/steps-s.svg"; + export { ReactComponent as CandlestickChartCompIconSmall } from "./v2/candlestick-chart-s.svg"; // new export { ReactComponent as FunnelChartCompIconSmall } from "./v2/funnel-chart-s.svg"; // new export { ReactComponent as GaugeChartCompIconSmall } from "./v2/gauge-chart-s.svg"; // new @@ -364,6 +365,10 @@ export { ReactComponent as PivotTableCompIconSmall } from "./v2/pivot-table-s.sv export { ReactComponent as TurnstileCaptchaCompIconSmall } from "./v2/turnstile-captcha-s.svg"; // new export { ReactComponent as GanttCompIconSmall } from "./v2/gantt-chart-s.svg"; // new +export { ReactComponent as PieChartCompIconSmall } from "./v2/pie-chart-s.svg"; // new +export { ReactComponent as BarChartCompIconSmall } from "./v2/bar-chart-s.svg"; // new +export { ReactComponent as LineChartCompIconSmall } from "./v2/line-chart-s.svg"; // new +export { ReactComponent as ScatterChartCompIconSmall } from "./v2/scatter-chart-s.svg"; // new // medium export { ReactComponent as AudioCompIcon } from "./v2/audio-player-m.svg"; @@ -465,6 +470,11 @@ export { ReactComponent as ThemeriverChartCompIcon } from "./v2/themeriver-chart export { ReactComponent as TreeChartCompIcon } from "./v2/tree-chart-m.svg"; export { ReactComponent as TreemapChartCompIcon } from "./v2/treemap-chart-m.svg"; +export { ReactComponent as PieChartCompIcon } from "./v2/pie-chart-m.svg"; // new +export { ReactComponent as BarChartCompIcon } from "./v2/bar-chart-m.svg"; // new +export { ReactComponent as LineChartCompIcon } from "./v2/line-chart-m.svg"; // new +export { ReactComponent as ScatterChartCompIcon } from "./v2/scatter-chart-m.svg"; // new + export { ReactComponent as BPMNEditorCompIcon } from "./v2/bpmn-editor-m.svg"; export { ReactComponent as GeoMapChartsCompIcon } from "./v2/geomap-charts-m.svg"; export { ReactComponent as GeoMapLayersCompIcon } from "./v2/geomap-layers-m.svg"; diff --git a/client/packages/lowcoder-design/src/icons/v2/line-chart-l.svg b/client/packages/lowcoder-design/src/icons/v2/line-chart-l.svg new file mode 100644 index 000000000..2c1b9074b --- /dev/null +++ b/client/packages/lowcoder-design/src/icons/v2/line-chart-l.svg @@ -0,0 +1,1264 @@ +<svg width="169" height="96" viewBox="0 0 169 96" fill="none" xmlns="http://www.w3.org/2000/svg"> +<g clip-path="url(#clip0_408_1800)"> +<rect width="169" height="96" fill="url(#paint0_radial_408_1800)"/> +<g opacity="0.06"> +<rect x="3.31445" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="3.31445" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="3.31445" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="8.02344" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 8.02344 3.07227)" fill="#B480DE"/> +<rect x="8.02344" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 8.02344 3.07227)" fill="#B480DE"/> +<rect x="8.02344" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 8.02344 3.07227)" fill="#B480DE"/> +<rect x="3.31445" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 3.31445 3.07227)" fill="#B480DE"/> +<rect x="3.31445" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 3.31445 3.07227)" fill="#B480DE"/> +<rect x="3.31445" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 3.31445 3.07227)" fill="#B480DE"/> +<rect x="15.9971" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="15.9971" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="15.9971" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="20.7061" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 20.7061 3.07227)" fill="#B480DE"/> +<rect x="20.7061" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 20.7061 3.07227)" fill="#B480DE"/> +<rect x="20.7061" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 20.7061 3.07227)" fill="#B480DE"/> +<rect x="15.9971" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 15.9971 3.07227)" fill="#B480DE"/> +<rect x="15.9971" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 15.9971 3.07227)" fill="#B480DE"/> +<rect x="15.9971" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 15.9971 3.07227)" fill="#B480DE"/> +<rect x="28.6787" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="28.6787" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="28.6787" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="33.3877" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 33.3877 3.07227)" fill="#B480DE"/> +<rect x="33.3877" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 33.3877 3.07227)" fill="#B480DE"/> +<rect x="33.3877" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 33.3877 3.07227)" fill="#B480DE"/> +<rect x="28.6787" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 28.6787 3.07227)" fill="#B480DE"/> +<rect x="28.6787" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 28.6787 3.07227)" fill="#B480DE"/> +<rect x="28.6787" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 28.6787 3.07227)" fill="#B480DE"/> +<rect x="41.3613" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="41.3613" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="41.3613" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="46.0703" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 46.0703 3.07227)" fill="#B480DE"/> +<rect x="46.0703" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 46.0703 3.07227)" fill="#B480DE"/> +<rect x="46.0703" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 46.0703 3.07227)" fill="#B480DE"/> +<rect x="41.3613" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 41.3613 3.07227)" fill="#B480DE"/> +<rect x="41.3613" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 41.3613 3.07227)" fill="#B480DE"/> +<rect x="41.3613" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 41.3613 3.07227)" fill="#B480DE"/> +<rect x="54.0439" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="54.0439" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="54.0439" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="58.7529" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 58.7529 3.07227)" fill="#B480DE"/> +<rect x="58.7529" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 58.7529 3.07227)" fill="#B480DE"/> +<rect x="58.7529" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 58.7529 3.07227)" fill="#B480DE"/> +<rect x="54.0439" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 54.0439 3.07227)" fill="#B480DE"/> +<rect x="54.0439" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 54.0439 3.07227)" fill="#B480DE"/> +<rect x="54.0439" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 54.0439 3.07227)" fill="#B480DE"/> +<rect x="66.7256" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="66.7256" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="66.7256" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="71.4346" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 71.4346 3.07227)" fill="#B480DE"/> +<rect x="71.4346" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 71.4346 3.07227)" fill="#B480DE"/> +<rect x="71.4346" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 71.4346 3.07227)" fill="#B480DE"/> +<rect x="66.7256" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 66.7256 3.07227)" fill="#B480DE"/> +<rect x="66.7256" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 66.7256 3.07227)" fill="#B480DE"/> +<rect x="66.7256" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 66.7256 3.07227)" fill="#B480DE"/> +<rect x="79.4082" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="79.4082" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="79.4082" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="84.1172" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 84.1172 3.07227)" fill="#B480DE"/> +<rect x="84.1172" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 84.1172 3.07227)" fill="#B480DE"/> +<rect x="84.1172" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 84.1172 3.07227)" fill="#B480DE"/> +<rect x="79.4082" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 79.4082 3.07227)" fill="#B480DE"/> +<rect x="79.4082" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 79.4082 3.07227)" fill="#B480DE"/> +<rect x="79.4082" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 79.4082 3.07227)" fill="#B480DE"/> +<rect x="92.0898" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="92.0898" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="92.0898" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="96.7988" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 96.7988 3.07227)" fill="#B480DE"/> +<rect x="96.7988" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 96.7988 3.07227)" fill="#B480DE"/> +<rect x="96.7988" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 96.7988 3.07227)" fill="#B480DE"/> +<rect x="92.0898" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 92.0898 3.07227)" fill="#B480DE"/> +<rect x="92.0898" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 92.0898 3.07227)" fill="#B480DE"/> +<rect x="92.0898" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 92.0898 3.07227)" fill="#B480DE"/> +<rect x="104.772" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="104.772" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="104.772" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="109.481" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 109.481 3.07227)" fill="#B480DE"/> +<rect x="109.481" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 109.481 3.07227)" fill="#B480DE"/> +<rect x="109.481" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 109.481 3.07227)" fill="#B480DE"/> +<rect x="104.772" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 104.772 3.07227)" fill="#B480DE"/> +<rect x="104.772" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 104.772 3.07227)" fill="#B480DE"/> +<rect x="104.772" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 104.772 3.07227)" fill="#B480DE"/> +<rect x="117.455" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="117.455" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="117.455" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="122.164" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 122.164 3.07227)" fill="#B480DE"/> +<rect x="122.164" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 122.164 3.07227)" fill="#B480DE"/> +<rect x="122.164" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 122.164 3.07227)" fill="#B480DE"/> +<rect x="117.455" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 117.455 3.07227)" fill="#B480DE"/> +<rect x="117.455" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 117.455 3.07227)" fill="#B480DE"/> +<rect x="117.455" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 117.455 3.07227)" fill="#B480DE"/> +<rect x="130.137" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="130.137" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="130.137" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="134.846" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 134.846 3.07227)" fill="#B480DE"/> +<rect x="134.846" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 134.846 3.07227)" fill="#B480DE"/> +<rect x="134.846" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 134.846 3.07227)" fill="#B480DE"/> +<rect x="130.137" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 130.137 3.07227)" fill="#B480DE"/> +<rect x="130.137" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 130.137 3.07227)" fill="#B480DE"/> +<rect x="130.137" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 130.137 3.07227)" fill="#B480DE"/> +<rect x="142.819" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="142.819" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="142.819" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="147.528" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 147.528 3.07227)" fill="#B480DE"/> +<rect x="147.528" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 147.528 3.07227)" fill="#B480DE"/> +<rect x="147.528" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 147.528 3.07227)" fill="#B480DE"/> +<rect x="142.819" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 142.819 3.07227)" fill="#B480DE"/> +<rect x="142.819" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 142.819 3.07227)" fill="#B480DE"/> +<rect x="142.819" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 142.819 3.07227)" fill="#B480DE"/> +<rect x="155.502" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="155.502" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="155.502" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="160.211" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 160.211 3.07227)" fill="#B480DE"/> +<rect x="160.211" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 160.211 3.07227)" fill="#B480DE"/> +<rect x="160.211" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 160.211 3.07227)" fill="#B480DE"/> +<rect x="155.502" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 155.502 3.07227)" fill="#B480DE"/> +<rect x="155.502" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 155.502 3.07227)" fill="#B480DE"/> +<rect x="155.502" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 155.502 3.07227)" fill="#B480DE"/> +<rect x="168.184" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="168.184" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="168.184" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="168.184" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 168.184 3.07227)" fill="#B480DE"/> +<rect x="168.184" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 168.184 3.07227)" fill="#B480DE"/> +<rect x="168.184" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 168.184 3.07227)" fill="#B480DE"/> +<rect x="1.68262" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 1.68262 12.8789)" fill="#B480DE"/> +<rect x="1.68262" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 1.68262 12.8789)" fill="#B480DE"/> +<rect x="1.68262" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 1.68262 12.8789)" fill="#B480DE"/> +<rect x="9.65625" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="9.65625" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="9.65625" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="14.3652" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 14.3652 12.8789)" fill="#B480DE"/> +<rect x="14.3652" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 14.3652 12.8789)" fill="#B480DE"/> +<rect x="14.3652" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 14.3652 12.8789)" fill="#B480DE"/> +<rect x="9.65625" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 9.65625 12.8789)" fill="#B480DE"/> +<rect x="9.65625" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 9.65625 12.8789)" fill="#B480DE"/> +<rect x="9.65625" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 9.65625 12.8789)" fill="#B480DE"/> +<rect x="22.3379" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="22.3379" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="22.3379" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="27.0469" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 27.0469 12.8789)" fill="#B480DE"/> +<rect x="27.0469" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 27.0469 12.8789)" fill="#B480DE"/> +<rect x="27.0469" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 27.0469 12.8789)" fill="#B480DE"/> +<rect x="22.3379" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 22.3379 12.8789)" fill="#B480DE"/> +<rect x="22.3379" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 22.3379 12.8789)" fill="#B480DE"/> +<rect x="22.3379" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 22.3379 12.8789)" fill="#B480DE"/> +<rect x="35.0205" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="35.0205" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="35.0205" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="39.7295" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 39.7295 12.8789)" fill="#B480DE"/> +<rect x="39.7295" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 39.7295 12.8789)" fill="#B480DE"/> +<rect x="39.7295" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 39.7295 12.8789)" fill="#B480DE"/> +<rect x="35.0205" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 35.0205 12.8789)" fill="#B480DE"/> +<rect x="35.0205" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 35.0205 12.8789)" fill="#B480DE"/> +<rect x="35.0205" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 35.0205 12.8789)" fill="#B480DE"/> +<rect x="47.7031" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="47.7031" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="47.7031" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="52.4121" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 52.4121 12.8789)" fill="#B480DE"/> +<rect x="52.4121" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 52.4121 12.8789)" fill="#B480DE"/> +<rect x="52.4121" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 52.4121 12.8789)" fill="#B480DE"/> +<rect x="47.7031" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 47.7031 12.8789)" fill="#B480DE"/> +<rect x="47.7031" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 47.7031 12.8789)" fill="#B480DE"/> +<rect x="47.7031" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 47.7031 12.8789)" fill="#B480DE"/> +<rect x="60.3848" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="60.3848" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="60.3848" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="65.0938" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 65.0938 12.8789)" fill="#B480DE"/> +<rect x="65.0938" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 65.0938 12.8789)" fill="#B480DE"/> +<rect x="65.0938" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 65.0938 12.8789)" fill="#B480DE"/> +<rect x="60.3848" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 60.3848 12.8789)" fill="#B480DE"/> +<rect x="60.3848" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 60.3848 12.8789)" fill="#B480DE"/> +<rect x="60.3848" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 60.3848 12.8789)" fill="#B480DE"/> +<rect x="73.0674" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="73.0674" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="73.0674" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="77.7764" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 77.7764 12.8789)" fill="#B480DE"/> +<rect x="77.7764" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 77.7764 12.8789)" fill="#B480DE"/> +<rect x="77.7764" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 77.7764 12.8789)" fill="#B480DE"/> +<rect x="73.0674" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 73.0674 12.8789)" fill="#B480DE"/> +<rect x="73.0674" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 73.0674 12.8789)" fill="#B480DE"/> +<rect x="73.0674" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 73.0674 12.8789)" fill="#B480DE"/> +<rect x="85.749" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="85.749" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="85.749" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="90.458" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 90.458 12.8789)" fill="#B480DE"/> +<rect x="90.458" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 90.458 12.8789)" fill="#B480DE"/> +<rect x="90.458" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 90.458 12.8789)" fill="#B480DE"/> +<rect x="85.749" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 85.749 12.8789)" fill="#B480DE"/> +<rect x="85.749" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 85.749 12.8789)" fill="#B480DE"/> +<rect x="85.749" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 85.749 12.8789)" fill="#B480DE"/> +<rect x="98.4316" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="98.4316" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="98.4316" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="103.141" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 103.141 12.8789)" fill="#B480DE"/> +<rect x="103.141" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 103.141 12.8789)" fill="#B480DE"/> +<rect x="103.141" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 103.141 12.8789)" fill="#B480DE"/> +<rect x="98.4316" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 98.4316 12.8789)" fill="#B480DE"/> +<rect x="98.4316" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 98.4316 12.8789)" fill="#B480DE"/> +<rect x="98.4316" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 98.4316 12.8789)" fill="#B480DE"/> +<rect x="111.114" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="111.114" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="111.114" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="115.823" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 115.823 12.8789)" fill="#B480DE"/> +<rect x="115.823" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 115.823 12.8789)" fill="#B480DE"/> +<rect x="115.823" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 115.823 12.8789)" fill="#B480DE"/> +<rect x="111.114" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 111.114 12.8789)" fill="#B480DE"/> +<rect x="111.114" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 111.114 12.8789)" fill="#B480DE"/> +<rect x="111.114" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 111.114 12.8789)" fill="#B480DE"/> +<rect x="123.796" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="123.796" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="123.796" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="128.505" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 128.505 12.8789)" fill="#B480DE"/> +<rect x="128.505" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 128.505 12.8789)" fill="#B480DE"/> +<rect x="128.505" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 128.505 12.8789)" fill="#B480DE"/> +<rect x="123.796" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 123.796 12.8789)" fill="#B480DE"/> +<rect x="123.796" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 123.796 12.8789)" fill="#B480DE"/> +<rect x="123.796" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 123.796 12.8789)" fill="#B480DE"/> +<rect x="136.479" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="136.479" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="136.479" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="141.188" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 141.188 12.8789)" fill="#B480DE"/> +<rect x="141.188" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 141.188 12.8789)" fill="#B480DE"/> +<rect x="141.188" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 141.188 12.8789)" fill="#B480DE"/> +<rect x="136.479" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 136.479 12.8789)" fill="#B480DE"/> +<rect x="136.479" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 136.479 12.8789)" fill="#B480DE"/> +<rect x="136.479" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 136.479 12.8789)" fill="#B480DE"/> +<rect x="149.161" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="149.161" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="149.161" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="153.87" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 153.87 12.8789)" fill="#B480DE"/> +<rect x="153.87" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 153.87 12.8789)" fill="#B480DE"/> +<rect x="153.87" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 153.87 12.8789)" fill="#B480DE"/> +<rect x="149.161" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 149.161 12.8789)" fill="#B480DE"/> +<rect x="149.161" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 149.161 12.8789)" fill="#B480DE"/> +<rect x="149.161" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 149.161 12.8789)" fill="#B480DE"/> +<rect x="161.843" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="161.843" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="161.843" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="166.552" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 166.552 12.8789)" fill="#B480DE"/> +<rect x="166.552" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 166.552 12.8789)" fill="#B480DE"/> +<rect x="166.552" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 166.552 12.8789)" fill="#B480DE"/> +<rect x="161.843" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 161.843 12.8789)" fill="#B480DE"/> +<rect x="161.843" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 161.843 12.8789)" fill="#B480DE"/> +<rect x="161.843" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 161.843 12.8789)" fill="#B480DE"/> +<rect x="3.31445" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="3.31445" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="3.31445" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="8.02344" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 8.02344 22.6855)" fill="#B480DE"/> +<rect x="8.02344" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 8.02344 22.6855)" fill="#B480DE"/> +<rect x="8.02344" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 8.02344 22.6855)" fill="#B480DE"/> +<rect x="3.31445" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 3.31445 22.6855)" fill="#B480DE"/> +<rect x="3.31445" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 3.31445 22.6855)" fill="#B480DE"/> +<rect x="3.31445" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 3.31445 22.6855)" fill="#B480DE"/> +<rect x="15.9971" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="15.9971" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="15.9971" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="20.7061" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 20.7061 22.6855)" fill="#B480DE"/> +<rect x="20.7061" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 20.7061 22.6855)" fill="#B480DE"/> +<rect x="20.7061" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 20.7061 22.6855)" fill="#B480DE"/> +<rect x="15.9971" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 15.9971 22.6855)" fill="#B480DE"/> +<rect x="15.9971" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 15.9971 22.6855)" fill="#B480DE"/> +<rect x="15.9971" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 15.9971 22.6855)" fill="#B480DE"/> +<rect x="28.6787" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="28.6787" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="28.6787" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="33.3877" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 33.3877 22.6855)" fill="#B480DE"/> +<rect x="33.3877" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 33.3877 22.6855)" fill="#B480DE"/> +<rect x="33.3877" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 33.3877 22.6855)" fill="#B480DE"/> +<rect x="28.6787" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 28.6787 22.6855)" fill="#B480DE"/> +<rect x="28.6787" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 28.6787 22.6855)" fill="#B480DE"/> +<rect x="28.6787" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 28.6787 22.6855)" fill="#B480DE"/> +<rect x="41.3613" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="41.3613" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="41.3613" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="46.0703" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 46.0703 22.6855)" fill="#B480DE"/> +<rect x="46.0703" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 46.0703 22.6855)" fill="#B480DE"/> +<rect x="46.0703" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 46.0703 22.6855)" fill="#B480DE"/> +<rect x="41.3613" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 41.3613 22.6855)" fill="#B480DE"/> +<rect x="41.3613" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 41.3613 22.6855)" fill="#B480DE"/> +<rect x="41.3613" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 41.3613 22.6855)" fill="#B480DE"/> +<rect x="54.0439" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="54.0439" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="54.0439" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="58.7529" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 58.7529 22.6855)" fill="#B480DE"/> +<rect x="58.7529" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 58.7529 22.6855)" fill="#B480DE"/> +<rect x="58.7529" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 58.7529 22.6855)" fill="#B480DE"/> +<rect x="54.0439" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 54.0439 22.6855)" fill="#B480DE"/> +<rect x="54.0439" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 54.0439 22.6855)" fill="#B480DE"/> +<rect x="54.0439" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 54.0439 22.6855)" fill="#B480DE"/> +<rect x="66.7256" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="66.7256" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="66.7256" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="71.4346" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 71.4346 22.6855)" fill="#B480DE"/> +<rect x="71.4346" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 71.4346 22.6855)" fill="#B480DE"/> +<rect x="71.4346" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 71.4346 22.6855)" fill="#B480DE"/> +<rect x="66.7256" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 66.7256 22.6855)" fill="#B480DE"/> +<rect x="66.7256" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 66.7256 22.6855)" fill="#B480DE"/> +<rect x="66.7256" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 66.7256 22.6855)" fill="#B480DE"/> +<rect x="79.4082" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="79.4082" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="79.4082" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="84.1172" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 84.1172 22.6855)" fill="#B480DE"/> +<rect x="84.1172" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 84.1172 22.6855)" fill="#B480DE"/> +<rect x="84.1172" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 84.1172 22.6855)" fill="#B480DE"/> +<rect x="79.4082" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 79.4082 22.6855)" fill="#B480DE"/> +<rect x="79.4082" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 79.4082 22.6855)" fill="#B480DE"/> +<rect x="79.4082" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 79.4082 22.6855)" fill="#B480DE"/> +<rect x="92.0898" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="92.0898" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="92.0898" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="96.7988" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 96.7988 22.6855)" fill="#B480DE"/> +<rect x="96.7988" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 96.7988 22.6855)" fill="#B480DE"/> +<rect x="96.7988" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 96.7988 22.6855)" fill="#B480DE"/> +<rect x="92.0898" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 92.0898 22.6855)" fill="#B480DE"/> +<rect x="92.0898" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 92.0898 22.6855)" fill="#B480DE"/> +<rect x="92.0898" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 92.0898 22.6855)" fill="#B480DE"/> +<rect x="104.772" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="104.772" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="104.772" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="109.481" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 109.481 22.6855)" fill="#B480DE"/> +<rect x="109.481" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 109.481 22.6855)" fill="#B480DE"/> +<rect x="109.481" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 109.481 22.6855)" fill="#B480DE"/> +<rect x="104.772" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 104.772 22.6855)" fill="#B480DE"/> +<rect x="104.772" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 104.772 22.6855)" fill="#B480DE"/> +<rect x="104.772" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 104.772 22.6855)" fill="#B480DE"/> +<rect x="117.455" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="117.455" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="117.455" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="122.164" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 122.164 22.6855)" fill="#B480DE"/> +<rect x="122.164" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 122.164 22.6855)" fill="#B480DE"/> +<rect x="122.164" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 122.164 22.6855)" fill="#B480DE"/> +<rect x="117.455" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 117.455 22.6855)" fill="#B480DE"/> +<rect x="117.455" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 117.455 22.6855)" fill="#B480DE"/> +<rect x="117.455" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 117.455 22.6855)" fill="#B480DE"/> +<rect x="130.137" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="130.137" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="130.137" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="134.846" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 134.846 22.6855)" fill="#B480DE"/> +<rect x="134.846" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 134.846 22.6855)" fill="#B480DE"/> +<rect x="134.846" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 134.846 22.6855)" fill="#B480DE"/> +<rect x="130.137" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 130.137 22.6855)" fill="#B480DE"/> +<rect x="130.137" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 130.137 22.6855)" fill="#B480DE"/> +<rect x="130.137" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 130.137 22.6855)" fill="#B480DE"/> +<rect x="142.819" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="142.819" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="142.819" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="147.528" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 147.528 22.6855)" fill="#B480DE"/> +<rect x="147.528" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 147.528 22.6855)" fill="#B480DE"/> +<rect x="147.528" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 147.528 22.6855)" fill="#B480DE"/> +<rect x="142.819" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 142.819 22.6855)" fill="#B480DE"/> +<rect x="142.819" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 142.819 22.6855)" fill="#B480DE"/> +<rect x="142.819" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 142.819 22.6855)" fill="#B480DE"/> +<rect x="155.502" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="155.502" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="155.502" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="160.211" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 160.211 22.6855)" fill="#B480DE"/> +<rect x="160.211" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 160.211 22.6855)" fill="#B480DE"/> +<rect x="160.211" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 160.211 22.6855)" fill="#B480DE"/> +<rect x="155.502" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 155.502 22.6855)" fill="#B480DE"/> +<rect x="155.502" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 155.502 22.6855)" fill="#B480DE"/> +<rect x="155.502" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 155.502 22.6855)" fill="#B480DE"/> +<rect x="168.184" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="168.184" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="168.184" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="168.184" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 168.184 22.6855)" fill="#B480DE"/> +<rect x="168.184" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 168.184 22.6855)" fill="#B480DE"/> +<rect x="168.184" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 168.184 22.6855)" fill="#B480DE"/> +<rect x="1.68262" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 1.68262 32.4902)" fill="#B480DE"/> +<rect x="1.68262" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 1.68262 32.4902)" fill="#B480DE"/> +<rect x="1.68262" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 1.68262 32.4902)" fill="#B480DE"/> +<rect x="9.65625" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="9.65625" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="9.65625" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="14.3652" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 14.3652 32.4902)" fill="#B480DE"/> +<rect x="14.3652" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 14.3652 32.4902)" fill="#B480DE"/> +<rect x="14.3652" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 14.3652 32.4902)" fill="#B480DE"/> +<rect x="9.65625" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 9.65625 32.4902)" fill="#B480DE"/> +<rect x="9.65625" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 9.65625 32.4902)" fill="#B480DE"/> +<rect x="9.65625" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 9.65625 32.4902)" fill="#B480DE"/> +<rect x="22.3379" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="22.3379" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="22.3379" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="27.0469" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 27.0469 32.4902)" fill="#B480DE"/> +<rect x="27.0469" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 27.0469 32.4902)" fill="#B480DE"/> +<rect x="27.0469" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 27.0469 32.4902)" fill="#B480DE"/> +<rect x="22.3379" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 22.3379 32.4902)" fill="#B480DE"/> +<rect x="22.3379" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 22.3379 32.4902)" fill="#B480DE"/> +<rect x="22.3379" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 22.3379 32.4902)" fill="#B480DE"/> +<rect x="35.0205" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="35.0205" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="35.0205" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="39.7295" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 39.7295 32.4902)" fill="#B480DE"/> +<rect x="39.7295" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 39.7295 32.4902)" fill="#B480DE"/> +<rect x="39.7295" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 39.7295 32.4902)" fill="#B480DE"/> +<rect x="35.0205" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 35.0205 32.4902)" fill="#B480DE"/> +<rect x="35.0205" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 35.0205 32.4902)" fill="#B480DE"/> +<rect x="35.0205" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 35.0205 32.4902)" fill="#B480DE"/> +<rect x="47.7031" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="47.7031" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="47.7031" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="52.4121" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 52.4121 32.4902)" fill="#B480DE"/> +<rect x="52.4121" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 52.4121 32.4902)" fill="#B480DE"/> +<rect x="52.4121" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 52.4121 32.4902)" fill="#B480DE"/> +<rect x="47.7031" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 47.7031 32.4902)" fill="#B480DE"/> +<rect x="47.7031" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 47.7031 32.4902)" fill="#B480DE"/> +<rect x="47.7031" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 47.7031 32.4902)" fill="#B480DE"/> +<rect x="60.3848" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="60.3848" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="60.3848" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="65.0938" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 65.0938 32.4902)" fill="#B480DE"/> +<rect x="65.0938" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 65.0938 32.4902)" fill="#B480DE"/> +<rect x="65.0938" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 65.0938 32.4902)" fill="#B480DE"/> +<rect x="60.3848" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 60.3848 32.4902)" fill="#B480DE"/> +<rect x="60.3848" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 60.3848 32.4902)" fill="#B480DE"/> +<rect x="60.3848" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 60.3848 32.4902)" fill="#B480DE"/> +<rect x="73.0674" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="73.0674" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="73.0674" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="77.7764" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 77.7764 32.4902)" fill="#B480DE"/> +<rect x="77.7764" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 77.7764 32.4902)" fill="#B480DE"/> +<rect x="77.7764" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 77.7764 32.4902)" fill="#B480DE"/> +<rect x="73.0674" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 73.0674 32.4902)" fill="#B480DE"/> +<rect x="73.0674" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 73.0674 32.4902)" fill="#B480DE"/> +<rect x="73.0674" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 73.0674 32.4902)" fill="#B480DE"/> +<rect x="85.749" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="85.749" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="85.749" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="90.458" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 90.458 32.4902)" fill="#B480DE"/> +<rect x="90.458" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 90.458 32.4902)" fill="#B480DE"/> +<rect x="90.458" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 90.458 32.4902)" fill="#B480DE"/> +<rect x="85.749" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 85.749 32.4902)" fill="#B480DE"/> +<rect x="85.749" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 85.749 32.4902)" fill="#B480DE"/> +<rect x="85.749" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 85.749 32.4902)" fill="#B480DE"/> +<rect x="98.4316" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="98.4316" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="98.4316" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="103.141" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 103.141 32.4902)" fill="#B480DE"/> +<rect x="103.141" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 103.141 32.4902)" fill="#B480DE"/> +<rect x="103.141" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 103.141 32.4902)" fill="#B480DE"/> +<rect x="98.4316" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 98.4316 32.4902)" fill="#B480DE"/> +<rect x="98.4316" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 98.4316 32.4902)" fill="#B480DE"/> +<rect x="98.4316" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 98.4316 32.4902)" fill="#B480DE"/> +<rect x="111.114" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="111.114" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="111.114" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="115.823" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 115.823 32.4902)" fill="#B480DE"/> +<rect x="115.823" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 115.823 32.4902)" fill="#B480DE"/> +<rect x="115.823" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 115.823 32.4902)" fill="#B480DE"/> +<rect x="111.114" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 111.114 32.4902)" fill="#B480DE"/> +<rect x="111.114" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 111.114 32.4902)" fill="#B480DE"/> +<rect x="111.114" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 111.114 32.4902)" fill="#B480DE"/> +<rect x="123.796" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="123.796" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="123.796" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="128.505" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 128.505 32.4902)" fill="#B480DE"/> +<rect x="128.505" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 128.505 32.4902)" fill="#B480DE"/> +<rect x="128.505" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 128.505 32.4902)" fill="#B480DE"/> +<rect x="123.796" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 123.796 32.4902)" fill="#B480DE"/> +<rect x="123.796" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 123.796 32.4902)" fill="#B480DE"/> +<rect x="123.796" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 123.796 32.4902)" fill="#B480DE"/> +<rect x="136.479" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="136.479" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="136.479" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="141.188" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 141.188 32.4902)" fill="#B480DE"/> +<rect x="141.188" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 141.188 32.4902)" fill="#B480DE"/> +<rect x="141.188" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 141.188 32.4902)" fill="#B480DE"/> +<rect x="136.479" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 136.479 32.4902)" fill="#B480DE"/> +<rect x="136.479" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 136.479 32.4902)" fill="#B480DE"/> +<rect x="136.479" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 136.479 32.4902)" fill="#B480DE"/> +<rect x="149.161" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="149.161" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="149.161" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="153.87" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 153.87 32.4902)" fill="#B480DE"/> +<rect x="153.87" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 153.87 32.4902)" fill="#B480DE"/> +<rect x="153.87" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 153.87 32.4902)" fill="#B480DE"/> +<rect x="149.161" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 149.161 32.4902)" fill="#B480DE"/> +<rect x="149.161" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 149.161 32.4902)" fill="#B480DE"/> +<rect x="149.161" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 149.161 32.4902)" fill="#B480DE"/> +<rect x="161.843" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="161.843" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="161.843" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="166.552" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 166.552 32.4902)" fill="#B480DE"/> +<rect x="166.552" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 166.552 32.4902)" fill="#B480DE"/> +<rect x="166.552" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 166.552 32.4902)" fill="#B480DE"/> +<rect x="161.843" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 161.843 32.4902)" fill="#B480DE"/> +<rect x="161.843" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 161.843 32.4902)" fill="#B480DE"/> +<rect x="161.843" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 161.843 32.4902)" fill="#B480DE"/> +<rect x="3.31445" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="3.31445" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="3.31445" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="8.02344" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 8.02344 42.2969)" fill="#B480DE"/> +<rect x="8.02344" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 8.02344 42.2969)" fill="#B480DE"/> +<rect x="8.02344" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 8.02344 42.2969)" fill="#B480DE"/> +<rect x="3.31445" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 3.31445 42.2969)" fill="#B480DE"/> +<rect x="3.31445" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 3.31445 42.2969)" fill="#B480DE"/> +<rect x="3.31445" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 3.31445 42.2969)" fill="#B480DE"/> +<rect x="15.9971" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="15.9971" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="15.9971" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="20.7061" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 20.7061 42.2969)" fill="#B480DE"/> +<rect x="20.7061" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 20.7061 42.2969)" fill="#B480DE"/> +<rect x="20.7061" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 20.7061 42.2969)" fill="#B480DE"/> +<rect x="15.9971" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 15.9971 42.2969)" fill="#B480DE"/> +<rect x="15.9971" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 15.9971 42.2969)" fill="#B480DE"/> +<rect x="15.9971" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 15.9971 42.2969)" fill="#B480DE"/> +<rect x="28.6787" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="28.6787" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="28.6787" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="33.3877" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 33.3877 42.2969)" fill="#B480DE"/> +<rect x="33.3877" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 33.3877 42.2969)" fill="#B480DE"/> +<rect x="33.3877" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 33.3877 42.2969)" fill="#B480DE"/> +<rect x="28.6787" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 28.6787 42.2969)" fill="#B480DE"/> +<rect x="28.6787" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 28.6787 42.2969)" fill="#B480DE"/> +<rect x="28.6787" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 28.6787 42.2969)" fill="#B480DE"/> +<rect x="41.3613" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="41.3613" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="41.3613" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="46.0703" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 46.0703 42.2969)" fill="#B480DE"/> +<rect x="46.0703" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 46.0703 42.2969)" fill="#B480DE"/> +<rect x="46.0703" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 46.0703 42.2969)" fill="#B480DE"/> +<rect x="41.3613" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 41.3613 42.2969)" fill="#B480DE"/> +<rect x="41.3613" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 41.3613 42.2969)" fill="#B480DE"/> +<rect x="41.3613" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 41.3613 42.2969)" fill="#B480DE"/> +<rect x="54.0439" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="54.0439" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="54.0439" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="58.7529" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 58.7529 42.2969)" fill="#B480DE"/> +<rect x="58.7529" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 58.7529 42.2969)" fill="#B480DE"/> +<rect x="58.7529" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 58.7529 42.2969)" fill="#B480DE"/> +<rect x="54.0439" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 54.0439 42.2969)" fill="#B480DE"/> +<rect x="54.0439" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 54.0439 42.2969)" fill="#B480DE"/> +<rect x="54.0439" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 54.0439 42.2969)" fill="#B480DE"/> +<rect x="66.7256" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="66.7256" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="66.7256" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="71.4346" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 71.4346 42.2969)" fill="#B480DE"/> +<rect x="71.4346" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 71.4346 42.2969)" fill="#B480DE"/> +<rect x="71.4346" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 71.4346 42.2969)" fill="#B480DE"/> +<rect x="66.7256" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 66.7256 42.2969)" fill="#B480DE"/> +<rect x="66.7256" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 66.7256 42.2969)" fill="#B480DE"/> +<rect x="66.7256" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 66.7256 42.2969)" fill="#B480DE"/> +<rect x="79.4082" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="79.4082" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="79.4082" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="84.1172" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 84.1172 42.2969)" fill="#B480DE"/> +<rect x="84.1172" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 84.1172 42.2969)" fill="#B480DE"/> +<rect x="84.1172" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 84.1172 42.2969)" fill="#B480DE"/> +<rect x="79.4082" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 79.4082 42.2969)" fill="#B480DE"/> +<rect x="79.4082" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 79.4082 42.2969)" fill="#B480DE"/> +<rect x="79.4082" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 79.4082 42.2969)" fill="#B480DE"/> +<rect x="92.0898" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="92.0898" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="92.0898" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="96.7988" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 96.7988 42.2969)" fill="#B480DE"/> +<rect x="96.7988" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 96.7988 42.2969)" fill="#B480DE"/> +<rect x="96.7988" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 96.7988 42.2969)" fill="#B480DE"/> +<rect x="92.0898" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 92.0898 42.2969)" fill="#B480DE"/> +<rect x="92.0898" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 92.0898 42.2969)" fill="#B480DE"/> +<rect x="92.0898" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 92.0898 42.2969)" fill="#B480DE"/> +<rect x="104.772" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="104.772" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="104.772" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="109.481" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 109.481 42.2969)" fill="#B480DE"/> +<rect x="109.481" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 109.481 42.2969)" fill="#B480DE"/> +<rect x="109.481" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 109.481 42.2969)" fill="#B480DE"/> +<rect x="104.772" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 104.772 42.2969)" fill="#B480DE"/> +<rect x="104.772" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 104.772 42.2969)" fill="#B480DE"/> +<rect x="104.772" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 104.772 42.2969)" fill="#B480DE"/> +<rect x="117.455" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="117.455" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="117.455" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="122.164" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 122.164 42.2969)" fill="#B480DE"/> +<rect x="122.164" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 122.164 42.2969)" fill="#B480DE"/> +<rect x="122.164" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 122.164 42.2969)" fill="#B480DE"/> +<rect x="117.455" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 117.455 42.2969)" fill="#B480DE"/> +<rect x="117.455" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 117.455 42.2969)" fill="#B480DE"/> +<rect x="117.455" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 117.455 42.2969)" fill="#B480DE"/> +<rect x="130.137" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="130.137" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="130.137" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="134.846" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 134.846 42.2969)" fill="#B480DE"/> +<rect x="134.846" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 134.846 42.2969)" fill="#B480DE"/> +<rect x="134.846" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 134.846 42.2969)" fill="#B480DE"/> +<rect x="130.137" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 130.137 42.2969)" fill="#B480DE"/> +<rect x="130.137" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 130.137 42.2969)" fill="#B480DE"/> +<rect x="130.137" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 130.137 42.2969)" fill="#B480DE"/> +<rect x="142.819" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="142.819" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="142.819" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="147.528" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 147.528 42.2969)" fill="#B480DE"/> +<rect x="147.528" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 147.528 42.2969)" fill="#B480DE"/> +<rect x="147.528" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 147.528 42.2969)" fill="#B480DE"/> +<rect x="142.819" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 142.819 42.2969)" fill="#B480DE"/> +<rect x="142.819" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 142.819 42.2969)" fill="#B480DE"/> +<rect x="142.819" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 142.819 42.2969)" fill="#B480DE"/> +<rect x="155.502" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="155.502" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="155.502" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="160.211" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 160.211 42.2969)" fill="#B480DE"/> +<rect x="160.211" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 160.211 42.2969)" fill="#B480DE"/> +<rect x="160.211" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 160.211 42.2969)" fill="#B480DE"/> +<rect x="155.502" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 155.502 42.2969)" fill="#B480DE"/> +<rect x="155.502" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 155.502 42.2969)" fill="#B480DE"/> +<rect x="155.502" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 155.502 42.2969)" fill="#B480DE"/> +<rect x="168.184" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="168.184" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="168.184" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="168.184" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 168.184 42.2969)" fill="#B480DE"/> +<rect x="168.184" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 168.184 42.2969)" fill="#B480DE"/> +<rect x="168.184" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 168.184 42.2969)" fill="#B480DE"/> +<rect x="1.68262" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 1.68262 52.1035)" fill="#B480DE"/> +<rect x="1.68262" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 1.68262 52.1035)" fill="#B480DE"/> +<rect x="1.68262" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 1.68262 52.1035)" fill="#B480DE"/> +<rect x="9.65625" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="9.65625" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="9.65625" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="14.3652" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 14.3652 52.1035)" fill="#B480DE"/> +<rect x="14.3652" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 14.3652 52.1035)" fill="#B480DE"/> +<rect x="14.3652" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 14.3652 52.1035)" fill="#B480DE"/> +<rect x="9.65625" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 9.65625 52.1035)" fill="#B480DE"/> +<rect x="9.65625" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 9.65625 52.1035)" fill="#B480DE"/> +<rect x="9.65625" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 9.65625 52.1035)" fill="#B480DE"/> +<rect x="22.3379" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="22.3379" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="22.3379" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="27.0469" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 27.0469 52.1035)" fill="#B480DE"/> +<rect x="27.0469" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 27.0469 52.1035)" fill="#B480DE"/> +<rect x="27.0469" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 27.0469 52.1035)" fill="#B480DE"/> +<rect x="22.3379" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 22.3379 52.1035)" fill="#B480DE"/> +<rect x="22.3379" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 22.3379 52.1035)" fill="#B480DE"/> +<rect x="22.3379" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 22.3379 52.1035)" fill="#B480DE"/> +<rect x="35.0205" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="35.0205" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="35.0205" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="39.7295" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 39.7295 52.1035)" fill="#B480DE"/> +<rect x="39.7295" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 39.7295 52.1035)" fill="#B480DE"/> +<rect x="39.7295" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 39.7295 52.1035)" fill="#B480DE"/> +<rect x="35.0205" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 35.0205 52.1035)" fill="#B480DE"/> +<rect x="35.0205" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 35.0205 52.1035)" fill="#B480DE"/> +<rect x="35.0205" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 35.0205 52.1035)" fill="#B480DE"/> +<rect x="47.7031" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="47.7031" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="47.7031" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="52.4121" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 52.4121 52.1035)" fill="#B480DE"/> +<rect x="52.4121" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 52.4121 52.1035)" fill="#B480DE"/> +<rect x="52.4121" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 52.4121 52.1035)" fill="#B480DE"/> +<rect x="47.7031" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 47.7031 52.1035)" fill="#B480DE"/> +<rect x="47.7031" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 47.7031 52.1035)" fill="#B480DE"/> +<rect x="47.7031" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 47.7031 52.1035)" fill="#B480DE"/> +<rect x="60.3848" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="60.3848" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="60.3848" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="65.0938" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 65.0938 52.1035)" fill="#B480DE"/> +<rect x="65.0938" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 65.0938 52.1035)" fill="#B480DE"/> +<rect x="65.0938" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 65.0938 52.1035)" fill="#B480DE"/> +<rect x="60.3848" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 60.3848 52.1035)" fill="#B480DE"/> +<rect x="60.3848" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 60.3848 52.1035)" fill="#B480DE"/> +<rect x="60.3848" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 60.3848 52.1035)" fill="#B480DE"/> +<rect x="73.0674" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="73.0674" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="73.0674" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="77.7764" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 77.7764 52.1035)" fill="#B480DE"/> +<rect x="77.7764" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 77.7764 52.1035)" fill="#B480DE"/> +<rect x="77.7764" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 77.7764 52.1035)" fill="#B480DE"/> +<rect x="73.0674" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 73.0674 52.1035)" fill="#B480DE"/> +<rect x="73.0674" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 73.0674 52.1035)" fill="#B480DE"/> +<rect x="73.0674" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 73.0674 52.1035)" fill="#B480DE"/> +<rect x="85.749" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="85.749" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="85.749" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="90.458" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 90.458 52.1035)" fill="#B480DE"/> +<rect x="90.458" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 90.458 52.1035)" fill="#B480DE"/> +<rect x="90.458" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 90.458 52.1035)" fill="#B480DE"/> +<rect x="85.749" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 85.749 52.1035)" fill="#B480DE"/> +<rect x="85.749" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 85.749 52.1035)" fill="#B480DE"/> +<rect x="85.749" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 85.749 52.1035)" fill="#B480DE"/> +<rect x="98.4316" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="98.4316" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="98.4316" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="103.141" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 103.141 52.1035)" fill="#B480DE"/> +<rect x="103.141" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 103.141 52.1035)" fill="#B480DE"/> +<rect x="103.141" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 103.141 52.1035)" fill="#B480DE"/> +<rect x="98.4316" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 98.4316 52.1035)" fill="#B480DE"/> +<rect x="98.4316" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 98.4316 52.1035)" fill="#B480DE"/> +<rect x="98.4316" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 98.4316 52.1035)" fill="#B480DE"/> +<rect x="111.114" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="111.114" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="111.114" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="115.823" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 115.823 52.1035)" fill="#B480DE"/> +<rect x="115.823" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 115.823 52.1035)" fill="#B480DE"/> +<rect x="115.823" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 115.823 52.1035)" fill="#B480DE"/> +<rect x="111.114" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 111.114 52.1035)" fill="#B480DE"/> +<rect x="111.114" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 111.114 52.1035)" fill="#B480DE"/> +<rect x="111.114" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 111.114 52.1035)" fill="#B480DE"/> +<rect x="123.796" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="123.796" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="123.796" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="128.505" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 128.505 52.1035)" fill="#B480DE"/> +<rect x="128.505" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 128.505 52.1035)" fill="#B480DE"/> +<rect x="128.505" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 128.505 52.1035)" fill="#B480DE"/> +<rect x="123.796" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 123.796 52.1035)" fill="#B480DE"/> +<rect x="123.796" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 123.796 52.1035)" fill="#B480DE"/> +<rect x="123.796" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 123.796 52.1035)" fill="#B480DE"/> +<rect x="136.479" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="136.479" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="136.479" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="141.188" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 141.188 52.1035)" fill="#B480DE"/> +<rect x="141.188" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 141.188 52.1035)" fill="#B480DE"/> +<rect x="141.188" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 141.188 52.1035)" fill="#B480DE"/> +<rect x="136.479" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 136.479 52.1035)" fill="#B480DE"/> +<rect x="136.479" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 136.479 52.1035)" fill="#B480DE"/> +<rect x="136.479" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 136.479 52.1035)" fill="#B480DE"/> +<rect x="149.161" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="149.161" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="149.161" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="153.87" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 153.87 52.1035)" fill="#B480DE"/> +<rect x="153.87" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 153.87 52.1035)" fill="#B480DE"/> +<rect x="153.87" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 153.87 52.1035)" fill="#B480DE"/> +<rect x="149.161" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 149.161 52.1035)" fill="#B480DE"/> +<rect x="149.161" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 149.161 52.1035)" fill="#B480DE"/> +<rect x="149.161" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 149.161 52.1035)" fill="#B480DE"/> +<rect x="161.843" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="161.843" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="161.843" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="166.552" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 166.552 52.1035)" fill="#B480DE"/> +<rect x="166.552" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 166.552 52.1035)" fill="#B480DE"/> +<rect x="166.552" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 166.552 52.1035)" fill="#B480DE"/> +<rect x="161.843" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 161.843 52.1035)" fill="#B480DE"/> +<rect x="161.843" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 161.843 52.1035)" fill="#B480DE"/> +<rect x="161.843" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 161.843 52.1035)" fill="#B480DE"/> +<rect x="3.31445" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="3.31445" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="3.31445" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="8.02344" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 8.02344 61.9102)" fill="#B480DE"/> +<rect x="8.02344" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 8.02344 61.9102)" fill="#B480DE"/> +<rect x="8.02344" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 8.02344 61.9102)" fill="#B480DE"/> +<rect x="3.31445" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 3.31445 61.9102)" fill="#B480DE"/> +<rect x="3.31445" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 3.31445 61.9102)" fill="#B480DE"/> +<rect x="3.31445" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 3.31445 61.9102)" fill="#B480DE"/> +<rect x="15.9971" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="15.9971" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="15.9971" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="20.7061" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 20.7061 61.9102)" fill="#B480DE"/> +<rect x="20.7061" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 20.7061 61.9102)" fill="#B480DE"/> +<rect x="20.7061" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 20.7061 61.9102)" fill="#B480DE"/> +<rect x="15.9971" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 15.9971 61.9102)" fill="#B480DE"/> +<rect x="15.9971" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 15.9971 61.9102)" fill="#B480DE"/> +<rect x="15.9971" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 15.9971 61.9102)" fill="#B480DE"/> +<rect x="28.6787" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="28.6787" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="28.6787" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="33.3877" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 33.3877 61.9102)" fill="#B480DE"/> +<rect x="33.3877" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 33.3877 61.9102)" fill="#B480DE"/> +<rect x="33.3877" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 33.3877 61.9102)" fill="#B480DE"/> +<rect x="28.6787" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 28.6787 61.9102)" fill="#B480DE"/> +<rect x="28.6787" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 28.6787 61.9102)" fill="#B480DE"/> +<rect x="28.6787" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 28.6787 61.9102)" fill="#B480DE"/> +<rect x="41.3613" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="41.3613" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="41.3613" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="46.0703" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 46.0703 61.9102)" fill="#B480DE"/> +<rect x="46.0703" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 46.0703 61.9102)" fill="#B480DE"/> +<rect x="46.0703" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 46.0703 61.9102)" fill="#B480DE"/> +<rect x="41.3613" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 41.3613 61.9102)" fill="#B480DE"/> +<rect x="41.3613" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 41.3613 61.9102)" fill="#B480DE"/> +<rect x="41.3613" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 41.3613 61.9102)" fill="#B480DE"/> +<rect x="54.0439" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="54.0439" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="54.0439" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="58.7529" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 58.7529 61.9102)" fill="#B480DE"/> +<rect x="58.7529" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 58.7529 61.9102)" fill="#B480DE"/> +<rect x="58.7529" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 58.7529 61.9102)" fill="#B480DE"/> +<rect x="54.0439" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 54.0439 61.9102)" fill="#B480DE"/> +<rect x="54.0439" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 54.0439 61.9102)" fill="#B480DE"/> +<rect x="54.0439" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 54.0439 61.9102)" fill="#B480DE"/> +<rect x="66.7256" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="66.7256" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="66.7256" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="71.4346" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 71.4346 61.9102)" fill="#B480DE"/> +<rect x="71.4346" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 71.4346 61.9102)" fill="#B480DE"/> +<rect x="71.4346" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 71.4346 61.9102)" fill="#B480DE"/> +<rect x="66.7256" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 66.7256 61.9102)" fill="#B480DE"/> +<rect x="66.7256" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 66.7256 61.9102)" fill="#B480DE"/> +<rect x="66.7256" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 66.7256 61.9102)" fill="#B480DE"/> +<rect x="79.4082" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="79.4082" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="79.4082" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="84.1172" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 84.1172 61.9102)" fill="#B480DE"/> +<rect x="84.1172" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 84.1172 61.9102)" fill="#B480DE"/> +<rect x="84.1172" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 84.1172 61.9102)" fill="#B480DE"/> +<rect x="79.4082" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 79.4082 61.9102)" fill="#B480DE"/> +<rect x="79.4082" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 79.4082 61.9102)" fill="#B480DE"/> +<rect x="79.4082" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 79.4082 61.9102)" fill="#B480DE"/> +<rect x="92.0898" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="92.0898" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="92.0898" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="96.7988" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 96.7988 61.9102)" fill="#B480DE"/> +<rect x="96.7988" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 96.7988 61.9102)" fill="#B480DE"/> +<rect x="96.7988" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 96.7988 61.9102)" fill="#B480DE"/> +<rect x="92.0898" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 92.0898 61.9102)" fill="#B480DE"/> +<rect x="92.0898" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 92.0898 61.9102)" fill="#B480DE"/> +<rect x="92.0898" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 92.0898 61.9102)" fill="#B480DE"/> +<rect x="104.772" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="104.772" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="104.772" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="109.481" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 109.481 61.9102)" fill="#B480DE"/> +<rect x="109.481" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 109.481 61.9102)" fill="#B480DE"/> +<rect x="109.481" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 109.481 61.9102)" fill="#B480DE"/> +<rect x="104.772" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 104.772 61.9102)" fill="#B480DE"/> +<rect x="104.772" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 104.772 61.9102)" fill="#B480DE"/> +<rect x="104.772" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 104.772 61.9102)" fill="#B480DE"/> +<rect x="117.455" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="117.455" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="117.455" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="122.164" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 122.164 61.9102)" fill="#B480DE"/> +<rect x="122.164" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 122.164 61.9102)" fill="#B480DE"/> +<rect x="122.164" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 122.164 61.9102)" fill="#B480DE"/> +<rect x="117.455" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 117.455 61.9102)" fill="#B480DE"/> +<rect x="117.455" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 117.455 61.9102)" fill="#B480DE"/> +<rect x="117.455" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 117.455 61.9102)" fill="#B480DE"/> +<rect x="130.137" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="130.137" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="130.137" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="134.846" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 134.846 61.9102)" fill="#B480DE"/> +<rect x="134.846" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 134.846 61.9102)" fill="#B480DE"/> +<rect x="134.846" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 134.846 61.9102)" fill="#B480DE"/> +<rect x="130.137" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 130.137 61.9102)" fill="#B480DE"/> +<rect x="130.137" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 130.137 61.9102)" fill="#B480DE"/> +<rect x="130.137" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 130.137 61.9102)" fill="#B480DE"/> +<rect x="142.819" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="142.819" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="142.819" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="147.528" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 147.528 61.9102)" fill="#B480DE"/> +<rect x="147.528" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 147.528 61.9102)" fill="#B480DE"/> +<rect x="147.528" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 147.528 61.9102)" fill="#B480DE"/> +<rect x="142.819" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 142.819 61.9102)" fill="#B480DE"/> +<rect x="142.819" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 142.819 61.9102)" fill="#B480DE"/> +<rect x="142.819" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 142.819 61.9102)" fill="#B480DE"/> +<rect x="155.502" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="155.502" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="155.502" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="160.211" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 160.211 61.9102)" fill="#B480DE"/> +<rect x="160.211" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 160.211 61.9102)" fill="#B480DE"/> +<rect x="160.211" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 160.211 61.9102)" fill="#B480DE"/> +<rect x="155.502" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 155.502 61.9102)" fill="#B480DE"/> +<rect x="155.502" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 155.502 61.9102)" fill="#B480DE"/> +<rect x="155.502" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 155.502 61.9102)" fill="#B480DE"/> +<rect x="168.184" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="168.184" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="168.184" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="168.184" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 168.184 61.9102)" fill="#B480DE"/> +<rect x="168.184" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 168.184 61.9102)" fill="#B480DE"/> +<rect x="168.184" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 168.184 61.9102)" fill="#B480DE"/> +<rect x="1.68262" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 1.68262 71.7168)" fill="#B480DE"/> +<rect x="1.68262" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 1.68262 71.7168)" fill="#B480DE"/> +<rect x="1.68262" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 1.68262 71.7168)" fill="#B480DE"/> +<rect x="9.65625" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="9.65625" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="9.65625" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="14.3652" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 14.3652 71.7168)" fill="#B480DE"/> +<rect x="14.3652" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 14.3652 71.7168)" fill="#B480DE"/> +<rect x="14.3652" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 14.3652 71.7168)" fill="#B480DE"/> +<rect x="9.65625" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 9.65625 71.7168)" fill="#B480DE"/> +<rect x="9.65625" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 9.65625 71.7168)" fill="#B480DE"/> +<rect x="9.65625" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 9.65625 71.7168)" fill="#B480DE"/> +<rect x="22.3379" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="22.3379" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="22.3379" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="27.0469" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 27.0469 71.7168)" fill="#B480DE"/> +<rect x="27.0469" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 27.0469 71.7168)" fill="#B480DE"/> +<rect x="27.0469" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 27.0469 71.7168)" fill="#B480DE"/> +<rect x="22.3379" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 22.3379 71.7168)" fill="#B480DE"/> +<rect x="22.3379" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 22.3379 71.7168)" fill="#B480DE"/> +<rect x="22.3379" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 22.3379 71.7168)" fill="#B480DE"/> +<rect x="35.0205" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="35.0205" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="35.0205" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="39.7295" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 39.7295 71.7168)" fill="#B480DE"/> +<rect x="39.7295" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 39.7295 71.7168)" fill="#B480DE"/> +<rect x="39.7295" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 39.7295 71.7168)" fill="#B480DE"/> +<rect x="35.0205" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 35.0205 71.7168)" fill="#B480DE"/> +<rect x="35.0205" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 35.0205 71.7168)" fill="#B480DE"/> +<rect x="35.0205" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 35.0205 71.7168)" fill="#B480DE"/> +<rect x="47.7031" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="47.7031" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="47.7031" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="52.4121" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 52.4121 71.7168)" fill="#B480DE"/> +<rect x="52.4121" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 52.4121 71.7168)" fill="#B480DE"/> +<rect x="52.4121" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 52.4121 71.7168)" fill="#B480DE"/> +<rect x="47.7031" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 47.7031 71.7168)" fill="#B480DE"/> +<rect x="47.7031" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 47.7031 71.7168)" fill="#B480DE"/> +<rect x="47.7031" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 47.7031 71.7168)" fill="#B480DE"/> +<rect x="60.3848" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="60.3848" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="60.3848" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="65.0938" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 65.0938 71.7168)" fill="#B480DE"/> +<rect x="65.0938" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 65.0938 71.7168)" fill="#B480DE"/> +<rect x="65.0938" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 65.0938 71.7168)" fill="#B480DE"/> +<rect x="60.3848" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 60.3848 71.7168)" fill="#B480DE"/> +<rect x="60.3848" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 60.3848 71.7168)" fill="#B480DE"/> +<rect x="60.3848" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 60.3848 71.7168)" fill="#B480DE"/> +<rect x="73.0674" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="73.0674" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="73.0674" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="77.7764" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 77.7764 71.7168)" fill="#B480DE"/> +<rect x="77.7764" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 77.7764 71.7168)" fill="#B480DE"/> +<rect x="77.7764" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 77.7764 71.7168)" fill="#B480DE"/> +<rect x="73.0674" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 73.0674 71.7168)" fill="#B480DE"/> +<rect x="73.0674" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 73.0674 71.7168)" fill="#B480DE"/> +<rect x="73.0674" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 73.0674 71.7168)" fill="#B480DE"/> +<rect x="85.749" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="85.749" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="85.749" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="90.458" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 90.458 71.7168)" fill="#B480DE"/> +<rect x="90.458" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 90.458 71.7168)" fill="#B480DE"/> +<rect x="90.458" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 90.458 71.7168)" fill="#B480DE"/> +<rect x="85.749" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 85.749 71.7168)" fill="#B480DE"/> +<rect x="85.749" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 85.749 71.7168)" fill="#B480DE"/> +<rect x="85.749" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 85.749 71.7168)" fill="#B480DE"/> +<rect x="98.4316" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="98.4316" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="98.4316" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="103.141" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 103.141 71.7168)" fill="#B480DE"/> +<rect x="103.141" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 103.141 71.7168)" fill="#B480DE"/> +<rect x="103.141" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 103.141 71.7168)" fill="#B480DE"/> +<rect x="98.4316" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 98.4316 71.7168)" fill="#B480DE"/> +<rect x="98.4316" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 98.4316 71.7168)" fill="#B480DE"/> +<rect x="98.4316" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 98.4316 71.7168)" fill="#B480DE"/> +<rect x="111.114" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="111.114" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="111.114" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="115.823" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 115.823 71.7168)" fill="#B480DE"/> +<rect x="115.823" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 115.823 71.7168)" fill="#B480DE"/> +<rect x="115.823" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 115.823 71.7168)" fill="#B480DE"/> +<rect x="111.114" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 111.114 71.7168)" fill="#B480DE"/> +<rect x="111.114" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 111.114 71.7168)" fill="#B480DE"/> +<rect x="111.114" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 111.114 71.7168)" fill="#B480DE"/> +<rect x="123.796" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="123.796" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="123.796" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="128.505" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 128.505 71.7168)" fill="#B480DE"/> +<rect x="128.505" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 128.505 71.7168)" fill="#B480DE"/> +<rect x="128.505" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 128.505 71.7168)" fill="#B480DE"/> +<rect x="123.796" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 123.796 71.7168)" fill="#B480DE"/> +<rect x="123.796" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 123.796 71.7168)" fill="#B480DE"/> +<rect x="123.796" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 123.796 71.7168)" fill="#B480DE"/> +<rect x="136.479" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="136.479" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="136.479" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="141.188" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 141.188 71.7168)" fill="#B480DE"/> +<rect x="141.188" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 141.188 71.7168)" fill="#B480DE"/> +<rect x="141.188" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 141.188 71.7168)" fill="#B480DE"/> +<rect x="136.479" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 136.479 71.7168)" fill="#B480DE"/> +<rect x="136.479" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 136.479 71.7168)" fill="#B480DE"/> +<rect x="136.479" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 136.479 71.7168)" fill="#B480DE"/> +<rect x="149.161" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="149.161" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="149.161" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="153.87" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 153.87 71.7168)" fill="#B480DE"/> +<rect x="153.87" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 153.87 71.7168)" fill="#B480DE"/> +<rect x="153.87" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 153.87 71.7168)" fill="#B480DE"/> +<rect x="149.161" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 149.161 71.7168)" fill="#B480DE"/> +<rect x="149.161" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 149.161 71.7168)" fill="#B480DE"/> +<rect x="149.161" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 149.161 71.7168)" fill="#B480DE"/> +<rect x="161.843" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="161.843" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="161.843" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="166.552" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 166.552 71.7168)" fill="#B480DE"/> +<rect x="166.552" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 166.552 71.7168)" fill="#B480DE"/> +<rect x="166.552" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 166.552 71.7168)" fill="#B480DE"/> +<rect x="161.843" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 161.843 71.7168)" fill="#B480DE"/> +<rect x="161.843" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 161.843 71.7168)" fill="#B480DE"/> +<rect x="161.843" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 161.843 71.7168)" fill="#B480DE"/> +<rect x="3.31445" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="3.31445" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="3.31445" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="8.02344" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 8.02344 81.5215)" fill="#B480DE"/> +<rect x="8.02344" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 8.02344 81.5215)" fill="#B480DE"/> +<rect x="8.02344" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 8.02344 81.5215)" fill="#B480DE"/> +<rect x="3.31445" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 3.31445 81.5215)" fill="#B480DE"/> +<rect x="3.31445" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 3.31445 81.5215)" fill="#B480DE"/> +<rect x="3.31445" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 3.31445 81.5215)" fill="#B480DE"/> +<rect x="15.9971" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="15.9971" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="15.9971" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="20.7061" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 20.7061 81.5215)" fill="#B480DE"/> +<rect x="20.7061" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 20.7061 81.5215)" fill="#B480DE"/> +<rect x="20.7061" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 20.7061 81.5215)" fill="#B480DE"/> +<rect x="15.9971" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 15.9971 81.5215)" fill="#B480DE"/> +<rect x="15.9971" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 15.9971 81.5215)" fill="#B480DE"/> +<rect x="15.9971" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 15.9971 81.5215)" fill="#B480DE"/> +<rect x="28.6787" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="28.6787" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="28.6787" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="33.3877" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 33.3877 81.5215)" fill="#B480DE"/> +<rect x="33.3877" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 33.3877 81.5215)" fill="#B480DE"/> +<rect x="33.3877" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 33.3877 81.5215)" fill="#B480DE"/> +<rect x="28.6787" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 28.6787 81.5215)" fill="#B480DE"/> +<rect x="28.6787" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 28.6787 81.5215)" fill="#B480DE"/> +<rect x="28.6787" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 28.6787 81.5215)" fill="#B480DE"/> +<rect x="41.3613" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="41.3613" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="41.3613" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="46.0703" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 46.0703 81.5215)" fill="#B480DE"/> +<rect x="46.0703" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 46.0703 81.5215)" fill="#B480DE"/> +<rect x="46.0703" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 46.0703 81.5215)" fill="#B480DE"/> +<rect x="41.3613" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 41.3613 81.5215)" fill="#B480DE"/> +<rect x="41.3613" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 41.3613 81.5215)" fill="#B480DE"/> +<rect x="41.3613" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 41.3613 81.5215)" fill="#B480DE"/> +<rect x="54.0439" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="54.0439" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="54.0439" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="58.7529" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 58.7529 81.5215)" fill="#B480DE"/> +<rect x="58.7529" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 58.7529 81.5215)" fill="#B480DE"/> +<rect x="58.7529" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 58.7529 81.5215)" fill="#B480DE"/> +<rect x="54.0439" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 54.0439 81.5215)" fill="#B480DE"/> +<rect x="54.0439" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 54.0439 81.5215)" fill="#B480DE"/> +<rect x="54.0439" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 54.0439 81.5215)" fill="#B480DE"/> +<rect x="66.7256" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="66.7256" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="66.7256" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="71.4346" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 71.4346 81.5215)" fill="#B480DE"/> +<rect x="71.4346" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 71.4346 81.5215)" fill="#B480DE"/> +<rect x="71.4346" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 71.4346 81.5215)" fill="#B480DE"/> +<rect x="66.7256" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 66.7256 81.5215)" fill="#B480DE"/> +<rect x="66.7256" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 66.7256 81.5215)" fill="#B480DE"/> +<rect x="66.7256" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 66.7256 81.5215)" fill="#B480DE"/> +<rect x="79.4082" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="79.4082" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="79.4082" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="84.1172" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 84.1172 81.5215)" fill="#B480DE"/> +<rect x="84.1172" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 84.1172 81.5215)" fill="#B480DE"/> +<rect x="84.1172" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 84.1172 81.5215)" fill="#B480DE"/> +<rect x="79.4082" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 79.4082 81.5215)" fill="#B480DE"/> +<rect x="79.4082" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 79.4082 81.5215)" fill="#B480DE"/> +<rect x="79.4082" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 79.4082 81.5215)" fill="#B480DE"/> +<rect x="92.0898" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="92.0898" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="92.0898" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="96.7988" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 96.7988 81.5215)" fill="#B480DE"/> +<rect x="96.7988" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 96.7988 81.5215)" fill="#B480DE"/> +<rect x="96.7988" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 96.7988 81.5215)" fill="#B480DE"/> +<rect x="92.0898" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 92.0898 81.5215)" fill="#B480DE"/> +<rect x="92.0898" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 92.0898 81.5215)" fill="#B480DE"/> +<rect x="92.0898" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 92.0898 81.5215)" fill="#B480DE"/> +<rect x="104.772" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="104.772" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="104.772" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="109.481" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 109.481 81.5215)" fill="#B480DE"/> +<rect x="109.481" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 109.481 81.5215)" fill="#B480DE"/> +<rect x="109.481" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 109.481 81.5215)" fill="#B480DE"/> +<rect x="104.772" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 104.772 81.5215)" fill="#B480DE"/> +<rect x="104.772" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 104.772 81.5215)" fill="#B480DE"/> +<rect x="104.772" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 104.772 81.5215)" fill="#B480DE"/> +<rect x="117.455" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="117.455" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="117.455" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="122.164" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 122.164 81.5215)" fill="#B480DE"/> +<rect x="122.164" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 122.164 81.5215)" fill="#B480DE"/> +<rect x="122.164" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 122.164 81.5215)" fill="#B480DE"/> +<rect x="117.455" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 117.455 81.5215)" fill="#B480DE"/> +<rect x="117.455" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 117.455 81.5215)" fill="#B480DE"/> +<rect x="117.455" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 117.455 81.5215)" fill="#B480DE"/> +<rect x="130.137" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="130.137" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="130.137" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="134.846" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 134.846 81.5215)" fill="#B480DE"/> +<rect x="134.846" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 134.846 81.5215)" fill="#B480DE"/> +<rect x="134.846" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 134.846 81.5215)" fill="#B480DE"/> +<rect x="130.137" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 130.137 81.5215)" fill="#B480DE"/> +<rect x="130.137" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 130.137 81.5215)" fill="#B480DE"/> +<rect x="130.137" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 130.137 81.5215)" fill="#B480DE"/> +<rect x="142.819" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="142.819" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="142.819" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="147.528" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 147.528 81.5215)" fill="#B480DE"/> +<rect x="147.528" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 147.528 81.5215)" fill="#B480DE"/> +<rect x="147.528" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 147.528 81.5215)" fill="#B480DE"/> +<rect x="142.819" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 142.819 81.5215)" fill="#B480DE"/> +<rect x="142.819" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 142.819 81.5215)" fill="#B480DE"/> +<rect x="142.819" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 142.819 81.5215)" fill="#B480DE"/> +<rect x="155.502" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="155.502" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="155.502" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="160.211" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 160.211 81.5215)" fill="#B480DE"/> +<rect x="160.211" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 160.211 81.5215)" fill="#B480DE"/> +<rect x="160.211" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 160.211 81.5215)" fill="#B480DE"/> +<rect x="155.502" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 155.502 81.5215)" fill="#B480DE"/> +<rect x="155.502" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 155.502 81.5215)" fill="#B480DE"/> +<rect x="155.502" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 155.502 81.5215)" fill="#B480DE"/> +<rect x="168.184" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="168.184" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="168.184" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="168.184" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 168.184 81.5215)" fill="#B480DE"/> +<rect x="168.184" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 168.184 81.5215)" fill="#B480DE"/> +<rect x="168.184" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 168.184 81.5215)" fill="#B480DE"/> +<rect x="1.68262" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 1.68262 91.3281)" fill="#B480DE"/> +<rect x="1.68262" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 1.68262 91.3281)" fill="#B480DE"/> +<rect x="1.68262" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 1.68262 91.3281)" fill="#B480DE"/> +<rect x="9.65625" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="9.65625" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="9.65625" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="14.3652" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 14.3652 91.3281)" fill="#B480DE"/> +<rect x="14.3652" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 14.3652 91.3281)" fill="#B480DE"/> +<rect x="14.3652" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 14.3652 91.3281)" fill="#B480DE"/> +<rect x="9.65625" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 9.65625 91.3281)" fill="#B480DE"/> +<rect x="9.65625" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 9.65625 91.3281)" fill="#B480DE"/> +<rect x="9.65625" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 9.65625 91.3281)" fill="#B480DE"/> +<rect x="22.3379" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="22.3379" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="22.3379" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="27.0469" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 27.0469 91.3281)" fill="#B480DE"/> +<rect x="27.0469" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 27.0469 91.3281)" fill="#B480DE"/> +<rect x="27.0469" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 27.0469 91.3281)" fill="#B480DE"/> +<rect x="22.3379" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 22.3379 91.3281)" fill="#B480DE"/> +<rect x="22.3379" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 22.3379 91.3281)" fill="#B480DE"/> +<rect x="22.3379" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 22.3379 91.3281)" fill="#B480DE"/> +<rect x="35.0205" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="35.0205" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="35.0205" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="39.7295" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 39.7295 91.3281)" fill="#B480DE"/> +<rect x="39.7295" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 39.7295 91.3281)" fill="#B480DE"/> +<rect x="39.7295" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 39.7295 91.3281)" fill="#B480DE"/> +<rect x="35.0205" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 35.0205 91.3281)" fill="#B480DE"/> +<rect x="35.0205" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 35.0205 91.3281)" fill="#B480DE"/> +<rect x="35.0205" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 35.0205 91.3281)" fill="#B480DE"/> +<rect x="47.7031" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="47.7031" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="47.7031" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="52.4121" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 52.4121 91.3281)" fill="#B480DE"/> +<rect x="52.4121" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 52.4121 91.3281)" fill="#B480DE"/> +<rect x="52.4121" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 52.4121 91.3281)" fill="#B480DE"/> +<rect x="47.7031" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 47.7031 91.3281)" fill="#B480DE"/> +<rect x="47.7031" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 47.7031 91.3281)" fill="#B480DE"/> +<rect x="47.7031" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 47.7031 91.3281)" fill="#B480DE"/> +<rect x="60.3848" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="60.3848" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="60.3848" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="65.0938" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 65.0938 91.3281)" fill="#B480DE"/> +<rect x="65.0938" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 65.0938 91.3281)" fill="#B480DE"/> +<rect x="65.0938" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 65.0938 91.3281)" fill="#B480DE"/> +<rect x="60.3848" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 60.3848 91.3281)" fill="#B480DE"/> +<rect x="60.3848" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 60.3848 91.3281)" fill="#B480DE"/> +<rect x="60.3848" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 60.3848 91.3281)" fill="#B480DE"/> +<rect x="73.0674" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="73.0674" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="73.0674" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="77.7764" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 77.7764 91.3281)" fill="#B480DE"/> +<rect x="77.7764" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 77.7764 91.3281)" fill="#B480DE"/> +<rect x="77.7764" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 77.7764 91.3281)" fill="#B480DE"/> +<rect x="73.0674" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 73.0674 91.3281)" fill="#B480DE"/> +<rect x="73.0674" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 73.0674 91.3281)" fill="#B480DE"/> +<rect x="73.0674" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 73.0674 91.3281)" fill="#B480DE"/> +<rect x="85.749" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="85.749" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="85.749" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="90.458" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 90.458 91.3281)" fill="#B480DE"/> +<rect x="90.458" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 90.458 91.3281)" fill="#B480DE"/> +<rect x="90.458" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 90.458 91.3281)" fill="#B480DE"/> +<rect x="85.749" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 85.749 91.3281)" fill="#B480DE"/> +<rect x="85.749" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 85.749 91.3281)" fill="#B480DE"/> +<rect x="85.749" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 85.749 91.3281)" fill="#B480DE"/> +<rect x="98.4316" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="98.4316" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="98.4316" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="103.141" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 103.141 91.3281)" fill="#B480DE"/> +<rect x="103.141" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 103.141 91.3281)" fill="#B480DE"/> +<rect x="103.141" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 103.141 91.3281)" fill="#B480DE"/> +<rect x="98.4316" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 98.4316 91.3281)" fill="#B480DE"/> +<rect x="98.4316" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 98.4316 91.3281)" fill="#B480DE"/> +<rect x="98.4316" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 98.4316 91.3281)" fill="#B480DE"/> +<rect x="111.114" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="111.114" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="111.114" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="115.823" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 115.823 91.3281)" fill="#B480DE"/> +<rect x="115.823" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 115.823 91.3281)" fill="#B480DE"/> +<rect x="115.823" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 115.823 91.3281)" fill="#B480DE"/> +<rect x="111.114" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 111.114 91.3281)" fill="#B480DE"/> +<rect x="111.114" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 111.114 91.3281)" fill="#B480DE"/> +<rect x="111.114" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 111.114 91.3281)" fill="#B480DE"/> +<rect x="123.796" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="123.796" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="123.796" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="128.505" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 128.505 91.3281)" fill="#B480DE"/> +<rect x="128.505" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 128.505 91.3281)" fill="#B480DE"/> +<rect x="128.505" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 128.505 91.3281)" fill="#B480DE"/> +<rect x="123.796" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 123.796 91.3281)" fill="#B480DE"/> +<rect x="123.796" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 123.796 91.3281)" fill="#B480DE"/> +<rect x="123.796" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 123.796 91.3281)" fill="#B480DE"/> +<rect x="136.479" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="136.479" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="136.479" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="141.188" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 141.188 91.3281)" fill="#B480DE"/> +<rect x="141.188" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 141.188 91.3281)" fill="#B480DE"/> +<rect x="141.188" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 141.188 91.3281)" fill="#B480DE"/> +<rect x="136.479" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 136.479 91.3281)" fill="#B480DE"/> +<rect x="136.479" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 136.479 91.3281)" fill="#B480DE"/> +<rect x="136.479" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 136.479 91.3281)" fill="#B480DE"/> +<rect x="149.161" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="149.161" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="149.161" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="153.87" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 153.87 91.3281)" fill="#B480DE"/> +<rect x="153.87" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 153.87 91.3281)" fill="#B480DE"/> +<rect x="153.87" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 153.87 91.3281)" fill="#B480DE"/> +<rect x="149.161" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 149.161 91.3281)" fill="#B480DE"/> +<rect x="149.161" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 149.161 91.3281)" fill="#B480DE"/> +<rect x="149.161" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 149.161 91.3281)" fill="#B480DE"/> +<rect x="161.843" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="161.843" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="161.843" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="166.552" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 166.552 91.3281)" fill="#B480DE"/> +<rect x="166.552" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 166.552 91.3281)" fill="#B480DE"/> +<rect x="166.552" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 166.552 91.3281)" fill="#B480DE"/> +<rect x="161.843" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 161.843 91.3281)" fill="#B480DE"/> +<rect x="161.843" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 161.843 91.3281)" fill="#B480DE"/> +<rect x="161.843" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 161.843 91.3281)" fill="#B480DE"/> +</g> +<path d="M62.2098 85.992V87H57.2058V78.684H58.3698V85.992H62.2098ZM64.4725 87H63.3565V80.76H64.4725V87ZM63.9085 79.632C63.7085 79.632 63.5365 79.568 63.3925 79.44C63.2565 79.304 63.1885 79.124 63.1885 78.9C63.1885 78.676 63.2565 78.5 63.3925 78.372C63.5365 78.236 63.7085 78.168 63.9085 78.168C64.1085 78.168 64.2765 78.236 64.4125 78.372C64.5565 78.5 64.6285 78.676 64.6285 78.9C64.6285 79.124 64.5565 79.304 64.4125 79.44C64.2765 79.568 64.1085 79.632 63.9085 79.632ZM66.3916 80.94C66.6476 80.876 66.9876 80.808 67.4116 80.736C67.8356 80.664 68.3236 80.628 68.8756 80.628C69.3716 80.628 69.7836 80.7 70.1116 80.844C70.4396 80.98 70.6996 81.176 70.8916 81.432C71.0916 81.68 71.2316 81.98 71.3116 82.332C71.3916 82.684 71.4316 83.072 71.4316 83.496V87H70.3156V83.736C70.3156 83.352 70.2876 83.024 70.2316 82.752C70.1836 82.48 70.0996 82.26 69.9796 82.092C69.8596 81.924 69.6996 81.804 69.4996 81.732C69.2996 81.652 69.0516 81.612 68.7556 81.612C68.6356 81.612 68.5116 81.616 68.3836 81.624C68.2556 81.632 68.1316 81.644 68.0116 81.66C67.8996 81.668 67.7956 81.68 67.6996 81.696C67.6116 81.712 67.5476 81.724 67.5076 81.732V87H66.3916V80.94ZM72.9343 83.892C72.9343 83.34 73.0143 82.86 73.1743 82.452C73.3343 82.036 73.5463 81.692 73.8103 81.42C74.0743 81.148 74.3783 80.944 74.7223 80.808C75.0663 80.672 75.4183 80.604 75.7783 80.604C76.6183 80.604 77.2623 80.868 77.7103 81.396C78.1583 81.916 78.3823 82.712 78.3823 83.784C78.3823 83.832 78.3823 83.896 78.3823 83.976C78.3823 84.048 78.3783 84.116 78.3703 84.18H74.0983C74.1463 84.828 74.3343 85.32 74.6623 85.656C74.9903 85.992 75.5023 86.16 76.1983 86.16C76.5903 86.16 76.9183 86.128 77.1823 86.064C77.4543 85.992 77.6583 85.924 77.7943 85.86L77.9503 86.796C77.8143 86.868 77.5743 86.944 77.2303 87.024C76.8943 87.104 76.5103 87.144 76.0783 87.144C75.5343 87.144 75.0623 87.064 74.6623 86.904C74.2703 86.736 73.9463 86.508 73.6903 86.22C73.4343 85.932 73.2423 85.592 73.1143 85.2C72.9943 84.8 72.9343 84.364 72.9343 83.892ZM77.2183 83.28C77.2263 82.776 77.0983 82.364 76.8343 82.044C76.5783 81.716 76.2223 81.552 75.7663 81.552C75.5103 81.552 75.2823 81.604 75.0823 81.708C74.8903 81.804 74.7263 81.932 74.5903 82.092C74.4543 82.252 74.3463 82.436 74.2663 82.644C74.1943 82.852 74.1463 83.064 74.1223 83.28H77.2183ZM86.4107 87.18C85.8267 87.18 85.2947 87.084 84.8147 86.892C84.3347 86.7 83.9227 86.42 83.5787 86.052C83.2347 85.684 82.9667 85.232 82.7747 84.696C82.5907 84.152 82.4987 83.532 82.4987 82.836C82.4987 82.14 82.6027 81.524 82.8107 80.988C83.0267 80.444 83.3147 79.988 83.6747 79.62C84.0347 79.252 84.4547 78.972 84.9347 78.78C85.4147 78.588 85.9267 78.492 86.4707 78.492C86.8147 78.492 87.1227 78.516 87.3947 78.564C87.6747 78.612 87.9147 78.668 88.1147 78.732C88.3227 78.796 88.4907 78.86 88.6187 78.924C88.7467 78.988 88.8347 79.036 88.8827 79.068L88.5467 80.028C88.4747 79.98 88.3707 79.928 88.2347 79.872C88.0987 79.816 87.9427 79.76 87.7667 79.704C87.5987 79.648 87.4107 79.604 87.2027 79.572C87.0027 79.532 86.7987 79.512 86.5907 79.512C86.1507 79.512 85.7547 79.588 85.4027 79.74C85.0507 79.892 84.7507 80.112 84.5027 80.4C84.2547 80.688 84.0627 81.04 83.9267 81.456C83.7987 81.864 83.7347 82.324 83.7347 82.836C83.7347 83.332 83.7907 83.784 83.9027 84.192C84.0227 84.6 84.1987 84.952 84.4307 85.248C84.6627 85.536 84.9507 85.76 85.2947 85.92C85.6467 86.08 86.0547 86.16 86.5187 86.16C87.0547 86.16 87.4987 86.104 87.8507 85.992C88.2027 85.88 88.4667 85.78 88.6427 85.692L88.9427 86.652C88.8867 86.692 88.7867 86.744 88.6427 86.808C88.4987 86.864 88.3187 86.92 88.1027 86.976C87.8867 87.032 87.6347 87.08 87.3467 87.12C87.0587 87.16 86.7467 87.18 86.4107 87.18ZM90.2041 87V77.88L91.3201 77.688V80.88C91.5281 80.8 91.7481 80.74 91.9801 80.7C92.2201 80.652 92.4561 80.628 92.6881 80.628C93.1841 80.628 93.5961 80.7 93.9241 80.844C94.2521 80.98 94.5121 81.176 94.7041 81.432C94.9041 81.68 95.0441 81.98 95.1241 82.332C95.2041 82.684 95.2441 83.072 95.2441 83.496V87H94.1281V83.736C94.1281 83.352 94.1001 83.024 94.0441 82.752C93.9961 82.48 93.9121 82.26 93.7921 82.092C93.6721 81.924 93.5121 81.804 93.3121 81.732C93.1121 81.652 92.8641 81.612 92.5681 81.612C92.4481 81.612 92.3241 81.62 92.1961 81.636C92.0681 81.652 91.9441 81.672 91.8241 81.696C91.7121 81.712 91.6081 81.732 91.5121 81.756C91.4241 81.78 91.3601 81.8 91.3201 81.816V87H90.2041ZM99.1716 86.196C99.4356 86.196 99.6676 86.192 99.8676 86.184C100.076 86.168 100.248 86.144 100.384 86.112V84.252C100.304 84.212 100.172 84.18 99.9876 84.156C99.8116 84.124 99.5956 84.108 99.3396 84.108C99.1716 84.108 98.9916 84.12 98.7996 84.144C98.6156 84.168 98.4436 84.22 98.2836 84.3C98.1316 84.372 98.0036 84.476 97.8996 84.612C97.7956 84.74 97.7436 84.912 97.7436 85.128C97.7436 85.528 97.8716 85.808 98.1276 85.968C98.3836 86.12 98.7316 86.196 99.1716 86.196ZM99.0756 80.604C99.5236 80.604 99.8996 80.664 100.204 80.784C100.516 80.896 100.764 81.06 100.948 81.276C101.14 81.484 101.276 81.736 101.356 82.032C101.436 82.32 101.476 82.64 101.476 82.992V86.892C101.38 86.908 101.244 86.932 101.068 86.964C100.9 86.988 100.708 87.012 100.492 87.036C100.276 87.06 100.04 87.08 99.7836 87.096C99.5356 87.12 99.2876 87.132 99.0396 87.132C98.6876 87.132 98.3636 87.096 98.0676 87.024C97.7716 86.952 97.5156 86.84 97.2996 86.688C97.0836 86.528 96.9156 86.32 96.7956 86.064C96.6756 85.808 96.6156 85.5 96.6156 85.14C96.6156 84.796 96.6836 84.5 96.8196 84.252C96.9636 84.004 97.1556 83.804 97.3956 83.652C97.6356 83.5 97.9156 83.388 98.2356 83.316C98.5556 83.244 98.8916 83.208 99.2436 83.208C99.3556 83.208 99.4716 83.216 99.5916 83.232C99.7116 83.24 99.8236 83.256 99.9276 83.28C100.04 83.296 100.136 83.312 100.216 83.328C100.296 83.344 100.352 83.356 100.384 83.364V83.052C100.384 82.868 100.364 82.688 100.324 82.512C100.284 82.328 100.212 82.168 100.108 82.032C100.004 81.888 99.8596 81.776 99.6756 81.696C99.4996 81.608 99.2676 81.564 98.9796 81.564C98.6116 81.564 98.2876 81.592 98.0076 81.648C97.7356 81.696 97.5316 81.748 97.3956 81.804L97.2636 80.88C97.4076 80.816 97.6476 80.756 97.9836 80.7C98.3196 80.636 98.6836 80.604 99.0756 80.604ZM105.633 80.628C105.729 80.628 105.837 80.636 105.957 80.652C106.085 80.66 106.209 80.676 106.329 80.7C106.449 80.716 106.557 80.736 106.653 80.76C106.757 80.776 106.833 80.792 106.881 80.808L106.689 81.78C106.601 81.748 106.453 81.712 106.245 81.672C106.045 81.624 105.785 81.6 105.465 81.6C105.257 81.6 105.049 81.624 104.841 81.672C104.641 81.712 104.509 81.74 104.445 81.756V87H103.329V81.024C103.593 80.928 103.921 80.84 104.313 80.76C104.705 80.672 105.145 80.628 105.633 80.628ZM109.002 80.76H111.366V81.696H109.002V84.576C109.002 84.888 109.026 85.148 109.074 85.356C109.122 85.556 109.194 85.716 109.29 85.836C109.386 85.948 109.506 86.028 109.65 86.076C109.794 86.124 109.962 86.148 110.154 86.148C110.49 86.148 110.758 86.112 110.958 86.04C111.166 85.96 111.31 85.904 111.39 85.872L111.606 86.796C111.494 86.852 111.298 86.92 111.018 87C110.738 87.088 110.418 87.132 110.058 87.132C109.634 87.132 109.282 87.08 109.002 86.976C108.73 86.864 108.51 86.7 108.342 86.484C108.174 86.268 108.054 86.004 107.982 85.692C107.918 85.372 107.886 85.004 107.886 84.588V79.02L109.002 78.828V80.76Z" fill="black"/> +<g filter="url(#filter0_dddd_408_1800)"> +<rect x="52" y="8" width="64" height="64" rx="6" fill="white"/> +<path fill-rule="evenodd" clip-rule="evenodd" d="M58.667 23.9993C58.667 23.263 59.2639 22.666 60.0003 22.666H108C108.737 22.666 109.334 23.263 109.334 23.9993C109.334 24.7357 108.737 25.3327 108 25.3327H60.0003C59.2639 25.3327 58.667 24.7357 58.667 23.9993Z" fill="#DEDEDE"/> +<path fill-rule="evenodd" clip-rule="evenodd" d="M58.667 37.3333C58.667 36.597 59.2639 36 60.0003 36H108C108.737 36 109.334 36.597 109.334 37.3333C109.334 38.0697 108.737 38.6667 108 38.6667H60.0003C59.2639 38.6667 58.667 38.0697 58.667 37.3333Z" fill="#DEDEDE"/> +<path fill-rule="evenodd" clip-rule="evenodd" d="M58.667 50.6654C58.667 49.929 59.2639 49.332 60.0003 49.332H108C108.737 49.332 109.334 49.929 109.334 50.6654C109.334 51.4017 108.737 51.9987 108 51.9987H60.0003C59.2639 51.9987 58.667 51.4017 58.667 50.6654Z" fill="#DEDEDE"/> +<path fill-rule="evenodd" clip-rule="evenodd" d="M58 64C58 62.8954 58.8954 62 60 62H108C109.105 62 110 62.8954 110 64C110 65.1046 109.105 66 108 66H60C58.8954 66 58 65.1046 58 64Z" fill="#DEDEDE"/> +<path d="M107 27.8732C107 26.29 105.704 25 104.114 25C102.524 25 101.228 26.29 101.228 27.8732C101.228 28.6355 101.522 29.3391 102.052 29.8669L96.516 40.0697C96.0448 40.0697 95.5736 40.187 95.1613 40.4215L91.1562 37.0206C91.2151 36.8447 91.2151 36.6688 91.2151 36.4929C91.2151 34.9097 89.9193 33.6197 88.3291 33.6197C86.7388 33.6197 85.443 34.9097 85.443 36.4929C85.443 36.9033 85.5608 37.3138 85.7375 37.6656L80.3188 47.6926C80.2599 47.6926 80.2599 47.6926 80.201 47.6926C79.4942 47.6926 78.8464 47.9857 78.3752 48.3962L74.3111 44.9366C74.37 44.7021 74.4289 44.4089 74.4289 44.1157C74.4289 42.5325 73.1332 41.2425 71.5429 41.2425C69.9526 41.2425 68.6569 42.5325 68.6569 44.1157C68.6569 44.8193 68.8924 45.4643 69.3636 45.9334L64.2983 56.3122C64.1805 56.3122 64.0627 56.2536 63.886 56.2536C62.2958 56.2536 61 57.5436 61 59.1268C61 60.71 62.2958 62 63.886 62C65.4763 62 66.7721 60.71 66.7721 59.1268C66.7721 58.5404 66.5954 58.0127 66.3009 57.5436L71.484 46.9303H71.5429C71.9552 46.9303 72.3675 46.813 72.7798 46.6371L77.315 50.5071C77.315 52.0903 78.6108 53.3217 80.201 53.3217C81.7913 53.3217 83.0871 52.0317 83.0871 50.4485C83.0871 49.7448 82.8515 49.1585 82.4392 48.6307L87.6223 39.1315C87.8579 39.1902 88.1524 39.2488 88.388 39.2488C88.9181 39.2488 89.4481 39.0729 89.8604 38.8384L93.7478 42.1807C93.6889 42.4152 93.6889 42.5911 93.6889 42.8257C93.6889 44.4089 94.9846 45.6989 96.5749 45.6989C98.1652 45.6989 99.4609 44.4089 99.4609 42.8257C99.4609 42.122 99.1665 41.477 98.7542 40.9493L104.35 30.6292C105.822 30.6878 107 29.4564 107 27.8732Z" fill="#B480DE"/> +</g> +</g> +<defs> +<filter id="filter0_dddd_408_1800" x="16" y="5" width="104" height="107" filterUnits="userSpaceOnUse" color-interpolation-filters="sRGB"> +<feFlood flood-opacity="0" result="BackgroundImageFix"/> +<feColorMatrix in="SourceAlpha" type="matrix" values="0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 127 0" result="hardAlpha"/> +<feOffset dx="-1" dy="2"/> +<feGaussianBlur stdDeviation="2.5"/> +<feColorMatrix type="matrix" values="0 0 0 0 0.388235 0 0 0 0 0.388235 0 0 0 0 0.388235 0 0 0 0.1 0"/> +<feBlend mode="normal" in2="BackgroundImageFix" result="effect1_dropShadow_408_1800"/> +<feColorMatrix in="SourceAlpha" type="matrix" values="0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 127 0" result="hardAlpha"/> +<feOffset dx="-6" dy="7"/> +<feGaussianBlur stdDeviation="4.5"/> +<feColorMatrix type="matrix" values="0 0 0 0 0.388235 0 0 0 0 0.388235 0 0 0 0 0.388235 0 0 0 0.09 0"/> +<feBlend mode="normal" in2="effect1_dropShadow_408_1800" result="effect2_dropShadow_408_1800"/> +<feColorMatrix in="SourceAlpha" type="matrix" values="0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 127 0" result="hardAlpha"/> +<feOffset dx="-12" dy="15"/> +<feGaussianBlur stdDeviation="6"/> +<feColorMatrix type="matrix" values="0 0 0 0 0.388235 0 0 0 0 0.388235 0 0 0 0 0.388235 0 0 0 0.05 0"/> +<feBlend mode="normal" in2="effect2_dropShadow_408_1800" result="effect3_dropShadow_408_1800"/> +<feColorMatrix in="SourceAlpha" type="matrix" values="0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 127 0" result="hardAlpha"/> +<feOffset dx="-22" dy="26"/> +<feGaussianBlur stdDeviation="7"/> +<feColorMatrix type="matrix" values="0 0 0 0 0.388235 0 0 0 0 0.388235 0 0 0 0 0.388235 0 0 0 0.01 0"/> +<feBlend mode="normal" in2="effect3_dropShadow_408_1800" result="effect4_dropShadow_408_1800"/> +<feBlend mode="normal" in="SourceGraphic" in2="effect4_dropShadow_408_1800" result="shape"/> +</filter> +<radialGradient id="paint0_radial_408_1800" cx="0" cy="0" r="1" gradientUnits="userSpaceOnUse" gradientTransform="translate(35 32.5) rotate(28.1162) scale(115.647 113.674)"> +<stop stop-color="white"/> +<stop offset="1" stop-color="#F7ECFF"/> +</radialGradient> +<clipPath id="clip0_408_1800"> +<rect width="169" height="96" fill="white"/> +</clipPath> +</defs> +</svg> diff --git a/client/packages/lowcoder-design/src/icons/v2/line-chart-m.svg b/client/packages/lowcoder-design/src/icons/v2/line-chart-m.svg new file mode 100644 index 000000000..aa24cf53d --- /dev/null +++ b/client/packages/lowcoder-design/src/icons/v2/line-chart-m.svg @@ -0,0 +1,7 @@ +<svg width="48" height="48" viewBox="0 0 48 48" fill="none" xmlns="http://www.w3.org/2000/svg"> +<path fill-rule="evenodd" clip-rule="evenodd" d="M5 12C5 11.4477 5.44772 11 6 11H42C42.5523 11 43 11.4477 43 12C43 12.5523 42.5523 13 42 13H6C5.44772 13 5 12.5523 5 12Z" fill="#DEDEDE"/> +<path fill-rule="evenodd" clip-rule="evenodd" d="M5 22C5 21.4477 5.44772 21 6 21H42C42.5523 21 43 21.4477 43 22C43 22.5523 42.5523 23 42 23H6C5.44772 23 5 22.5523 5 22Z" fill="#DEDEDE"/> +<path fill-rule="evenodd" clip-rule="evenodd" d="M5 32C5 31.4477 5.44772 31 6 31H42C42.5523 31 43 31.4477 43 32C43 32.5523 42.5523 33 42 33H6C5.44772 33 5 32.5523 5 32Z" fill="#DEDEDE"/> +<path fill-rule="evenodd" clip-rule="evenodd" d="M5 42.5C5 41.6716 5.67157 41 6.5 41H42.5C43.3284 41 44 41.6716 44 42.5C44 43.3284 43.3284 44 42.5 44H6.5C5.67157 44 5 43.3284 5 42.5Z" fill="#DEDEDE"/> +<path d="M41 15.1743C41 13.9762 40.0423 13 38.8668 13C37.6914 13 36.7337 13.9762 36.7337 15.1743C36.7337 15.7512 36.9513 16.2837 37.3432 16.683L33.251 24.4041C32.9027 24.4041 32.5544 24.4929 32.2497 24.6704L29.2894 22.0967C29.3329 21.9635 29.3329 21.8304 29.3329 21.6973C29.3329 20.4992 28.3752 19.523 27.1997 19.523C26.0243 19.523 25.0666 20.4992 25.0666 21.6973C25.0666 22.0079 25.1537 22.3185 25.2843 22.5848L21.2791 30.1727C21.2356 30.1727 21.2356 30.1727 21.1921 30.1727C20.6697 30.1727 20.1908 30.3946 19.8425 30.7052L16.8387 28.0872C16.8822 27.9097 16.9257 27.6878 16.9257 27.4659C16.9257 26.2678 15.968 25.2916 14.7926 25.2916C13.6172 25.2916 12.6594 26.2678 12.6594 27.4659C12.6594 27.9984 12.8335 28.4865 13.1818 28.8415L9.4379 36.6957C9.35083 36.6957 9.26376 36.6513 9.13316 36.6513C7.95774 36.6513 7 37.6276 7 38.8257C7 40.0238 7.95774 41 9.13316 41C10.3086 41 11.2663 40.0238 11.2663 38.8257C11.2663 38.3819 11.1357 37.9826 10.9181 37.6276L14.749 29.5959H14.7926C15.0973 29.5959 15.402 29.5071 15.7068 29.374L19.0589 32.3027C19.0589 33.5008 20.0166 34.4326 21.1921 34.4326C22.3675 34.4326 23.3252 33.4564 23.3252 32.2583C23.3252 31.7258 23.1511 31.2821 22.8464 30.8827L26.6773 23.6941C26.8515 23.7385 27.0691 23.7829 27.2433 23.7829C27.6351 23.7829 28.0269 23.6498 28.3316 23.4723L31.2049 26.0016C31.1613 26.1791 31.1613 26.3122 31.1613 26.4897C31.1613 27.6878 32.1191 28.664 33.2945 28.664C34.4699 28.664 35.4277 27.6878 35.4277 26.4897C35.4277 25.9572 35.21 25.4691 34.9052 25.0697L39.041 17.2599C40.1293 17.3043 41 16.3724 41 15.1743Z" fill="#B480DE"/> +</svg> diff --git a/client/packages/lowcoder-design/src/icons/v2/line-chart-s.svg b/client/packages/lowcoder-design/src/icons/v2/line-chart-s.svg new file mode 100644 index 000000000..a39612795 --- /dev/null +++ b/client/packages/lowcoder-design/src/icons/v2/line-chart-s.svg @@ -0,0 +1,7 @@ +<svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg"> +<path d="M3 6H21" stroke="black" stroke-linecap="round"/> +<path d="M3 11H21" stroke="black" stroke-linecap="round"/> +<path d="M3 16H21" stroke="black" stroke-linecap="round"/> +<path d="M3 20H21" stroke="black" stroke-width="1.5" stroke-linecap="round"/> +<path d="M20 7.08716C20 6.48811 19.5493 6 18.9962 6C18.443 6 17.9923 6.48811 17.9923 7.08716C17.9923 7.37559 18.0948 7.64184 18.2791 7.84152L16.3534 11.7021C16.1895 11.7021 16.0256 11.7464 15.8822 11.8352L14.4891 10.5483C14.5096 10.4818 14.5096 10.4152 14.5096 10.3487C14.5096 9.7496 14.0589 9.26149 13.5058 9.26149C12.9526 9.26149 12.5019 9.7496 12.5019 10.3487C12.5019 10.504 12.5429 10.6593 12.6044 10.7924L10.7196 14.5864C10.6991 14.5864 10.6991 14.5864 10.6786 14.5864C10.4328 14.5864 10.2074 14.6973 10.0435 14.8526L8.62996 13.5436C8.65045 13.4548 8.67093 13.3439 8.67093 13.233C8.67093 12.6339 8.22023 12.1458 7.66709 12.1458C7.11396 12.1458 6.66325 12.6339 6.66325 13.233C6.66325 13.4992 6.7452 13.7433 6.90909 13.9208L5.14725 17.8479C5.10627 17.8479 5.0653 17.8257 5.00384 17.8257C4.4507 17.8257 4 18.3138 4 18.9128C4 19.5119 4.4507 20 5.00384 20C5.55698 20 6.00768 19.5119 6.00768 18.9128C6.00768 18.691 5.94622 18.4913 5.84379 18.3138L7.6466 14.2979H7.66709C7.8105 14.2979 7.95391 14.2536 8.09731 14.187L9.67478 15.6513C9.67478 16.2504 10.1255 16.7163 10.6786 16.7163C11.2318 16.7163 11.6825 16.2282 11.6825 15.6292C11.6825 15.3629 11.6005 15.141 11.4571 14.9414L13.2599 11.3471C13.3419 11.3693 13.4443 11.3914 13.5262 11.3914C13.7106 11.3914 13.895 11.3249 14.0384 11.2361L15.3905 12.5008C15.37 12.5895 15.37 12.6561 15.37 12.7448C15.37 13.3439 15.8207 13.832 16.3739 13.832C16.927 13.832 17.3777 13.3439 17.3777 12.7448C17.3777 12.4786 17.2753 12.2346 17.1319 12.0349L19.0781 8.12995C19.5903 8.15214 20 7.68621 20 7.08716Z" fill="black"/> +</svg> diff --git a/client/packages/lowcoder-design/src/icons/v2/scatter-chart-l.svg b/client/packages/lowcoder-design/src/icons/v2/scatter-chart-l.svg new file mode 100644 index 000000000..8bf8071c8 --- /dev/null +++ b/client/packages/lowcoder-design/src/icons/v2/scatter-chart-l.svg @@ -0,0 +1,1269 @@ +<svg width="169" height="96" viewBox="0 0 169 96" fill="none" xmlns="http://www.w3.org/2000/svg"> +<g clip-path="url(#clip0_408_2441)"> +<rect width="169" height="96" fill="url(#paint0_radial_408_2441)"/> +<g opacity="0.06"> +<rect x="3.31445" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="3.31445" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="3.31445" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="8.02344" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 8.02344 3.07227)" fill="#B480DE"/> +<rect x="8.02344" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 8.02344 3.07227)" fill="#B480DE"/> +<rect x="8.02344" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 8.02344 3.07227)" fill="#B480DE"/> +<rect x="3.31445" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 3.31445 3.07227)" fill="#B480DE"/> +<rect x="3.31445" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 3.31445 3.07227)" fill="#B480DE"/> +<rect x="3.31445" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 3.31445 3.07227)" fill="#B480DE"/> +<rect x="15.9971" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="15.9971" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="15.9971" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="20.7061" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 20.7061 3.07227)" fill="#B480DE"/> +<rect x="20.7061" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 20.7061 3.07227)" fill="#B480DE"/> +<rect x="20.7061" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 20.7061 3.07227)" fill="#B480DE"/> +<rect x="15.9971" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 15.9971 3.07227)" fill="#B480DE"/> +<rect x="15.9971" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 15.9971 3.07227)" fill="#B480DE"/> +<rect x="15.9971" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 15.9971 3.07227)" fill="#B480DE"/> +<rect x="28.6787" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="28.6787" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="28.6787" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="33.3877" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 33.3877 3.07227)" fill="#B480DE"/> +<rect x="33.3877" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 33.3877 3.07227)" fill="#B480DE"/> +<rect x="33.3877" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 33.3877 3.07227)" fill="#B480DE"/> +<rect x="28.6787" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 28.6787 3.07227)" fill="#B480DE"/> +<rect x="28.6787" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 28.6787 3.07227)" fill="#B480DE"/> +<rect x="28.6787" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 28.6787 3.07227)" fill="#B480DE"/> +<rect x="41.3613" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="41.3613" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="41.3613" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="46.0703" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 46.0703 3.07227)" fill="#B480DE"/> +<rect x="46.0703" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 46.0703 3.07227)" fill="#B480DE"/> +<rect x="46.0703" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 46.0703 3.07227)" fill="#B480DE"/> +<rect x="41.3613" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 41.3613 3.07227)" fill="#B480DE"/> +<rect x="41.3613" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 41.3613 3.07227)" fill="#B480DE"/> +<rect x="41.3613" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 41.3613 3.07227)" fill="#B480DE"/> +<rect x="54.0439" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="54.0439" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="54.0439" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="58.7529" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 58.7529 3.07227)" fill="#B480DE"/> +<rect x="58.7529" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 58.7529 3.07227)" fill="#B480DE"/> +<rect x="58.7529" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 58.7529 3.07227)" fill="#B480DE"/> +<rect x="54.0439" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 54.0439 3.07227)" fill="#B480DE"/> +<rect x="54.0439" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 54.0439 3.07227)" fill="#B480DE"/> +<rect x="54.0439" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 54.0439 3.07227)" fill="#B480DE"/> +<rect x="66.7256" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="66.7256" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="66.7256" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="71.4346" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 71.4346 3.07227)" fill="#B480DE"/> +<rect x="71.4346" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 71.4346 3.07227)" fill="#B480DE"/> +<rect x="71.4346" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 71.4346 3.07227)" fill="#B480DE"/> +<rect x="66.7256" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 66.7256 3.07227)" fill="#B480DE"/> +<rect x="66.7256" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 66.7256 3.07227)" fill="#B480DE"/> +<rect x="66.7256" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 66.7256 3.07227)" fill="#B480DE"/> +<rect x="79.4082" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="79.4082" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="79.4082" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="84.1172" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 84.1172 3.07227)" fill="#B480DE"/> +<rect x="84.1172" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 84.1172 3.07227)" fill="#B480DE"/> +<rect x="84.1172" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 84.1172 3.07227)" fill="#B480DE"/> +<rect x="79.4082" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 79.4082 3.07227)" fill="#B480DE"/> +<rect x="79.4082" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 79.4082 3.07227)" fill="#B480DE"/> +<rect x="79.4082" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 79.4082 3.07227)" fill="#B480DE"/> +<rect x="92.0898" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="92.0898" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="92.0898" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="96.7988" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 96.7988 3.07227)" fill="#B480DE"/> +<rect x="96.7988" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 96.7988 3.07227)" fill="#B480DE"/> +<rect x="96.7988" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 96.7988 3.07227)" fill="#B480DE"/> +<rect x="92.0898" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 92.0898 3.07227)" fill="#B480DE"/> +<rect x="92.0898" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 92.0898 3.07227)" fill="#B480DE"/> +<rect x="92.0898" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 92.0898 3.07227)" fill="#B480DE"/> +<rect x="104.772" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="104.772" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="104.772" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="109.481" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 109.481 3.07227)" fill="#B480DE"/> +<rect x="109.481" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 109.481 3.07227)" fill="#B480DE"/> +<rect x="109.481" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 109.481 3.07227)" fill="#B480DE"/> +<rect x="104.772" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 104.772 3.07227)" fill="#B480DE"/> +<rect x="104.772" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 104.772 3.07227)" fill="#B480DE"/> +<rect x="104.772" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 104.772 3.07227)" fill="#B480DE"/> +<rect x="117.455" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="117.455" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="117.455" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="122.164" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 122.164 3.07227)" fill="#B480DE"/> +<rect x="122.164" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 122.164 3.07227)" fill="#B480DE"/> +<rect x="122.164" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 122.164 3.07227)" fill="#B480DE"/> +<rect x="117.455" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 117.455 3.07227)" fill="#B480DE"/> +<rect x="117.455" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 117.455 3.07227)" fill="#B480DE"/> +<rect x="117.455" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 117.455 3.07227)" fill="#B480DE"/> +<rect x="130.137" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="130.137" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="130.137" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="134.846" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 134.846 3.07227)" fill="#B480DE"/> +<rect x="134.846" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 134.846 3.07227)" fill="#B480DE"/> +<rect x="134.846" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 134.846 3.07227)" fill="#B480DE"/> +<rect x="130.137" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 130.137 3.07227)" fill="#B480DE"/> +<rect x="130.137" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 130.137 3.07227)" fill="#B480DE"/> +<rect x="130.137" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 130.137 3.07227)" fill="#B480DE"/> +<rect x="142.819" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="142.819" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="142.819" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="147.528" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 147.528 3.07227)" fill="#B480DE"/> +<rect x="147.528" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 147.528 3.07227)" fill="#B480DE"/> +<rect x="147.528" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 147.528 3.07227)" fill="#B480DE"/> +<rect x="142.819" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 142.819 3.07227)" fill="#B480DE"/> +<rect x="142.819" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 142.819 3.07227)" fill="#B480DE"/> +<rect x="142.819" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 142.819 3.07227)" fill="#B480DE"/> +<rect x="155.502" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="155.502" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="155.502" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="160.211" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 160.211 3.07227)" fill="#B480DE"/> +<rect x="160.211" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 160.211 3.07227)" fill="#B480DE"/> +<rect x="160.211" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 160.211 3.07227)" fill="#B480DE"/> +<rect x="155.502" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 155.502 3.07227)" fill="#B480DE"/> +<rect x="155.502" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 155.502 3.07227)" fill="#B480DE"/> +<rect x="155.502" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 155.502 3.07227)" fill="#B480DE"/> +<rect x="168.184" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="168.184" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="168.184" y="-3" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="168.184" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 168.184 3.07227)" fill="#B480DE"/> +<rect x="168.184" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 168.184 3.07227)" fill="#B480DE"/> +<rect x="168.184" y="3.07227" width="1.73475" height="2.97386" transform="rotate(90 168.184 3.07227)" fill="#B480DE"/> +<rect x="1.68262" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 1.68262 12.8789)" fill="#B480DE"/> +<rect x="1.68262" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 1.68262 12.8789)" fill="#B480DE"/> +<rect x="1.68262" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 1.68262 12.8789)" fill="#B480DE"/> +<rect x="9.65625" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="9.65625" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="9.65625" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="14.3652" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 14.3652 12.8789)" fill="#B480DE"/> +<rect x="14.3652" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 14.3652 12.8789)" fill="#B480DE"/> +<rect x="14.3652" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 14.3652 12.8789)" fill="#B480DE"/> +<rect x="9.65625" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 9.65625 12.8789)" fill="#B480DE"/> +<rect x="9.65625" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 9.65625 12.8789)" fill="#B480DE"/> +<rect x="9.65625" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 9.65625 12.8789)" fill="#B480DE"/> +<rect x="22.3379" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="22.3379" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="22.3379" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="27.0469" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 27.0469 12.8789)" fill="#B480DE"/> +<rect x="27.0469" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 27.0469 12.8789)" fill="#B480DE"/> +<rect x="27.0469" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 27.0469 12.8789)" fill="#B480DE"/> +<rect x="22.3379" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 22.3379 12.8789)" fill="#B480DE"/> +<rect x="22.3379" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 22.3379 12.8789)" fill="#B480DE"/> +<rect x="22.3379" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 22.3379 12.8789)" fill="#B480DE"/> +<rect x="35.0205" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="35.0205" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="35.0205" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="39.7295" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 39.7295 12.8789)" fill="#B480DE"/> +<rect x="39.7295" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 39.7295 12.8789)" fill="#B480DE"/> +<rect x="39.7295" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 39.7295 12.8789)" fill="#B480DE"/> +<rect x="35.0205" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 35.0205 12.8789)" fill="#B480DE"/> +<rect x="35.0205" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 35.0205 12.8789)" fill="#B480DE"/> +<rect x="35.0205" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 35.0205 12.8789)" fill="#B480DE"/> +<rect x="47.7031" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="47.7031" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="47.7031" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="52.4121" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 52.4121 12.8789)" fill="#B480DE"/> +<rect x="52.4121" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 52.4121 12.8789)" fill="#B480DE"/> +<rect x="52.4121" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 52.4121 12.8789)" fill="#B480DE"/> +<rect x="47.7031" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 47.7031 12.8789)" fill="#B480DE"/> +<rect x="47.7031" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 47.7031 12.8789)" fill="#B480DE"/> +<rect x="47.7031" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 47.7031 12.8789)" fill="#B480DE"/> +<rect x="60.3848" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="60.3848" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="60.3848" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="65.0938" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 65.0938 12.8789)" fill="#B480DE"/> +<rect x="65.0938" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 65.0938 12.8789)" fill="#B480DE"/> +<rect x="65.0938" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 65.0938 12.8789)" fill="#B480DE"/> +<rect x="60.3848" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 60.3848 12.8789)" fill="#B480DE"/> +<rect x="60.3848" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 60.3848 12.8789)" fill="#B480DE"/> +<rect x="60.3848" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 60.3848 12.8789)" fill="#B480DE"/> +<rect x="73.0674" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="73.0674" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="73.0674" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="77.7764" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 77.7764 12.8789)" fill="#B480DE"/> +<rect x="77.7764" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 77.7764 12.8789)" fill="#B480DE"/> +<rect x="77.7764" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 77.7764 12.8789)" fill="#B480DE"/> +<rect x="73.0674" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 73.0674 12.8789)" fill="#B480DE"/> +<rect x="73.0674" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 73.0674 12.8789)" fill="#B480DE"/> +<rect x="73.0674" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 73.0674 12.8789)" fill="#B480DE"/> +<rect x="85.749" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="85.749" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="85.749" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="90.458" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 90.458 12.8789)" fill="#B480DE"/> +<rect x="90.458" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 90.458 12.8789)" fill="#B480DE"/> +<rect x="90.458" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 90.458 12.8789)" fill="#B480DE"/> +<rect x="85.749" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 85.749 12.8789)" fill="#B480DE"/> +<rect x="85.749" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 85.749 12.8789)" fill="#B480DE"/> +<rect x="85.749" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 85.749 12.8789)" fill="#B480DE"/> +<rect x="98.4316" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="98.4316" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="98.4316" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="103.141" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 103.141 12.8789)" fill="#B480DE"/> +<rect x="103.141" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 103.141 12.8789)" fill="#B480DE"/> +<rect x="103.141" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 103.141 12.8789)" fill="#B480DE"/> +<rect x="98.4316" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 98.4316 12.8789)" fill="#B480DE"/> +<rect x="98.4316" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 98.4316 12.8789)" fill="#B480DE"/> +<rect x="98.4316" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 98.4316 12.8789)" fill="#B480DE"/> +<rect x="111.114" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="111.114" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="111.114" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="115.823" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 115.823 12.8789)" fill="#B480DE"/> +<rect x="115.823" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 115.823 12.8789)" fill="#B480DE"/> +<rect x="115.823" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 115.823 12.8789)" fill="#B480DE"/> +<rect x="111.114" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 111.114 12.8789)" fill="#B480DE"/> +<rect x="111.114" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 111.114 12.8789)" fill="#B480DE"/> +<rect x="111.114" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 111.114 12.8789)" fill="#B480DE"/> +<rect x="123.796" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="123.796" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="123.796" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="128.505" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 128.505 12.8789)" fill="#B480DE"/> +<rect x="128.505" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 128.505 12.8789)" fill="#B480DE"/> +<rect x="128.505" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 128.505 12.8789)" fill="#B480DE"/> +<rect x="123.796" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 123.796 12.8789)" fill="#B480DE"/> +<rect x="123.796" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 123.796 12.8789)" fill="#B480DE"/> +<rect x="123.796" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 123.796 12.8789)" fill="#B480DE"/> +<rect x="136.479" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="136.479" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="136.479" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="141.188" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 141.188 12.8789)" fill="#B480DE"/> +<rect x="141.188" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 141.188 12.8789)" fill="#B480DE"/> +<rect x="141.188" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 141.188 12.8789)" fill="#B480DE"/> +<rect x="136.479" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 136.479 12.8789)" fill="#B480DE"/> +<rect x="136.479" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 136.479 12.8789)" fill="#B480DE"/> +<rect x="136.479" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 136.479 12.8789)" fill="#B480DE"/> +<rect x="149.161" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="149.161" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="149.161" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="153.87" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 153.87 12.8789)" fill="#B480DE"/> +<rect x="153.87" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 153.87 12.8789)" fill="#B480DE"/> +<rect x="153.87" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 153.87 12.8789)" fill="#B480DE"/> +<rect x="149.161" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 149.161 12.8789)" fill="#B480DE"/> +<rect x="149.161" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 149.161 12.8789)" fill="#B480DE"/> +<rect x="149.161" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 149.161 12.8789)" fill="#B480DE"/> +<rect x="161.843" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="161.843" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="161.843" y="6.80664" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="166.552" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 166.552 12.8789)" fill="#B480DE"/> +<rect x="166.552" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 166.552 12.8789)" fill="#B480DE"/> +<rect x="166.552" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 166.552 12.8789)" fill="#B480DE"/> +<rect x="161.843" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 161.843 12.8789)" fill="#B480DE"/> +<rect x="161.843" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 161.843 12.8789)" fill="#B480DE"/> +<rect x="161.843" y="12.8789" width="1.73475" height="2.97386" transform="rotate(90 161.843 12.8789)" fill="#B480DE"/> +<rect x="3.31445" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="3.31445" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="3.31445" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="8.02344" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 8.02344 22.6855)" fill="#B480DE"/> +<rect x="8.02344" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 8.02344 22.6855)" fill="#B480DE"/> +<rect x="8.02344" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 8.02344 22.6855)" fill="#B480DE"/> +<rect x="3.31445" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 3.31445 22.6855)" fill="#B480DE"/> +<rect x="3.31445" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 3.31445 22.6855)" fill="#B480DE"/> +<rect x="3.31445" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 3.31445 22.6855)" fill="#B480DE"/> +<rect x="15.9971" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="15.9971" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="15.9971" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="20.7061" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 20.7061 22.6855)" fill="#B480DE"/> +<rect x="20.7061" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 20.7061 22.6855)" fill="#B480DE"/> +<rect x="20.7061" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 20.7061 22.6855)" fill="#B480DE"/> +<rect x="15.9971" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 15.9971 22.6855)" fill="#B480DE"/> +<rect x="15.9971" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 15.9971 22.6855)" fill="#B480DE"/> +<rect x="15.9971" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 15.9971 22.6855)" fill="#B480DE"/> +<rect x="28.6787" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="28.6787" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="28.6787" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="33.3877" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 33.3877 22.6855)" fill="#B480DE"/> +<rect x="33.3877" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 33.3877 22.6855)" fill="#B480DE"/> +<rect x="33.3877" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 33.3877 22.6855)" fill="#B480DE"/> +<rect x="28.6787" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 28.6787 22.6855)" fill="#B480DE"/> +<rect x="28.6787" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 28.6787 22.6855)" fill="#B480DE"/> +<rect x="28.6787" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 28.6787 22.6855)" fill="#B480DE"/> +<rect x="41.3613" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="41.3613" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="41.3613" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="46.0703" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 46.0703 22.6855)" fill="#B480DE"/> +<rect x="46.0703" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 46.0703 22.6855)" fill="#B480DE"/> +<rect x="46.0703" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 46.0703 22.6855)" fill="#B480DE"/> +<rect x="41.3613" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 41.3613 22.6855)" fill="#B480DE"/> +<rect x="41.3613" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 41.3613 22.6855)" fill="#B480DE"/> +<rect x="41.3613" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 41.3613 22.6855)" fill="#B480DE"/> +<rect x="54.0439" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="54.0439" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="54.0439" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="58.7529" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 58.7529 22.6855)" fill="#B480DE"/> +<rect x="58.7529" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 58.7529 22.6855)" fill="#B480DE"/> +<rect x="58.7529" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 58.7529 22.6855)" fill="#B480DE"/> +<rect x="54.0439" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 54.0439 22.6855)" fill="#B480DE"/> +<rect x="54.0439" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 54.0439 22.6855)" fill="#B480DE"/> +<rect x="54.0439" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 54.0439 22.6855)" fill="#B480DE"/> +<rect x="66.7256" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="66.7256" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="66.7256" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="71.4346" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 71.4346 22.6855)" fill="#B480DE"/> +<rect x="71.4346" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 71.4346 22.6855)" fill="#B480DE"/> +<rect x="71.4346" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 71.4346 22.6855)" fill="#B480DE"/> +<rect x="66.7256" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 66.7256 22.6855)" fill="#B480DE"/> +<rect x="66.7256" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 66.7256 22.6855)" fill="#B480DE"/> +<rect x="66.7256" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 66.7256 22.6855)" fill="#B480DE"/> +<rect x="79.4082" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="79.4082" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="79.4082" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="84.1172" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 84.1172 22.6855)" fill="#B480DE"/> +<rect x="84.1172" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 84.1172 22.6855)" fill="#B480DE"/> +<rect x="84.1172" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 84.1172 22.6855)" fill="#B480DE"/> +<rect x="79.4082" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 79.4082 22.6855)" fill="#B480DE"/> +<rect x="79.4082" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 79.4082 22.6855)" fill="#B480DE"/> +<rect x="79.4082" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 79.4082 22.6855)" fill="#B480DE"/> +<rect x="92.0898" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="92.0898" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="92.0898" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="96.7988" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 96.7988 22.6855)" fill="#B480DE"/> +<rect x="96.7988" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 96.7988 22.6855)" fill="#B480DE"/> +<rect x="96.7988" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 96.7988 22.6855)" fill="#B480DE"/> +<rect x="92.0898" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 92.0898 22.6855)" fill="#B480DE"/> +<rect x="92.0898" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 92.0898 22.6855)" fill="#B480DE"/> +<rect x="92.0898" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 92.0898 22.6855)" fill="#B480DE"/> +<rect x="104.772" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="104.772" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="104.772" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="109.481" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 109.481 22.6855)" fill="#B480DE"/> +<rect x="109.481" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 109.481 22.6855)" fill="#B480DE"/> +<rect x="109.481" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 109.481 22.6855)" fill="#B480DE"/> +<rect x="104.772" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 104.772 22.6855)" fill="#B480DE"/> +<rect x="104.772" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 104.772 22.6855)" fill="#B480DE"/> +<rect x="104.772" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 104.772 22.6855)" fill="#B480DE"/> +<rect x="117.455" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="117.455" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="117.455" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="122.164" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 122.164 22.6855)" fill="#B480DE"/> +<rect x="122.164" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 122.164 22.6855)" fill="#B480DE"/> +<rect x="122.164" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 122.164 22.6855)" fill="#B480DE"/> +<rect x="117.455" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 117.455 22.6855)" fill="#B480DE"/> +<rect x="117.455" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 117.455 22.6855)" fill="#B480DE"/> +<rect x="117.455" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 117.455 22.6855)" fill="#B480DE"/> +<rect x="130.137" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="130.137" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="130.137" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="134.846" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 134.846 22.6855)" fill="#B480DE"/> +<rect x="134.846" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 134.846 22.6855)" fill="#B480DE"/> +<rect x="134.846" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 134.846 22.6855)" fill="#B480DE"/> +<rect x="130.137" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 130.137 22.6855)" fill="#B480DE"/> +<rect x="130.137" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 130.137 22.6855)" fill="#B480DE"/> +<rect x="130.137" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 130.137 22.6855)" fill="#B480DE"/> +<rect x="142.819" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="142.819" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="142.819" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="147.528" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 147.528 22.6855)" fill="#B480DE"/> +<rect x="147.528" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 147.528 22.6855)" fill="#B480DE"/> +<rect x="147.528" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 147.528 22.6855)" fill="#B480DE"/> +<rect x="142.819" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 142.819 22.6855)" fill="#B480DE"/> +<rect x="142.819" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 142.819 22.6855)" fill="#B480DE"/> +<rect x="142.819" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 142.819 22.6855)" fill="#B480DE"/> +<rect x="155.502" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="155.502" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="155.502" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="160.211" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 160.211 22.6855)" fill="#B480DE"/> +<rect x="160.211" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 160.211 22.6855)" fill="#B480DE"/> +<rect x="160.211" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 160.211 22.6855)" fill="#B480DE"/> +<rect x="155.502" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 155.502 22.6855)" fill="#B480DE"/> +<rect x="155.502" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 155.502 22.6855)" fill="#B480DE"/> +<rect x="155.502" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 155.502 22.6855)" fill="#B480DE"/> +<rect x="168.184" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="168.184" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="168.184" y="16.6133" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="168.184" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 168.184 22.6855)" fill="#B480DE"/> +<rect x="168.184" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 168.184 22.6855)" fill="#B480DE"/> +<rect x="168.184" y="22.6855" width="1.73475" height="2.97386" transform="rotate(90 168.184 22.6855)" fill="#B480DE"/> +<rect x="1.68262" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 1.68262 32.4902)" fill="#B480DE"/> +<rect x="1.68262" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 1.68262 32.4902)" fill="#B480DE"/> +<rect x="1.68262" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 1.68262 32.4902)" fill="#B480DE"/> +<rect x="9.65625" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="9.65625" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="9.65625" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="14.3652" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 14.3652 32.4902)" fill="#B480DE"/> +<rect x="14.3652" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 14.3652 32.4902)" fill="#B480DE"/> +<rect x="14.3652" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 14.3652 32.4902)" fill="#B480DE"/> +<rect x="9.65625" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 9.65625 32.4902)" fill="#B480DE"/> +<rect x="9.65625" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 9.65625 32.4902)" fill="#B480DE"/> +<rect x="9.65625" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 9.65625 32.4902)" fill="#B480DE"/> +<rect x="22.3379" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="22.3379" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="22.3379" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="27.0469" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 27.0469 32.4902)" fill="#B480DE"/> +<rect x="27.0469" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 27.0469 32.4902)" fill="#B480DE"/> +<rect x="27.0469" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 27.0469 32.4902)" fill="#B480DE"/> +<rect x="22.3379" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 22.3379 32.4902)" fill="#B480DE"/> +<rect x="22.3379" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 22.3379 32.4902)" fill="#B480DE"/> +<rect x="22.3379" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 22.3379 32.4902)" fill="#B480DE"/> +<rect x="35.0205" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="35.0205" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="35.0205" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="39.7295" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 39.7295 32.4902)" fill="#B480DE"/> +<rect x="39.7295" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 39.7295 32.4902)" fill="#B480DE"/> +<rect x="39.7295" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 39.7295 32.4902)" fill="#B480DE"/> +<rect x="35.0205" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 35.0205 32.4902)" fill="#B480DE"/> +<rect x="35.0205" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 35.0205 32.4902)" fill="#B480DE"/> +<rect x="35.0205" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 35.0205 32.4902)" fill="#B480DE"/> +<rect x="47.7031" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="47.7031" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="47.7031" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="52.4121" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 52.4121 32.4902)" fill="#B480DE"/> +<rect x="52.4121" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 52.4121 32.4902)" fill="#B480DE"/> +<rect x="52.4121" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 52.4121 32.4902)" fill="#B480DE"/> +<rect x="47.7031" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 47.7031 32.4902)" fill="#B480DE"/> +<rect x="47.7031" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 47.7031 32.4902)" fill="#B480DE"/> +<rect x="47.7031" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 47.7031 32.4902)" fill="#B480DE"/> +<rect x="60.3848" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="60.3848" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="60.3848" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="65.0938" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 65.0938 32.4902)" fill="#B480DE"/> +<rect x="65.0938" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 65.0938 32.4902)" fill="#B480DE"/> +<rect x="65.0938" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 65.0938 32.4902)" fill="#B480DE"/> +<rect x="60.3848" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 60.3848 32.4902)" fill="#B480DE"/> +<rect x="60.3848" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 60.3848 32.4902)" fill="#B480DE"/> +<rect x="60.3848" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 60.3848 32.4902)" fill="#B480DE"/> +<rect x="73.0674" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="73.0674" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="73.0674" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="77.7764" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 77.7764 32.4902)" fill="#B480DE"/> +<rect x="77.7764" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 77.7764 32.4902)" fill="#B480DE"/> +<rect x="77.7764" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 77.7764 32.4902)" fill="#B480DE"/> +<rect x="73.0674" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 73.0674 32.4902)" fill="#B480DE"/> +<rect x="73.0674" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 73.0674 32.4902)" fill="#B480DE"/> +<rect x="73.0674" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 73.0674 32.4902)" fill="#B480DE"/> +<rect x="85.749" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="85.749" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="85.749" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="90.458" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 90.458 32.4902)" fill="#B480DE"/> +<rect x="90.458" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 90.458 32.4902)" fill="#B480DE"/> +<rect x="90.458" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 90.458 32.4902)" fill="#B480DE"/> +<rect x="85.749" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 85.749 32.4902)" fill="#B480DE"/> +<rect x="85.749" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 85.749 32.4902)" fill="#B480DE"/> +<rect x="85.749" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 85.749 32.4902)" fill="#B480DE"/> +<rect x="98.4316" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="98.4316" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="98.4316" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="103.141" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 103.141 32.4902)" fill="#B480DE"/> +<rect x="103.141" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 103.141 32.4902)" fill="#B480DE"/> +<rect x="103.141" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 103.141 32.4902)" fill="#B480DE"/> +<rect x="98.4316" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 98.4316 32.4902)" fill="#B480DE"/> +<rect x="98.4316" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 98.4316 32.4902)" fill="#B480DE"/> +<rect x="98.4316" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 98.4316 32.4902)" fill="#B480DE"/> +<rect x="111.114" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="111.114" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="111.114" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="115.823" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 115.823 32.4902)" fill="#B480DE"/> +<rect x="115.823" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 115.823 32.4902)" fill="#B480DE"/> +<rect x="115.823" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 115.823 32.4902)" fill="#B480DE"/> +<rect x="111.114" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 111.114 32.4902)" fill="#B480DE"/> +<rect x="111.114" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 111.114 32.4902)" fill="#B480DE"/> +<rect x="111.114" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 111.114 32.4902)" fill="#B480DE"/> +<rect x="123.796" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="123.796" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="123.796" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="128.505" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 128.505 32.4902)" fill="#B480DE"/> +<rect x="128.505" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 128.505 32.4902)" fill="#B480DE"/> +<rect x="128.505" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 128.505 32.4902)" fill="#B480DE"/> +<rect x="123.796" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 123.796 32.4902)" fill="#B480DE"/> +<rect x="123.796" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 123.796 32.4902)" fill="#B480DE"/> +<rect x="123.796" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 123.796 32.4902)" fill="#B480DE"/> +<rect x="136.479" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="136.479" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="136.479" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="141.188" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 141.188 32.4902)" fill="#B480DE"/> +<rect x="141.188" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 141.188 32.4902)" fill="#B480DE"/> +<rect x="141.188" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 141.188 32.4902)" fill="#B480DE"/> +<rect x="136.479" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 136.479 32.4902)" fill="#B480DE"/> +<rect x="136.479" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 136.479 32.4902)" fill="#B480DE"/> +<rect x="136.479" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 136.479 32.4902)" fill="#B480DE"/> +<rect x="149.161" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="149.161" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="149.161" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="153.87" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 153.87 32.4902)" fill="#B480DE"/> +<rect x="153.87" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 153.87 32.4902)" fill="#B480DE"/> +<rect x="153.87" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 153.87 32.4902)" fill="#B480DE"/> +<rect x="149.161" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 149.161 32.4902)" fill="#B480DE"/> +<rect x="149.161" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 149.161 32.4902)" fill="#B480DE"/> +<rect x="149.161" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 149.161 32.4902)" fill="#B480DE"/> +<rect x="161.843" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="161.843" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="161.843" y="26.418" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="166.552" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 166.552 32.4902)" fill="#B480DE"/> +<rect x="166.552" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 166.552 32.4902)" fill="#B480DE"/> +<rect x="166.552" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 166.552 32.4902)" fill="#B480DE"/> +<rect x="161.843" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 161.843 32.4902)" fill="#B480DE"/> +<rect x="161.843" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 161.843 32.4902)" fill="#B480DE"/> +<rect x="161.843" y="32.4902" width="1.73475" height="2.97386" transform="rotate(90 161.843 32.4902)" fill="#B480DE"/> +<rect x="3.31445" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="3.31445" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="3.31445" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="8.02344" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 8.02344 42.2969)" fill="#B480DE"/> +<rect x="8.02344" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 8.02344 42.2969)" fill="#B480DE"/> +<rect x="8.02344" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 8.02344 42.2969)" fill="#B480DE"/> +<rect x="3.31445" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 3.31445 42.2969)" fill="#B480DE"/> +<rect x="3.31445" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 3.31445 42.2969)" fill="#B480DE"/> +<rect x="3.31445" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 3.31445 42.2969)" fill="#B480DE"/> +<rect x="15.9971" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="15.9971" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="15.9971" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="20.7061" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 20.7061 42.2969)" fill="#B480DE"/> +<rect x="20.7061" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 20.7061 42.2969)" fill="#B480DE"/> +<rect x="20.7061" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 20.7061 42.2969)" fill="#B480DE"/> +<rect x="15.9971" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 15.9971 42.2969)" fill="#B480DE"/> +<rect x="15.9971" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 15.9971 42.2969)" fill="#B480DE"/> +<rect x="15.9971" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 15.9971 42.2969)" fill="#B480DE"/> +<rect x="28.6787" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="28.6787" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="28.6787" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="33.3877" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 33.3877 42.2969)" fill="#B480DE"/> +<rect x="33.3877" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 33.3877 42.2969)" fill="#B480DE"/> +<rect x="33.3877" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 33.3877 42.2969)" fill="#B480DE"/> +<rect x="28.6787" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 28.6787 42.2969)" fill="#B480DE"/> +<rect x="28.6787" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 28.6787 42.2969)" fill="#B480DE"/> +<rect x="28.6787" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 28.6787 42.2969)" fill="#B480DE"/> +<rect x="41.3613" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="41.3613" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="41.3613" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="46.0703" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 46.0703 42.2969)" fill="#B480DE"/> +<rect x="46.0703" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 46.0703 42.2969)" fill="#B480DE"/> +<rect x="46.0703" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 46.0703 42.2969)" fill="#B480DE"/> +<rect x="41.3613" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 41.3613 42.2969)" fill="#B480DE"/> +<rect x="41.3613" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 41.3613 42.2969)" fill="#B480DE"/> +<rect x="41.3613" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 41.3613 42.2969)" fill="#B480DE"/> +<rect x="54.0439" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="54.0439" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="54.0439" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="58.7529" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 58.7529 42.2969)" fill="#B480DE"/> +<rect x="58.7529" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 58.7529 42.2969)" fill="#B480DE"/> +<rect x="58.7529" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 58.7529 42.2969)" fill="#B480DE"/> +<rect x="54.0439" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 54.0439 42.2969)" fill="#B480DE"/> +<rect x="54.0439" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 54.0439 42.2969)" fill="#B480DE"/> +<rect x="54.0439" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 54.0439 42.2969)" fill="#B480DE"/> +<rect x="66.7256" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="66.7256" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="66.7256" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="71.4346" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 71.4346 42.2969)" fill="#B480DE"/> +<rect x="71.4346" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 71.4346 42.2969)" fill="#B480DE"/> +<rect x="71.4346" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 71.4346 42.2969)" fill="#B480DE"/> +<rect x="66.7256" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 66.7256 42.2969)" fill="#B480DE"/> +<rect x="66.7256" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 66.7256 42.2969)" fill="#B480DE"/> +<rect x="66.7256" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 66.7256 42.2969)" fill="#B480DE"/> +<rect x="79.4082" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="79.4082" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="79.4082" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="84.1172" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 84.1172 42.2969)" fill="#B480DE"/> +<rect x="84.1172" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 84.1172 42.2969)" fill="#B480DE"/> +<rect x="84.1172" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 84.1172 42.2969)" fill="#B480DE"/> +<rect x="79.4082" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 79.4082 42.2969)" fill="#B480DE"/> +<rect x="79.4082" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 79.4082 42.2969)" fill="#B480DE"/> +<rect x="79.4082" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 79.4082 42.2969)" fill="#B480DE"/> +<rect x="92.0898" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="92.0898" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="92.0898" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="96.7988" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 96.7988 42.2969)" fill="#B480DE"/> +<rect x="96.7988" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 96.7988 42.2969)" fill="#B480DE"/> +<rect x="96.7988" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 96.7988 42.2969)" fill="#B480DE"/> +<rect x="92.0898" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 92.0898 42.2969)" fill="#B480DE"/> +<rect x="92.0898" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 92.0898 42.2969)" fill="#B480DE"/> +<rect x="92.0898" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 92.0898 42.2969)" fill="#B480DE"/> +<rect x="104.772" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="104.772" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="104.772" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="109.481" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 109.481 42.2969)" fill="#B480DE"/> +<rect x="109.481" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 109.481 42.2969)" fill="#B480DE"/> +<rect x="109.481" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 109.481 42.2969)" fill="#B480DE"/> +<rect x="104.772" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 104.772 42.2969)" fill="#B480DE"/> +<rect x="104.772" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 104.772 42.2969)" fill="#B480DE"/> +<rect x="104.772" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 104.772 42.2969)" fill="#B480DE"/> +<rect x="117.455" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="117.455" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="117.455" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="122.164" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 122.164 42.2969)" fill="#B480DE"/> +<rect x="122.164" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 122.164 42.2969)" fill="#B480DE"/> +<rect x="122.164" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 122.164 42.2969)" fill="#B480DE"/> +<rect x="117.455" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 117.455 42.2969)" fill="#B480DE"/> +<rect x="117.455" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 117.455 42.2969)" fill="#B480DE"/> +<rect x="117.455" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 117.455 42.2969)" fill="#B480DE"/> +<rect x="130.137" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="130.137" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="130.137" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="134.846" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 134.846 42.2969)" fill="#B480DE"/> +<rect x="134.846" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 134.846 42.2969)" fill="#B480DE"/> +<rect x="134.846" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 134.846 42.2969)" fill="#B480DE"/> +<rect x="130.137" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 130.137 42.2969)" fill="#B480DE"/> +<rect x="130.137" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 130.137 42.2969)" fill="#B480DE"/> +<rect x="130.137" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 130.137 42.2969)" fill="#B480DE"/> +<rect x="142.819" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="142.819" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="142.819" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="147.528" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 147.528 42.2969)" fill="#B480DE"/> +<rect x="147.528" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 147.528 42.2969)" fill="#B480DE"/> +<rect x="147.528" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 147.528 42.2969)" fill="#B480DE"/> +<rect x="142.819" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 142.819 42.2969)" fill="#B480DE"/> +<rect x="142.819" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 142.819 42.2969)" fill="#B480DE"/> +<rect x="142.819" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 142.819 42.2969)" fill="#B480DE"/> +<rect x="155.502" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="155.502" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="155.502" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="160.211" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 160.211 42.2969)" fill="#B480DE"/> +<rect x="160.211" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 160.211 42.2969)" fill="#B480DE"/> +<rect x="160.211" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 160.211 42.2969)" fill="#B480DE"/> +<rect x="155.502" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 155.502 42.2969)" fill="#B480DE"/> +<rect x="155.502" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 155.502 42.2969)" fill="#B480DE"/> +<rect x="155.502" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 155.502 42.2969)" fill="#B480DE"/> +<rect x="168.184" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="168.184" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="168.184" y="36.2246" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="168.184" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 168.184 42.2969)" fill="#B480DE"/> +<rect x="168.184" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 168.184 42.2969)" fill="#B480DE"/> +<rect x="168.184" y="42.2969" width="1.73475" height="2.97386" transform="rotate(90 168.184 42.2969)" fill="#B480DE"/> +<rect x="1.68262" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 1.68262 52.1035)" fill="#B480DE"/> +<rect x="1.68262" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 1.68262 52.1035)" fill="#B480DE"/> +<rect x="1.68262" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 1.68262 52.1035)" fill="#B480DE"/> +<rect x="9.65625" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="9.65625" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="9.65625" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="14.3652" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 14.3652 52.1035)" fill="#B480DE"/> +<rect x="14.3652" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 14.3652 52.1035)" fill="#B480DE"/> +<rect x="14.3652" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 14.3652 52.1035)" fill="#B480DE"/> +<rect x="9.65625" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 9.65625 52.1035)" fill="#B480DE"/> +<rect x="9.65625" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 9.65625 52.1035)" fill="#B480DE"/> +<rect x="9.65625" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 9.65625 52.1035)" fill="#B480DE"/> +<rect x="22.3379" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="22.3379" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="22.3379" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="27.0469" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 27.0469 52.1035)" fill="#B480DE"/> +<rect x="27.0469" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 27.0469 52.1035)" fill="#B480DE"/> +<rect x="27.0469" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 27.0469 52.1035)" fill="#B480DE"/> +<rect x="22.3379" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 22.3379 52.1035)" fill="#B480DE"/> +<rect x="22.3379" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 22.3379 52.1035)" fill="#B480DE"/> +<rect x="22.3379" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 22.3379 52.1035)" fill="#B480DE"/> +<rect x="35.0205" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="35.0205" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="35.0205" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="39.7295" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 39.7295 52.1035)" fill="#B480DE"/> +<rect x="39.7295" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 39.7295 52.1035)" fill="#B480DE"/> +<rect x="39.7295" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 39.7295 52.1035)" fill="#B480DE"/> +<rect x="35.0205" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 35.0205 52.1035)" fill="#B480DE"/> +<rect x="35.0205" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 35.0205 52.1035)" fill="#B480DE"/> +<rect x="35.0205" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 35.0205 52.1035)" fill="#B480DE"/> +<rect x="47.7031" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="47.7031" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="47.7031" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="52.4121" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 52.4121 52.1035)" fill="#B480DE"/> +<rect x="52.4121" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 52.4121 52.1035)" fill="#B480DE"/> +<rect x="52.4121" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 52.4121 52.1035)" fill="#B480DE"/> +<rect x="47.7031" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 47.7031 52.1035)" fill="#B480DE"/> +<rect x="47.7031" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 47.7031 52.1035)" fill="#B480DE"/> +<rect x="47.7031" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 47.7031 52.1035)" fill="#B480DE"/> +<rect x="60.3848" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="60.3848" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="60.3848" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="65.0938" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 65.0938 52.1035)" fill="#B480DE"/> +<rect x="65.0938" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 65.0938 52.1035)" fill="#B480DE"/> +<rect x="65.0938" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 65.0938 52.1035)" fill="#B480DE"/> +<rect x="60.3848" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 60.3848 52.1035)" fill="#B480DE"/> +<rect x="60.3848" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 60.3848 52.1035)" fill="#B480DE"/> +<rect x="60.3848" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 60.3848 52.1035)" fill="#B480DE"/> +<rect x="73.0674" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="73.0674" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="73.0674" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="77.7764" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 77.7764 52.1035)" fill="#B480DE"/> +<rect x="77.7764" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 77.7764 52.1035)" fill="#B480DE"/> +<rect x="77.7764" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 77.7764 52.1035)" fill="#B480DE"/> +<rect x="73.0674" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 73.0674 52.1035)" fill="#B480DE"/> +<rect x="73.0674" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 73.0674 52.1035)" fill="#B480DE"/> +<rect x="73.0674" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 73.0674 52.1035)" fill="#B480DE"/> +<rect x="85.749" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="85.749" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="85.749" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="90.458" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 90.458 52.1035)" fill="#B480DE"/> +<rect x="90.458" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 90.458 52.1035)" fill="#B480DE"/> +<rect x="90.458" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 90.458 52.1035)" fill="#B480DE"/> +<rect x="85.749" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 85.749 52.1035)" fill="#B480DE"/> +<rect x="85.749" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 85.749 52.1035)" fill="#B480DE"/> +<rect x="85.749" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 85.749 52.1035)" fill="#B480DE"/> +<rect x="98.4316" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="98.4316" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="98.4316" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="103.141" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 103.141 52.1035)" fill="#B480DE"/> +<rect x="103.141" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 103.141 52.1035)" fill="#B480DE"/> +<rect x="103.141" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 103.141 52.1035)" fill="#B480DE"/> +<rect x="98.4316" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 98.4316 52.1035)" fill="#B480DE"/> +<rect x="98.4316" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 98.4316 52.1035)" fill="#B480DE"/> +<rect x="98.4316" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 98.4316 52.1035)" fill="#B480DE"/> +<rect x="111.114" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="111.114" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="111.114" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="115.823" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 115.823 52.1035)" fill="#B480DE"/> +<rect x="115.823" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 115.823 52.1035)" fill="#B480DE"/> +<rect x="115.823" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 115.823 52.1035)" fill="#B480DE"/> +<rect x="111.114" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 111.114 52.1035)" fill="#B480DE"/> +<rect x="111.114" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 111.114 52.1035)" fill="#B480DE"/> +<rect x="111.114" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 111.114 52.1035)" fill="#B480DE"/> +<rect x="123.796" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="123.796" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="123.796" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="128.505" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 128.505 52.1035)" fill="#B480DE"/> +<rect x="128.505" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 128.505 52.1035)" fill="#B480DE"/> +<rect x="128.505" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 128.505 52.1035)" fill="#B480DE"/> +<rect x="123.796" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 123.796 52.1035)" fill="#B480DE"/> +<rect x="123.796" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 123.796 52.1035)" fill="#B480DE"/> +<rect x="123.796" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 123.796 52.1035)" fill="#B480DE"/> +<rect x="136.479" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="136.479" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="136.479" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="141.188" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 141.188 52.1035)" fill="#B480DE"/> +<rect x="141.188" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 141.188 52.1035)" fill="#B480DE"/> +<rect x="141.188" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 141.188 52.1035)" fill="#B480DE"/> +<rect x="136.479" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 136.479 52.1035)" fill="#B480DE"/> +<rect x="136.479" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 136.479 52.1035)" fill="#B480DE"/> +<rect x="136.479" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 136.479 52.1035)" fill="#B480DE"/> +<rect x="149.161" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="149.161" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="149.161" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="153.87" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 153.87 52.1035)" fill="#B480DE"/> +<rect x="153.87" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 153.87 52.1035)" fill="#B480DE"/> +<rect x="153.87" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 153.87 52.1035)" fill="#B480DE"/> +<rect x="149.161" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 149.161 52.1035)" fill="#B480DE"/> +<rect x="149.161" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 149.161 52.1035)" fill="#B480DE"/> +<rect x="149.161" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 149.161 52.1035)" fill="#B480DE"/> +<rect x="161.843" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="161.843" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="161.843" y="46.0312" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="166.552" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 166.552 52.1035)" fill="#B480DE"/> +<rect x="166.552" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 166.552 52.1035)" fill="#B480DE"/> +<rect x="166.552" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 166.552 52.1035)" fill="#B480DE"/> +<rect x="161.843" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 161.843 52.1035)" fill="#B480DE"/> +<rect x="161.843" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 161.843 52.1035)" fill="#B480DE"/> +<rect x="161.843" y="52.1035" width="1.73475" height="2.97386" transform="rotate(90 161.843 52.1035)" fill="#B480DE"/> +<rect x="3.31445" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="3.31445" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="3.31445" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="8.02344" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 8.02344 61.9102)" fill="#B480DE"/> +<rect x="8.02344" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 8.02344 61.9102)" fill="#B480DE"/> +<rect x="8.02344" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 8.02344 61.9102)" fill="#B480DE"/> +<rect x="3.31445" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 3.31445 61.9102)" fill="#B480DE"/> +<rect x="3.31445" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 3.31445 61.9102)" fill="#B480DE"/> +<rect x="3.31445" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 3.31445 61.9102)" fill="#B480DE"/> +<rect x="15.9971" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="15.9971" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="15.9971" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="20.7061" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 20.7061 61.9102)" fill="#B480DE"/> +<rect x="20.7061" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 20.7061 61.9102)" fill="#B480DE"/> +<rect x="20.7061" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 20.7061 61.9102)" fill="#B480DE"/> +<rect x="15.9971" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 15.9971 61.9102)" fill="#B480DE"/> +<rect x="15.9971" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 15.9971 61.9102)" fill="#B480DE"/> +<rect x="15.9971" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 15.9971 61.9102)" fill="#B480DE"/> +<rect x="28.6787" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="28.6787" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="28.6787" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="33.3877" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 33.3877 61.9102)" fill="#B480DE"/> +<rect x="33.3877" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 33.3877 61.9102)" fill="#B480DE"/> +<rect x="33.3877" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 33.3877 61.9102)" fill="#B480DE"/> +<rect x="28.6787" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 28.6787 61.9102)" fill="#B480DE"/> +<rect x="28.6787" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 28.6787 61.9102)" fill="#B480DE"/> +<rect x="28.6787" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 28.6787 61.9102)" fill="#B480DE"/> +<rect x="41.3613" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="41.3613" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="41.3613" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="46.0703" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 46.0703 61.9102)" fill="#B480DE"/> +<rect x="46.0703" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 46.0703 61.9102)" fill="#B480DE"/> +<rect x="46.0703" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 46.0703 61.9102)" fill="#B480DE"/> +<rect x="41.3613" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 41.3613 61.9102)" fill="#B480DE"/> +<rect x="41.3613" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 41.3613 61.9102)" fill="#B480DE"/> +<rect x="41.3613" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 41.3613 61.9102)" fill="#B480DE"/> +<rect x="54.0439" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="54.0439" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="54.0439" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="58.7529" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 58.7529 61.9102)" fill="#B480DE"/> +<rect x="58.7529" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 58.7529 61.9102)" fill="#B480DE"/> +<rect x="58.7529" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 58.7529 61.9102)" fill="#B480DE"/> +<rect x="54.0439" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 54.0439 61.9102)" fill="#B480DE"/> +<rect x="54.0439" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 54.0439 61.9102)" fill="#B480DE"/> +<rect x="54.0439" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 54.0439 61.9102)" fill="#B480DE"/> +<rect x="66.7256" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="66.7256" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="66.7256" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="71.4346" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 71.4346 61.9102)" fill="#B480DE"/> +<rect x="71.4346" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 71.4346 61.9102)" fill="#B480DE"/> +<rect x="71.4346" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 71.4346 61.9102)" fill="#B480DE"/> +<rect x="66.7256" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 66.7256 61.9102)" fill="#B480DE"/> +<rect x="66.7256" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 66.7256 61.9102)" fill="#B480DE"/> +<rect x="66.7256" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 66.7256 61.9102)" fill="#B480DE"/> +<rect x="79.4082" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="79.4082" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="79.4082" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="84.1172" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 84.1172 61.9102)" fill="#B480DE"/> +<rect x="84.1172" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 84.1172 61.9102)" fill="#B480DE"/> +<rect x="84.1172" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 84.1172 61.9102)" fill="#B480DE"/> +<rect x="79.4082" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 79.4082 61.9102)" fill="#B480DE"/> +<rect x="79.4082" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 79.4082 61.9102)" fill="#B480DE"/> +<rect x="79.4082" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 79.4082 61.9102)" fill="#B480DE"/> +<rect x="92.0898" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="92.0898" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="92.0898" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="96.7988" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 96.7988 61.9102)" fill="#B480DE"/> +<rect x="96.7988" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 96.7988 61.9102)" fill="#B480DE"/> +<rect x="96.7988" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 96.7988 61.9102)" fill="#B480DE"/> +<rect x="92.0898" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 92.0898 61.9102)" fill="#B480DE"/> +<rect x="92.0898" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 92.0898 61.9102)" fill="#B480DE"/> +<rect x="92.0898" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 92.0898 61.9102)" fill="#B480DE"/> +<rect x="104.772" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="104.772" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="104.772" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="109.481" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 109.481 61.9102)" fill="#B480DE"/> +<rect x="109.481" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 109.481 61.9102)" fill="#B480DE"/> +<rect x="109.481" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 109.481 61.9102)" fill="#B480DE"/> +<rect x="104.772" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 104.772 61.9102)" fill="#B480DE"/> +<rect x="104.772" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 104.772 61.9102)" fill="#B480DE"/> +<rect x="104.772" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 104.772 61.9102)" fill="#B480DE"/> +<rect x="117.455" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="117.455" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="117.455" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="122.164" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 122.164 61.9102)" fill="#B480DE"/> +<rect x="122.164" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 122.164 61.9102)" fill="#B480DE"/> +<rect x="122.164" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 122.164 61.9102)" fill="#B480DE"/> +<rect x="117.455" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 117.455 61.9102)" fill="#B480DE"/> +<rect x="117.455" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 117.455 61.9102)" fill="#B480DE"/> +<rect x="117.455" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 117.455 61.9102)" fill="#B480DE"/> +<rect x="130.137" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="130.137" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="130.137" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="134.846" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 134.846 61.9102)" fill="#B480DE"/> +<rect x="134.846" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 134.846 61.9102)" fill="#B480DE"/> +<rect x="134.846" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 134.846 61.9102)" fill="#B480DE"/> +<rect x="130.137" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 130.137 61.9102)" fill="#B480DE"/> +<rect x="130.137" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 130.137 61.9102)" fill="#B480DE"/> +<rect x="130.137" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 130.137 61.9102)" fill="#B480DE"/> +<rect x="142.819" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="142.819" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="142.819" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="147.528" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 147.528 61.9102)" fill="#B480DE"/> +<rect x="147.528" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 147.528 61.9102)" fill="#B480DE"/> +<rect x="147.528" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 147.528 61.9102)" fill="#B480DE"/> +<rect x="142.819" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 142.819 61.9102)" fill="#B480DE"/> +<rect x="142.819" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 142.819 61.9102)" fill="#B480DE"/> +<rect x="142.819" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 142.819 61.9102)" fill="#B480DE"/> +<rect x="155.502" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="155.502" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="155.502" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="160.211" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 160.211 61.9102)" fill="#B480DE"/> +<rect x="160.211" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 160.211 61.9102)" fill="#B480DE"/> +<rect x="160.211" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 160.211 61.9102)" fill="#B480DE"/> +<rect x="155.502" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 155.502 61.9102)" fill="#B480DE"/> +<rect x="155.502" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 155.502 61.9102)" fill="#B480DE"/> +<rect x="155.502" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 155.502 61.9102)" fill="#B480DE"/> +<rect x="168.184" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="168.184" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="168.184" y="55.8379" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="168.184" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 168.184 61.9102)" fill="#B480DE"/> +<rect x="168.184" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 168.184 61.9102)" fill="#B480DE"/> +<rect x="168.184" y="61.9102" width="1.73475" height="2.97386" transform="rotate(90 168.184 61.9102)" fill="#B480DE"/> +<rect x="1.68262" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 1.68262 71.7168)" fill="#B480DE"/> +<rect x="1.68262" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 1.68262 71.7168)" fill="#B480DE"/> +<rect x="1.68262" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 1.68262 71.7168)" fill="#B480DE"/> +<rect x="9.65625" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="9.65625" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="9.65625" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="14.3652" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 14.3652 71.7168)" fill="#B480DE"/> +<rect x="14.3652" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 14.3652 71.7168)" fill="#B480DE"/> +<rect x="14.3652" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 14.3652 71.7168)" fill="#B480DE"/> +<rect x="9.65625" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 9.65625 71.7168)" fill="#B480DE"/> +<rect x="9.65625" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 9.65625 71.7168)" fill="#B480DE"/> +<rect x="9.65625" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 9.65625 71.7168)" fill="#B480DE"/> +<rect x="22.3379" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="22.3379" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="22.3379" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="27.0469" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 27.0469 71.7168)" fill="#B480DE"/> +<rect x="27.0469" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 27.0469 71.7168)" fill="#B480DE"/> +<rect x="27.0469" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 27.0469 71.7168)" fill="#B480DE"/> +<rect x="22.3379" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 22.3379 71.7168)" fill="#B480DE"/> +<rect x="22.3379" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 22.3379 71.7168)" fill="#B480DE"/> +<rect x="22.3379" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 22.3379 71.7168)" fill="#B480DE"/> +<rect x="35.0205" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="35.0205" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="35.0205" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="39.7295" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 39.7295 71.7168)" fill="#B480DE"/> +<rect x="39.7295" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 39.7295 71.7168)" fill="#B480DE"/> +<rect x="39.7295" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 39.7295 71.7168)" fill="#B480DE"/> +<rect x="35.0205" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 35.0205 71.7168)" fill="#B480DE"/> +<rect x="35.0205" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 35.0205 71.7168)" fill="#B480DE"/> +<rect x="35.0205" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 35.0205 71.7168)" fill="#B480DE"/> +<rect x="47.7031" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="47.7031" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="47.7031" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="52.4121" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 52.4121 71.7168)" fill="#B480DE"/> +<rect x="52.4121" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 52.4121 71.7168)" fill="#B480DE"/> +<rect x="52.4121" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 52.4121 71.7168)" fill="#B480DE"/> +<rect x="47.7031" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 47.7031 71.7168)" fill="#B480DE"/> +<rect x="47.7031" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 47.7031 71.7168)" fill="#B480DE"/> +<rect x="47.7031" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 47.7031 71.7168)" fill="#B480DE"/> +<rect x="60.3848" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="60.3848" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="60.3848" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="65.0938" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 65.0938 71.7168)" fill="#B480DE"/> +<rect x="65.0938" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 65.0938 71.7168)" fill="#B480DE"/> +<rect x="65.0938" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 65.0938 71.7168)" fill="#B480DE"/> +<rect x="60.3848" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 60.3848 71.7168)" fill="#B480DE"/> +<rect x="60.3848" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 60.3848 71.7168)" fill="#B480DE"/> +<rect x="60.3848" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 60.3848 71.7168)" fill="#B480DE"/> +<rect x="73.0674" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="73.0674" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="73.0674" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="77.7764" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 77.7764 71.7168)" fill="#B480DE"/> +<rect x="77.7764" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 77.7764 71.7168)" fill="#B480DE"/> +<rect x="77.7764" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 77.7764 71.7168)" fill="#B480DE"/> +<rect x="73.0674" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 73.0674 71.7168)" fill="#B480DE"/> +<rect x="73.0674" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 73.0674 71.7168)" fill="#B480DE"/> +<rect x="73.0674" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 73.0674 71.7168)" fill="#B480DE"/> +<rect x="85.749" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="85.749" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="85.749" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="90.458" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 90.458 71.7168)" fill="#B480DE"/> +<rect x="90.458" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 90.458 71.7168)" fill="#B480DE"/> +<rect x="90.458" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 90.458 71.7168)" fill="#B480DE"/> +<rect x="85.749" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 85.749 71.7168)" fill="#B480DE"/> +<rect x="85.749" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 85.749 71.7168)" fill="#B480DE"/> +<rect x="85.749" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 85.749 71.7168)" fill="#B480DE"/> +<rect x="98.4316" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="98.4316" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="98.4316" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="103.141" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 103.141 71.7168)" fill="#B480DE"/> +<rect x="103.141" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 103.141 71.7168)" fill="#B480DE"/> +<rect x="103.141" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 103.141 71.7168)" fill="#B480DE"/> +<rect x="98.4316" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 98.4316 71.7168)" fill="#B480DE"/> +<rect x="98.4316" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 98.4316 71.7168)" fill="#B480DE"/> +<rect x="98.4316" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 98.4316 71.7168)" fill="#B480DE"/> +<rect x="111.114" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="111.114" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="111.114" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="115.823" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 115.823 71.7168)" fill="#B480DE"/> +<rect x="115.823" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 115.823 71.7168)" fill="#B480DE"/> +<rect x="115.823" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 115.823 71.7168)" fill="#B480DE"/> +<rect x="111.114" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 111.114 71.7168)" fill="#B480DE"/> +<rect x="111.114" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 111.114 71.7168)" fill="#B480DE"/> +<rect x="111.114" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 111.114 71.7168)" fill="#B480DE"/> +<rect x="123.796" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="123.796" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="123.796" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="128.505" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 128.505 71.7168)" fill="#B480DE"/> +<rect x="128.505" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 128.505 71.7168)" fill="#B480DE"/> +<rect x="128.505" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 128.505 71.7168)" fill="#B480DE"/> +<rect x="123.796" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 123.796 71.7168)" fill="#B480DE"/> +<rect x="123.796" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 123.796 71.7168)" fill="#B480DE"/> +<rect x="123.796" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 123.796 71.7168)" fill="#B480DE"/> +<rect x="136.479" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="136.479" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="136.479" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="141.188" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 141.188 71.7168)" fill="#B480DE"/> +<rect x="141.188" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 141.188 71.7168)" fill="#B480DE"/> +<rect x="141.188" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 141.188 71.7168)" fill="#B480DE"/> +<rect x="136.479" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 136.479 71.7168)" fill="#B480DE"/> +<rect x="136.479" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 136.479 71.7168)" fill="#B480DE"/> +<rect x="136.479" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 136.479 71.7168)" fill="#B480DE"/> +<rect x="149.161" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="149.161" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="149.161" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="153.87" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 153.87 71.7168)" fill="#B480DE"/> +<rect x="153.87" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 153.87 71.7168)" fill="#B480DE"/> +<rect x="153.87" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 153.87 71.7168)" fill="#B480DE"/> +<rect x="149.161" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 149.161 71.7168)" fill="#B480DE"/> +<rect x="149.161" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 149.161 71.7168)" fill="#B480DE"/> +<rect x="149.161" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 149.161 71.7168)" fill="#B480DE"/> +<rect x="161.843" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="161.843" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="161.843" y="65.6445" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="166.552" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 166.552 71.7168)" fill="#B480DE"/> +<rect x="166.552" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 166.552 71.7168)" fill="#B480DE"/> +<rect x="166.552" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 166.552 71.7168)" fill="#B480DE"/> +<rect x="161.843" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 161.843 71.7168)" fill="#B480DE"/> +<rect x="161.843" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 161.843 71.7168)" fill="#B480DE"/> +<rect x="161.843" y="71.7168" width="1.73475" height="2.97386" transform="rotate(90 161.843 71.7168)" fill="#B480DE"/> +<rect x="3.31445" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="3.31445" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="3.31445" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="8.02344" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 8.02344 81.5215)" fill="#B480DE"/> +<rect x="8.02344" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 8.02344 81.5215)" fill="#B480DE"/> +<rect x="8.02344" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 8.02344 81.5215)" fill="#B480DE"/> +<rect x="3.31445" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 3.31445 81.5215)" fill="#B480DE"/> +<rect x="3.31445" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 3.31445 81.5215)" fill="#B480DE"/> +<rect x="3.31445" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 3.31445 81.5215)" fill="#B480DE"/> +<rect x="15.9971" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="15.9971" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="15.9971" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="20.7061" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 20.7061 81.5215)" fill="#B480DE"/> +<rect x="20.7061" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 20.7061 81.5215)" fill="#B480DE"/> +<rect x="20.7061" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 20.7061 81.5215)" fill="#B480DE"/> +<rect x="15.9971" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 15.9971 81.5215)" fill="#B480DE"/> +<rect x="15.9971" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 15.9971 81.5215)" fill="#B480DE"/> +<rect x="15.9971" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 15.9971 81.5215)" fill="#B480DE"/> +<rect x="28.6787" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="28.6787" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="28.6787" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="33.3877" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 33.3877 81.5215)" fill="#B480DE"/> +<rect x="33.3877" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 33.3877 81.5215)" fill="#B480DE"/> +<rect x="33.3877" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 33.3877 81.5215)" fill="#B480DE"/> +<rect x="28.6787" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 28.6787 81.5215)" fill="#B480DE"/> +<rect x="28.6787" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 28.6787 81.5215)" fill="#B480DE"/> +<rect x="28.6787" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 28.6787 81.5215)" fill="#B480DE"/> +<rect x="41.3613" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="41.3613" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="41.3613" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="46.0703" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 46.0703 81.5215)" fill="#B480DE"/> +<rect x="46.0703" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 46.0703 81.5215)" fill="#B480DE"/> +<rect x="46.0703" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 46.0703 81.5215)" fill="#B480DE"/> +<rect x="41.3613" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 41.3613 81.5215)" fill="#B480DE"/> +<rect x="41.3613" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 41.3613 81.5215)" fill="#B480DE"/> +<rect x="41.3613" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 41.3613 81.5215)" fill="#B480DE"/> +<rect x="54.0439" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="54.0439" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="54.0439" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="58.7529" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 58.7529 81.5215)" fill="#B480DE"/> +<rect x="58.7529" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 58.7529 81.5215)" fill="#B480DE"/> +<rect x="58.7529" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 58.7529 81.5215)" fill="#B480DE"/> +<rect x="54.0439" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 54.0439 81.5215)" fill="#B480DE"/> +<rect x="54.0439" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 54.0439 81.5215)" fill="#B480DE"/> +<rect x="54.0439" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 54.0439 81.5215)" fill="#B480DE"/> +<rect x="66.7256" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="66.7256" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="66.7256" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="71.4346" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 71.4346 81.5215)" fill="#B480DE"/> +<rect x="71.4346" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 71.4346 81.5215)" fill="#B480DE"/> +<rect x="71.4346" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 71.4346 81.5215)" fill="#B480DE"/> +<rect x="66.7256" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 66.7256 81.5215)" fill="#B480DE"/> +<rect x="66.7256" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 66.7256 81.5215)" fill="#B480DE"/> +<rect x="66.7256" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 66.7256 81.5215)" fill="#B480DE"/> +<rect x="79.4082" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="79.4082" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="79.4082" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="84.1172" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 84.1172 81.5215)" fill="#B480DE"/> +<rect x="84.1172" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 84.1172 81.5215)" fill="#B480DE"/> +<rect x="84.1172" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 84.1172 81.5215)" fill="#B480DE"/> +<rect x="79.4082" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 79.4082 81.5215)" fill="#B480DE"/> +<rect x="79.4082" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 79.4082 81.5215)" fill="#B480DE"/> +<rect x="79.4082" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 79.4082 81.5215)" fill="#B480DE"/> +<rect x="92.0898" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="92.0898" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="92.0898" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="96.7988" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 96.7988 81.5215)" fill="#B480DE"/> +<rect x="96.7988" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 96.7988 81.5215)" fill="#B480DE"/> +<rect x="96.7988" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 96.7988 81.5215)" fill="#B480DE"/> +<rect x="92.0898" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 92.0898 81.5215)" fill="#B480DE"/> +<rect x="92.0898" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 92.0898 81.5215)" fill="#B480DE"/> +<rect x="92.0898" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 92.0898 81.5215)" fill="#B480DE"/> +<rect x="104.772" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="104.772" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="104.772" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="109.481" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 109.481 81.5215)" fill="#B480DE"/> +<rect x="109.481" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 109.481 81.5215)" fill="#B480DE"/> +<rect x="109.481" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 109.481 81.5215)" fill="#B480DE"/> +<rect x="104.772" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 104.772 81.5215)" fill="#B480DE"/> +<rect x="104.772" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 104.772 81.5215)" fill="#B480DE"/> +<rect x="104.772" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 104.772 81.5215)" fill="#B480DE"/> +<rect x="117.455" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="117.455" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="117.455" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="122.164" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 122.164 81.5215)" fill="#B480DE"/> +<rect x="122.164" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 122.164 81.5215)" fill="#B480DE"/> +<rect x="122.164" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 122.164 81.5215)" fill="#B480DE"/> +<rect x="117.455" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 117.455 81.5215)" fill="#B480DE"/> +<rect x="117.455" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 117.455 81.5215)" fill="#B480DE"/> +<rect x="117.455" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 117.455 81.5215)" fill="#B480DE"/> +<rect x="130.137" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="130.137" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="130.137" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="134.846" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 134.846 81.5215)" fill="#B480DE"/> +<rect x="134.846" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 134.846 81.5215)" fill="#B480DE"/> +<rect x="134.846" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 134.846 81.5215)" fill="#B480DE"/> +<rect x="130.137" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 130.137 81.5215)" fill="#B480DE"/> +<rect x="130.137" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 130.137 81.5215)" fill="#B480DE"/> +<rect x="130.137" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 130.137 81.5215)" fill="#B480DE"/> +<rect x="142.819" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="142.819" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="142.819" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="147.528" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 147.528 81.5215)" fill="#B480DE"/> +<rect x="147.528" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 147.528 81.5215)" fill="#B480DE"/> +<rect x="147.528" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 147.528 81.5215)" fill="#B480DE"/> +<rect x="142.819" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 142.819 81.5215)" fill="#B480DE"/> +<rect x="142.819" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 142.819 81.5215)" fill="#B480DE"/> +<rect x="142.819" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 142.819 81.5215)" fill="#B480DE"/> +<rect x="155.502" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="155.502" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="155.502" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="160.211" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 160.211 81.5215)" fill="#B480DE"/> +<rect x="160.211" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 160.211 81.5215)" fill="#B480DE"/> +<rect x="160.211" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 160.211 81.5215)" fill="#B480DE"/> +<rect x="155.502" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 155.502 81.5215)" fill="#B480DE"/> +<rect x="155.502" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 155.502 81.5215)" fill="#B480DE"/> +<rect x="155.502" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 155.502 81.5215)" fill="#B480DE"/> +<rect x="168.184" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="168.184" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="168.184" y="75.4492" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="168.184" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 168.184 81.5215)" fill="#B480DE"/> +<rect x="168.184" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 168.184 81.5215)" fill="#B480DE"/> +<rect x="168.184" y="81.5215" width="1.73475" height="2.97386" transform="rotate(90 168.184 81.5215)" fill="#B480DE"/> +<rect x="1.68262" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 1.68262 91.3281)" fill="#B480DE"/> +<rect x="1.68262" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 1.68262 91.3281)" fill="#B480DE"/> +<rect x="1.68262" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 1.68262 91.3281)" fill="#B480DE"/> +<rect x="9.65625" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="9.65625" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="9.65625" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="14.3652" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 14.3652 91.3281)" fill="#B480DE"/> +<rect x="14.3652" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 14.3652 91.3281)" fill="#B480DE"/> +<rect x="14.3652" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 14.3652 91.3281)" fill="#B480DE"/> +<rect x="9.65625" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 9.65625 91.3281)" fill="#B480DE"/> +<rect x="9.65625" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 9.65625 91.3281)" fill="#B480DE"/> +<rect x="9.65625" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 9.65625 91.3281)" fill="#B480DE"/> +<rect x="22.3379" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="22.3379" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="22.3379" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="27.0469" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 27.0469 91.3281)" fill="#B480DE"/> +<rect x="27.0469" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 27.0469 91.3281)" fill="#B480DE"/> +<rect x="27.0469" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 27.0469 91.3281)" fill="#B480DE"/> +<rect x="22.3379" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 22.3379 91.3281)" fill="#B480DE"/> +<rect x="22.3379" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 22.3379 91.3281)" fill="#B480DE"/> +<rect x="22.3379" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 22.3379 91.3281)" fill="#B480DE"/> +<rect x="35.0205" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="35.0205" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="35.0205" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="39.7295" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 39.7295 91.3281)" fill="#B480DE"/> +<rect x="39.7295" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 39.7295 91.3281)" fill="#B480DE"/> +<rect x="39.7295" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 39.7295 91.3281)" fill="#B480DE"/> +<rect x="35.0205" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 35.0205 91.3281)" fill="#B480DE"/> +<rect x="35.0205" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 35.0205 91.3281)" fill="#B480DE"/> +<rect x="35.0205" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 35.0205 91.3281)" fill="#B480DE"/> +<rect x="47.7031" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="47.7031" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="47.7031" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="52.4121" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 52.4121 91.3281)" fill="#B480DE"/> +<rect x="52.4121" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 52.4121 91.3281)" fill="#B480DE"/> +<rect x="52.4121" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 52.4121 91.3281)" fill="#B480DE"/> +<rect x="47.7031" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 47.7031 91.3281)" fill="#B480DE"/> +<rect x="47.7031" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 47.7031 91.3281)" fill="#B480DE"/> +<rect x="47.7031" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 47.7031 91.3281)" fill="#B480DE"/> +<rect x="60.3848" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="60.3848" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="60.3848" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="65.0938" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 65.0938 91.3281)" fill="#B480DE"/> +<rect x="65.0938" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 65.0938 91.3281)" fill="#B480DE"/> +<rect x="65.0938" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 65.0938 91.3281)" fill="#B480DE"/> +<rect x="60.3848" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 60.3848 91.3281)" fill="#B480DE"/> +<rect x="60.3848" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 60.3848 91.3281)" fill="#B480DE"/> +<rect x="60.3848" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 60.3848 91.3281)" fill="#B480DE"/> +<rect x="73.0674" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="73.0674" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="73.0674" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="77.7764" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 77.7764 91.3281)" fill="#B480DE"/> +<rect x="77.7764" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 77.7764 91.3281)" fill="#B480DE"/> +<rect x="77.7764" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 77.7764 91.3281)" fill="#B480DE"/> +<rect x="73.0674" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 73.0674 91.3281)" fill="#B480DE"/> +<rect x="73.0674" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 73.0674 91.3281)" fill="#B480DE"/> +<rect x="73.0674" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 73.0674 91.3281)" fill="#B480DE"/> +<rect x="85.749" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="85.749" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="85.749" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="90.458" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 90.458 91.3281)" fill="#B480DE"/> +<rect x="90.458" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 90.458 91.3281)" fill="#B480DE"/> +<rect x="90.458" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 90.458 91.3281)" fill="#B480DE"/> +<rect x="85.749" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 85.749 91.3281)" fill="#B480DE"/> +<rect x="85.749" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 85.749 91.3281)" fill="#B480DE"/> +<rect x="85.749" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 85.749 91.3281)" fill="#B480DE"/> +<rect x="98.4316" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="98.4316" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="98.4316" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="103.141" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 103.141 91.3281)" fill="#B480DE"/> +<rect x="103.141" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 103.141 91.3281)" fill="#B480DE"/> +<rect x="103.141" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 103.141 91.3281)" fill="#B480DE"/> +<rect x="98.4316" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 98.4316 91.3281)" fill="#B480DE"/> +<rect x="98.4316" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 98.4316 91.3281)" fill="#B480DE"/> +<rect x="98.4316" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 98.4316 91.3281)" fill="#B480DE"/> +<rect x="111.114" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="111.114" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="111.114" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="115.823" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 115.823 91.3281)" fill="#B480DE"/> +<rect x="115.823" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 115.823 91.3281)" fill="#B480DE"/> +<rect x="115.823" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 115.823 91.3281)" fill="#B480DE"/> +<rect x="111.114" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 111.114 91.3281)" fill="#B480DE"/> +<rect x="111.114" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 111.114 91.3281)" fill="#B480DE"/> +<rect x="111.114" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 111.114 91.3281)" fill="#B480DE"/> +<rect x="123.796" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="123.796" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="123.796" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="128.505" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 128.505 91.3281)" fill="#B480DE"/> +<rect x="128.505" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 128.505 91.3281)" fill="#B480DE"/> +<rect x="128.505" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 128.505 91.3281)" fill="#B480DE"/> +<rect x="123.796" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 123.796 91.3281)" fill="#B480DE"/> +<rect x="123.796" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 123.796 91.3281)" fill="#B480DE"/> +<rect x="123.796" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 123.796 91.3281)" fill="#B480DE"/> +<rect x="136.479" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="136.479" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="136.479" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="141.188" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 141.188 91.3281)" fill="#B480DE"/> +<rect x="141.188" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 141.188 91.3281)" fill="#B480DE"/> +<rect x="141.188" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 141.188 91.3281)" fill="#B480DE"/> +<rect x="136.479" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 136.479 91.3281)" fill="#B480DE"/> +<rect x="136.479" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 136.479 91.3281)" fill="#B480DE"/> +<rect x="136.479" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 136.479 91.3281)" fill="#B480DE"/> +<rect x="149.161" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="149.161" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="149.161" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="153.87" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 153.87 91.3281)" fill="#B480DE"/> +<rect x="153.87" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 153.87 91.3281)" fill="#B480DE"/> +<rect x="153.87" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 153.87 91.3281)" fill="#B480DE"/> +<rect x="149.161" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 149.161 91.3281)" fill="#B480DE"/> +<rect x="149.161" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 149.161 91.3281)" fill="#B480DE"/> +<rect x="149.161" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 149.161 91.3281)" fill="#B480DE"/> +<rect x="161.843" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="161.843" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="161.843" y="85.2559" width="1.73475" height="4.70861" fill="#B480DE"/> +<rect x="166.552" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 166.552 91.3281)" fill="#B480DE"/> +<rect x="166.552" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 166.552 91.3281)" fill="#B480DE"/> +<rect x="166.552" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 166.552 91.3281)" fill="#B480DE"/> +<rect x="161.843" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 161.843 91.3281)" fill="#B480DE"/> +<rect x="161.843" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 161.843 91.3281)" fill="#B480DE"/> +<rect x="161.843" y="91.3281" width="1.73475" height="2.97386" transform="rotate(90 161.843 91.3281)" fill="#B480DE"/> +</g> +<path d="M62.2098 85.992V87H57.2058V78.684H58.3698V85.992H62.2098ZM64.4725 87H63.3565V80.76H64.4725V87ZM63.9085 79.632C63.7085 79.632 63.5365 79.568 63.3925 79.44C63.2565 79.304 63.1885 79.124 63.1885 78.9C63.1885 78.676 63.2565 78.5 63.3925 78.372C63.5365 78.236 63.7085 78.168 63.9085 78.168C64.1085 78.168 64.2765 78.236 64.4125 78.372C64.5565 78.5 64.6285 78.676 64.6285 78.9C64.6285 79.124 64.5565 79.304 64.4125 79.44C64.2765 79.568 64.1085 79.632 63.9085 79.632ZM66.3916 80.94C66.6476 80.876 66.9876 80.808 67.4116 80.736C67.8356 80.664 68.3236 80.628 68.8756 80.628C69.3716 80.628 69.7836 80.7 70.1116 80.844C70.4396 80.98 70.6996 81.176 70.8916 81.432C71.0916 81.68 71.2316 81.98 71.3116 82.332C71.3916 82.684 71.4316 83.072 71.4316 83.496V87H70.3156V83.736C70.3156 83.352 70.2876 83.024 70.2316 82.752C70.1836 82.48 70.0996 82.26 69.9796 82.092C69.8596 81.924 69.6996 81.804 69.4996 81.732C69.2996 81.652 69.0516 81.612 68.7556 81.612C68.6356 81.612 68.5116 81.616 68.3836 81.624C68.2556 81.632 68.1316 81.644 68.0116 81.66C67.8996 81.668 67.7956 81.68 67.6996 81.696C67.6116 81.712 67.5476 81.724 67.5076 81.732V87H66.3916V80.94ZM72.9343 83.892C72.9343 83.34 73.0143 82.86 73.1743 82.452C73.3343 82.036 73.5463 81.692 73.8103 81.42C74.0743 81.148 74.3783 80.944 74.7223 80.808C75.0663 80.672 75.4183 80.604 75.7783 80.604C76.6183 80.604 77.2623 80.868 77.7103 81.396C78.1583 81.916 78.3823 82.712 78.3823 83.784C78.3823 83.832 78.3823 83.896 78.3823 83.976C78.3823 84.048 78.3783 84.116 78.3703 84.18H74.0983C74.1463 84.828 74.3343 85.32 74.6623 85.656C74.9903 85.992 75.5023 86.16 76.1983 86.16C76.5903 86.16 76.9183 86.128 77.1823 86.064C77.4543 85.992 77.6583 85.924 77.7943 85.86L77.9503 86.796C77.8143 86.868 77.5743 86.944 77.2303 87.024C76.8943 87.104 76.5103 87.144 76.0783 87.144C75.5343 87.144 75.0623 87.064 74.6623 86.904C74.2703 86.736 73.9463 86.508 73.6903 86.22C73.4343 85.932 73.2423 85.592 73.1143 85.2C72.9943 84.8 72.9343 84.364 72.9343 83.892ZM77.2183 83.28C77.2263 82.776 77.0983 82.364 76.8343 82.044C76.5783 81.716 76.2223 81.552 75.7663 81.552C75.5103 81.552 75.2823 81.604 75.0823 81.708C74.8903 81.804 74.7263 81.932 74.5903 82.092C74.4543 82.252 74.3463 82.436 74.2663 82.644C74.1943 82.852 74.1463 83.064 74.1223 83.28H77.2183ZM86.4107 87.18C85.8267 87.18 85.2947 87.084 84.8147 86.892C84.3347 86.7 83.9227 86.42 83.5787 86.052C83.2347 85.684 82.9667 85.232 82.7747 84.696C82.5907 84.152 82.4987 83.532 82.4987 82.836C82.4987 82.14 82.6027 81.524 82.8107 80.988C83.0267 80.444 83.3147 79.988 83.6747 79.62C84.0347 79.252 84.4547 78.972 84.9347 78.78C85.4147 78.588 85.9267 78.492 86.4707 78.492C86.8147 78.492 87.1227 78.516 87.3947 78.564C87.6747 78.612 87.9147 78.668 88.1147 78.732C88.3227 78.796 88.4907 78.86 88.6187 78.924C88.7467 78.988 88.8347 79.036 88.8827 79.068L88.5467 80.028C88.4747 79.98 88.3707 79.928 88.2347 79.872C88.0987 79.816 87.9427 79.76 87.7667 79.704C87.5987 79.648 87.4107 79.604 87.2027 79.572C87.0027 79.532 86.7987 79.512 86.5907 79.512C86.1507 79.512 85.7547 79.588 85.4027 79.74C85.0507 79.892 84.7507 80.112 84.5027 80.4C84.2547 80.688 84.0627 81.04 83.9267 81.456C83.7987 81.864 83.7347 82.324 83.7347 82.836C83.7347 83.332 83.7907 83.784 83.9027 84.192C84.0227 84.6 84.1987 84.952 84.4307 85.248C84.6627 85.536 84.9507 85.76 85.2947 85.92C85.6467 86.08 86.0547 86.16 86.5187 86.16C87.0547 86.16 87.4987 86.104 87.8507 85.992C88.2027 85.88 88.4667 85.78 88.6427 85.692L88.9427 86.652C88.8867 86.692 88.7867 86.744 88.6427 86.808C88.4987 86.864 88.3187 86.92 88.1027 86.976C87.8867 87.032 87.6347 87.08 87.3467 87.12C87.0587 87.16 86.7467 87.18 86.4107 87.18ZM90.2041 87V77.88L91.3201 77.688V80.88C91.5281 80.8 91.7481 80.74 91.9801 80.7C92.2201 80.652 92.4561 80.628 92.6881 80.628C93.1841 80.628 93.5961 80.7 93.9241 80.844C94.2521 80.98 94.5121 81.176 94.7041 81.432C94.9041 81.68 95.0441 81.98 95.1241 82.332C95.2041 82.684 95.2441 83.072 95.2441 83.496V87H94.1281V83.736C94.1281 83.352 94.1001 83.024 94.0441 82.752C93.9961 82.48 93.9121 82.26 93.7921 82.092C93.6721 81.924 93.5121 81.804 93.3121 81.732C93.1121 81.652 92.8641 81.612 92.5681 81.612C92.4481 81.612 92.3241 81.62 92.1961 81.636C92.0681 81.652 91.9441 81.672 91.8241 81.696C91.7121 81.712 91.6081 81.732 91.5121 81.756C91.4241 81.78 91.3601 81.8 91.3201 81.816V87H90.2041ZM99.1716 86.196C99.4356 86.196 99.6676 86.192 99.8676 86.184C100.076 86.168 100.248 86.144 100.384 86.112V84.252C100.304 84.212 100.172 84.18 99.9876 84.156C99.8116 84.124 99.5956 84.108 99.3396 84.108C99.1716 84.108 98.9916 84.12 98.7996 84.144C98.6156 84.168 98.4436 84.22 98.2836 84.3C98.1316 84.372 98.0036 84.476 97.8996 84.612C97.7956 84.74 97.7436 84.912 97.7436 85.128C97.7436 85.528 97.8716 85.808 98.1276 85.968C98.3836 86.12 98.7316 86.196 99.1716 86.196ZM99.0756 80.604C99.5236 80.604 99.8996 80.664 100.204 80.784C100.516 80.896 100.764 81.06 100.948 81.276C101.14 81.484 101.276 81.736 101.356 82.032C101.436 82.32 101.476 82.64 101.476 82.992V86.892C101.38 86.908 101.244 86.932 101.068 86.964C100.9 86.988 100.708 87.012 100.492 87.036C100.276 87.06 100.04 87.08 99.7836 87.096C99.5356 87.12 99.2876 87.132 99.0396 87.132C98.6876 87.132 98.3636 87.096 98.0676 87.024C97.7716 86.952 97.5156 86.84 97.2996 86.688C97.0836 86.528 96.9156 86.32 96.7956 86.064C96.6756 85.808 96.6156 85.5 96.6156 85.14C96.6156 84.796 96.6836 84.5 96.8196 84.252C96.9636 84.004 97.1556 83.804 97.3956 83.652C97.6356 83.5 97.9156 83.388 98.2356 83.316C98.5556 83.244 98.8916 83.208 99.2436 83.208C99.3556 83.208 99.4716 83.216 99.5916 83.232C99.7116 83.24 99.8236 83.256 99.9276 83.28C100.04 83.296 100.136 83.312 100.216 83.328C100.296 83.344 100.352 83.356 100.384 83.364V83.052C100.384 82.868 100.364 82.688 100.324 82.512C100.284 82.328 100.212 82.168 100.108 82.032C100.004 81.888 99.8596 81.776 99.6756 81.696C99.4996 81.608 99.2676 81.564 98.9796 81.564C98.6116 81.564 98.2876 81.592 98.0076 81.648C97.7356 81.696 97.5316 81.748 97.3956 81.804L97.2636 80.88C97.4076 80.816 97.6476 80.756 97.9836 80.7C98.3196 80.636 98.6836 80.604 99.0756 80.604ZM105.633 80.628C105.729 80.628 105.837 80.636 105.957 80.652C106.085 80.66 106.209 80.676 106.329 80.7C106.449 80.716 106.557 80.736 106.653 80.76C106.757 80.776 106.833 80.792 106.881 80.808L106.689 81.78C106.601 81.748 106.453 81.712 106.245 81.672C106.045 81.624 105.785 81.6 105.465 81.6C105.257 81.6 105.049 81.624 104.841 81.672C104.641 81.712 104.509 81.74 104.445 81.756V87H103.329V81.024C103.593 80.928 103.921 80.84 104.313 80.76C104.705 80.672 105.145 80.628 105.633 80.628ZM109.002 80.76H111.366V81.696H109.002V84.576C109.002 84.888 109.026 85.148 109.074 85.356C109.122 85.556 109.194 85.716 109.29 85.836C109.386 85.948 109.506 86.028 109.65 86.076C109.794 86.124 109.962 86.148 110.154 86.148C110.49 86.148 110.758 86.112 110.958 86.04C111.166 85.96 111.31 85.904 111.39 85.872L111.606 86.796C111.494 86.852 111.298 86.92 111.018 87C110.738 87.088 110.418 87.132 110.058 87.132C109.634 87.132 109.282 87.08 109.002 86.976C108.73 86.864 108.51 86.7 108.342 86.484C108.174 86.268 108.054 86.004 107.982 85.692C107.918 85.372 107.886 85.004 107.886 84.588V79.02L109.002 78.828V80.76Z" fill="black"/> +<g filter="url(#filter0_dddd_408_2441)"> +<rect x="52" y="8" width="64" height="64" rx="6" fill="white"/> +<path fill-rule="evenodd" clip-rule="evenodd" d="M58.667 23.9993C58.667 23.263 59.2639 22.666 60.0003 22.666H108C108.737 22.666 109.334 23.263 109.334 23.9993C109.334 24.7357 108.737 25.3327 108 25.3327H60.0003C59.2639 25.3327 58.667 24.7357 58.667 23.9993Z" fill="#DEDEDE"/> +<path fill-rule="evenodd" clip-rule="evenodd" d="M58.667 37.3333C58.667 36.597 59.2639 36 60.0003 36H108C108.737 36 109.334 36.597 109.334 37.3333C109.334 38.0697 108.737 38.6667 108 38.6667H60.0003C59.2639 38.6667 58.667 38.0697 58.667 37.3333Z" fill="#DEDEDE"/> +<path fill-rule="evenodd" clip-rule="evenodd" d="M58.667 50.6654C58.667 49.929 59.2639 49.332 60.0003 49.332H108C108.737 49.332 109.334 49.929 109.334 50.6654C109.334 51.4017 108.737 51.9987 108 51.9987H60.0003C59.2639 51.9987 58.667 51.4017 58.667 50.6654Z" fill="#DEDEDE"/> +<path fill-rule="evenodd" clip-rule="evenodd" d="M58 64C58 62.8954 58.8954 62 60 62H108C109.105 62 110 62.8954 110 64C110 65.1046 109.105 66 108 66H60C58.8954 66 58 65.1046 58 64Z" fill="#DEDEDE"/> +<path d="M90.9258 51.3373C90.9258 53.8611 88.7673 55.9072 86.1048 55.9072C83.4424 55.9072 81.2838 53.8611 81.2838 51.3373C81.2838 48.8135 83.4424 46.7675 86.1048 46.7675C88.7673 46.7675 90.9258 48.8135 90.9258 51.3373Z" fill="#B480DE"/> +<path d="M102.175 34.5811C104.837 34.5811 106.996 32.5352 106.996 30.0113C106.996 27.4874 104.837 25.4414 102.175 25.4414C99.5122 25.4414 97.3537 27.4874 97.3537 30.0113C97.3537 32.5352 99.5122 34.5811 102.175 34.5811Z" fill="#B480DE"/> +<path d="M90.9258 39.151C90.9258 41.6749 88.7673 43.7209 86.1048 43.7209C83.4424 43.7209 81.2838 41.6749 81.2838 39.151C81.2838 36.6271 83.4424 34.5811 86.1048 34.5811C88.7673 34.5811 90.9258 36.6271 90.9258 39.151Z" fill="#B480DE"/> +<path d="M71.6419 57.4305C71.6419 59.9543 69.4835 62.0004 66.821 62.0004C64.1584 62.0004 62 59.9543 62 57.4305C62 54.9067 64.1584 52.8606 66.821 52.8606C69.4835 52.8606 71.6419 54.9067 71.6419 57.4305Z" fill="#B480DE"/> +<path d="M71.8423 49.4829C76.0024 49.4829 79.3751 46.0204 79.3751 41.7492C79.3751 37.4781 76.0024 34.0156 71.8423 34.0156C67.6822 34.0156 64.3096 37.4781 64.3096 41.7492C64.3096 46.0204 67.6822 49.4829 71.8423 49.4829Z" fill="#B480DE"/> +<path d="M100.467 57.2165C104.627 57.2165 108 53.7541 108 49.4829C108 45.2117 104.627 41.7492 100.467 41.7492C96.3071 41.7492 92.9344 45.2117 92.9344 49.4829C92.9344 53.7541 96.3071 57.2165 100.467 57.2165Z" fill="#B480DE"/> +</g> +</g> +<defs> +<filter id="filter0_dddd_408_2441" x="16" y="5" width="104" height="107" filterUnits="userSpaceOnUse" color-interpolation-filters="sRGB"> +<feFlood flood-opacity="0" result="BackgroundImageFix"/> +<feColorMatrix in="SourceAlpha" type="matrix" values="0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 127 0" result="hardAlpha"/> +<feOffset dx="-1" dy="2"/> +<feGaussianBlur stdDeviation="2.5"/> +<feColorMatrix type="matrix" values="0 0 0 0 0.388235 0 0 0 0 0.388235 0 0 0 0 0.388235 0 0 0 0.1 0"/> +<feBlend mode="normal" in2="BackgroundImageFix" result="effect1_dropShadow_408_2441"/> +<feColorMatrix in="SourceAlpha" type="matrix" values="0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 127 0" result="hardAlpha"/> +<feOffset dx="-6" dy="7"/> +<feGaussianBlur stdDeviation="4.5"/> +<feColorMatrix type="matrix" values="0 0 0 0 0.388235 0 0 0 0 0.388235 0 0 0 0 0.388235 0 0 0 0.09 0"/> +<feBlend mode="normal" in2="effect1_dropShadow_408_2441" result="effect2_dropShadow_408_2441"/> +<feColorMatrix in="SourceAlpha" type="matrix" values="0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 127 0" result="hardAlpha"/> +<feOffset dx="-12" dy="15"/> +<feGaussianBlur stdDeviation="6"/> +<feColorMatrix type="matrix" values="0 0 0 0 0.388235 0 0 0 0 0.388235 0 0 0 0 0.388235 0 0 0 0.05 0"/> +<feBlend mode="normal" in2="effect2_dropShadow_408_2441" result="effect3_dropShadow_408_2441"/> +<feColorMatrix in="SourceAlpha" type="matrix" values="0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 127 0" result="hardAlpha"/> +<feOffset dx="-22" dy="26"/> +<feGaussianBlur stdDeviation="7"/> +<feColorMatrix type="matrix" values="0 0 0 0 0.388235 0 0 0 0 0.388235 0 0 0 0 0.388235 0 0 0 0.01 0"/> +<feBlend mode="normal" in2="effect3_dropShadow_408_2441" result="effect4_dropShadow_408_2441"/> +<feBlend mode="normal" in="SourceGraphic" in2="effect4_dropShadow_408_2441" result="shape"/> +</filter> +<radialGradient id="paint0_radial_408_2441" cx="0" cy="0" r="1" gradientUnits="userSpaceOnUse" gradientTransform="translate(35 32.5) rotate(28.1162) scale(115.647 113.674)"> +<stop stop-color="white"/> +<stop offset="1" stop-color="#F7ECFF"/> +</radialGradient> +<clipPath id="clip0_408_2441"> +<rect width="169" height="96" fill="white"/> +</clipPath> +</defs> +</svg> diff --git a/client/packages/lowcoder-design/src/icons/v2/scatter-chart-m.svg b/client/packages/lowcoder-design/src/icons/v2/scatter-chart-m.svg new file mode 100644 index 000000000..7c063a0cd --- /dev/null +++ b/client/packages/lowcoder-design/src/icons/v2/scatter-chart-m.svg @@ -0,0 +1,12 @@ +<svg width="48" height="48" viewBox="0 0 48 48" fill="none" xmlns="http://www.w3.org/2000/svg"> +<path fill-rule="evenodd" clip-rule="evenodd" d="M5 12C5 11.4477 5.44772 11 6 11H42C42.5523 11 43 11.4477 43 12C43 12.5523 42.5523 13 42 13H6C5.44772 13 5 12.5523 5 12Z" fill="#DEDEDE"/> +<path fill-rule="evenodd" clip-rule="evenodd" d="M5 22C5 21.4477 5.44772 21 6 21H42C42.5523 21 43 21.4477 43 22C43 22.5523 42.5523 23 42 23H6C5.44772 23 5 22.5523 5 22Z" fill="#DEDEDE"/> +<path fill-rule="evenodd" clip-rule="evenodd" d="M5 32C5 31.4477 5.44772 31 6 31H42C42.5523 31 43 31.4477 43 32C43 32.5523 42.5523 33 42 33H6C5.44772 33 5 32.5523 5 32Z" fill="#DEDEDE"/> +<path fill-rule="evenodd" clip-rule="evenodd" d="M5 42.5C5 41.6716 5.67157 41 6.5 41H42.5C43.3284 41 44 41.6716 44 42.5C44 43.3284 43.3284 44 42.5 44H6.5C5.67157 44 5 43.3284 5 42.5Z" fill="#DEDEDE"/> +<path d="M28.2798 32.8333C28.2798 34.7663 26.6267 36.3333 24.5875 36.3333C22.5484 36.3333 20.8952 34.7663 20.8952 32.8333C20.8952 30.9004 22.5484 29.3333 24.5875 29.3333C26.6267 29.3333 28.2798 30.9004 28.2798 32.8333Z" fill="#B480DE"/> +<path d="M36.8952 20C38.9343 20 40.5875 18.433 40.5875 16.5C40.5875 14.567 38.9343 13 36.8952 13C34.8561 13 33.2029 14.567 33.2029 16.5C33.2029 18.433 34.8561 20 36.8952 20Z" fill="#B480DE"/> +<path d="M28.2798 23.5C28.2798 25.433 26.6267 27 24.5875 27C22.5484 27 20.8952 25.433 20.8952 23.5C20.8952 21.567 22.5484 20 24.5875 20C26.6267 20 28.2798 21.567 28.2798 23.5Z" fill="#B480DE"/> +<path d="M13.5106 37.5C13.5106 39.4329 11.8575 41 9.81828 41C7.77907 41 6.12598 39.4329 6.12598 37.5C6.12598 35.5671 7.77907 34 9.81828 34C11.8575 34 13.5106 35.5671 13.5106 37.5Z" fill="#B480DE"/> +<path d="M13.6638 31.4126C16.8499 31.4126 19.433 28.7607 19.433 25.4895C19.433 22.2182 16.8499 19.5664 13.6638 19.5664C10.4776 19.5664 7.89453 22.2182 7.89453 25.4895C7.89453 28.7607 10.4776 31.4126 13.6638 31.4126Z" fill="#B480DE"/> +<path d="M35.5871 37.3356C38.7733 37.3356 41.3564 34.6838 41.3564 31.4126C41.3564 28.1413 38.7733 25.4895 35.5871 25.4895C32.401 25.4895 29.8179 28.1413 29.8179 31.4126C29.8179 34.6838 32.401 37.3356 35.5871 37.3356Z" fill="#B480DE"/> +</svg> diff --git a/client/packages/lowcoder-design/src/icons/v2/scatter-chart-s.svg b/client/packages/lowcoder-design/src/icons/v2/scatter-chart-s.svg new file mode 100644 index 000000000..42491c32c --- /dev/null +++ b/client/packages/lowcoder-design/src/icons/v2/scatter-chart-s.svg @@ -0,0 +1,12 @@ +<svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg"> +<path d="M3 6H21" stroke="black" stroke-linecap="round"/> +<path d="M3 11H21" stroke="black" stroke-linecap="round"/> +<path d="M3 16H21" stroke="black" stroke-linecap="round"/> +<path d="M3 20H21" stroke="black" stroke-width="1.5" stroke-linecap="round"/> +<path d="M14.2857 15.2083C14.2857 16.1058 13.5182 16.8333 12.5714 16.8333C11.6247 16.8333 10.8571 16.1058 10.8571 15.2083C10.8571 14.3109 11.6247 13.5833 12.5714 13.5833C13.5182 13.5833 14.2857 14.3109 14.2857 15.2083Z" fill="black"/> +<path d="M18.2857 9.25C19.2325 9.25 20 8.52247 20 7.625C20 6.72753 19.2325 6 18.2857 6C17.339 6 16.5714 6.72753 16.5714 7.625C16.5714 8.52247 17.339 9.25 18.2857 9.25Z" fill="black"/> +<path d="M14.2857 10.875C14.2857 11.7725 13.5182 12.5 12.5714 12.5C11.6247 12.5 10.8571 11.7725 10.8571 10.875C10.8571 9.97753 11.6247 9.25 12.5714 9.25C13.5182 9.25 14.2857 9.97753 14.2857 10.875Z" fill="black"/> +<path d="M7.42857 17.375C7.42857 18.2724 6.66106 19 5.71429 19C4.76751 19 4 18.2724 4 17.375C4 16.4776 4.76751 15.75 5.71429 15.75C6.66106 15.75 7.42857 16.4776 7.42857 17.375Z" fill="black"/> +<path d="M7.49986 14.5488C8.97915 14.5488 10.1784 13.3176 10.1784 11.7988C10.1784 10.28 8.97915 9.04883 7.49986 9.04883C6.02057 9.04883 4.82129 10.28 4.82129 11.7988C4.82129 13.3176 6.02057 14.5488 7.49986 14.5488Z" fill="black"/> +<path d="M17.6786 17.2988C19.1579 17.2988 20.3571 16.0676 20.3571 14.5488C20.3571 13.03 19.1579 11.7988 17.6786 11.7988C16.1993 11.7988 15 13.03 15 14.5488C15 16.0676 16.1993 17.2988 17.6786 17.2988Z" fill="black"/> +</svg> diff --git a/client/packages/lowcoder-sdk/package.json b/client/packages/lowcoder-sdk/package.json index f5df08715..4c57864a4 100644 --- a/client/packages/lowcoder-sdk/package.json +++ b/client/packages/lowcoder-sdk/package.json @@ -1,6 +1,6 @@ { "name": "lowcoder-sdk", - "version": "2.6.3", + "version": "2.6.6", "type": "module", "files": [ "src", @@ -25,6 +25,9 @@ }, "./dist/style.css": { "import": "./dist/style.css" + }, + "./dist/chunks/": { + "import": "./dist/chunks/" } }, "scripts": { diff --git a/client/packages/lowcoder-sdk/vite.config.mts b/client/packages/lowcoder-sdk/vite.config.mts index 903b336f6..3cd7b5c45 100644 --- a/client/packages/lowcoder-sdk/vite.config.mts +++ b/client/packages/lowcoder-sdk/vite.config.mts @@ -36,17 +36,7 @@ export const viteConfig: UserConfig = { }, base: ensureLastSlash(process.env.PUBLIC_URL), build: { - minify: "terser", - terserOptions: { - compress: { - drop_console: true, - drop_debugger: true, - pure_funcs: ["console.info", "console.debug", "console.log"], - }, - format: { - comments: false, - }, - }, + minify: "terser", chunkSizeWarningLimit: 500, lib: { formats: ["es"], @@ -56,7 +46,7 @@ export const viteConfig: UserConfig = { }, rollupOptions: { treeshake: { - moduleSideEffects: false, + moduleSideEffects: true, propertyReadSideEffects: false, tryCatchDeoptimization: false, unknownGlobalSideEffects: false, @@ -64,38 +54,23 @@ export const viteConfig: UserConfig = { external: ["react", "react-dom"], output: { chunkFileNames: "chunks/[name]-[hash].js", - entryFileNames: "entry/[name]-[hash].js", - assetFileNames: "assets/[name]-[hash].[ext]", + entryFileNames: "lowcoder-sdk.js", + assetFileNames: "style.css", manualChunks: (id) => { if (id.includes("node_modules")) { - // CORE FRAMEWORK CHUNKS - if (id.includes("react")) return "react"; - if (id.includes("react-dom")) return "react-dom"; - if (id.includes("react-router")) return "react-router"; - if (id.includes("react-redux")) return "react-redux"; - if (id.includes("redux")) return "redux"; - if (id.includes("redux-saga")) return "redux-saga"; - // UI LIBRARIES if (id.includes("@ant-design/icons")) return "ant-design-icons"; - if (id.includes("antd")) return "antd"; + if (id.includes("node_modules/antd")) return "antd"; if (id.includes("styled-components")) return "styled-components"; // 🔹 BARCODE & QR CODE PROCESSING - if (id.includes("zxing") || id.includes("Barcode") || id.includes("QRCode") || id.includes("PDF417")) return "barcode"; - - // CHARTING & DATA VISUALIZATION - if (id.includes("echarts")) return "echarts"; - if (id.includes("echarts-wordcloud")) return "echarts-wordcloud"; - if (id.includes("d3")) return "d3"; + if (id.includes("react-qr-barcode-scanner")) return "barcode"; // TEXT EDITORS & PARSERS if (id.includes("codemirror")) return "codemirror"; if (id.includes("quill")) return "quill"; if (id.includes("react-json-view")) return "react-json-view"; - if (id.includes("react-markdown")) return "react-markdown"; if (id.includes("react-quill")) return "react-quill"; - if (id.includes("remark") || id.includes("rehype") || id.includes("markdown")) return "markdown-parsers"; if (id.includes("remark-gfm")) return "remark-gfm"; if (id.includes("rehype-raw")) return "rehype-raw"; if (id.includes("rehype-sanitize")) return "rehype-sanitize"; @@ -133,7 +108,6 @@ export const viteConfig: UserConfig = { if (id.includes("xlsx")) return "xlsx"; if (id.includes("alasql")) return "alasql"; if (id.includes("sql-formatter")) return "sql-formatter"; - if (id.includes("tern")) return "tern"; // NETWORK & HTTP if (id.includes("axios")) return "axios"; @@ -158,41 +132,38 @@ export const viteConfig: UserConfig = { if (id.includes("cnchar")) return "cnchar"; if (id.includes("hotkeys-js")) return "hotkeys-js"; if (id.includes("loglevel")) return "loglevel"; - if (id.includes("qrcode-react")) return "qrcode-react"; + if (id.includes("qrcode.react")) return "qrcode-react"; if (id.includes("react-joyride")) return "react-joyride"; if (id.includes("rc-trigger")) return "rc-trigger"; if (id.includes("really-relaxed-json")) return "really-relaxed-json"; if (id.includes("simplebar-react")) return "simplebar-react"; - return "vendor"; + if (id.includes("react-documents")) return "react-documents"; + if (id.includes("react-colorful")) return "react-colorful"; + if (id.includes("react-best-gradient-color-picker")) return "react-best-gradient-color-picker"; + if (id.includes("@supabase/supabase-js")) return "supabase"; + return null; } - if (id.includes("src/api")) return "api"; - if (id.includes("src/appView")) return "appView"; - if (id.includes("src/base")) return "base"; - if (id.includes("src/constants")) return "constants"; - if (id.includes("src/i18n")) return "i18n"; - if (id.includes("src/ide")) return "ide"; - if (id.includes("src/layout")) return "layout"; - if (id.includes("src/pages")) return "pages"; - if (id.includes("src/redux")) return "app_redux"; - if (id.includes("src/comps")) return "comps"; - if (id.includes("comps/comps")) return "comps2"; - if (id.includes("comps/controls")) return "controls"; - if (id.includes("comps/queries")) return "queries"; - if (id.includes("comps/utils")) return "utils"; - if (id.includes("src/hooks")) return "hooks"; - if (id.includes("src/util")) return "util"; - return "common"; // 📦 Internal app shared code - }, + return null; + } }, experimental: { minChunkSize: 300000, // 📏 Force smaller chunks (~300KB) }, plugins: [ - terser(), + terser({ + compress: { + drop_console: true, + drop_debugger: true, + pure_funcs: ["console.info", "console.debug", "console.log"], + }, + format: { + comments: /(@vite-ignore|webpackIgnore)/ + }, + }) as PluginOption, strip({ functions: ["console.log", "debugger"], // ✅ Remove logs sourceMap: true, - }), + }) as PluginOption, ], onwarn: (warning, warn) => { if (warning.code === 'MODULE_LEVEL_DIRECTIVE') { diff --git a/client/packages/lowcoder/index.html b/client/packages/lowcoder/index.html index 0f69f0293..8bd8757bc 100644 --- a/client/packages/lowcoder/index.html +++ b/client/packages/lowcoder/index.html @@ -30,6 +30,7 @@ flex-direction: column; top: 0; z-index: 10000; + transition: opacity 0.25s linear; } #loading svg { animation: breath 1s linear infinite; diff --git a/client/packages/lowcoder/package.json b/client/packages/lowcoder/package.json index 65146553a..f3f02092e 100644 --- a/client/packages/lowcoder/package.json +++ b/client/packages/lowcoder/package.json @@ -1,6 +1,6 @@ { "name": "lowcoder", - "version": "2.6.3", + "version": "2.6.4", "private": true, "type": "module", "main": "src/index.sdk.ts", @@ -127,6 +127,7 @@ "eslint-config-react-app": "^7.0.1", "eslint-plugin-only-ascii": "^0.0.0", "http-proxy-middleware": "^2.0.6", + "rollup-plugin-terser": "^7.0.2", "rollup-plugin-visualizer": "^5.9.2", "typescript": "^4.8.4", "vite": "^4.5.5", diff --git a/client/packages/lowcoder/src/api/subscriptionApi.ts b/client/packages/lowcoder/src/api/subscriptionApi.ts index 02a3ff5f6..6bfcdb259 100644 --- a/client/packages/lowcoder/src/api/subscriptionApi.ts +++ b/client/packages/lowcoder/src/api/subscriptionApi.ts @@ -182,6 +182,22 @@ export const createCustomer = async (subscriptionCustomer: LowcoderNewCustomer) } }; +export const cleanupCustomer = async (subscriptionCustomer: LowcoderSearchCustomer) => { + const apiBody = { + path: "webhook/secure/cleanup-customer", + data: subscriptionCustomer, + method: "post", + headers: lcHeaders + }; + try { + const result = await SubscriptionApi.secureRequest(apiBody, 15000); + return result?.data as any; + } catch (error) { + console.error("Error creating customer:", error); + throw error; + } +}; + export const getProduct = async (productId : string) => { const apiBody = { path: "webhook/secure/get-product", diff --git a/client/packages/lowcoder/src/base/codeEditor/autoFormat.tsx b/client/packages/lowcoder/src/base/codeEditor/autoFormat.tsx index 17b5820a3..8a1c63caa 100644 --- a/client/packages/lowcoder/src/base/codeEditor/autoFormat.tsx +++ b/client/packages/lowcoder/src/base/codeEditor/autoFormat.tsx @@ -2,30 +2,31 @@ import type { CodeType } from "lowcoder-core"; import { relaxedJSONToJSON } from "lowcoder-core"; import { getDynamicStringSegments, isDynamicSegment } from "lowcoder-core"; import { format as formatSQL } from "sql-formatter"; +import estree from "prettier/plugins/estree"; import type { Language } from "./codeEditorTypes"; export async function cssFormatter(text: string) { - const prettier = await require("prettier/standalone"); - const parserPlugin = await require("prettier/parser-postcss"); + const prettier = await import("prettier/standalone"); + const parserPlugin = await import("prettier/plugins/postcss"); return (await prettier.format(text, { parser: "css", plugins: [parserPlugin], semi: false })).trim(); } export async function htmlFormatter(text: string) { - const prettier = await require("prettier/standalone"); - const parserPlugin = await require("prettier/parser-html"); + const prettier = await import("prettier/standalone"); + const parserPlugin = await import("prettier/plugins/html"); return (await prettier.format(text, { parser: "html", plugins: [parserPlugin], semi: false })).trim(); } async function getJavascriptFormatter() { - const prettier = await require("prettier/standalone"); - const parserBabel = await require("prettier/parser-babel"); + const prettier = await import("prettier/standalone"); + const parserBabel = await import("prettier/plugins/babel"); return async (text: string) => - (await prettier.format(text, { parser: "babel", plugins: [parserBabel], semi: false })).trim(); + (await prettier.format(text, { parser: "babel", plugins: [parserBabel, estree], semi: false })).trim(); } export async function getJsonFormatter() { - const prettier = await require("prettier/standalone"); - const parserBabel = await require("prettier/parser-babel"); + const prettier = await import("prettier/standalone"); + const parserBabel = await import("prettier/plugins/babel"); return async (text: string) => (await prettier.format(text, { parser: "json", plugins: [parserBabel] })).trim(); } @@ -46,15 +47,16 @@ async function formatJsSegment(formatter: (text: string) => Promise<string>, scr async function getJsSegmentFormatter() { const formatter = await getJavascriptFormatter(); return async (segment: string) => { - return "{{" + formatJsSegment(formatter, segment.slice(2, -2)) + "}}"; + return "{{" + await formatJsSegment(formatter, segment.slice(2, -2)) + "}}"; }; } export async function formatStringWithJsSnippets(text: string): Promise<string> { const jsSegmentFormatter = await getJsSegmentFormatter(); - return getDynamicStringSegments(text) - .map((s) => (isDynamicSegment(s) ? jsSegmentFormatter(s) : s)) - .join(""); + const formatedSegments = await Promise.all( + getDynamicStringSegments(text).map((s) => (isDynamicSegment(s) ? jsSegmentFormatter(s) : s)) + ); + return formatedSegments.join(""); } export async function formatSqlWithJsSnippets(text: string) { diff --git a/client/packages/lowcoder/src/comps/comps/avatar.tsx b/client/packages/lowcoder/src/comps/comps/avatar.tsx index fc7f6f433..a1da4984a 100644 --- a/client/packages/lowcoder/src/comps/comps/avatar.tsx +++ b/client/packages/lowcoder/src/comps/comps/avatar.tsx @@ -41,12 +41,12 @@ const AvatarWrapper = styled(Avatar) <AvatarProps & { $cursorPointer?: boolean, cursor: ${(props) => props.$cursorPointer ? 'pointer' : ''}; `; -const Wrapper = styled.div <{ iconSize: number, labelPosition: string,$style: AvatarContainerStyleType}>` +const Wrapper = styled.div <{ $iconSize: number, $labelPosition: string,$style: AvatarContainerStyleType}>` display: flex; width: 100%; height: 100%; align-items: center; -flex-direction: ${(props) => props.labelPosition === 'left' ? 'row' : 'row-reverse'}; +flex-direction: ${(props) => props.$labelPosition === 'left' ? 'row' : 'row-reverse'}; ${(props) => { return ( props.$style && { @@ -57,14 +57,14 @@ ${(props) => { }} ` -const LabelWrapper = styled.div<{ iconSize: number, alignmentPosition: string }>` -width: calc(100% - ${(props) => props.iconSize}px); +const LabelWrapper = styled.div<{ $iconSize: number, $alignmentPosition: string }>` +width: calc(100% - ${(props) => props.$iconSize}px); display: flex; padding-left: 5px; padding-right: 5px; flex-direction: column; justify-content: flex-end; -align-items: ${(props) => props.alignmentPosition === 'left' ? 'flex-start' : 'flex-end'}; +align-items: ${(props) => props.$alignmentPosition === 'left' ? 'flex-start' : 'flex-end'}; ` const LabelSpan = styled.span<{ $style:AvatarLabelStyleType }>` max-width: 100%; @@ -166,7 +166,7 @@ const AvatarView = (props: RecordConstructorToView<typeof childrenMap>) => { disabled={!props.enableDropdownMenu} dropdownRender={() => menu} > - <Wrapper iconSize={props.iconSize} labelPosition={props.labelPosition} $style={props.style}> + <Wrapper $iconSize={props.iconSize} $labelPosition={props.labelPosition} $style={props.style}> <Badge count={props.badgeCount.value} dot={props.badgeType === 'dot'} @@ -187,7 +187,7 @@ const AvatarView = (props: RecordConstructorToView<typeof childrenMap>) => { {title.value} </AvatarWrapper> </Badge> - <LabelWrapper iconSize={props.iconSize} alignmentPosition={props.alignmentPosition}> + <LabelWrapper $iconSize={props.iconSize} $alignmentPosition={props.alignmentPosition}> <LabelSpan $style={props.labelStyle}>{props.avatarLabel.value}</LabelSpan> <CaptionSpan $style={props.captionStyle}>{props.avatarCatption.value}</CaptionSpan> </LabelWrapper> diff --git a/client/packages/lowcoder/src/comps/comps/avatarGroup.tsx b/client/packages/lowcoder/src/comps/comps/avatarGroup.tsx index cba007ee1..4cc2567c6 100644 --- a/client/packages/lowcoder/src/comps/comps/avatarGroup.tsx +++ b/client/packages/lowcoder/src/comps/comps/avatarGroup.tsx @@ -111,11 +111,11 @@ const AvatarGroupView = (props: RecordConstructorToView<typeof childrenMap> & { alignment={props.alignment} > { - <Avatar.Group maxCount={props.maxCount} size={props.avatarSize}> + <Avatar.Group max={{ count: props.maxCount }} size={props.avatarSize}> { props.avatars.map((item, index) => { return ( - <Tooltip title={item.Tooltip}> + <Tooltip title={item.Tooltip} key={index}> <Avatar src={item.src ?? undefined} icon={(item.AvatarIcon as ReactElement)?.props.value === '' || item.label.trim() !== '' ? undefined : item.AvatarIcon} diff --git a/client/packages/lowcoder/src/comps/comps/columnLayout/columnLayout.tsx b/client/packages/lowcoder/src/comps/comps/columnLayout/columnLayout.tsx index fa602fa6b..7b9c80a24 100644 --- a/client/packages/lowcoder/src/comps/comps/columnLayout/columnLayout.tsx +++ b/client/packages/lowcoder/src/comps/comps/columnLayout/columnLayout.tsx @@ -40,7 +40,7 @@ import { EditorContext } from "comps/editorState"; import { disabledPropertyView, hiddenPropertyView } from "comps/utils/propertyUtils"; import { DisabledContext } from "comps/generators/uiCompBuilder"; -import SliderControl from "@lowcoder-ee/comps/controls/sliderControl"; +import { SliderControl } from "@lowcoder-ee/comps/controls/sliderControl"; import { getBackgroundStyle } from "@lowcoder-ee/util/styleUtils"; const ContainWrapper = styled.div<{ diff --git a/client/packages/lowcoder/src/comps/comps/containerComp/containerView.tsx b/client/packages/lowcoder/src/comps/comps/containerComp/containerView.tsx index ff00f7fc7..55e287a6f 100644 --- a/client/packages/lowcoder/src/comps/comps/containerComp/containerView.tsx +++ b/client/packages/lowcoder/src/comps/comps/containerComp/containerView.tsx @@ -326,7 +326,7 @@ const GridItemWrapper = React.memo(React.forwardRef( const editorState = useContext(EditorContext); const { children, ...divProps } = props; return ( - <ItemWrapper ref={ref} $disableInteract={editorState.disableInteract} {...divProps}> + <ItemWrapper ref={ref} $disableInteract={editorState?.disableInteract} {...divProps}> {props.children} </ItemWrapper> ); @@ -350,9 +350,9 @@ export const InnerGrid = React.memo((props: ViewPropsWithSelect) => { const [currentRowHeight, setRowHeight] = useState(positionParams.rowHeight || DEFAULT_ROW_HEIGHT); const editorState = useContext(EditorContext); const { readOnly } = useContext(ExternalEditorContext); - const appSettingsComp = editorState.getAppSettingsComp().getView(); + const appSettingsComp = editorState?.getAppSettingsComp().getView(); - const maxWidth = useMemo(() => appSettingsComp.maxWidth, [appSettingsComp.maxWidth]); + const maxWidth = useMemo(() => appSettingsComp?.maxWidth, [appSettingsComp?.maxWidth]); // Falk: TODO: Here we can define the inner grid columns dynamically const defaultGrid = useMemo(() => { @@ -372,10 +372,10 @@ export const InnerGrid = React.memo((props: ViewPropsWithSelect) => { getExtraLayout( props.items, props.layout, - editorState.selectedCompNames, + editorState?.selectedCompNames, props.dragSelectedComps ), - [props.items, props.layout, editorState.selectedCompNames, props.dragSelectedComps] + [props.items, props.layout, editorState?.selectedCompNames, props.dragSelectedComps] ); const [containerSelectNames, setContainerSelectNames] = useState<Set<string>>(new Set([])); @@ -392,8 +392,8 @@ export const InnerGrid = React.memo((props: ViewPropsWithSelect) => { }, [extraLayout, containerSelectNames]); const canAddSelect = useMemo( - () => _.size(containerSelectNames) === _.size(editorState.selectedCompNames), - [containerSelectNames, editorState.selectedCompNames] + () => _.size(containerSelectNames) === _.size(editorState?.selectedCompNames), + [containerSelectNames, editorState?.selectedCompNames] ); const dispatchPositionParamsTimerRef = useRef(0); @@ -439,21 +439,23 @@ export const InnerGrid = React.memo((props: ViewPropsWithSelect) => { isRowCountLocked, onPositionParamsChange, onRowCountChange, - positionParams, + JSON.stringify(positionParams), + JSON.stringify(props.containerPadding), props.dispatch, - props.containerPadding, ] ); const setSelectedNames = useCallback( (names: Set<string>) => { - editorState.setSelectedCompNames(names); + editorState?.setSelectedCompNames(names); }, - [editorState.setSelectedCompNames] + [editorState?.setSelectedCompNames] ); const { width, ref } = useResizeDetector({ onResize, handleHeight: isRowCountLocked, + refreshMode: 'debounce', + refreshRate: 100, }); const itemViewRef = useRef<GirdItemViewRecord>({}); @@ -500,7 +502,7 @@ export const InnerGrid = React.memo((props: ViewPropsWithSelect) => { style={props.style} scrollContainerRef={props.scrollContainerRef} width={width ?? 0} - showGridLines={editorState.showGridLines() && (isDroppable || enableGridLines)} + showGridLines={editorState?.showGridLines() && (isDroppable || enableGridLines)} isRowCountLocked={isRowCountLocked} isDraggable={isDraggable} isResizable={isResizable} @@ -517,7 +519,7 @@ export const InnerGrid = React.memo((props: ViewPropsWithSelect) => { : defaultLayout(compType); return { size: compLayout ?? defaultSize, - positionParams: editorState.canvasPositionParams(), + positionParams: editorState?.canvasPositionParams(), }; } }} @@ -533,18 +535,18 @@ export const InnerGrid = React.memo((props: ViewPropsWithSelect) => { const items = _.pick(props.items, Object.keys(layoutItems)); draggingUtils.setData("sourceDispatch", props.dispatch); draggingUtils.setData<Record<string, GridItem>>("items", items); - editorState.setDragging(true); + editorState?.setDragging(true); const names = Object.values(items).map((item) => item.name); - editorState.setSelectedCompNames(new Set(names)); + editorState?.setSelectedCompNames(new Set(names)); }} onFlyDrop={(layout, items) => { onFlyDrop(layout, items, props.dispatch); }} onResizeStart={(_a, _b, _c, _d, event) => { event.stopPropagation(); - editorState.setDragging(true); + editorState?.setDragging(true); }} - onResizeStop={() => editorState.setDragging(false)} + onResizeStop={() => editorState?.setDragging(false)} margin={[0, 0]} containerPadding={props.containerPadding} fixedRowCount={props.emptyRows !== DEFAULT_ROW_COUNT} @@ -558,12 +560,12 @@ export const InnerGrid = React.memo((props: ViewPropsWithSelect) => { minHeight={props.minHeight} bgColor={props.bgColor} radius={props.radius} - hintPlaceholder={!editorState.isDragging && !readOnly && props.hintPlaceholder} + hintPlaceholder={!editorState?.isDragging && !readOnly && props.hintPlaceholder} selectedSize={_.size(containerSelectNames)} clickItem={clickItem} isCanvas={props.isCanvas} showName={props.showName} - disableDirectionKey={editorState.isDragging || readOnly} + disableDirectionKey={editorState?.isDragging || readOnly} > {itemViews} </ReactGridLayout> diff --git a/client/packages/lowcoder/src/comps/comps/gridItemComp.tsx b/client/packages/lowcoder/src/comps/comps/gridItemComp.tsx index 7ef5440cc..f6522d583 100644 --- a/client/packages/lowcoder/src/comps/comps/gridItemComp.tsx +++ b/client/packages/lowcoder/src/comps/comps/gridItemComp.tsx @@ -55,6 +55,7 @@ const TmpComp = withTypeAndChildren< undefined, undefined, manifest.withoutLoading, + manifest.layoutInfo?.h, ) } const comp = manifest.withoutLoading ? manifest.comp : withIsLoading(manifest.comp!); @@ -96,6 +97,7 @@ const CachedPropertyView = React.memo((props: { useEffect(() => { setSearchText(""); }, [props.name]); + return useMemo(() => { return ( <> diff --git a/client/packages/lowcoder/src/comps/comps/lazyLoadComp/lazyLoadComp.tsx b/client/packages/lowcoder/src/comps/comps/lazyLoadComp/lazyLoadComp.tsx index 7a45714b3..0b2ac21f6 100644 --- a/client/packages/lowcoder/src/comps/comps/lazyLoadComp/lazyLoadComp.tsx +++ b/client/packages/lowcoder/src/comps/comps/lazyLoadComp/lazyLoadComp.tsx @@ -49,6 +49,7 @@ interface LazyCompViewProps { loadComp: () => Promise<void>; loadingElement?: () => React.ReactNode; errorElement?: (error: any) => React.ReactNode; + height?: number, } const LazyCompView = React.memo((props: React.PropsWithChildren<LazyCompViewProps>) => { @@ -82,7 +83,7 @@ const LazyCompView = React.memo((props: React.PropsWithChildren<LazyCompViewProp } return ( - <WhiteLoading /> + <WhiteLoading compHeight={props.height} /> ); }); @@ -94,6 +95,7 @@ export function lazyLoadComp( loader?: LazyloadCompLoader, loadingElement?: () => React.ReactNode, withoutLoading?: boolean, + height?: number, ) { class LazyLoadComp extends simpleMultiComp({}) { compValue: any; @@ -145,7 +147,12 @@ export function lazyLoadComp( // const key = `${remoteInfo?.packageName}-${remoteInfo?.packageVersion}-${remoteInfo?.compName}`; const key = `${compName}`; return ( - <LazyCompView key={key} loadComp={() => this.load()} loadingElement={loadingElement} /> + <LazyCompView + key={key} + loadComp={() => this.load()} + loadingElement={loadingElement} + height={height} + /> ); } diff --git a/client/packages/lowcoder/src/comps/comps/listViewComp/listViewComp.tsx b/client/packages/lowcoder/src/comps/comps/listViewComp/listViewComp.tsx index cd9644997..47da5c6f3 100644 --- a/client/packages/lowcoder/src/comps/comps/listViewComp/listViewComp.tsx +++ b/client/packages/lowcoder/src/comps/comps/listViewComp/listViewComp.tsx @@ -39,7 +39,7 @@ import { ListView } from "./listView"; import { listPropertyView } from "./listViewPropertyView"; import { getData } from "./listViewUtils"; import { withMethodExposing } from "comps/generators/withMethodExposing"; -import SliderControl from "@lowcoder-ee/comps/controls/sliderControl"; +import { SliderControl } from "@lowcoder-ee/comps/controls/sliderControl"; const childrenMap = { noOfRows: withIsLoadingMethod(NumberOrJSONObjectArrayControl), // FIXME: migrate "noOfRows" to "data" diff --git a/client/packages/lowcoder/src/comps/comps/pageLayoutComp/pageLayoutComp.tsx b/client/packages/lowcoder/src/comps/comps/pageLayoutComp/pageLayoutComp.tsx index d4c890015..febeddabf 100644 --- a/client/packages/lowcoder/src/comps/comps/pageLayoutComp/pageLayoutComp.tsx +++ b/client/packages/lowcoder/src/comps/comps/pageLayoutComp/pageLayoutComp.tsx @@ -28,7 +28,7 @@ import { ContainerBodyChildComp } from "./containerBodyChildComp"; import { trans } from "i18n"; import { ControlNode } from "lowcoder-design"; import { StringControl } from "comps/controls/codeControl"; -import SliderControl from "@lowcoder-ee/comps/controls/sliderControl"; +import { SliderControl } from "@lowcoder-ee/comps/controls/sliderControl"; import { useMergeCompStyles } from "@lowcoder-ee/util/hooks"; const childrenMap = { diff --git a/client/packages/lowcoder/src/comps/comps/responsiveLayout/responsiveLayout.tsx b/client/packages/lowcoder/src/comps/comps/responsiveLayout/responsiveLayout.tsx index fc8e47536..13b3b8b5c 100644 --- a/client/packages/lowcoder/src/comps/comps/responsiveLayout/responsiveLayout.tsx +++ b/client/packages/lowcoder/src/comps/comps/responsiveLayout/responsiveLayout.tsx @@ -42,7 +42,7 @@ import { EditorContext } from "comps/editorState"; import { disabledPropertyView, hiddenPropertyView } from "comps/utils/propertyUtils"; import { DisabledContext } from "comps/generators/uiCompBuilder"; -import SliderControl from "@lowcoder-ee/comps/controls/sliderControl"; +import { SliderControl } from "@lowcoder-ee/comps/controls/sliderControl"; import { getBackgroundStyle } from "@lowcoder-ee/util/styleUtils"; import { useScreenInfo } from "../../hooks/screenInfoComp"; @@ -136,7 +136,7 @@ type ColumnContainerProps = Omit<ContainerBaseProps, 'style'> & { style: ResponsiveLayoutColStyleType, } -const ColumnContainer = (props: ColumnContainerProps) => { +const ColumnContainer = React.memo((props: ColumnContainerProps) => { return ( <InnerGrid {...props} @@ -145,7 +145,7 @@ const ColumnContainer = (props: ColumnContainerProps) => { style={props.style} /> ); -}; +}); const ResponsiveLayout = (props: ResponsiveLayoutProps) => { const screenInfo = useScreenInfo(); diff --git a/client/packages/lowcoder/src/comps/comps/rootComp.tsx b/client/packages/lowcoder/src/comps/comps/rootComp.tsx index b28e4c045..edf1f3a34 100644 --- a/client/packages/lowcoder/src/comps/comps/rootComp.tsx +++ b/client/packages/lowcoder/src/comps/comps/rootComp.tsx @@ -35,6 +35,7 @@ import { useUserViewMode } from "util/hooks"; import React from "react"; import { isEqual } from "lodash"; import {LoadingBarHideTrigger} from "@lowcoder-ee/util/hideLoading"; +import clsx from "clsx"; const EditorView = lazy( () => import("pages/editor/editorView"), ); @@ -130,7 +131,11 @@ const RootView = React.memo((props: RootViewProps) => { } return ( - <div {...divProps} style={{height: '100%'}}> + <div {...divProps} + className={clsx( + divProps.id, + )} + style={{height: '100%'}}> <PropertySectionContext.Provider value={propertySectionContextValue}> <ThemeContext.Provider value={themeContextValue}> <EditorContext.Provider value={editorState}> diff --git a/client/packages/lowcoder/src/comps/comps/splitLayout/splitLayout.tsx b/client/packages/lowcoder/src/comps/comps/splitLayout/splitLayout.tsx index dfac3b4f8..b988eca54 100644 --- a/client/packages/lowcoder/src/comps/comps/splitLayout/splitLayout.tsx +++ b/client/packages/lowcoder/src/comps/comps/splitLayout/splitLayout.tsx @@ -28,7 +28,7 @@ import { NameGenerator } from "comps/utils"; import { AutoHeightControl } from "comps/controls/autoHeightControl"; import { messageInstance } from "lowcoder-design/src/components/GlobalInstances"; import { NameConfigHidden, withExposingConfigs } from "comps/generators/withExposing"; -import SliderControl from "@lowcoder-ee/comps/controls/sliderControl"; +import { SliderControl } from "@lowcoder-ee/comps/controls/sliderControl"; import { getBackgroundStyle } from "@lowcoder-ee/util/styleUtils"; import _ from "lodash"; diff --git a/client/packages/lowcoder/src/comps/comps/tableComp/column/columnTypeComp.tsx b/client/packages/lowcoder/src/comps/comps/tableComp/column/columnTypeComp.tsx index 3757e6bc8..58e0b7df4 100644 --- a/client/packages/lowcoder/src/comps/comps/tableComp/column/columnTypeComp.tsx +++ b/client/packages/lowcoder/src/comps/comps/tableComp/column/columnTypeComp.tsx @@ -1,5 +1,6 @@ import { CellProps } from "components/table/EditableCell"; import { DateTimeComp } from "comps/comps/tableComp/column/columnTypeComps/columnDateTimeComp"; +import { TimeComp } from "./columnTypeComps/columnTimeComp"; import { ButtonComp } from "comps/comps/tableComp/column/simpleColumnTypeComps"; import { withType } from "comps/generators"; import { trans } from "i18n"; @@ -67,6 +68,11 @@ const actionOptions = [ label: trans("table.image"), value: "image", }, + { + label: trans("table.time"), + value: "time", + }, + { label: trans("table.date"), value: "date", @@ -116,6 +122,7 @@ export const ColumnTypeCompMap = { rating: RatingComp, progress: ProgressComp, date: DateComp, + time: TimeComp, }; type ColumnTypeMapType = typeof ColumnTypeCompMap; diff --git a/client/packages/lowcoder/src/comps/comps/tableComp/column/columnTypeComps/columnTimeComp.tsx b/client/packages/lowcoder/src/comps/comps/tableComp/column/columnTypeComps/columnTimeComp.tsx new file mode 100644 index 000000000..b4ad2d73d --- /dev/null +++ b/client/packages/lowcoder/src/comps/comps/tableComp/column/columnTypeComps/columnTimeComp.tsx @@ -0,0 +1,166 @@ +import { default as TimePicker } from "antd/es/time-picker"; +import { + ColumnTypeCompBuilder, + ColumnTypeViewFn, +} from "comps/comps/tableComp/column/columnTypeCompBuilder"; +import { ColumnValueTooltip } from "comps/comps/tableComp/column/simpleColumnTypeComps"; +import { StringControl } from "comps/controls/codeControl"; +import { withDefault } from "comps/generators"; +import { formatPropertyView } from "comps/utils/propertyUtils"; +import { trans } from "i18n"; +import dayjs from "dayjs"; +import { useEffect, useRef, useState } from "react"; +import styled from "styled-components"; +import { TIME_FORMAT } from "util/dateTimeUtils"; +import { hasIcon } from "comps/utils"; +import { IconControl } from "comps/controls/iconControl"; + + +const TimePickerStyled = styled(TimePicker)<{ $open: boolean }>` + width: 100%; + height: 100%; + position: absolute; + top: 0; + padding: 0; + padding-left: 11px; + .ant-picker-input { + height: 100%; + } + input { + padding-right: 18px; + cursor: pointer; + } + &.ant-picker-focused .ant-picker-suffix svg g { + stroke: ${(props) => props.$open && "#315EFB"}; + } + .ant-picker-suffix { + height: calc(100% - 1px); + position: absolute; + right: 0; + top: 0.5px; + display: flex; + align-items: center; + padding: 0 3px; + } +`; + +const Wrapper = styled.div` + background: transparent !important; +`; + +export function formatTime(time: string, format: string) { + const parsedTime = dayjs(time, TIME_FORMAT); + return parsedTime.isValid() ? parsedTime.format(format) : ""; +} + +const childrenMap = { + text: StringControl, + prefixIcon: IconControl, + suffixIcon: IconControl, + format: withDefault(StringControl, TIME_FORMAT), + inputFormat: withDefault(StringControl, TIME_FORMAT), +}; + +let inputFormat = TIME_FORMAT; + +const getBaseValue: ColumnTypeViewFn<typeof childrenMap, string, string> = (props) => props.text; + +type TimeEditProps = { + value: string; + onChange: (value: string) => void; + onChangeEnd: () => void; + inputFormat: string; +}; + +export const TimeEdit = (props: TimeEditProps) => { + const pickerRef = useRef<any>(); + const [panelOpen, setPanelOpen] = useState(true); + let value = dayjs(props.value, TIME_FORMAT); + if (!value.isValid()) { + value = dayjs("00:00:00", TIME_FORMAT); + } + + const [tempValue, setTempValue] = useState<dayjs.Dayjs | null>(value); + + useEffect(() => { + const value = props.value ? dayjs(props.value, TIME_FORMAT) : null; + setTempValue(value); + }, [props.value]); + + return ( + <Wrapper + onKeyDown={(e) => { + if (e.key === "Enter" && !panelOpen) { + props.onChangeEnd(); + } + }} + onMouseDown={(e) => { + e.stopPropagation(); + e.preventDefault(); + }} + > + <TimePickerStyled + ref={pickerRef} + $open={panelOpen} + format={props.inputFormat} + allowClear={true} + autoFocus + value={tempValue} + defaultOpen={true} + onOpenChange={(open) => setPanelOpen(open)} + onChange={(value, timeString) => { + props.onChange(timeString as string); + }} + onBlur={() => props.onChangeEnd()} + /> + </Wrapper> + ); +}; + +export const TimeComp = (function () { + return new ColumnTypeCompBuilder( + childrenMap, + (props, dispatch) => { + inputFormat = props.inputFormat; + const value = props.changeValue ?? getBaseValue(props, dispatch); + return( + <> + {hasIcon(props.prefixIcon) && ( + <span>{props.prefixIcon}</span> + )} + <span>{value}</span> + {hasIcon(props.suffixIcon) && ( + <span>{props.suffixIcon}</span> + )} + </> + ); + + }, + (nodeValue) => formatTime(nodeValue.text.value, nodeValue.format.value), + getBaseValue + ) + .setEditViewFn((props) => ( + <TimeEdit + value={props.value} + onChange={props.onChange} + onChangeEnd={props.onChangeEnd} + inputFormat={inputFormat} + /> + )) + .setPropertyViewFn((children) => ( + <> + {children.text.propertyView({ + label: trans("table.columnValue"), + tooltip: ColumnValueTooltip, + })} + {children.prefixIcon.propertyView({ + label: trans("button.prefixIcon"), + })} + {children.suffixIcon.propertyView({ + label: trans("button.suffixIcon"), + })} + {formatPropertyView({ children, placeholder: TIME_FORMAT })} + </> + )) + .build(); +})(); diff --git a/client/packages/lowcoder/src/comps/comps/tableComp/column/tableColumnComp.tsx b/client/packages/lowcoder/src/comps/comps/tableComp/column/tableColumnComp.tsx index 440d6f1e0..3e7a8df61 100644 --- a/client/packages/lowcoder/src/comps/comps/tableComp/column/tableColumnComp.tsx +++ b/client/packages/lowcoder/src/comps/comps/tableComp/column/tableColumnComp.tsx @@ -219,6 +219,7 @@ export class ColumnComp extends ColumnInitComp { const columnType = this.children.render.getSelectedComp().getComp().children.compType.getView(); return { ...superView, + columnType, editable: ColumnTypeCompMap[columnType].canBeEditable() && superView.editable, }; } diff --git a/client/packages/lowcoder/src/comps/comps/tableComp/tableToolbarComp.tsx b/client/packages/lowcoder/src/comps/comps/tableComp/tableToolbarComp.tsx index 85703fd11..64d0b6fae 100644 --- a/client/packages/lowcoder/src/comps/comps/tableComp/tableToolbarComp.tsx +++ b/client/packages/lowcoder/src/comps/comps/tableComp/tableToolbarComp.tsx @@ -686,8 +686,10 @@ function ToolbarPopover(props: { return ( <Popover open={visible} - overlayStyle={{ pointerEvents: "auto" }} - overlayInnerStyle={{ padding: '0' }} + styles={{ + root: { pointerEvents: "auto" }, + body: {padding: '0'} + }} content={ <div ref={popOverRef} diff --git a/client/packages/lowcoder/src/comps/comps/tableComp/tableUtils.tsx b/client/packages/lowcoder/src/comps/comps/tableComp/tableUtils.tsx index bca13e0aa..0fa834172 100644 --- a/client/packages/lowcoder/src/comps/comps/tableComp/tableUtils.tsx +++ b/client/packages/lowcoder/src/comps/comps/tableComp/tableUtils.tsx @@ -21,6 +21,7 @@ import { TableColumnLinkStyleType, TableColumnStyleType } from "comps/controls/s import Tooltip from "antd/es/tooltip"; import InfoCircleOutlined from "@ant-design/icons/InfoCircleOutlined"; import { EMPTY_ROW_KEY } from "./tableCompView"; +import dayjs from "dayjs"; export const COLUMN_CHILDREN_KEY = "children"; export const OB_ROW_ORI_INDEX = "__ob_origin_index"; @@ -399,7 +400,14 @@ export function columnsToAntdFormat( }, ...(column.sortable ? { - sorter: { multiple: (sortedColumns.length - mIndex) + 1 }, + sorter: { + multiple: (sortedColumns.length - mIndex) + 1, + compare: column.columnType === 'date' || column.columnType === 'dateTime' + ? (a,b) => { + return dayjs(a[column.dataIndex] as string).unix() - dayjs(b[column.dataIndex] as string).unix(); + } + : undefined + }, sortOrder: sortMap.get(column.dataIndex), showSorterTooltip: false, } diff --git a/client/packages/lowcoder/src/comps/comps/tabs/tabbedContainerComp.tsx b/client/packages/lowcoder/src/comps/comps/tabs/tabbedContainerComp.tsx index e062ba3bb..2d930fbf4 100644 --- a/client/packages/lowcoder/src/comps/comps/tabs/tabbedContainerComp.tsx +++ b/client/packages/lowcoder/src/comps/comps/tabs/tabbedContainerComp.tsx @@ -35,7 +35,7 @@ import { checkIsMobile } from "util/commonUtils"; import { messageInstance } from "lowcoder-design/src/components/GlobalInstances"; import { BoolControl } from "comps/controls/boolControl"; import { PositionControl } from "comps/controls/dropdownControl"; -import SliderControl from "@lowcoder-ee/comps/controls/sliderControl"; +import { SliderControl } from "@lowcoder-ee/comps/controls/sliderControl"; import { getBackgroundStyle } from "@lowcoder-ee/util/styleUtils"; const EVENT_OPTIONS = [ diff --git a/client/packages/lowcoder/src/comps/comps/textInputComp/textAreaComp.tsx b/client/packages/lowcoder/src/comps/comps/textInputComp/textAreaComp.tsx index a41fed3a2..b631d65fb 100644 --- a/client/packages/lowcoder/src/comps/comps/textInputComp/textAreaComp.tsx +++ b/client/packages/lowcoder/src/comps/comps/textInputComp/textAreaComp.tsx @@ -54,6 +54,9 @@ const Wrapper = styled.div<{ .ant-input { height:100% !important; } + .ant-input-affix-wrapper { + height:100% !important; + } .ant-input-clear-icon { opacity: 0.75; diff --git a/client/packages/lowcoder/src/comps/comps/timerComp.tsx b/client/packages/lowcoder/src/comps/comps/timerComp.tsx index 907566e12..a749cb068 100644 --- a/client/packages/lowcoder/src/comps/comps/timerComp.tsx +++ b/client/packages/lowcoder/src/comps/comps/timerComp.tsx @@ -1,7 +1,7 @@ -import { CompAction, RecordConstructorToView, changeChildAction } from "lowcoder-core"; +import { CompAction, RecordConstructorToComp, RecordConstructorToView, changeChildAction } from "lowcoder-core"; import { styleControl } from "comps/controls/styleControl"; import { AnimationStyle, AnimationStyleType, startButtonStyle, StartButtonStyleType, timerStyle, timerStyleType } from "comps/controls/styleControlConstants"; -import { UICompBuilder } from "comps/generators/uiCompBuilder"; +import { NewChildren, UICompBuilder } from "comps/generators/uiCompBuilder"; import { NameConfig, NameConfigHidden, withExposingConfigs } from "comps/generators/withExposing"; import { Section, sectionNames } from "lowcoder-design"; import { hiddenPropertyView, showDataLoadingIndicatorsPropertyView } from "comps/utils/propertyUtils"; @@ -15,6 +15,7 @@ import { EditorContext } from "comps/editorState"; import { dropdownControl } from "../controls/dropdownControl"; import { stringExposingStateControl } from "comps/controls/codeStateControl"; import { BoolControl } from "comps/controls/boolControl"; +import React from "react"; const Container = styled.div<{ $style: timerStyleType | undefined; @@ -113,7 +114,9 @@ const childrenMap = { hideButton: BoolControl, }; -const AvatarGroupView = (props: RecordConstructorToView<typeof childrenMap> & { dispatch: (action: CompAction) => void; }) => { +type ChildrenType = NewChildren<RecordConstructorToComp<typeof childrenMap>>; + +const TimerCompView = React.memo((props: RecordConstructorToView<typeof childrenMap> & { dispatch: (action: CompAction) => void; }) => { const [startTime, setStartTime] = useState(0) const [timerState, setTimerState] = useState('stoped') const [elapsedTime, setElapsedTime] = useState(0) @@ -219,51 +222,57 @@ const AvatarGroupView = (props: RecordConstructorToView<typeof childrenMap> & { </ButtonWarrper> </Container> ); -}; +}); -let AvatarGroupBasicComp = (function () { - return new UICompBuilder(childrenMap, (props, dispatch) => <AvatarGroupView {...props} dispatch={dispatch} />) - .setPropertyViewFn((children) => ( - <> - {["logic", "both"].includes(useContext(EditorContext).editorModeStatus) && ( - <> - <Section name={sectionNames.basic}> - {children.timerType.propertyView({ - label: trans('timer.timerType') - })} - {children.defaultValue.propertyView({ - label: trans('timer.defaultValue') - })} - {children.hideButton.propertyView({ - label: trans('timer.hideButton') - })} - </Section> - <Section name={sectionNames.interaction}> - {children.onEvent.propertyView()} - {hiddenPropertyView(children)} - {showDataLoadingIndicatorsPropertyView(children)} - </Section> - </> - )} - - {["layout", "both"].includes(useContext(EditorContext).editorModeStatus) && ( - <> - <Section name={sectionNames.style}> - {children.style.getPropertyView()} - </Section> - <Section name={sectionNames.animationStyle} hasTooltip={true}> - {children.animationStyle.getPropertyView()} - </Section> - <Section name={sectionNames.startButtonStyle}> - {children.startButtonStyle.getPropertyView()} +const TimerCompPropertyView = React.memo((props: { + children: ChildrenType +}) => { + return ( + <> + {["logic", "both"].includes(useContext(EditorContext).editorModeStatus) && ( + <> + <Section name={sectionNames.basic}> + {props.children.timerType.propertyView({ + label: trans('timer.timerType') + })} + {props.children.defaultValue.propertyView({ + label: trans('timer.defaultValue') + })} + {props.children.hideButton.propertyView({ + label: trans('timer.hideButton') + })} </Section> - <Section name={sectionNames.resetButtonStyle}> - {children.resetButtonStyle.getPropertyView()} + <Section name={sectionNames.interaction}> + {props.children.onEvent.propertyView()} + {hiddenPropertyView(props.children)} + {showDataLoadingIndicatorsPropertyView(props.children)} </Section> - </> - )} - </> - )) + </> + )} + + {["layout", "both"].includes(useContext(EditorContext).editorModeStatus) && ( + <> + <Section name={sectionNames.style}> + {props.children.style.getPropertyView()} + </Section> + <Section name={sectionNames.animationStyle} hasTooltip={true}> + {props.children.animationStyle.getPropertyView()} + </Section> + <Section name={sectionNames.startButtonStyle}> + {props.children.startButtonStyle.getPropertyView()} + </Section> + <Section name={sectionNames.resetButtonStyle}> + {props.children.resetButtonStyle.getPropertyView()} + </Section> + </> + )} + </> + ) +}); + +let TimerCompBasic = (function () { + return new UICompBuilder(childrenMap, (props, dispatch) => <TimerCompView {...props} dispatch={dispatch} />) + .setPropertyViewFn((children) => <TimerCompPropertyView children={children} />) .setExposeMethodConfigs([ { method: { @@ -294,7 +303,7 @@ let AvatarGroupBasicComp = (function () { .build(); })(); -export const TimerComp = withExposingConfigs(AvatarGroupBasicComp, [ +export const TimerComp = withExposingConfigs(TimerCompBasic, [ new NameConfig("defaultValue", trans("timer.defaultValue")), new NameConfig("elapsedTime", trans("timer.elapsedTime")), new NameConfig("timerState", trans("timer.timerState")), diff --git a/client/packages/lowcoder/src/comps/comps/transferComp.tsx b/client/packages/lowcoder/src/comps/comps/transferComp.tsx index 300020bd7..56a20d064 100644 --- a/client/packages/lowcoder/src/comps/comps/transferComp.tsx +++ b/client/packages/lowcoder/src/comps/comps/transferComp.tsx @@ -1,9 +1,9 @@ -import { CompAction, RecordConstructorToView, changeChildAction } from "lowcoder-core"; +import { CompAction, RecordConstructorToComp, RecordConstructorToView, changeChildAction } from "lowcoder-core"; import { BoolControl } from "comps/controls/boolControl"; import { arrayObjectExposingStateControl, arrayStringExposingStateControl } from "comps/controls/codeStateControl"; import { styleControl } from "comps/controls/styleControl"; import { TransferStyle, TransferStyleType, heightCalculator, widthCalculator } from "comps/controls/styleControlConstants"; -import { UICompBuilder } from "comps/generators/uiCompBuilder"; +import { NewChildren, UICompBuilder } from "comps/generators/uiCompBuilder"; import { NameConfig, NameConfigHidden, withExposingConfigs } from "comps/generators/withExposing"; import { Section, sectionNames } from "lowcoder-design"; import { hiddenPropertyView, showDataLoadingIndicatorsPropertyView } from "comps/utils/propertyUtils"; @@ -17,6 +17,7 @@ import styled, { css } from "styled-components"; import { useContext, useEffect, useRef, useState } from "react"; import { valueComp, withDefault } from "../generators"; import type { TransferDirection } from 'antd/es/transfer'; +import React from "react"; const Container = styled.div<{ $style: TransferStyleType }>` height: 100%; @@ -71,7 +72,9 @@ const childrenMap = { searchInfo: valueComp<string[]>(['', '']), }; -const TransferView = (props: RecordConstructorToView<typeof childrenMap> & { +type ChildrenType = NewChildren<RecordConstructorToComp<typeof childrenMap>>; + +const TransferView = React.memo((props: RecordConstructorToView<typeof childrenMap> & { dispatch: (action: CompAction) => void; }) => { const conRef = useRef<HTMLDivElement>(null); @@ -136,48 +139,54 @@ const TransferView = (props: RecordConstructorToView<typeof childrenMap> & { </Container> </ReactResizeDetector> ); -}; +}); + +const TransferCompPropertyView = React.memo((props: { + children: ChildrenType +}) => { + return ( + <> + <Section name={sectionNames.basic}> + {props.children.items.propertyView({ + label: trans("transfer.items"), + })} + {props.children.targetKeys.propertyView({ + label: trans("transfer.targetKeys"), + })} + {props.children.sourceTitle.propertyView({ + label: trans("transfer.sourceTitle"), + })} + {props.children.targetTitle.propertyView({ + label: trans("transfer.targetTitle"), + })} + {props.children.showSearch.propertyView({ + label: trans("transfer.allowSearch"), + })} + {props.children.oneWay.propertyView({ + label: trans("transfer.oneWay"), + })} + {props.children.pagination.propertyView({ + label: trans("transfer.pagination"), + })} + {props.children.pagination.getView() && props.children.pageSize.propertyView({ + label: trans("transfer.pageSize"), + })} + </Section> + <Section name={sectionNames.interaction}> + {props.children.onEvent.propertyView()} + {hiddenPropertyView(props.children)} + {showDataLoadingIndicatorsPropertyView(props.children)} + </Section> + <Section name={sectionNames.style}>{props.children.style.getPropertyView()}</Section> + </> + ) +}); let TransferBasicComp = (function () { return new UICompBuilder(childrenMap, (props, dispatch) => { return ( <TransferView {...props} dispatch={dispatch} />)}) - .setPropertyViewFn((children) => ( - <> - <Section name={sectionNames.basic}> - {children.items.propertyView({ - label: trans("transfer.items"), - })} - {children.targetKeys.propertyView({ - label: trans("transfer.targetKeys"), - })} - {children.sourceTitle.propertyView({ - label: trans("transfer.sourceTitle"), - })} - {children.targetTitle.propertyView({ - label: trans("transfer.targetTitle"), - })} - {children.showSearch.propertyView({ - label: trans("transfer.allowSearch"), - })} - {children.oneWay.propertyView({ - label: trans("transfer.oneWay"), - })} - {children.pagination.propertyView({ - label: trans("transfer.pagination"), - })} - {children.pagination.getView() && children.pageSize.propertyView({ - label: trans("transfer.pageSize"), - })} - </Section> - <Section name={sectionNames.interaction}> - {children.onEvent.propertyView()} - {hiddenPropertyView(children)} - {showDataLoadingIndicatorsPropertyView(children)} - </Section> - <Section name={sectionNames.style}>{children.style.getPropertyView()}</Section> - </> - )) + .setPropertyViewFn((children) => <TransferCompPropertyView children={children} />) .build(); })(); diff --git a/client/packages/lowcoder/src/comps/comps/triContainerComp/triContainerComp.tsx b/client/packages/lowcoder/src/comps/comps/triContainerComp/triContainerComp.tsx index 307531ccf..0af8dbe95 100644 --- a/client/packages/lowcoder/src/comps/comps/triContainerComp/triContainerComp.tsx +++ b/client/packages/lowcoder/src/comps/comps/triContainerComp/triContainerComp.tsx @@ -27,7 +27,7 @@ import { SimpleContainerComp } from "../containerBase/simpleContainerComp"; import { ContainerBodyChildComp } from "./containerBodyChildComp"; import { trans } from "i18n"; import { ControlNode } from "lowcoder-design"; -import SliderControl from "@lowcoder-ee/comps/controls/sliderControl"; +import { SliderControl } from "@lowcoder-ee/comps/controls/sliderControl"; import { useMergeCompStyles } from "@lowcoder-ee/util/hooks"; const childrenMap = { diff --git a/client/packages/lowcoder/src/comps/controls/actionSelector/executeQueryAction.tsx b/client/packages/lowcoder/src/comps/controls/actionSelector/executeQueryAction.tsx index 5febe82ff..a368e73db 100644 --- a/client/packages/lowcoder/src/comps/controls/actionSelector/executeQueryAction.tsx +++ b/client/packages/lowcoder/src/comps/controls/actionSelector/executeQueryAction.tsx @@ -56,6 +56,9 @@ const ExecuteQueryPropertyView = ({ }, [placement]); const getVariableOptions = useCallback((editorState?: EditorState) => { + const queryVariables = comp.children.queryVariables.getView(); + if (!queryVariables.length) return null; + return comp.children.queryVariables.propertyView({ label: trans("eventHandler.queryVariables"), layout: "vertical", @@ -121,6 +124,7 @@ export class ExecuteQueryAction extends ExecuteQueryTmpAction { if (!queryName) { return () => Promise.resolve(); } + return () => getPromiseAfterDispatch( this.dispatch, diff --git a/client/packages/lowcoder/src/comps/controls/eventHandlerControl.tsx b/client/packages/lowcoder/src/comps/controls/eventHandlerControl.tsx index 70bf77962..11f81b569 100644 --- a/client/packages/lowcoder/src/comps/controls/eventHandlerControl.tsx +++ b/client/packages/lowcoder/src/comps/controls/eventHandlerControl.tsx @@ -170,7 +170,7 @@ const EventHandlerControlPropertyView = (props: { const queryVariables = editorState ?.selectedOrFirstQueryComp() - ?.children.variables.children.variables.toJsonValue(); + ?.children.variables.toJsonValue(); const queryExecHandler = { compType: "executeQuery", diff --git a/client/packages/lowcoder/src/comps/controls/keyValueControl.tsx b/client/packages/lowcoder/src/comps/controls/keyValueControl.tsx index 319d8ac0a..6b9018cc3 100644 --- a/client/packages/lowcoder/src/comps/controls/keyValueControl.tsx +++ b/client/packages/lowcoder/src/comps/controls/keyValueControl.tsx @@ -6,7 +6,7 @@ import { StringControl } from "./codeControl"; import { ControlParams } from "./controlParams"; import { dropdownControl } from "./dropdownControl"; import { ParamsStringControl } from "./paramsControl"; -import { SimpleVariableHeaderComp } from "../comps/simpleVariableHeaderComp"; +import { SimpleNameComp } from "../comps/simpleNameComp"; const KeyValueWrapper = styled.div` display: flex; @@ -68,8 +68,8 @@ export function keyValueControl<T extends OptionsType>( }; if(controlType === "variable") { childrenMap = { - key: SimpleVariableHeaderComp(true) as any, - value: SimpleVariableHeaderComp() as any, + key: SimpleNameComp as any, + value: StringControl, type: dropdownControl(types, types[0]?.value), }; } diff --git a/client/packages/lowcoder/src/comps/controls/sliderControl.tsx b/client/packages/lowcoder/src/comps/controls/sliderControl.tsx index 4161667a8..a02562887 100644 --- a/client/packages/lowcoder/src/comps/controls/sliderControl.tsx +++ b/client/packages/lowcoder/src/comps/controls/sliderControl.tsx @@ -31,4 +31,4 @@ class SliderControl extends SimpleComp<number> { } } -export default SliderControl; +export { SliderControl }; diff --git a/client/packages/lowcoder/src/comps/editorState.tsx b/client/packages/lowcoder/src/comps/editorState.tsx index 02f2d200a..ff928f6f6 100644 --- a/client/packages/lowcoder/src/comps/editorState.tsx +++ b/client/packages/lowcoder/src/comps/editorState.tsx @@ -509,7 +509,7 @@ export class EditorState { //Check query variable name duplication const queryComInfoList:string[] = [].concat(...(this.getQueriesComp() - .toJsonValue().map((item: any) => item.variables.variables.map((v: any) => v.key)))); + .toJsonValue().map((item: any) => item.variables.map((v: any) => v.key)))); if (name !== oldName && queryComInfoList.includes(name)) { return trans("comp.nameExists", { name: name }); diff --git a/client/packages/lowcoder/src/comps/generators/hookToComp.tsx b/client/packages/lowcoder/src/comps/generators/hookToComp.tsx index 40e92bf4b..68dce72cd 100644 --- a/client/packages/lowcoder/src/comps/generators/hookToComp.tsx +++ b/client/packages/lowcoder/src/comps/generators/hookToComp.tsx @@ -36,9 +36,11 @@ export function hookToStateComp(useHookFn: () => JSONObject) { const hookValue = useHookFn(); const stateValue = useMemo(() => comp.children.stateValue.getView(), [comp.children.stateValue]); - if (!isEqual(hookValue, stateValue)) { - comp.children.stateValue.dispatchChangeValueAction(hookValue); - } + useEffect(() => { + if (!isEqual(hookValue, stateValue)) { + comp.children.stateValue.dispatchChangeValueAction(hookValue); + } + }, [hookValue, stateValue]); return null; } ); diff --git a/client/packages/lowcoder/src/comps/generators/withMultiContext.tsx b/client/packages/lowcoder/src/comps/generators/withMultiContext.tsx index a8bcd8f44..ec843eb91 100644 --- a/client/packages/lowcoder/src/comps/generators/withMultiContext.tsx +++ b/client/packages/lowcoder/src/comps/generators/withMultiContext.tsx @@ -125,7 +125,11 @@ export function withMultiContext<TCtor extends MultiCompConstructor>(VariantComp const params = this.cacheParamsMap.get(key); if (_.isNil(comp) && !_.isNil(params)) { const mapComps = this.getMap(); - if (mapComps.hasOwnProperty(key) && !paramsEqual(params, mapComps[key].getParams())) { + if ( + Object.keys(mapComps).length === Object.keys(this.cacheParamsMap.getMap()).length + && mapComps.hasOwnProperty(key) + && !paramsEqual(params, mapComps[key].getParams()) + ) { // refresh the item, since params changed // this.dispatch(deferAction(wrapChildAction(MAP_KEY, MapCtor.batchDeleteAction([key])))); this.dispatch(wrapChildAction(MAP_KEY, MapCtor.batchDeleteAction([key]))); @@ -177,16 +181,18 @@ export function withMultiContext<TCtor extends MultiCompConstructor>(VariantComp const params = comp.cacheParamsMap.get(key); if (params) { const childComp = comp - .getComp(key)! + .getOriginalComp() .setParams(params) .changeDispatch(wrapDispatch(wrapDispatch(comp.dispatch, MAP_KEY), key)); const newChildComp = childComp.reduce(childAction); - const comps = { [key]: newChildComp }; - comp = comp.setChild( - MAP_KEY, - comp.children[MAP_KEY].reduce(MapCtor.batchSetCompAction(comps)) - ); + if (childComp !== newChildComp) { + const comps = { [key]: newChildComp }; + comp = comp.setChild( + MAP_KEY, + comp.children[MAP_KEY].reduce(MapCtor.batchSetCompAction(comps)) + ); + } } } else { comp = super.reduce(action); diff --git a/client/packages/lowcoder/src/comps/hooks/drawerComp.tsx b/client/packages/lowcoder/src/comps/hooks/drawerComp.tsx index 9d52075e9..d607c3211 100644 --- a/client/packages/lowcoder/src/comps/hooks/drawerComp.tsx +++ b/client/packages/lowcoder/src/comps/hooks/drawerComp.tsx @@ -25,7 +25,9 @@ import { useUserViewMode } from "util/hooks"; import { isNumeric } from "util/stringUtils"; import { NameConfig, withExposingConfigs } from "../generators/withExposing"; import { title } from "process"; -import SliderControl from "../controls/sliderControl"; +import { SliderControl } from "../controls/sliderControl"; +import clsx from "clsx"; +import { useApplicationId } from "util/hooks"; const EventOptions = [closeEvent] as const; @@ -119,6 +121,7 @@ let TmpDrawerComp = (function () { const isTopBom = ["top", "bottom"].includes(props.placement); const { items, ...otherContainerProps } = props.container; const userViewMode = useUserViewMode(); + const appID = useApplicationId(); const resizable = !userViewMode && (!isTopBom || !props.autoHeight); const onResizeStop = useCallback( ( @@ -172,7 +175,7 @@ let TmpDrawerComp = (function () { zIndex={Layers.drawer} maskClosable={props.maskClosable} mask={props.showMask} - className={props.className as string} + className={clsx(`app-${appID}`, props.className)} data-testid={props.dataTestId as string} > {props.toggleClose && ( diff --git a/client/packages/lowcoder/src/comps/hooks/modalComp.tsx b/client/packages/lowcoder/src/comps/hooks/modalComp.tsx index 2a3235f9d..7cdcbe4fd 100644 --- a/client/packages/lowcoder/src/comps/hooks/modalComp.tsx +++ b/client/packages/lowcoder/src/comps/hooks/modalComp.tsx @@ -22,8 +22,10 @@ import { isNumeric } from "util/stringUtils"; import { NameConfig, withExposingConfigs } from "../generators/withExposing"; import { BoolControl } from "comps/controls/boolControl"; import { withDefault } from "comps/generators"; -import SliderControl from "../controls/sliderControl"; +import { SliderControl } from "../controls/sliderControl"; import { getBackgroundStyle } from "@lowcoder-ee/util/styleUtils"; +import clsx from "clsx"; +import { useApplicationId } from "util/hooks"; const EventOptions = [ { label: trans("modalComp.open"), value: "open", description: trans("modalComp.openDesc") }, @@ -113,6 +115,7 @@ let TmpModalComp = (function () { }, (props, dispatch) => { const userViewMode = useUserViewMode(); + const appID = useApplicationId(); const bodyStyle: CSSProperties = { padding: 0 }; const width = transToPxSize(props.width || DEFAULT_WIDTH); let height = undefined; @@ -177,7 +180,7 @@ let TmpModalComp = (function () { zIndex={Layers.modal} modalRender={(node) => <ModalStyled $style={props.style} $modalScrollbar={props.modalScrollbar}>{node}</ModalStyled>} mask={props.showMask} - className={props.className as string} + className={clsx(`app-${appID}`, props.className)} data-testid={props.dataTestId as string} > <InnerGrid diff --git a/client/packages/lowcoder/src/comps/hooks/screenInfoComp.tsx b/client/packages/lowcoder/src/comps/hooks/screenInfoComp.tsx index 61652fb0f..0d4fb1df0 100644 --- a/client/packages/lowcoder/src/comps/hooks/screenInfoComp.tsx +++ b/client/packages/lowcoder/src/comps/hooks/screenInfoComp.tsx @@ -22,7 +22,9 @@ type ScreenInfo = { export function useScreenInfo() { const canvasContainer = document.getElementById(CanvasContainerID); const canvas = document.getElementsByClassName('lowcoder-app-canvas')?.[0]; - const canvasWidth = canvasContainer?.clientWidth || canvas?.clientWidth; + const canvasWidth = useMemo(() => { + return canvasContainer?.clientWidth || canvas?.clientWidth; + }, [canvasContainer?.clientWidth, canvas?.clientWidth]); const getDeviceType = (width: number) => { if (width < 768) return ScreenTypes.Mobile; @@ -71,7 +73,9 @@ export function useScreenInfo() { }, [ updateScreenInfo ]) useEffect(() => { - updateScreenInfo(); + if (canvasWidth) { + updateScreenInfo(); + } }, [canvasWidth]); return screenInfo; diff --git a/client/packages/lowcoder/src/comps/hooks/themeComp.tsx b/client/packages/lowcoder/src/comps/hooks/themeComp.tsx index 7fdff5ed0..8e11723fa 100644 --- a/client/packages/lowcoder/src/comps/hooks/themeComp.tsx +++ b/client/packages/lowcoder/src/comps/hooks/themeComp.tsx @@ -64,12 +64,15 @@ let ThemeTempComp = withViewFn( return stateValue; }, [themeList, currentTheme, stateValue]) - if (!isEqual(themeValue, stateValue)) { - comp.children.stateValue.dispatchChangeValueAction({ - ...exposingTheme(currentTheme), - allThemes: themeList.map((t) => exposingTheme(t)), - }) - } + useEffect(() => { + if (!isEqual(themeValue, stateValue)) { + comp.children.stateValue.dispatchChangeValueAction({ + ...exposingTheme(currentTheme), + allThemes: themeList.map((t) => exposingTheme(t)), + }) + } + }, [themeValue, stateValue]); + return null; } ); diff --git a/client/packages/lowcoder/src/comps/hooks/utilsComp.ts b/client/packages/lowcoder/src/comps/hooks/utilsComp.ts index 7824b1439..f91bae194 100644 --- a/client/packages/lowcoder/src/comps/hooks/utilsComp.ts +++ b/client/packages/lowcoder/src/comps/hooks/utilsComp.ts @@ -8,6 +8,8 @@ import { openApp, recordToSearchStr } from "../../util/appUtils"; import { trans } from "i18n"; import { logoutAction } from "redux/reduxActions/userActions"; import StoreRegistry from "@lowcoder-ee/redux/store/storeRegistry"; +import UserApi from "@lowcoder-ee/api/userApi"; +import { messageInstance } from "components/GlobalInstances"; const UtilsCompBase = simpleMultiComp({}); export let UtilsComp = withExposingConfigs(UtilsCompBase, []); @@ -121,4 +123,33 @@ UtilsComp = withMethodExposing(UtilsComp, [ ); }, }, + { + method: { + name: "resetPassword", + description: trans("utilsComp.resetPassword"), + params: [ + { name: "oldPassword", type: "string" }, + { name: "newPassword", type: "string" }, + ], + }, + execute: async (comp, params) => { + const oldPassword = params?.[0]; + const newPassword = params?.[1]; + try { + if (Boolean(oldPassword) && Boolean(newPassword)) { + const response = await UserApi.updatePassword({ + oldPassword: oldPassword as string, + newPassword: newPassword as string, + }); + if (!response.data.success) { + throw (new Error(response.data.message)); + } + } else { + throw(new Error('Reset password requires both old and new passwords')) + } + } catch(e: any) { + messageInstance.error(e.message) + } + }, + } ]); diff --git a/client/packages/lowcoder/src/comps/index.tsx b/client/packages/lowcoder/src/comps/index.tsx index 4acecfd14..f6ce3e1c3 100644 --- a/client/packages/lowcoder/src/comps/index.tsx +++ b/client/packages/lowcoder/src/comps/index.tsx @@ -97,7 +97,6 @@ import { CandlestickChartCompIcon, FunnelChartCompIcon, - // GraphChartCompIcon, HeatmapChartCompIcon, GaugeChartCompIcon, RadarChartCompIcon, @@ -115,7 +114,10 @@ import { GraphChartCompIcon, GanttCompIcon, KanbanCompIcon, - + PieChartCompIcon, + BarChartCompIcon, + LineChartCompIcon, + ScatterChartCompIcon } from "lowcoder-design"; import { ModuleComp } from "./comps/moduleComp/moduleComp"; import { TableComp } from "./comps/tableComp/tableComp"; @@ -128,6 +130,68 @@ import { TextComp } from "./comps/textComp"; import { SelectComp } from "./comps/selectInputComp/selectComp"; import { InputComp } from "./comps/textInputComp/inputComp"; import { TextAreaComp } from "./comps/textInputComp/textAreaComp"; +import { AutoCompleteComp } from "./comps/autoCompleteComp/autoCompleteComp"; +import { AvatarComp } from "./comps/avatar"; +import { AvatarGroupComp } from "./comps/avatarGroup"; +import { DropdownComp } from "./comps/buttonComp/dropdownComp"; +import { FloatButtonComp } from "./comps/buttonComp/floatButtonComp"; +import { LinkComp } from "./comps/buttonComp/linkComp"; +import { ScannerComp } from "./comps/buttonComp/scannerComp"; +import { ToggleButtonComp } from "./comps/buttonComp/toggleButtonComp"; +import { CarouselComp } from "./comps/carouselComp"; +import { CommentComp } from "./comps/commentComp/commentComp"; +import { CardComp } from "./comps/containerComp/cardComp"; +import { CustomComp } from "./comps/customComp/customComp"; +import { DatePickerComp, DateRangeComp } from "./comps/dateComp/dateComp"; +import { TimePickerComp, TimeRangeComp } from "./comps/dateComp/timeComp"; +import { DividerComp } from "./comps/dividerComp"; +import { FileComp } from "./comps/fileComp/fileComp"; +import { FileViewerComp } from "./comps/fileViewerComp"; +import { defaultFormData, FormComp } from "./comps/formComp/formComp"; +import { IconComp } from "./comps/iconComp"; +import { IFrameComp } from "./comps/iframeComp"; +import { ImageComp } from "./comps/imageComp"; +import { JsonEditorComp } from "./comps/jsonComp/jsonEditorComp"; +import { JsonExplorerComp } from "./comps/jsonComp/jsonExplorerComp"; +import { JsonLottieComp } from "./comps/jsonComp/jsonLottieComp"; +import { JsonSchemaFormComp } from "./comps/jsonSchemaFormComp/jsonSchemaFormComp"; +import { ListViewComp, GridComp, defaultListViewData, defaultGridData } from "./comps/listViewComp"; +import { AudioComp } from "./comps/mediaComp/audioComp"; +import { ColorPickerComp } from "./comps/mediaComp/colorPickerComp"; +import { VideoComp } from "./comps/mediaComp/videoComp"; +import { ControlButton } from "./comps/meetingComp/controlButton"; +import { NavComp } from "./comps/navComp/navComp"; +import { NumberInputComp } from "./comps/numberInputComp/numberInputComp"; +import { RangeSliderComp } from "./comps/numberInputComp/rangeSliderComp"; +import { SliderComp } from "./comps/numberInputComp/sliderComp"; +import { defaultPageLayoutData, PageLayoutComp } from "./comps/containerComp/pageLayoutComp"; +import { ProgressCircleComp } from "./comps/progressCircleComp"; +import { ProgressComp } from "./comps/progressComp"; +import { QRCodeComp } from "./comps/qrCodeComp"; +import { RatingComp } from "./comps/ratingComp"; +import { ResponsiveLayoutComp } from "./comps/responsiveLayout"; +import { RichTextEditorComp } from "./comps/richTextEditorComp"; +import { CascaderWithDefault } from "./comps/selectInputComp/cascaderComp"; +import { CheckboxComp } from "./comps/selectInputComp/checkboxComp"; +import { MultiSelectComp } from "./comps/selectInputComp/multiSelectComp"; +import { RadioComp } from "./comps/selectInputComp/radioComp"; +import { SegmentedControlComp } from "./comps/selectInputComp/segmentedControl"; +import { StepComp } from "./comps/selectInputComp/stepControl"; +import { ShapeComp } from "./comps/shapeComp/shapeComp"; +import { SignatureComp } from "./comps/signatureComp"; +import { SplitLayoutComp } from "./comps/splitLayout"; +import { SwitchComp } from "./comps/switchComp"; +import { MentionComp } from "./comps/textInputComp/mentionComp"; +import { PasswordComp } from "./comps/textInputComp/passwordComp"; +import { TimeLineComp } from "./comps/timelineComp/timelineComp"; +import { TimerComp } from "./comps/timerComp"; +import { TourComp } from "./comps/tourComp/tourComp"; +import { transferComp } from "./comps/transferComp"; +import { TreeComp } from "./comps/treeComp/treeComp"; +import { TreeSelectComp } from "./comps/treeComp/treeSelectComp"; +import { DrawerComp } from "./hooks/drawerComp"; +import { ModalComp } from "./hooks/modalComp"; +import { defaultCollapsibleContainerData } from "./comps/containerComp/collapsibleContainerComp"; type Registry = { [key in UICompType]?: UICompManifest; @@ -145,10 +209,10 @@ export var uiCompMap: Registry = { // charts chart: { - name: trans("uiComp.chartCompName") + " (legacy)", + name: trans("uiComp.chartCompName"), enName: "Chart", description: trans("uiComp.chartCompDesc"), - categories: ["dashboards"], + categories: ["legacy"], icon: ChartCompIcon, comp: remoteComp({ ...builtInRemoteComps, compName: "chart" }), keywords: trans("uiComp.chartCompKeywords"), @@ -162,7 +226,7 @@ export var uiCompMap: Registry = { name: trans("uiComp.basicChartCompName"), enName: "Basic Chart", description: trans("uiComp.basicChartCompDesc"), - categories: ["dashboards"], + categories: ["legacy"], icon: ChartCompIcon, comp: remoteComp({ ...builtInRemoteComps, compName: "basicChart" }), keywords: trans("uiComp.basicChartCompKeywords"), @@ -172,6 +236,62 @@ export var uiCompMap: Registry = { }, }, + barChart: { + name: trans("uiComp.barChartCompName"), + enName: "Bar Chart", + description: trans("uiComp.barChartCompDesc"), + categories: ["dashboards"], + icon: BarChartCompIcon, + comp: remoteComp({ ...builtInRemoteComps, compName: "barChart" }), + keywords: trans("uiComp.barChartCompKeywords"), + layoutInfo: { + w: 12, + h: 40, + }, + }, + + lineChart: { + name: trans("uiComp.lineChartCompName"), + enName: "Line Chart", + description: trans("uiComp.lineChartCompDesc"), + categories: ["dashboards"], + icon: LineChartCompIcon, + comp: remoteComp({ ...builtInRemoteComps, compName: "lineChart" }), + keywords: trans("uiComp.lineChartCompKeywords"), + layoutInfo: { + w: 12, + h: 40, + }, + }, + + pieChart: { + name: trans("uiComp.pieChartCompName"), + enName: "Pie Chart", + description: trans("uiComp.piehartCompDesc"), + categories: ["dashboards"], + icon: PieChartCompIcon, + comp: remoteComp({ ...builtInRemoteComps, compName: "pieChart" }), + keywords: trans("uiComp.pieChartCompKeywords"), + layoutInfo: { + w: 12, + h: 40, + }, + }, + + scatterChart: { + name: trans("uiComp.scatterChartCompName"), + enName: "Scatter Chart", + description: trans("uiComp.scatterChartCompDesc"), + categories: ["dashboards"], + icon: ScatterChartCompIcon, + comp: remoteComp({ ...builtInRemoteComps, compName: "scatterChart" }), + keywords: trans("uiComp.scatterChartCompKeywords"), + layoutInfo: { + w: 12, + h: 40, + }, + }, + candleStickChart: { name: trans("uiComp.candleStickChartCompName"), enName: "Candlestick Chart", @@ -407,9 +527,7 @@ export var uiCompMap: Registry = { categories: ["dashboards"], icon: TimeLineCompIcon, keywords: trans("uiComp.timelineCompKeywords"), - lazyLoad: true, - compName: "TimeLineComp", - compPath: "comps/timelineComp/timelineComp", + comp: TimeLineComp, layoutInfo: { w: 12, h: 40, @@ -425,9 +543,7 @@ export var uiCompMap: Registry = { categories: ["layout"], icon: ResponsiveLayoutCompIcon, keywords: trans("uiComp.responsiveLayoutCompKeywords"), - lazyLoad: true, - compName: "ResponsiveLayoutComp", - compPath: "comps/responsiveLayout/index", + comp: ResponsiveLayoutComp, withoutLoading: true, layoutInfo: { w: 24, @@ -442,9 +558,7 @@ export var uiCompMap: Registry = { categories: ["layout"], icon: PageLayoutCompIcon, keywords: trans("uiComp.pageLayoutCompKeywords"), - lazyLoad: true, - compName: "PageLayoutComp", - compPath: "comps/containerComp/pageLayoutComp", + comp: PageLayoutComp, withoutLoading: true, layoutInfo: { w: 12, @@ -452,8 +566,7 @@ export var uiCompMap: Registry = { // static: true, delayCollision: true, }, - defaultDataFnName: "defaultPageLayoutData", - defaultDataFnPath: "comps/tableComp/mockTableComp", + defaultDataFn: defaultPageLayoutData, }, columnLayout: { name: "Column Layout", @@ -477,9 +590,7 @@ export var uiCompMap: Registry = { categories: ["layout"], icon: SplitLayoutCompIcon, keywords: trans("uiComp.splitLayoutCompKeywords"), - lazyLoad: true, - compName: "SplitLayoutComp", - compPath: "comps/splitLayout/index", + comp: SplitLayoutComp, withoutLoading: true, layoutInfo: { w: 24, @@ -494,9 +605,7 @@ export var uiCompMap: Registry = { categories: ["layout"], icon: FloatingTextCompIcon, keywords: trans("uiComp.floatTextContainerCompKeywords"), - lazyLoad: true, - compName: "ContainerComp", - compPath: "comps/containerComp/textContainerComp", + comp: ContainerComp, withoutLoading: true, layoutInfo: { w: 12, @@ -504,8 +613,7 @@ export var uiCompMap: Registry = { // static: true, delayCollision: true, }, - defaultDataFnName: "defaultContainerData", - defaultDataFnPath: "comps/containerComp/containerComp", + defaultDataFn: defaultContainerData, }, card: { name: trans("uiComp.cardCompName"), @@ -514,9 +622,7 @@ export var uiCompMap: Registry = { description: trans("uiComp.cardCompDesc"), categories: ["layout"], keywords: trans("uiComp.cardCompKeywords"), - lazyLoad: true, - compName: "CardComp", - compPath: "comps/containerComp/cardComp", + comp: CardComp, layoutInfo: { h: 44, w: 6, @@ -545,9 +651,7 @@ export var uiCompMap: Registry = { categories: ["layout"], icon: CollapsibleContainerCompIcon, keywords: trans("uiComp.collapsibleContainerCompKeywords"), - lazyLoad: true, - compName: "ContainerComp", - compPath: "comps/containerComp/containerComp", + comp: ContainerComp, withoutLoading: true, layoutInfo: { w: 12, @@ -555,8 +659,7 @@ export var uiCompMap: Registry = { // static: true, delayCollision: true, }, - defaultDataFnName: "defaultCollapsibleContainerData", - defaultDataFnPath: "comps/containerComp/collapsibleContainerComp", + defaultDataFn: defaultCollapsibleContainerData, }, container: { name: trans("uiComp.containerCompName"), @@ -582,16 +685,13 @@ export var uiCompMap: Registry = { description: trans("uiComp.listViewCompDesc"), categories: ["layout"], keywords: trans("uiComp.listViewCompKeywords"), - lazyLoad: true, - compName: "ListViewComp", - compPath: "comps/listViewComp/index", + comp: ListViewComp, layoutInfo: { w: 12, h: 40, delayCollision: true, }, - defaultDataFnName: "defaultListViewData", - defaultDataFnPath: "comps/listViewComp/index", + defaultDataFn: defaultListViewData, }, grid: { name: trans("uiComp.gridCompName"), @@ -600,16 +700,13 @@ export var uiCompMap: Registry = { description: trans("uiComp.gridCompDesc"), categories: ["layout"], keywords: trans("uiComp.gridCompKeywords"), - lazyLoad: true, - compName: "GridComp", - compPath: "comps/listViewComp/index", + comp: GridComp, layoutInfo: { w: 12, h: 40, delayCollision: true, }, - defaultDataFnName: "defaultGridData", - defaultDataFnPath: "comps/listViewComp/index", + defaultDataFn: defaultGridData, }, modal: { name: trans("uiComp.modalCompName"), @@ -618,9 +715,7 @@ export var uiCompMap: Registry = { description: trans("uiComp.modalCompDesc"), categories: ["layout"], keywords: trans("uiComp.modalCompKeywords"), - lazyLoad: true, - compName: "ModalComp", - compPath: "hooks/modalComp", + comp: ModalComp, withoutLoading: true, }, drawer: { @@ -630,9 +725,7 @@ export var uiCompMap: Registry = { categories: ["layout"], icon: DrawerCompIcon, keywords: trans("uiComp.drawerCompKeywords"), - lazyLoad: true, - compName: "DrawerComp", - compPath: "hooks/drawerComp", + comp: DrawerComp, withoutLoading: true, }, divider: { @@ -642,9 +735,7 @@ export var uiCompMap: Registry = { categories: ["layout"], icon: DividerCompIcon, keywords: trans("uiComp.dividerCompKeywords"), - lazyLoad: true, - compName: "DividerComp", - compPath: "comps/dividerComp", + comp: DividerComp, layoutInfo: { w: 12, h: 1, @@ -657,9 +748,7 @@ export var uiCompMap: Registry = { icon: NavComIcon, categories: ["layout"], keywords: trans("uiComp.navigationCompKeywords"), - lazyLoad: true, - compName: "NavComp", - compPath: "comps/navComp/navComp", + comp: NavComp, layoutInfo: { w: 24, h: 5, @@ -672,9 +761,7 @@ export var uiCompMap: Registry = { categories: ["layout"], icon: StepCompIcon, keywords: trans("uiComp.stepControlCompKeywords"), - lazyLoad: true, - compName: "StepComp", - compPath: "comps/selectInputComp/stepControl", + comp: StepComp, layoutInfo: { w: 19, h: 6, @@ -687,9 +774,7 @@ export var uiCompMap: Registry = { categories: ["layout"], icon: CascaderCompIcon, keywords: trans("uiComp.cascaderCompKeywords"), - lazyLoad: true, - compName: "CascaderWithDefault", - compPath: "comps/selectInputComp/cascaderComp", + comp: CascaderWithDefault, layoutInfo: { w: 9, h: 5, @@ -702,9 +787,7 @@ export var uiCompMap: Registry = { categories: ["layout"], icon: LinkCompIcon, keywords: trans("uiComp.linkCompKeywords"), - lazyLoad: true, - compName: "LinkComp", - compPath: "comps/buttonComp/linkComp", + comp: LinkComp, layoutInfo: { w: 6, h: 5, @@ -717,9 +800,7 @@ export var uiCompMap: Registry = { categories: ["layout"], icon: FloatingButtonCompIcon, keywords: trans("uiComp.floatButtonCompKeywords"), - lazyLoad: true, - compName: "FloatButtonComp", - compPath: "comps/buttonComp/floatButtonComp", + comp: FloatButtonComp, layoutInfo: { w: 1, h: 1, @@ -749,9 +830,7 @@ export var uiCompMap: Registry = { description: trans("uiComp.timerCompDesc"), categories: ["scheduling", "projectmanagement"], keywords: trans("uiComp.timerCompKeywords"), - lazyLoad: true, - compName: "TimerComp", - compPath: "comps/timerComp", + comp: TimerComp, layoutInfo: { h: 14, w: 6, @@ -807,9 +886,7 @@ export var uiCompMap: Registry = { categories: ["collaboration"], icon: AvatarCompIcon, keywords: trans("uiComp.avatarCompKeywords"), - lazyLoad: true, - compName: "AvatarComp", - compPath: "comps/avatar", + comp: AvatarComp, layoutInfo: { w: 6, h: 6, @@ -823,9 +900,7 @@ export var uiCompMap: Registry = { description: trans("uiComp.avatarGroupCompDesc"), categories: ["collaboration"], keywords: trans("uiComp.avatarGroupCompKeywords"), - lazyLoad: true, - compName: "AvatarGroupComp", - compPath: "comps/avatarGroup", + comp: AvatarGroupComp, withoutLoading: true, layoutInfo: { w: 6, @@ -840,9 +915,7 @@ export var uiCompMap: Registry = { categories: ["collaboration"], icon: CommentCompIcon, keywords: trans("uiComp.commentCompKeywords"), - lazyLoad: true, - compName: "CommentComp", - compPath: "comps/commentComp/commentComp", + comp: CommentComp, layoutInfo: { w: 12, h: 55, @@ -855,9 +928,7 @@ export var uiCompMap: Registry = { categories: ["collaboration"], icon: MentionCompIcon, keywords: trans("uiComp.mentionCompKeywords"), - lazyLoad: true, - compName: "MentionComp", - compPath: "comps/textInputComp/mentionComp", + comp: MentionComp, }, // Forms @@ -869,9 +940,7 @@ export var uiCompMap: Registry = { categories: ["forms"], icon: FormCompIcon, keywords: trans("uiComp.formCompKeywords"), - lazyLoad: true, - compName: "FormComp", - compPath: "comps/formComp/formComp", + comp: FormComp, withoutLoading: true, layoutInfo: { w: 12, @@ -879,8 +948,7 @@ export var uiCompMap: Registry = { // static: true, delayCollision: true, }, - defaultDataFnName: "defaultFormData", - defaultDataFnPath: "comps/formComp/formComp", + defaultDataFn: defaultFormData, }, jsonSchemaForm: { name: trans("uiComp.jsonSchemaFormCompName"), @@ -889,9 +957,7 @@ export var uiCompMap: Registry = { categories: ["forms"], icon: JsonFormCompIcon, keywords: trans("uiComp.jsonSchemaFormCompKeywords"), - lazyLoad: true, - compName: "JsonSchemaFormComp", - compPath: "comps/jsonSchemaFormComp/jsonSchemaFormComp", + comp: JsonSchemaFormComp, layoutInfo: { w: 12, h: 50, @@ -904,9 +970,7 @@ export var uiCompMap: Registry = { categories: ["forms"], icon: JsonEditorCompIcon, keywords: trans("uiComp.jsonEditorCompKeywords"), - lazyLoad: true, - compName: "JsonEditorComp", - compPath: "comps/jsonComp/jsonEditorComp", + comp: JsonEditorComp, layoutInfo: { w: 12, h: 50, @@ -919,9 +983,7 @@ export var uiCompMap: Registry = { categories: ["forms"], icon: JsonExplorerCompIcon, keywords: trans("uiComp.jsonExplorerCompKeywords"), - lazyLoad: true, - compName: "JsonExplorerComp", - compPath: "comps/jsonComp/jsonExplorerComp", + comp: JsonExplorerComp, layoutInfo: { w: 12, h: 50, @@ -934,9 +996,7 @@ export var uiCompMap: Registry = { description: trans("uiComp.richTextEditorCompDesc"), icon: RichTextEditorCompIcon, keywords: trans("uiComp.richTextEditorCompKeywords"), - lazyLoad: true, - compName: "RichTextEditorComp", - compPath: "comps/richTextEditorComp", + comp: RichTextEditorComp, layoutInfo: { w: 12, h: 50, @@ -962,9 +1022,7 @@ export var uiCompMap: Registry = { categories: ["forms"], icon: PasswordCompIcon, keywords: trans("uiComp.passwordCompKeywords"), - lazyLoad: true, - compName: "PasswordComp", - compPath: "comps/textInputComp/passwordComp", + comp: PasswordComp, layoutInfo: { w: 6, h: 6, @@ -977,9 +1035,7 @@ export var uiCompMap: Registry = { categories: ["forms"], icon: NumberInputCompIcon, keywords: trans("uiComp.numberInputCompKeywords"), - lazyLoad: true, - compName: "NumberInputComp", - compPath: "comps/numberInputComp/numberInputComp", + comp: NumberInputComp, layoutInfo: { w: 6, h: 6, @@ -1007,9 +1063,10 @@ export var uiCompMap: Registry = { keywords: cnchar .spell(trans("uiComp.autoCompleteCompName"), "first", "low") .toString(), - lazyLoad: true, - compName: "AutoCompleteComp", - compPath: "comps/autoCompleteComp/autoCompleteComp", + comp: AutoCompleteComp, + // lazyLoad: true, + // compName: "AutoCompleteComp", + // compPath: "comps/autoCompleteComp/autoCompleteComp", layoutInfo: { w: 6, h: 5, @@ -1022,9 +1079,7 @@ export var uiCompMap: Registry = { categories: ["forms"], icon: SwitchCompIcon, keywords: trans("uiComp.switchCompKeywords"), - lazyLoad: true, - compName: "SwitchComp", - compPath: "comps/switchComp", + comp: SwitchComp, layoutInfo: { w: 6, h: 6, @@ -1037,9 +1092,7 @@ export var uiCompMap: Registry = { categories: ["forms"], icon: CheckboxCompIcon, keywords: trans("uiComp.checkboxCompKeywords"), - lazyLoad: true, - compName: "CheckboxComp", - compPath: "comps/selectInputComp/checkboxComp", + comp: CheckboxComp, layoutInfo: { w: 6, h: 6, @@ -1052,9 +1105,7 @@ export var uiCompMap: Registry = { categories: ["forms"], icon: RadioCompIcon, keywords: trans("uiComp.radioCompKeywords"), - lazyLoad: true, - compName: "RadioComp", - compPath: "comps/selectInputComp/radioComp", + comp: RadioComp, layoutInfo: { w: 6, h: 6, @@ -1067,9 +1118,7 @@ export var uiCompMap: Registry = { categories: ["forms", "scheduling"], icon: DateCompIcon, keywords: trans("uiComp.dateCompKeywords"), - lazyLoad: true, - compName: "DatePickerComp", - compPath: "comps/dateComp/dateComp", + comp: DatePickerComp, layoutInfo: { w: 6, h: 6, @@ -1082,9 +1131,7 @@ export var uiCompMap: Registry = { categories: ["forms", "scheduling"], icon: DateRangeCompIcon, keywords: trans("uiComp.dateRangeCompKeywords"), - lazyLoad: true, - compName: "DateRangeComp", - compPath: "comps/dateComp/dateComp", + comp: DateRangeComp, layoutInfo: { w: 12, h: 6, @@ -1097,9 +1144,7 @@ export var uiCompMap: Registry = { categories: ["forms", "scheduling"], icon: TimeCompIcon, keywords: trans("uiComp.timeCompKeywords"), - lazyLoad: true, - compName: "TimePickerComp", - compPath: "comps/dateComp/timeComp", + comp: TimePickerComp, layoutInfo: { w: 6, h: 6, @@ -1112,9 +1157,7 @@ export var uiCompMap: Registry = { description: trans("uiComp.timeRangeCompDesc"), icon: TimeRangeCompIcon, keywords: trans("uiComp.timeRangeCompKeywords"), - lazyLoad: true, - compName: "TimeRangeComp", - compPath: "comps/dateComp/timeComp", + comp: TimeRangeComp, layoutInfo: { w: 12, h: 6, @@ -1128,9 +1171,7 @@ export var uiCompMap: Registry = { categories: ["forms"], icon: SliderCompIcon, keywords: trans("uiComp.sliderCompKeywords"), - lazyLoad: true, - compName: "SliderComp", - compPath: "comps/numberInputComp/sliderComp", + comp: SliderComp, layoutInfo: { w: 6, h: 5, @@ -1143,9 +1184,7 @@ export var uiCompMap: Registry = { categories: ["forms"], icon: RangeSliderCompIcon, keywords: trans("uiComp.rangeSliderCompKeywords"), - lazyLoad: true, - compName: "RangeSliderComp", - compPath: "comps/numberInputComp/rangeSliderComp", + comp: RangeSliderComp, layoutInfo: { w: 6, h: 5, @@ -1173,9 +1212,7 @@ export var uiCompMap: Registry = { categories: ["forms", "collaboration"], icon: IconButtonCompIcon, keywords: trans("uiComp.meetingCompKeywords"), - lazyLoad: true, - compName: "ControlButton", - compPath: "comps/meetingComp/controlButton", + comp: ControlButton, withoutLoading: true, layoutInfo: { w: 3, @@ -1189,9 +1226,7 @@ export var uiCompMap: Registry = { categories: ["forms"], icon: DropdownCompIcon, keywords: trans("uiComp.dropdownCompKeywords"), - lazyLoad: true, - compName: "DropdownComp", - compPath: "comps/buttonComp/dropdownComp", + comp: DropdownComp, layoutInfo: { w: 6, h: 6, @@ -1204,9 +1239,7 @@ export var uiCompMap: Registry = { categories: ["forms"], icon: ToggleButtonCompIcon, keywords: trans("uiComp.toggleButtonCompKeywords"), - lazyLoad: true, - compName: "ToggleButtonComp", - compPath: "comps/buttonComp/toggleButtonComp", + comp: ToggleButtonComp, layoutInfo: { w: 3, h: 6, @@ -1219,9 +1252,7 @@ export var uiCompMap: Registry = { categories: ["forms"], icon: SegmentedCompIcon, keywords: trans("uiComp.segmentedControlCompKeywords"), - lazyLoad: true, - compName: "SegmentedControlComp", - compPath: "comps/selectInputComp/segmentedControl", + comp: SegmentedControlComp, layoutInfo: { w: 6, h: 6, @@ -1235,9 +1266,7 @@ export var uiCompMap: Registry = { categories: ["forms"], icon: RatingCompIcon, keywords: trans("uiComp.ratingCompKeywords"), - lazyLoad: true, - compName: "RatingComp", - compPath: "comps/ratingComp", + comp: RatingComp, layoutInfo: { w: 6, h: 6, @@ -1331,9 +1360,7 @@ export var uiCompMap: Registry = { categories: ["dashboards", "projectmanagement"], icon: ProgressCompIcon, keywords: trans("uiComp.progressCompKeywords"), - lazyLoad: true, - compName: "ProgressComp", - compPath: "comps/progressComp", + comp: ProgressComp, layoutInfo: { w: 6, h: 5, @@ -1346,9 +1373,7 @@ export var uiCompMap: Registry = { categories: ["dashboards", "projectmanagement"], icon: ProcessCircleCompIcon, keywords: trans("uiComp.progressCircleCompKeywords"), - lazyLoad: true, - compName: "ProgressCircleComp", - compPath: "comps/progressCircleComp", + comp: ProgressCircleComp, layoutInfo: { w: 6, h: 20, @@ -1364,9 +1389,7 @@ export var uiCompMap: Registry = { categories: ["documents"], icon: UploadCompIcon, keywords: trans("uiComp.fileUploadCompKeywords"), - lazyLoad: true, - compName: "FileComp", - compPath: "comps/fileComp/fileComp", + comp: FileComp, layoutInfo: { w: 6, h: 5, @@ -1379,9 +1402,7 @@ export var uiCompMap: Registry = { categories: ["documents"], icon: FileViewerCompIcon, keywords: trans("uiComp.fileViewerCompKeywords"), - lazyLoad: true, - compName: "FileViewerComp", - compPath: "comps/fileViewerComp", + comp: FileViewerComp, layoutInfo: { w: 12, h: 40, @@ -1397,9 +1418,7 @@ export var uiCompMap: Registry = { categories: ["multimedia"], icon: ImageCompIcon, keywords: trans("uiComp.imageCompKeywords"), - lazyLoad: true, - compName: "ImageComp", - compPath: "comps/imageComp", + comp: ImageComp, layoutInfo: { w: 12, h: 40, @@ -1412,9 +1431,7 @@ export var uiCompMap: Registry = { categories: ["multimedia"], icon: CarouselCompIcon, keywords: trans("uiComp.drawerCompKeywords"), - lazyLoad: true, - compName: "CarouselComp", - compPath: "comps/carouselComp", + comp: CarouselComp, withoutLoading: true, layoutInfo: { w: 12, @@ -1428,9 +1445,7 @@ export var uiCompMap: Registry = { categories: ["multimedia"], icon: AudioCompIcon, keywords: trans("uiComp.audioCompKeywords"), - lazyLoad: true, - compName: "AudioComp", - compPath: "comps/mediaComp/audioComp", + comp: AudioComp, layoutInfo: { w: 6, h: 5, @@ -1443,9 +1458,7 @@ export var uiCompMap: Registry = { categories: ["multimedia"], icon: VideoCompIcon, keywords: trans("uiComp.videoCompKeywords"), - lazyLoad: true, - compName: "VideoComp", - compPath: "comps/mediaComp/videoComp", + comp: VideoComp, layoutInfo: { w: 12, h: 40, @@ -1459,9 +1472,7 @@ export var uiCompMap: Registry = { categories: ["multimedia", "dashboards"], icon: ShapesCompIcon, keywords: trans("uiComp.shapeCompKeywords"), - lazyLoad: true, - compName: "ShapeComp", - compPath: "comps/shapeComp/shapeComp", + comp: ShapeComp, layoutInfo: { w: 12, h: 40, @@ -1475,9 +1486,7 @@ export var uiCompMap: Registry = { categories: ["multimedia"], icon: LottieAnimationCompIcon, keywords: trans("uiComp.jsonLottieCompKeywords"), - lazyLoad: true, - compName: "JsonLottieComp", - compPath: "comps/jsonComp/jsonLottieComp", + comp: JsonLottieComp, layoutInfo: { w: 12, h: 40, @@ -1490,9 +1499,7 @@ export var uiCompMap: Registry = { categories: ["multimedia"], icon: IconCompIcon, keywords: trans("uiComp.iconCompKeywords"), - lazyLoad: true, - compName: "IconComp", - compPath: "comps/iconComp", + comp: IconComp, layoutInfo: { w: 2, h: 10, @@ -1520,9 +1527,7 @@ export var uiCompMap: Registry = { categories: ["multimedia"], icon: ColorPickerCompIcon, keywords: trans("uiComp.colorPickerCompKeywords"), - lazyLoad: true, - compName: "ColorPickerComp", - compPath: "comps/mediaComp/colorPickerComp", + comp: ColorPickerComp, }, // item Handling @@ -1534,9 +1539,7 @@ export var uiCompMap: Registry = { categories: ["itemHandling", "documents"], icon: QRCodeCompIcon, keywords: trans("uiComp.qrCodeCompKeywords"), - lazyLoad: true, - compName: "QRCodeComp", - compPath: "comps/qrCodeComp", + comp: QRCodeComp, layoutInfo: { w: 6, h: 32, @@ -1549,9 +1552,7 @@ export var uiCompMap: Registry = { categories: ["itemHandling"], icon: ScannerCompIcon, keywords: trans("uiComp.scannerCompKeywords"), - lazyLoad: true, - compName: "ScannerComp", - compPath: "comps/buttonComp/scannerComp", + comp: ScannerComp, layoutInfo: { w: 6, h: 5, @@ -1564,9 +1565,7 @@ export var uiCompMap: Registry = { categories: ["itemHandling"], icon: SignatureCompIcon, keywords: trans("uiComp.signatureCompKeywords"), - lazyLoad: true, - compName: "SignatureComp", - compPath: "comps/signatureComp", + comp: SignatureComp, layoutInfo: { w: 12, h: 40, @@ -1592,9 +1591,7 @@ export var uiCompMap: Registry = { categories: ["multimedia", "itemHandling"], icon: TourCompIcon, keywords: trans("uiComp.tourCompKeywords"), - lazyLoad: true, - compName: "TourComp", - compPath: "comps/tourComp/tourComp", + comp: TourComp, layoutInfo: { w: 1, h: 1, @@ -1607,9 +1604,7 @@ export var uiCompMap: Registry = { categories: ["forms", "itemHandling"], icon: MultiSelectCompIcon, keywords: trans("uiComp.multiSelectCompKeywords"), - lazyLoad: true, - compName: "MultiSelectComp", - compPath: "comps/selectInputComp/multiSelectComp", + comp: MultiSelectComp, layoutInfo: { w: 6, h: 5, @@ -1622,9 +1617,7 @@ export var uiCompMap: Registry = { categories: ["layout", "itemHandling", "documents"], icon: TreeDisplayCompIcon, keywords: trans("uiComp.treeCompKeywords"), - lazyLoad: true, - compName: "TreeComp", - compPath: "comps/treeComp/treeComp", + comp: TreeComp, layoutInfo: { w: 12, h: 40, @@ -1637,9 +1630,7 @@ export var uiCompMap: Registry = { categories: ["layout", "itemHandling", "documents"], icon: TreeSelectCompIcon, keywords: trans("uiComp.treeSelectCompKeywords"), - lazyLoad: true, - compName: "TreeSelectComp", - compPath: "comps/treeComp/treeSelectComp", + comp: TreeSelectComp, layoutInfo: { w: 12, h: 5, @@ -1652,9 +1643,7 @@ export var uiCompMap: Registry = { description: trans("uiComp.transferDesc"), categories: ["itemHandling", "documents"], keywords: trans("uiComp.transferKeywords"), - lazyLoad: true, - compName: "transferComp", - compPath: "comps/transferComp", + comp: transferComp, layoutInfo: { w: 12, h: 50, @@ -1689,9 +1678,7 @@ export var uiCompMap: Registry = { icon: IFrameCompIcon, categories: ["integration"], keywords: trans("uiComp.iframeCompKeywords"), - lazyLoad: true, - compName: "IFrameComp", - compPath: "comps/iframeComp", + comp: IFrameComp, layoutInfo: { w: 12, h: 40, @@ -1704,9 +1691,7 @@ export var uiCompMap: Registry = { icon: CustomCompIcon, categories: ["integration"], keywords: trans("uiComp.customCompKeywords"), - lazyLoad: true, - compName: "CustomComp", - compPath: "comps/customComp/customComp", + comp: CustomComp, layoutInfo: { w: 12, h: 40, diff --git a/client/packages/lowcoder/src/comps/queries/httpQuery/graphqlQuery.tsx b/client/packages/lowcoder/src/comps/queries/httpQuery/graphqlQuery.tsx index aca0e742b..2ccba0539 100644 --- a/client/packages/lowcoder/src/comps/queries/httpQuery/graphqlQuery.tsx +++ b/client/packages/lowcoder/src/comps/queries/httpQuery/graphqlQuery.tsx @@ -15,6 +15,7 @@ import { HttpParametersPropertyView, HttpPathPropertyView, } from "./httpQueryConstants"; +import { SimpleNameComp } from "@lowcoder-ee/comps/comps/simpleNameComp"; interface VariablesControlParams { // variables: string[]; todo support parse variables diff --git a/client/packages/lowcoder/src/comps/queries/queryComp.tsx b/client/packages/lowcoder/src/comps/queries/queryComp.tsx index 066b351fe..c8ac3032e 100644 --- a/client/packages/lowcoder/src/comps/queries/queryComp.tsx +++ b/client/packages/lowcoder/src/comps/queries/queryComp.tsx @@ -37,6 +37,7 @@ import { FetchCheckNode, FetchInfo, fromRecord, + fromValue, isCustomAction, MultiBaseComp, multiChangeAction, @@ -67,7 +68,7 @@ import { JSONObject, JSONValue } from "../../util/jsonTypes"; import { BoolPureControl } from "../controls/boolControl"; import { millisecondsControl } from "../controls/millisecondControl"; import { paramsMillisecondsControl } from "../controls/paramsControl"; -import { DepsConfig, NameConfig, withExposingConfigs } from "../generators/withExposing"; +import { NameConfig, withExposingConfigs } from "../generators/withExposing"; import { HttpQuery } from "./httpQuery/httpQuery"; import { StreamQuery } from "./httpQuery/streamQuery"; import { QueryConfirmationModal } from "./queryComp/queryConfirmationModal"; @@ -76,6 +77,7 @@ import { QueryPropertyView } from "./queryComp/queryPropertyView"; import { getTriggerType, onlyManualTrigger } from "./queryCompUtils"; import { messageInstance } from "lowcoder-design/src/components/GlobalInstances"; import {VariablesComp} from "@lowcoder-ee/comps/queries/queryComp/variablesComp"; +import { migrateOldData } from "../generators/simpleGenerators"; const latestExecution: Record<string, string> = {}; @@ -257,7 +259,11 @@ QueryCompTmp = class extends QueryCompTmp { || isInputChangeTrigger || (isPageLoadTrigger && notExecuted) ) - // && (!isJsQuery || (isJsQuery && notExecuted)) // query which has deps can be executed on page load(first time) + && ( + !isJsQuery + || (isJsQuery && !isAutomatic) + || (isJsQuery && isAutomatic && notExecuted) + ) // query which has deps can be executed on page load(first time) ) { const next = super.reduce(action); const depends = this.children.comp.node()?.dependValues(); @@ -363,7 +369,7 @@ QueryCompTmp = class extends QueryCompTmp { } if (action.type === CompActionTypes.EXECUTE_QUERY) { if (getReduceContext().disableUpdateState) return this; - if(!action.args) action.args = this.children.variables.children.variables.toJsonValue().reduce((acc, curr) => Object.assign(acc, {[curr.key as string]:curr.value}), {}); + if(!action.args) action.args = this.children.variables.toJsonValue().filter(kv => kv.key).reduce((acc, curr) => Object.assign(acc, {[curr.key as string]:curr.value}), {}); action.args.$queryName = this.children.name.getView(); return this.executeQuery(action); @@ -655,6 +661,13 @@ QueryCompTmp = withMethodExposing(QueryCompTmp, [ }, ]); +QueryCompTmp = migrateOldData(QueryCompTmp, (oldData: any) => { + if (oldData?.variables?.variables) { + oldData.variables = oldData.variables.variables; + } + return oldData; +}); + export const QueryComp = withExposingConfigs(QueryCompTmp, [ new NameConfig("data", trans("query.dataExportDesc")), new NameConfig("code", trans("query.codeExportDesc")), @@ -664,23 +677,6 @@ export const QueryComp = withExposingConfigs(QueryCompTmp, [ new NameConfig("isFetching", trans("query.isFetchingExportDesc")), new NameConfig("runTime", trans("query.runTimeExportDesc")), new NameConfig("latestEndTime", trans("query.latestEndTimeExportDesc")), - new DepsConfig( - "variables", - (children: any) => { - return {data: children.variables.children.variables.node()}; - }, - (input) => { - if (!input.data) { - return undefined; - } - const newNode = Object.values(input.data) - .filter((kvNode: any) => kvNode.key) - .map((kvNode: any) => ({[kvNode.key]: kvNode.value})) - .reduce((prev, obj) => ({...prev, ...obj}), {}); - return newNode; - }, - trans("query.variables") - ), new NameConfig("triggerType", trans("query.triggerTypeExportDesc")), ]); @@ -718,7 +714,22 @@ class QueryListComp extends QueryListTmpComp implements BottomResListComp { const result: NameAndExposingInfo = {}; Object.values(this.children).forEach((comp) => { result[comp.children.name.getView()] = comp.exposingInfo(); + + const variables = comp.children.variables.toJsonValue(); + variables.forEach((variable: Record<string, any>) => { + result[variable.key] = { + property: fromRecord({ + value: fromValue(variable.value), + }), + propertyValue: { + value: variable.value, + }, + propertyDesc: {}, + methods: {}, + }; + }) }); + return result; } @@ -777,13 +788,15 @@ class QueryListComp extends QueryListTmpComp implements BottomResListComp { const jsonData = originQuery.toJsonValue(); //Regenerate variable header - jsonData.variables?.variables?.forEach(kv => { + const newKeys:string[] = []; + jsonData.variables?.forEach(kv => { const [prefix, _] = (kv.key as string).split(/(?=\d+$)/); let i=1, newName = ""; do { newName = prefix + (i++); - } while(editorState.checkRename("", newName)); + } while(editorState.checkRename("", newName) || newKeys.includes(newName)); kv.key = newName; + newKeys.push(newName); }) const newQueryName = this.genNewName(editorState); diff --git a/client/packages/lowcoder/src/comps/queries/queryComp/queryPropertyView.tsx b/client/packages/lowcoder/src/comps/queries/queryComp/queryPropertyView.tsx index 3a818f72e..a6d56e430 100644 --- a/client/packages/lowcoder/src/comps/queries/queryComp/queryPropertyView.tsx +++ b/client/packages/lowcoder/src/comps/queries/queryComp/queryPropertyView.tsx @@ -177,7 +177,7 @@ export function QueryPropertyView(props: { comp: InstanceType<typeof QueryComp> children: ( <QueryPropertyViewWrapper> <QuerySectionWrapper> - {children.variables.getPropertyView()} + {children.variables.propertyView({})} </QuerySectionWrapper> </QueryPropertyViewWrapper> ), diff --git a/client/packages/lowcoder/src/comps/queries/queryComp/variablesComp.tsx b/client/packages/lowcoder/src/comps/queries/queryComp/variablesComp.tsx index ec271e28f..337a2df61 100644 --- a/client/packages/lowcoder/src/comps/queries/queryComp/variablesComp.tsx +++ b/client/packages/lowcoder/src/comps/queries/queryComp/variablesComp.tsx @@ -1,15 +1,110 @@ -import {MultiCompBuilder, withDefault} from "../../generators"; -import { keyValueListControl } from "../../controls/keyValueListControl"; - -export const VariablesComp = new MultiCompBuilder( - { - variables: withDefault(keyValueListControl(false, [], "variable"), [{ key: "", value: "" }]), - }, - (props) => props //props.variables - ) - .setPropertyViewFn((children) => ( +import { simpleMultiComp } from "../../generators"; +import { SimpleNameComp } from "@lowcoder-ee/comps/comps/simpleNameComp"; +import { StringControl } from "@lowcoder-ee/comps/controls/codeControl"; +import { list } from "@lowcoder-ee/comps/generators/list"; +import { Input } from "components/Input"; +import { ControlPropertyViewWrapper } from "components/control"; +import { ReactNode, useContext, useState } from "react"; +import { KeyValueList } from "components/keyValueList"; +import { trans } from "i18n"; +import { PopupCard } from "components/popupCard"; +import { EditorContext, EditorState } from "@lowcoder-ee/comps/editorState"; +import { migrateOldData } from "@lowcoder-ee/comps/generators/simpleGenerators"; + +interface VariablesParams { + // variables: string[]; todo support parse variables +} + +const VariableKey = ({children, dispatch}: any) => { + const [editing, setEditing] = useState(false); + const [error, setError] = useState<string | undefined>(undefined); + const editorState = useContext(EditorContext); + + return ( <> - {children.variables.propertyView({})} + <div style={{ flexGrow: 1, marginRight: "8px" }}> + <Input + value={children.key.getView()} + onBlur={(e) => { + const { value } = e.target; + value !== children.key.getView() && + editorState.rename(children.key.getView(), value) + }} + onPressEnter={(e) => { + const { value } = e.target as HTMLInputElement; + value !== children.key.getView() && + editorState.rename(children.key.getView(), value) + }} + onChange={(e) => { + const nextName = e.target.value; + setError(editorState.checkRename(children.key.getView(), nextName)); + }} + /> + <PopupCard + editorFocus={!!error} + title={error ? trans("error") : ""} + content={error} + hasError={!!error} + /> + </div> </> - )) - .build(); + ) +} +const VariableItem = class extends simpleMultiComp({ + key: SimpleNameComp, + value: StringControl, +}) { + propertyView(params: VariablesParams): ReactNode { + return ( + <> + <div style={{ display: "flex", gap: "8px", flexGrow: 1 }}> + <VariableKey + children={this.children} + dispatch={this.dispatch} + /> + <div style={{ width: "232px", flexGrow: 1 }}> + {this.children.value.propertyView({ placeholder: "value" })} + </div> + </div> + </> + ) + } +} + +const VariableListPropertyViewWrapper = ({children}: any) => { + const editorState = useContext(EditorContext); + return children(editorState); +} + +export const VariablesComp = class extends list(VariableItem) { + genNewName(editorState: EditorState) { + const name = editorState.getNameGenerator().genItemName("variable"); + return name; + } + + add(editorState: EditorState, extraInfo?: any) { + const name = this.genNewName(editorState); + + this.dispatch( + this.pushAction({ + key: name, + value: '', + }) + ); + } + propertyView(params: VariablesParams): ReactNode { + return ( + <VariableListPropertyViewWrapper> + {(editorState: EditorState) => ( + <ControlPropertyViewWrapper {...params}> + <KeyValueList + list={this.getView().map((child) => child.propertyView(params))} + onAdd={() => this.add(editorState)} + onDelete={(item, index) => this.dispatch(this.deleteAction(index))} + /> + </ControlPropertyViewWrapper> + )} + </VariableListPropertyViewWrapper> + ); + } +}; diff --git a/client/packages/lowcoder/src/comps/queries/queryCompUtils.tsx b/client/packages/lowcoder/src/comps/queries/queryCompUtils.tsx index d319689e7..bb518fcad 100644 --- a/client/packages/lowcoder/src/comps/queries/queryCompUtils.tsx +++ b/client/packages/lowcoder/src/comps/queries/queryCompUtils.tsx @@ -28,10 +28,22 @@ export function toQueryView(params: FunctionProperty[]) { variables?: any; timeout: InstanceType<ParamsControlType>; }): Promise<QueryResult> => { - console.log("toQueryView props", props, params); const { applicationId, isViewMode } = getGlobalSettings(); - const mappedVariables = Object.keys(props.variables).map(key => ({key: `${props.args?.$queryName}.variables.${key}`, value: props.variables[key]})); + let mappedVariables: Array<{key: string, value: string}> = []; + Object.keys(props.variables) + .filter(k => k !== "$queryName") + .forEach(key => { + mappedVariables.push({ + key: `${key}.value`, + value: props.variables[key] || "" + }) + mappedVariables.push({ + key: `${props.args?.$queryName}.variables.${key}`, + value: props.variables[key] || "" + }) + }) + let request: QueryExecuteRequest = { path: props.applicationPath, params: [ diff --git a/client/packages/lowcoder/src/comps/uiCompRegistry.ts b/client/packages/lowcoder/src/comps/uiCompRegistry.ts index fb766807a..4c320de47 100644 --- a/client/packages/lowcoder/src/comps/uiCompRegistry.ts +++ b/client/packages/lowcoder/src/comps/uiCompRegistry.ts @@ -33,6 +33,7 @@ export const uiCompCategoryNames = { itemHandling: trans("uiCompCategory.itemHandling"), multimedia: trans("uiCompCategory.multimedia"), integration: trans("uiCompCategory.integration"), + legacy: trans("uiCompCategory.legacy"), }; export type UICompCategory = keyof typeof uiCompCategoryNames; @@ -149,6 +150,10 @@ export type UICompType = | "responsiveLayout" | "splitLayout" | "tour" + | "barChart" + | "lineChart" + | "pieChart" + | "scatterChart" | "funnelChart" | "gaugeChart" | "sankeyChart" diff --git a/client/packages/lowcoder/src/comps/utils/useCompInstance.tsx b/client/packages/lowcoder/src/comps/utils/useCompInstance.tsx index 812ae7389..c15e7c0db 100644 --- a/client/packages/lowcoder/src/comps/utils/useCompInstance.tsx +++ b/client/packages/lowcoder/src/comps/utils/useCompInstance.tsx @@ -304,11 +304,11 @@ export function useCompInstance<T extends CompConstructor>( let updateHandler = () => setComp(container.comp); - if (UPDATE_ROOT_VIEW_DEBOUNCE > 0) { + // if (UPDATE_ROOT_VIEW_DEBOUNCE > 0) { updateHandler = debounce(() => { setComp(container.comp); - }, UPDATE_ROOT_VIEW_DEBOUNCE); - } + }, 50 /* UPDATE_ROOT_VIEW_DEBOUNCE */); + // } const finalHandlers = [...(handlers || []), updateHandler]; finalHandlers.forEach((handler) => container.addChangeListener(handler)); diff --git a/client/packages/lowcoder/src/i18n/locales/de.ts b/client/packages/lowcoder/src/i18n/locales/de.ts index d6f234f61..33c894090 100644 --- a/client/packages/lowcoder/src/i18n/locales/de.ts +++ b/client/packages/lowcoder/src/i18n/locales/de.ts @@ -989,6 +989,7 @@ export const de = { "itemHandling": "Handhabung von Inventar", "multimedia": "Multimedia und Animation", "integration": "Integration & Erweiterung", + "legacy" : "Älter & Auslaufend" }, "uiComp": { ...en.uiComp, diff --git a/client/packages/lowcoder/src/i18n/locales/en.ts b/client/packages/lowcoder/src/i18n/locales/en.ts index 48d4cbdc4..735b797d4 100644 --- a/client/packages/lowcoder/src/i18n/locales/en.ts +++ b/client/packages/lowcoder/src/i18n/locales/en.ts @@ -979,7 +979,8 @@ export const en = { "documents": "Document & File Management", "itemHandling": "Item & Signature Handling", "multimedia": "Multimedia & Animation", - "integration": "Integration & Extension" + "integration": "Integration & Extension", + "legacy" : "Legacy & Deprecated" }, "uiComp": { "autoCompleteCompName": "Auto Complete", @@ -1210,7 +1211,7 @@ export const en = { "drawerCompDesc": "A sliding panel component that can be used for additional navigation or content display, typically emerging from the edge of the screen.", "drawerCompKeywords": "drawer, sliding, panel, navigation", - "chartCompName": "Chart", + "chartCompName": "Chart (deprecated)", "chartCompDesc": "A versatile component for visualizing data through various types of charts and graphs.", "chartCompKeywords": "chart, graph, data, visualization", @@ -1334,7 +1335,7 @@ export const en = { "themeriverChartCompDesc": "A visualization resembling a stream graph that shows changes in a data set over time across categories.", "themeriverChartCompKeywords": "theme river, time series, trends", - "basicChartCompName": "Basic Chart", + "basicChartCompName": "Multitype Chart", "basicChartCompDesc": "A versatile component for visualizing data through various types of charts and graphs.", "basicChartCompKeywords": "chart, graph, data, visualization", @@ -1350,6 +1351,22 @@ export const en = { "kanbanCompDesc" : "A board for visualizing workflow, with columns representing stages of work and cards representing tasks.", "kanbanCompKeywords" : "kanban, board, workflow, tasks", + "pieChartCompName": "Pie Chart", + "pieChartCompDesc": "A versatile component for visualizing data with Pie Charts.", + "pieChartCompKeywords": "chart, data, visualization", + + "lineChartCompName": "Line Chart", + "lineChartCompDesc": "A versatile component for visualizing data with Line Charts.", + "lineChartCompKeywords": "chart, data, visualization", + + "barChartCompName": "Bar Chart", + "barChartCompDesc": "A versatile component for visualizing data with Bar Charts.", + "barChartCompKeywords": "chart, data, visualization", + + "scatterChartCompName": "Scatter Chart", + "scatterChartCompDesc": "A versatile component for visualizing data with Scatter Charts.", + "scatterChartCompKeywords": "chart, data, visualization", + // by mousheng "colorPickerCompName": "Color Picker", @@ -2029,6 +2046,7 @@ export const en = { "tag": "Tag", "select": "Select", "dropdown": "Dropdown", + "time" : "Time", "date": "Date", "dateTime": "Date Time", "badgeStatus": "Status", @@ -2629,6 +2647,7 @@ export const en = { "copyToClipboard": "Copy to Clipboard", "downloadFile": "Download File", "logoutUser" : "Logout User", + "resetPassword" : "Reset Password", }, "messageComp": { "info": "Send a Notification", @@ -3376,6 +3395,7 @@ export const en = { }, "support" : { + "selfUser" : "You", "supportTitle": "Lowcoder Support", "supportContent": "If you have any questions or need help, please use the ticket system get your issue solved fast.", "newSupportTicket": "New Support Ticket", diff --git a/client/packages/lowcoder/src/index.sdk.ts b/client/packages/lowcoder/src/index.sdk.ts index db8d14daa..b51d016e3 100644 --- a/client/packages/lowcoder/src/index.sdk.ts +++ b/client/packages/lowcoder/src/index.sdk.ts @@ -105,6 +105,7 @@ export * from "comps/controls/stringSimpleControl"; export * from "comps/controls/styleControl"; export * from "comps/controls/styleControlConstants"; export * from "comps/controls/slotControl"; +export * from "comps/controls/sliderControl"; // generators export * from "comps/generators/changeDataType"; diff --git a/client/packages/lowcoder/src/layout/calculateUtils.tsx b/client/packages/lowcoder/src/layout/calculateUtils.tsx index 1d919bd1b..44a661e00 100644 --- a/client/packages/lowcoder/src/layout/calculateUtils.tsx +++ b/client/packages/lowcoder/src/layout/calculateUtils.tsx @@ -93,7 +93,6 @@ export function calcGridItemSizePx( const width = calcGridItemWHPx(w, colWidth, margin[0], false); const isTouchSBound = top ? isTouchBound(maxRows, rowHeight, h, top) : false; - // console.log('positionParams',positionParams); const height = calcGridItemWHPx(h, rowHeight, margin[1], isTouchSBound); return { width, height }; } diff --git a/client/packages/lowcoder/src/layout/compSelectionWrapper.tsx b/client/packages/lowcoder/src/layout/compSelectionWrapper.tsx index 4b347907e..d9eb475d4 100644 --- a/client/packages/lowcoder/src/layout/compSelectionWrapper.tsx +++ b/client/packages/lowcoder/src/layout/compSelectionWrapper.tsx @@ -11,6 +11,7 @@ import React, { MouseEventHandler, useCallback, useContext, + useMemo, useRef, useState, } from "react"; @@ -18,7 +19,8 @@ import ReactResizeDetector, { useResizeDetector } from "react-resize-detector"; import styled, { css } from "styled-components"; import { EllipsisTextCss } from "lowcoder-design"; import { draggingUtils } from "./draggingUtils"; -import { ResizeHandleAxis } from "./gridLayoutPropTypes"; +import type { ResizeHandleAxis } from "./gridLayoutPropTypes"; +import { isEqual } from "lodash"; export type DragHandleName = "w" | "e" | "nw" | "ne" | "sw" | "se"; type NamePos = "top" | "bottom" | "bottomInside"; @@ -273,7 +275,7 @@ export const CompSelectionWrapper = React.memo((props: { } setHover(true); }, - [setHover] + [nameDivRef.current, setHover] ); const onMouseOut = useCallback( (e: MouseEvent<HTMLDivElement>) => { @@ -287,42 +289,61 @@ export const CompSelectionWrapper = React.memo((props: { } setHover(false); }, - [setHover] + [nameDivRef.current, setHover] ); - const selectableDivProps = props.isSelectable - ? { - onMouseOver, - onMouseOut, - onClick: props.onClick, - $hover: hover || undefined, - $showDashLine: editorState.showGridLines() || props.hidden, - $isSelected: props.isSelected, - $isHidden: props.hidden, - } - : { - $hover: undefined, - $showDashLine: false, - $isSelected: false, - $isHidden: false, - }; + const selectableDivProps = useMemo(() => { + return props.isSelectable + ? { + onMouseOver, + onMouseOut, + onClick: props.onClick, + $hover: hover || undefined, + $showDashLine: editorState.showGridLines() || props.hidden, + $isSelected: props.isSelected, + $isHidden: props.hidden, + } + : { + $hover: undefined, + $showDashLine: false, + $isSelected: false, + $isHidden: false, + }; + }, [ + hover, + props.hidden, + props.isSelected, + props.isSelectable, + ]); + + const zIndex = useMemo(() => { + return props.isSelected + ? Layers.compSelected + : hover + ? Layers.compHover + : props.hidden + ? Layers.compHidden + : undefined; + }, [ + hover, + props.hidden, + props.isSelected + ]); - const zIndex = props.isSelected - ? Layers.compSelected - : hover - ? Layers.compHover - : props.hidden - ? Layers.compHidden - : undefined; + const needResizeDetector = useMemo(() => { + return props.autoHeight && !props.placeholder; + }, [props.autoHeight, props.placeholder]); - const needResizeDetector = props.autoHeight && !props.placeholder; const { ref: wrapperRef } = useResizeDetector({ onResize: props.onWrapperResize, handleHeight: needResizeDetector, handleWidth: false, + refreshMode: 'debounce', + refreshRate: 100, }); // log.debug("CompSelectionWrapper. name: ", props.name, " zIndex: ", zIndex); const { nameConfig, resizeIconSize } = props; + return ( <div id={props.id} style={{ ...props.style, zIndex }} className={props.className}> <SelectableDiv @@ -369,8 +390,18 @@ export const CompSelectionWrapper = React.memo((props: { {!needResizeDetector && props.children} {needResizeDetector && ( <ReactResizeDetector + skipOnMount={ + props.compType === 'responsiveLayout' + || props.compType === 'columnLayout' + || props.compType === 'pageLayout' + || props.compType === 'splitLayout' + || props.compType === 'floatTextContainer' + || props.compType === 'tabbedContainer' + || props.compType === 'collapsibleContainer' + || props.compType === 'container' + } refreshMode="debounce" - refreshRate={250} + refreshRate={0} onResize={props.onInnerResize} observerOptions={{ box: "border-box" }} > @@ -380,4 +411,4 @@ export const CompSelectionWrapper = React.memo((props: { </SelectableDiv> </div> ); -}); +}, (prev, next) => isEqual(prev, next)); diff --git a/client/packages/lowcoder/src/layout/gridItem.tsx b/client/packages/lowcoder/src/layout/gridItem.tsx index 963c1c056..3594f3acd 100644 --- a/client/packages/lowcoder/src/layout/gridItem.tsx +++ b/client/packages/lowcoder/src/layout/gridItem.tsx @@ -113,8 +113,8 @@ export const GridItem = React.memo((props: GridItemProps) => { maxRows: props.maxRows, }, props.x, props.y, props.w, props.h)}, [ - props.margin, - props.containerPadding, + JSON.stringify(props.margin), + JSON.stringify(props.containerPadding), props.containerWidth, props.cols, props.rowHeight, @@ -123,7 +123,6 @@ export const GridItem = React.memo((props: GridItemProps) => { props.y, props.w, props.h, - calcGridItemPosition, ] ); @@ -230,8 +229,8 @@ export const GridItem = React.memo((props: GridItemProps) => { y: yy, }); }, [ - resizing, - dragging, + JSON.stringify(resizing), + JSON.stringify(dragging), props.cols, props.maxRows, props.x, @@ -417,7 +416,7 @@ export const GridItem = React.memo((props: GridItemProps) => { itemHeightRef.current = height; } adjustWrapperHeight(width, height); - }, [itemHeightRef, adjustWrapperHeight]); + }, [itemHeightRef.current, adjustWrapperHeight]); /** * re-calculate the occupied gird-cells. @@ -427,7 +426,7 @@ export const GridItem = React.memo((props: GridItemProps) => { */ const onWrapperSizeChange = useCallback(() => { adjustWrapperHeight(undefined, itemHeightRef.current); - }, [itemHeightRef, adjustWrapperHeight]); + }, [itemHeightRef.current, adjustWrapperHeight]); const mixinChildWrapper = useCallback((child: React.ReactElement): React.ReactElement => { const { @@ -535,6 +534,21 @@ export const GridItem = React.memo((props: GridItemProps) => { const pos = useMemo(calcPosition, [calcPosition]); + const transform = useMemo(() => { + return setTransform( + pos, + props.name, + props.autoHeight, + props.hidden, + Boolean(draggingUtils.isDragging()) + ) + }, [ + JSON.stringify(pos), + props.name, + props.autoHeight, + props.hidden + ]); + const render = useMemo(() => { let child = React.Children.only(children); // Create the child element. We clone the existing element but modify its className and style. @@ -563,13 +577,7 @@ export const GridItem = React.memo((props: GridItemProps) => { cssTransforms: true, }), style: { - ...setTransform( - pos, - props.name, - props.autoHeight, - props.hidden, - Boolean(draggingUtils.isDragging()) - ), + ...transform, opacity: layoutHide ? 0 : undefined, pointerEvents: layoutHide ? "none" : "auto", }, @@ -580,11 +588,12 @@ export const GridItem = React.memo((props: GridItemProps) => { newChild = mixinDraggable(newChild, isDraggable); return newChild; }, [ - pos, + JSON.stringify(transform), + JSON.stringify(pos), children, elementRef, - resizing, - dragging, + Boolean(resizing), + Boolean(dragging), isDraggable, layoutHide, zIndex, @@ -593,8 +602,6 @@ export const GridItem = React.memo((props: GridItemProps) => { props.className, props.style, props.static, - props.autoHeight, - props.hidden, setTransform, mixinChildWrapper, mixinResizable, diff --git a/client/packages/lowcoder/src/layout/gridLayout.tsx b/client/packages/lowcoder/src/layout/gridLayout.tsx index 0b88786c2..0b25763b7 100644 --- a/client/packages/lowcoder/src/layout/gridLayout.tsx +++ b/client/packages/lowcoder/src/layout/gridLayout.tsx @@ -1,8 +1,8 @@ import clsx from "clsx"; import { colord } from "colord"; -import { UICompType } from "comps/uiCompRegistry"; +import type { UICompType } from "comps/uiCompRegistry"; import { ModulePrimaryColor, PrimaryColor } from "constants/style"; -import _ from "lodash"; +import _, { isEqual } from "lodash"; import log from "loglevel"; import React, { DragEvent, DragEventHandler, MouseEventHandler, ReactElement } from "react"; import ReactResizeDetector from "react-resize-detector"; @@ -21,7 +21,7 @@ import { import { draggingUtils } from "./draggingUtils"; import { FlyOverInfo, FlyStartInfo } from "./flyInfo"; import { GridItem } from "./gridItem"; -import { GridLayoutProps } from "./gridLayoutPropTypes"; +import type { GridLayoutProps } from "./gridLayoutPropTypes"; import { GridLines } from "./gridLines"; import { changeItemOp, deleteItemOp, LayoutOp, renameItemOp } from "./layoutOp"; import { getUILayout, LayoutOps, layoutOpUtils } from "./layoutOpUtils"; @@ -1102,7 +1102,7 @@ const LayoutContainer = styled.div<{ }`} `; -export const ReactGridLayout = React.memo(GridLayout); +export const ReactGridLayout = React.memo(GridLayout, (prev, next) => isEqual(prev, next)); function moveOrResize( e: React.KeyboardEvent, diff --git a/client/packages/lowcoder/src/layout/gridLines.tsx b/client/packages/lowcoder/src/layout/gridLines.tsx index c7cfc1366..33b5eefec 100644 --- a/client/packages/lowcoder/src/layout/gridLines.tsx +++ b/client/packages/lowcoder/src/layout/gridLines.tsx @@ -1,6 +1,7 @@ import { CSSProperties } from "react"; import { calcGridColWidth, PositionParams } from "./calculateUtils"; import { Position, setTransform } from "./utils"; +import React from "react"; interface GridLineProps { position: Position; @@ -19,10 +20,10 @@ function setBackgroundProps(positionParams: PositionParams, lineColor: string): }; } -export function GridLines(props: GridLineProps) { +export const GridLines = React.memo((props: GridLineProps) => { const style = { ...setTransform(props.position), ...setBackgroundProps(props.positionParams, props.lineColor), }; return <div style={style} />; -} +}) diff --git a/client/packages/lowcoder/src/pages/ApplicationV2/components/CreateApiKeyModal.tsx b/client/packages/lowcoder/src/pages/ApplicationV2/components/CreateApiKeyModal.tsx index 0a174c0c5..4a2d48508 100644 --- a/client/packages/lowcoder/src/pages/ApplicationV2/components/CreateApiKeyModal.tsx +++ b/client/packages/lowcoder/src/pages/ApplicationV2/components/CreateApiKeyModal.tsx @@ -134,6 +134,8 @@ function CreateApiKeyModal(props: CreateApiKeyModalProps) { width="500px" title={"Create API Key"} open={modalVisible} + showOkButton + showCancelButton okText={"Save"} okButtonProps={{ loading: saveLoading diff --git a/client/packages/lowcoder/src/pages/ApplicationV2/index.tsx b/client/packages/lowcoder/src/pages/ApplicationV2/index.tsx index ccbdf1a78..71c13d039 100644 --- a/client/packages/lowcoder/src/pages/ApplicationV2/index.tsx +++ b/client/packages/lowcoder/src/pages/ApplicationV2/index.tsx @@ -10,6 +10,7 @@ import { TRASH_URL, NEWS_URL, ORG_HOME_URL, + SUBSCRIPTION_SETTING, } from "constants/routesURL"; import { getUser, isFetchingUser } from "redux/selectors/usersSelectors"; import { useDispatch, useSelector } from "react-redux"; @@ -57,6 +58,7 @@ import { trans } from "../../i18n"; import { foldersSelector } from "../../redux/selectors/folderSelector"; import Setting from "pages/setting"; import { Support } from "pages/support"; +import { Subscription } from "pages/setting/subscriptions" // import { TypographyText } from "../../components/TypographyText"; // import { messageInstance } from "lowcoder-design/src/components/GlobalInstances"; import { isEE } from "util/envUtils"; @@ -248,6 +250,19 @@ export default function ApplicationHome() { ], } : { items: [] }, + !supportSubscription && user.orgDev ? { + items: [ + { + text: <TabLabel>{trans("home.support")}</TabLabel>, + routePath: SUBSCRIPTION_SETTING, + routeComp: Subscription, + routePathExact: false, + icon: ({ selected, ...otherProps }) => selected ? <SupportIcon {...otherProps} width={"24px"}/> : <SupportIcon {...otherProps} width={"24px"}/>, + mobileVisible: true, + }, + ], + } : { items: [] }, + supportSubscription && user.orgDev ? { items: [ { diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ButtonComp/Button.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ButtonComp/Button.tsx index 115ea9122..a68074d32 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ButtonComp/Button.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ButtonComp/Button.tsx @@ -28,6 +28,24 @@ export default function ButtonExample() { config={{ type: "default", text: trans("componentDoc.submit"), disabled: true }} compFactory={ButtonComp} /> + <Example + title="Hiding the Button component" + width={120} + config={{ type: "default", text: trans("componentDoc.submit"), hidden: true }} + compFactory={ButtonComp} + /> + <Example + title="Prefix Icon" + width={120} + config={{ type: "default", text: trans("componentDoc.submit"), prefixIcon: "/icon:solid/book", }} + compFactory={ButtonComp} + /> + <Example + title="Suffix Icon" + width={120} + config={{ type: "default", text: trans("componentDoc.submit"), suffixIcon : "/icon:solid/book-open-reader", }} + compFactory={ButtonComp} + /> </ExampleGroup> <ExampleGroup title={trans("componentDoc.style")}> @@ -55,6 +73,28 @@ export default function ButtonExample() { }} compFactory={ButtonComp} /> + <Example + title="Custom Styling" + width={180} + config={{ + style: { + "background": "linear-gradient(90deg, #fa709a 0%, #fee140 100%)", + "padding": "10px", + "text": "#222222", + "textTransform": "Uppercase", + "textDecoration": "underline", + "textSize": "16px", + "textWeight": "bold", + "fontFamily": "Courier New", + "fontStyle": "italic", + "border": "#222222", + "borderStyle": "solid", + "radius": "10px", + "borderWidth": "2px" + }, + }} + compFactory={ButtonComp} + /> </ExampleGroup> </> ); diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ButtonComp/DropDownButton.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ButtonComp/DropDownButton.tsx index 57bb20afe..2986d3336 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ButtonComp/DropDownButton.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ButtonComp/DropDownButton.tsx @@ -32,9 +32,11 @@ export default function DropdownExample() { }; return ( <> + <ExampleGroup title={trans("componentDoc.basicUsage")} - description={trans("componentDoc.basicDemoDescription")} + description="The Following Examples Show the Basic Usage of the Dropdown Component." + > <Example title={trans("componentDoc.default")} @@ -55,14 +57,99 @@ export default function DropdownExample() { blackListConfig={blackListConfig} compFactory={DropdownComp} /> + <Example + title="Hiding the Dropdown component" + width={120} + config={{ + type: "default", + text: trans("componentDoc.menu"), + hidden: true, + options: options, + }} + blackListConfig={blackListConfig} + compFactory={DropdownComp} + /> </ExampleGroup> - <ExampleGroup title={trans("componentDoc.style")}> + <ExampleGroup + title="Layout" + description="The Following Examples Show the Layout options of the Dropdown Component." + > + <Example + title="Display Dropdown without the Dots" + width={120} + config={{ + onlyMenu: true, + }} + compFactory={DropdownComp} + /> + <Example + title="Show Dropdown options on Hover" + width={120} + config={{ + onlyMenu: true, + triggerMode: "hover", + }} + compFactory={DropdownComp} + /> <Example - title={trans("componentDoc.onlyMenu")} + title="Show Dropdown options on Click" width={120} config={{ onlyMenu: true, + triggerMode: "click", + }} + compFactory={DropdownComp} + /> + </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the different Styling properties on the Dropdown Component." + > + <Example + title="Background Color" + width={120} + config={{ + style:{ + "background": "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + }, + }} + compFactory={DropdownComp} + /> + <Example + title="Margin & Padding" + width={120} + config={{ + style:{ + "background": "linear-gradient(135deg, #00FFFF 0%, #00FFFF 100%)", + "margin": "10px", + "padding": "10px", + }, + }} + compFactory={DropdownComp} + /> + <Example + title="Border Radius" + width={120} + config={{ + style:{ + "background": "linear-gradient(135deg, #00FFFF 0%, #00FFFF 100%)", + "radius": "15px" + }, + }} + compFactory={DropdownComp} + /> + <Example + title="Text Properties" + width={120} + config={{ + style:{ + "text": "#E67373", + "textSize": "25px", + "textWeight": "bold", + "fontStyle": "italic", + }, }} compFactory={DropdownComp} /> diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ButtonComp/FloatButton.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ButtonComp/FloatButton.tsx index 252e3d782..df7351b7a 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ButtonComp/FloatButton.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ButtonComp/FloatButton.tsx @@ -31,6 +31,7 @@ export default function FloatButtonExample() { > <Example title="A Simple Float Button" + height={150} config={{ buttons: buttons, }} @@ -38,6 +39,7 @@ export default function FloatButtonExample() { /> <Example title="Hiding the Float Button" + height={150} config={{ buttons: buttons, hidden: true, @@ -46,6 +48,7 @@ export default function FloatButtonExample() { /> <Example title="Different Icon on Float Button" + height={150} config={{ buttons: buttons, icon: "/icon:solid/align-justify", @@ -54,6 +57,7 @@ export default function FloatButtonExample() { /> <Example title="Button Theme - Default" + height={150} config={{ buttons: buttons, buttonTheme: "default", @@ -66,12 +70,107 @@ export default function FloatButtonExample() { /> <Example title="Button Shape - Square" + height={150} config={{ buttons: buttons, shape: "square", }} compFactory={FloatButtonComp} /> + <Example + title="Show Badge - True" + height={150} + config={{ + buttons: buttons, + dot: true, + }} + compFactory={FloatButtonComp} + /> + <Example + title="Show Badge - False" + height={150} + config={{ + buttons: buttons, + }} + compFactory={FloatButtonComp} + /> + </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the different Styling properties of the Float Button Component." + > + <Example + title="Badge Color" + height={150} + config={{ + buttons: buttons, + dot: true, + badgeStyle: { + "badgeColor": "#E68E50", + }, + }} + compFactory={FloatButtonComp} + /> + <Example + title="Styling properties" + height={150} + config={{ + buttons: buttons, + style: { + "background": "linear-gradient(90deg, #fa709a 0%, #fee140 100%)", + "border": "#3377FF", + "borderStyle": "dashed", + "borderWidth": "3px" + }, + }} + compFactory={FloatButtonComp} + /> + </ExampleGroup> + + <ExampleGroup + title="Animation Style" + description="The Following Examples Show different animations on the Float Button Component." + > + <Example + title="Bounce Animation" + height={150} + config={{ + animationStyle: { + "animation": "bounce", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={FloatButtonComp} + /> + <Example + title="Swing Animation" + height={150} + config={{ + animationStyle: { + "animation": "swing", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={FloatButtonComp} + /> + <Example + title="Tada Animation" + height={150} + config={{ + animationStyle: { + "animation": "tada", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={FloatButtonComp} + /> </ExampleGroup> </> diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ButtonComp/IconButton.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ButtonComp/IconButton.tsx index 67a3fad0d..e5eb0784f 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ButtonComp/IconButton.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ButtonComp/IconButton.tsx @@ -90,6 +90,7 @@ export default function IconButtonExample() { <Example title="Icon Size - 30px" width={120} + height={50} config={{ prefixIcon: "/icon:antd/audiofilled", iconSize: "30px", @@ -103,6 +104,7 @@ export default function IconButtonExample() { <Example title="Icon Size - 40px" width={120} + height={60} config={{ prefixIcon: "/icon:antd/audiofilled", iconSize: "40px", @@ -113,6 +115,30 @@ export default function IconButtonExample() { }} compFactory={ControlButton} /> + <Example + title="Custom Styling" + width={120} + height={50} + config={{ + prefixIcon: "/icon:antd/audiofilled", + style: { + "background": "linear-gradient(90deg, #fa709a 0%, #fee140 100%)", + "padding": "10px", + "text": "#222222", + "textTransform": "Uppercase", + "textDecoration": "underline", + "textSize": "16px", + "textWeight": "bold", + "fontFamily": "Courier New", + "fontStyle": "italic", + "border": "#222222", + "borderStyle": "solid", + "radius": "10px", + "borderWidth": "2px" + }, + }} + compFactory={ControlButton} + /> </ExampleGroup> </> ); diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ButtonComp/ToggleButton.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ButtonComp/ToggleButton.tsx index e9e65cf74..00fef73f9 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ButtonComp/ToggleButton.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ButtonComp/ToggleButton.tsx @@ -36,9 +36,18 @@ export default function ToggleButtonExample() { }} compFactory={ToggleButtonComp} /> + <Example + title="Hiding the Toggle Button" + width={120} + config={{ + text: trans("componentDoc.submit"), + hidden: true + }} + compFactory={ToggleButtonComp} + /> </ExampleGroup> - <ExampleGroup title="Advanced"> + <ExampleGroup title="Advanced Usage"> <Example title="Hide Text" width={120} @@ -104,6 +113,74 @@ export default function ToggleButtonExample() { }} compFactory={ToggleButtonComp} /> + <Example + title="Custom Styling" + width={180} + config={{ + text: trans("componentDoc.submit"), + style: { + "background": "linear-gradient(90deg, #fa709a 0%, #fee140 100%)", + "padding": "10px", + "text": "#222222", + "textTransform": "Uppercase", + "textDecoration": "underline", + "textSize": "16px", + "textWeight": "bold", + "fontFamily": "Courier New", + "fontStyle": "italic", + "border": "#222222", + "borderStyle": "solid", + "radius": "10px", + "borderWidth": "2px" + }, + }} + compFactory={ToggleButtonComp} + /> + </ExampleGroup> + + <ExampleGroup + title="Animation Style" + description="The Following Examples Show different animations on the Toggle Button Component." + > + <Example + title="Bounce Animation" + width={120} + config={{ + animationStyle: { + "animation": "bounce", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={ToggleButtonComp} + /> + <Example + title="Swing Animation" + width={120} + config={{ + animationStyle: { + "animation": "swing", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={ToggleButtonComp} + /> + <Example + title="Tada Animation" + width={120} + config={{ + animationStyle: { + "animation": "tada", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={ToggleButtonComp} + /> </ExampleGroup> </> ); diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/CalendarInputComp/Calendar.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/CalendarInputComp/Calendar.tsx index 6370df675..22375e860 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/CalendarInputComp/Calendar.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/CalendarInputComp/Calendar.tsx @@ -11,14 +11,163 @@ export default function CalendarExample() { <> <ExampleGroup title={trans("componentDoc.basicUsage")} - description={trans("componentDoc.basicDemoDescription")} + description="The Following Examples Show the Basic Usage of the Calendar Component." > <Example - title={trans("componentDoc.default")} + title="Default Calendar" + width={700} + height={600} config={{ }} compFactory={ChartCompWithDefault} /> + <Example + title="Hiding the Calendar component" + width={700} + height={600} + config={{ + hidden: true, + }} + compFactory={ChartCompWithDefault} + /> + </ExampleGroup> + + <ExampleGroup + title="Advanced Options" + description="The Following Examples Show the Advance usage/options of the Calendar Component." + > + <Example + title="Editable - Double Click on a slot to add the Event" + width={700} + height={600} + config={{ + editable: true, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Hiding Event Times" + width={700} + height={600} + config={{ + showEventTime: false, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Hiding Weekends" + width={700} + height={600} + config={{ + showWeekends: false, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Hiding All Day Option" + width={700} + height={600} + config={{ + showAllDay: false, + }} + compFactory={ChartCompWithDefault} + /> + </ExampleGroup> + + <ExampleGroup + title="Layout" + description="The Following Examples Show different Layout options of the Calendar Component." + > + <Example + title="Initial Calendar View - Year" + width={700} + height={600} + config={{ + currentFreeView: "multiMonthYear", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Initial Calendar View - Month" + width={700} + height={600} + config={{ + currentFreeView: "dayGridMonth", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Initial Calendar View - Week" + width={700} + height={600} + config={{ + currentFreeView: "timeGridWeek", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Initial Calendar View - Week" + width={700} + height={600} + config={{ + currentFreeView: "dayGridWeek", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Initial Calendar View - Day Event List" + width={700} + height={600} + config={{ + currentFreeView: "dayGridDay", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Initial Calendar View - Time Event List" + width={700} + height={600} + config={{ + currentFreeView: "timeGridDay", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Initial Calendar View - Event List" + width={700} + height={600} + config={{ + currentFreeView: "listWeek", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Start From - Saturday" + width={700} + height={600} + config={{ + firstDay: 6, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Start From - Monday" + width={700} + height={600} + config={{ + firstDay: 1, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Show Vertical ScrollBar" + width={700} + height={600} + config={{ + showVerticalScrollbar: true, + }} + compFactory={ChartCompWithDefault} + /> </ExampleGroup> </> ); diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/CalendarInputComp/Date.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/CalendarInputComp/Date.tsx index c58a54332..b146a2f4b 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/CalendarInputComp/Date.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/CalendarInputComp/Date.tsx @@ -53,6 +53,67 @@ export default function DateExample() { /> </ExampleGroup> + <ExampleGroup + title="Date Component - Picker mode" + description="The Following Examples Show the different picker modes of the Date Component." + > + <Example + title="Picker mode - Date" + config={{ + pickerMode: "day", + label: { + text: trans("componentDoc.date"), + }, + }} + blackListConfig={blackListConfig} + compFactory={DatePickerComp} + /> + <Example + title="Picker mode - Week" + config={{ + pickerMode: "week", + label: { + text: trans("componentDoc.date"), + }, + }} + blackListConfig={blackListConfig} + compFactory={DatePickerComp} + /> + <Example + title="Picker mode - Month" + config={{ + pickerMode: "month", + label: { + text: trans("componentDoc.date"), + }, + }} + blackListConfig={blackListConfig} + compFactory={DatePickerComp} + /> + <Example + title="Picker mode - Quarter" + config={{ + pickerMode: "quarter", + label: { + text: trans("componentDoc.date"), + }, + }} + blackListConfig={blackListConfig} + compFactory={DatePickerComp} + /> + <Example + title="Picker mode - Year" + config={{ + pickerMode: "year", + label: { + text: trans("componentDoc.date"), + }, + }} + blackListConfig={blackListConfig} + compFactory={DatePickerComp} + /> + </ExampleGroup> + <ExampleGroup title={trans("componentDoc.labelText")} description=""> <Example title={trans("componentDoc.leftLeftAlign")} @@ -130,6 +191,238 @@ export default function DateExample() { compFactory={DatePickerComp} /> </ExampleGroup> + + <ExampleGroup + title="Advance Usage" + description="The Following Examples Show the Advance Usage of the Date Component." + > + <Example + title="Show Time alongwith Calendar" + config={{ + showTime: true, + label: { + text: trans("componentDoc.date"), + }, + }} + blackListConfig={blackListConfig} + compFactory={DatePickerComp} + /> + <Example + title="Show Time in 12 Hours format" + config={{ + showTime: true, + use12Hours: true, + label: { + text: trans("componentDoc.date"), + }, + }} + blackListConfig={blackListConfig} + compFactory={DatePickerComp} + /> + <Example + title="Date Input Format : DD-MM-YYYY" + config={{ + inputFormat: "DD-MM-YYYY", + label: { + text: trans("componentDoc.date"), + }, + }} + blackListConfig={blackListConfig} + compFactory={DatePickerComp} + /> + <Example + title="Time Input Format : MM-DD-YYYY" + config={{ + inputFormat: "MM-DD-YYYY", + label: { + text: trans("componentDoc.date"), + }, + }} + blackListConfig={blackListConfig} + compFactory={DatePickerComp} + /> + <Example + title="Time Input Format : YYYY-MM-DD" + config={{ + inputFormat: "YYYY-MM-DD", + label: { + text: trans("componentDoc.date"), + }, + }} + blackListConfig={blackListConfig} + compFactory={DatePickerComp} + /> + <Example + title="Time Input Format : MM-YYYY" + config={{ + inputFormat: "MM-YYYY", + label: { + text: trans("componentDoc.date"), + }, + }} + blackListConfig={blackListConfig} + compFactory={DatePickerComp} + /> + <Example + title="Suffix Icon on Calendar component" + config={{ + suffixIcon: "/icon:regular/calendar-days", + label: { + text: trans("componentDoc.date"), + }, + }} + blackListConfig={blackListConfig} + compFactory={DatePickerComp} + /> + </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the different Styling properties of the Time Component." + > + <Example + title="Time component Styling properties" + config={{ + label: { + text: trans("componentDoc.date"), + }, + style: { + "background": "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + "margin": "10px", + "padding": "10px", + "text": "#222222", + "textSize": "20px", + "textWeight": "bold", + "fontStyle": "italic", + "border": "#222222", + "borderStyle": "solid", + "radius": "10px", + "borderWidth": "2px", + }, + }} + compFactory={DatePickerComp} + /> + <Example + title="Label Styling properties" + config={{ + label: { + text: trans("componentDoc.date"), + }, + labelStyle: { + "margin": "5px", + "padding": "5px", + "label": "#01865B", + "textTransform": "Uppercase", + "textDecoration": "underline", + "textSize": "18px", + "textWeight": "bold", + "fontStyle": "italic", + "border": "#222222", + "borderWidth": "2px", + "borderStyle": "solid", + }, + }} + compFactory={DatePickerComp} + /> + <Example + title="Input Field Styling properties" + config={{ + label: { + text: trans("componentDoc.date"), + }, + inputFieldStyle: { + "background": "linear-gradient(45deg, #d53369 0%, #daae51 100%)", + "border": "#222222", + "radius": "10px", + "text": "#222222", + "margin": "5px", + "padding": "10px", + "borderStyle": "dashed", + "borderWidth": "3px", + "accent": "#36B389" + }, + }} + compFactory={DatePickerComp} + /> + <Example + title="Children Input Field Styling properties" + config={{ + label: { + text: trans("componentDoc.date"), + }, + childrenInputFieldStyle: { + "margin": "5px", + "padding": "20px", + "text": "#3377FF", + "textDecoration": "underline", + "textSize": "15px", + "textWeight": "bold", + "fontFamily": "Courier New", + "fontStyle": "italic", + "border": "#36B389", + "borderStyle": "solid", + "radius": "10px", + "borderWidth": "3px", + "background": "#11F7E9" + }, + }} + compFactory={DatePickerComp} + /> + </ExampleGroup> + + <ExampleGroup + title="Animation Style" + description="The Following Examples Show different Animation Styles on the Time Component." + > + <Example + title="Bounce Animation" + config={{ + showInfo: true, + label: { + text: trans("componentDoc.date"), + }, + animationStyle: { + "animation": "bounce", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={DatePickerComp} + /> + <Example + title="Swing Animation" + config={{ + label: { + text: trans("componentDoc.date"), + }, + showInfo: true, + animationStyle: { + "animation": "swing", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={DatePickerComp} + /> + <Example + title="Tada Animation" + config={{ + label: { + text: trans("componentDoc.date"), + }, + showInfo: true, + animationStyle: { + "animation": "tada", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={DatePickerComp} + /> + </ExampleGroup> </> ); } diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/CalendarInputComp/DateRange.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/CalendarInputComp/DateRange.tsx index ff2821dcb..b287c7bba 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/CalendarInputComp/DateRange.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/CalendarInputComp/DateRange.tsx @@ -23,6 +23,7 @@ export default function DateRangeExample() { > <Example title={trans("componentDoc.value")} + width={500} config={{ start: "2022-01-01", end: "2022-02-01", @@ -40,6 +41,7 @@ export default function DateRangeExample() { /> <Example title={trans("componentDoc.noDefaultValue")} + width={500} config={{ value: trans("componentDoc.noValue"), format: "YYYY-MM-DD", @@ -56,6 +58,7 @@ export default function DateRangeExample() { /> <Example title={trans("componentDoc.disabled")} + width={500} config={{ start: "2022-01-01", end: "2022-02-01", @@ -73,6 +76,82 @@ export default function DateRangeExample() { /> </ExampleGroup> + <ExampleGroup + title="Date Component - Picker mode" + description="The Following Examples Show the different picker modes of the Date Range Component." + > + <Example + title="Picker mode - Date" + width={500} + config={{ + pickerMode: "day", + label: { + text: trans("componentDoc.date"), + position: "column", + align: "left", + }, + }} + blackListConfig={blackListConfig} + compFactory={DateRangeComp} + /> + <Example + title="Picker mode - Week" + width={500} + config={{ + pickerMode: "week", + label: { + text: trans("componentDoc.date"), + position: "column", + align: "left", + }, + }} + blackListConfig={blackListConfig} + compFactory={DateRangeComp} + /> + <Example + title="Picker mode - Month" + width={500} + config={{ + pickerMode: "month", + label: { + text: trans("componentDoc.date"), + position: "column", + align: "left", + }, + }} + blackListConfig={blackListConfig} + compFactory={DateRangeComp} + /> + <Example + title="Picker mode - Quarter" + width={500} + config={{ + pickerMode: "quarter", + label: { + text: trans("componentDoc.date"), + position: "column", + align: "left", + }, + }} + blackListConfig={blackListConfig} + compFactory={DateRangeComp} + /> + <Example + title="Picker mode - Year" + width={500} + config={{ + pickerMode: "year", + label: { + text: trans("componentDoc.date"), + position: "column", + align: "left", + }, + }} + blackListConfig={blackListConfig} + compFactory={DateRangeComp} + /> + </ExampleGroup> + <ExampleGroup title={trans("componentDoc.labelText")} description=""> <Example title={trans("componentDoc.leftLeftAlign")} @@ -198,6 +277,213 @@ export default function DateRangeExample() { compFactory={DateRangeComp} /> </ExampleGroup> + + <ExampleGroup + title="Advance Usage" + description="The Following Examples Show the Advance Usage of the Date Range Component." + > + <Example + title="Show Time alongwith Calendar" + width={500} + config={{ + showTime: true, + label: { + text: trans("componentDoc.date"), + position: "column", + align: "left", + }, + }} + blackListConfig={blackListConfig} + compFactory={DateRangeComp} + /> + <Example + title="Show Time in 12 Hours format" + width={500} + config={{ + showTime: true, + use12Hours: true, + label: { + text: trans("componentDoc.date"), + position: "column", + align: "left", + }, + }} + blackListConfig={blackListConfig} + compFactory={DateRangeComp} + /> + <Example + title="Date Input Format : DD-MM-YYYY" + width={500} + config={{ + inputFormat: "DD-MM-YYYY", + label: { + text: trans("componentDoc.date"), + position: "column", + align: "left", + }, + }} + blackListConfig={blackListConfig} + compFactory={DateRangeComp} + /> + <Example + title="Time Input Format : MM-DD-YYYY" + width={500} + config={{ + inputFormat: "MM-DD-YYYY", + label: { + text: trans("componentDoc.date"), + position: "column", + align: "left", + }, + }} + blackListConfig={blackListConfig} + compFactory={DateRangeComp} + /> + <Example + title="Time Input Format : YYYY-MM-DD" + width={500} + config={{ + inputFormat: "YYYY-MM-DD", + label: { + text: trans("componentDoc.date"), + position: "column", + align: "left", + }, + }} + blackListConfig={blackListConfig} + compFactory={DateRangeComp} + /> + <Example + title="Time Input Format : MM-YYYY" + width={500} + config={{ + inputFormat: "MM-YYYY", + label: { + text: trans("componentDoc.date"), + position: "column", + align: "left", + }, + }} + blackListConfig={blackListConfig} + compFactory={DateRangeComp} + /> + <Example + title="Suffix Icon on Calendar component" + width={500} + config={{ + suffixIcon: "/icon:regular/calendar-days", + label: { + text: trans("componentDoc.date"), + position: "column", + align: "left", + }, + }} + blackListConfig={blackListConfig} + compFactory={DateRangeComp} + /> + </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the different Styling properties of the Time Range Component." + > + <Example + title="Time Range component Styling properties" + config={{ + style: { + "background": "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + "margin": "10px", + "padding": "10px", + "text": "#222222", + "textSize": "20px", + "textWeight": "bold", + "fontStyle": "italic", + "border": "#222222", + "borderStyle": "solid", + "radius": "10px", + "borderWidth": "2px", + }, + label: { + text: trans("componentDoc.date"), + position: "column", + align: "left", + }, + }} + compFactory={DateRangeComp} + /> + <Example + title="Label Styling properties" + config={{ + labelStyle: { + "margin": "5px", + "padding": "5px", + "label": "#01865B", + "textTransform": "Uppercase", + "textDecoration": "underline", + "textSize": "18px", + "textWeight": "bold", + "fontStyle": "italic", + "border": "#222222", + "borderWidth": "2px", + "borderStyle": "solid", + }, + label: { + text: trans("componentDoc.date"), + position: "column", + align: "left", + }, + }} + compFactory={DateRangeComp} + /> + <Example + title="Input Field Styling properties" + config={{ + inputFieldStyle: { + "background": "linear-gradient(45deg, #d53369 0%, #daae51 100%)", + "border": "#222222", + "radius": "10px", + "text": "#222222", + "margin": "5px", + "padding": "10px", + "borderStyle": "dashed", + "borderWidth": "3px", + "accent": "#36B389" + }, + label: { + text: trans("componentDoc.date"), + position: "column", + align: "left", + }, + }} + compFactory={DateRangeComp} + /> + <Example + title="Children Input Field Styling properties" + config={{ + childrenInputFieldStyle: { + "margin": "5px", + "padding": "20px", + "text": "#3377FF", + "textDecoration": "underline", + "textSize": "15px", + "textWeight": "bold", + "fontFamily": "Courier New", + "fontStyle": "italic", + "border": "#36B389", + "borderStyle": "solid", + "radius": "10px", + "borderWidth": "3px", + "background": "#11F7E9" + }, + label: { + text: trans("componentDoc.date"), + position: "column", + align: "left", + }, + }} + compFactory={DateRangeComp} + /> + </ExampleGroup> </> ); } diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/CalendarInputComp/Time.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/CalendarInputComp/Time.tsx index efb8b6b30..dc39976b9 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/CalendarInputComp/Time.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/CalendarInputComp/Time.tsx @@ -51,6 +51,31 @@ export default function TimeExample() { blackListConfig={blackListConfig} compFactory={TimePickerComp} /> + <Example + title="Hiding the Time component" + config={{ + value: "10:00:00", + format: "hh:mm:ss", + hidden: true, + label: { + text: trans("componentDoc.time"), + }, + }} + blackListConfig={blackListConfig} + compFactory={TimePickerComp} + /> + <Example + title="Placeholder" + config={{ + format: "hh:mm:ss", + placeholder: "Select Time Quickly", + label: { + text: trans("componentDoc.time"), + }, + }} + blackListConfig={blackListConfig} + compFactory={TimePickerComp} + /> </ExampleGroup> <ExampleGroup title={trans("componentDoc.labelText")} description=""> @@ -117,11 +142,11 @@ export default function TimeExample() { compFactory={TimePickerComp} /> <Example - title={trans("componentDoc.time")} + title="Minimum and Maximum Time Limits" config={{ value: "10:00:00", label: { - text: trans("componentDoc.date"), + text: trans("componentDoc.time"), }, minTime: "11:00:00", maxTime: "12:00:00", @@ -158,6 +183,187 @@ export default function TimeExample() { blackListConfig={blackListConfig} compFactory={TimePickerComp} /> + <Example + title="Time Input Format : HH:mm" + config={{ + inputFormat: "HH:mm", + label: { + text: trans("componentDoc.time"), + }, + }} + blackListConfig={blackListConfig} + compFactory={TimePickerComp} + /> + <Example + title="Time Input Format : mm:ss" + config={{ + inputFormat: "mm:ss", + label: { + text: trans("componentDoc.time"), + }, + }} + blackListConfig={blackListConfig} + compFactory={TimePickerComp} + /> + <Example + title="Time Input Format : HH" + config={{ + inputFormat: "HH", + label: { + text: trans("componentDoc.time"), + }, + }} + blackListConfig={blackListConfig} + compFactory={TimePickerComp} + /> + </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the different Styling properties of the Time Component." + > + <Example + title="Time component Styling properties" + config={{ + label: { + text: trans("componentDoc.time"), + }, + style: { + "background": "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + "margin": "10px", + "padding": "10px", + "text": "#222222", + "textSize": "20px", + "textWeight": "bold", + "fontStyle": "italic", + "border": "#222222", + "borderStyle": "solid", + "radius": "10px", + "borderWidth": "2px", + }, + }} + compFactory={TimePickerComp} + /> + <Example + title="Label Styling properties" + config={{ + label: { + text: trans("componentDoc.time"), + }, + labelStyle: { + "margin": "5px", + "padding": "5px", + "label": "#01865B", + "textTransform": "Uppercase", + "textDecoration": "underline", + "textSize": "18px", + "textWeight": "bold", + "fontStyle": "italic", + "border": "#222222", + "borderWidth": "2px", + "borderStyle": "solid", + }, + }} + compFactory={TimePickerComp} + /> + <Example + title="Input Field Styling properties" + config={{ + label: { + text: trans("componentDoc.time"), + }, + inputFieldStyle: { + "background": "linear-gradient(45deg, #d53369 0%, #daae51 100%)", + "border": "#222222", + "radius": "10px", + "text": "#222222", + "margin": "5px", + "padding": "10px", + "borderStyle": "dashed", + "borderWidth": "3px", + "accent": "#36B389" + }, + }} + compFactory={TimePickerComp} + /> + <Example + title="Children Input Field Styling properties" + config={{ + label: { + text: trans("componentDoc.time"), + }, + childrenInputFieldStyle: { + "margin": "5px", + "padding": "20px", + "text": "#3377FF", + "textDecoration": "underline", + "textSize": "15px", + "textWeight": "bold", + "fontFamily": "Courier New", + "fontStyle": "italic", + "border": "#36B389", + "borderStyle": "solid", + "radius": "10px", + "borderWidth": "3px", + "background": "#11F7E9" + }, + }} + compFactory={TimePickerComp} + /> + </ExampleGroup> + + <ExampleGroup + title="Animation Style" + description="The Following Examples Show different Animation Styles on the Time Component." + > + <Example + title="Bounce Animation" + config={{ + label: { + text: trans("componentDoc.time"), + }, + showInfo: true, + animationStyle: { + "animation": "bounce", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={TimePickerComp} + /> + <Example + title="Swing Animation" + config={{ + label: { + text: trans("componentDoc.time"), + }, + showInfo: true, + animationStyle: { + "animation": "swing", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={TimePickerComp} + /> + <Example + title="Tada Animation" + config={{ + label: { + text: trans("componentDoc.time"), + }, + showInfo: true, + animationStyle: { + "animation": "tada", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={TimePickerComp} + /> </ExampleGroup> </> ); diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/CalendarInputComp/TimeRange.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/CalendarInputComp/TimeRange.tsx index 93d319b0e..de6df7cab 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/CalendarInputComp/TimeRange.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/CalendarInputComp/TimeRange.tsx @@ -64,6 +64,19 @@ export default function TimeRangeExample() { blackListConfig={blackListConfig} compFactory={TimeRangeComp} /> + <Example + title="Placeholder" + config={{ + placeholder: "Select Time Range", + label: { + text: trans("componentDoc.time"), + position: "column", + align: "left", + }, + }} + blackListConfig={blackListConfig} + compFactory={TimeRangeComp} + /> </ExampleGroup> <ExampleGroup title={trans("componentDoc.labelText")} description=""> @@ -140,10 +153,8 @@ export default function TimeRangeExample() { <Example title={trans("componentDoc.time")} config={{ - start: "10:00:00", - end: "12:00:00", label: { - text: trans("componentDoc.date"), + text: trans("componentDoc.time"), position: "column", align: "left", }, @@ -176,6 +187,207 @@ export default function TimeRangeExample() { blackListConfig={blackListConfig} compFactory={TimeRangeComp} /> + <Example + title="Time Input Format : HH:mm" + config={{ + inputFormat: "HH:mm", + label: { + text: trans("componentDoc.time"), + position: "column", + align: "left", + }, + }} + blackListConfig={blackListConfig} + compFactory={TimeRangeComp} + /> + <Example + title="Time Input Format : mm:ss" + config={{ + inputFormat: "mm:ss", + label: { + text: trans("componentDoc.time"), + position: "column", + align: "left", + }, + }} + blackListConfig={blackListConfig} + compFactory={TimeRangeComp} + /> + <Example + title="Time Input Format : HH" + config={{ + inputFormat: "HH", + label: { + text: trans("componentDoc.time"), + position: "column", + align: "left", + }, + }} + blackListConfig={blackListConfig} + compFactory={TimeRangeComp} + /> + </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the different Styling properties of the Time Range Component." + > + <Example + title="Time Range component Styling properties" + config={{ + style: { + "background": "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + "margin": "10px", + "padding": "10px", + "text": "#222222", + "textSize": "20px", + "textWeight": "bold", + "fontStyle": "italic", + "border": "#222222", + "borderStyle": "solid", + "radius": "10px", + "borderWidth": "2px", + }, + label: { + text: trans("componentDoc.time"), + position: "column", + align: "left", + }, + }} + compFactory={TimeRangeComp} + /> + <Example + title="Label Styling properties" + config={{ + labelStyle: { + "margin": "5px", + "padding": "5px", + "label": "#01865B", + "textTransform": "Uppercase", + "textDecoration": "underline", + "textSize": "18px", + "textWeight": "bold", + "fontStyle": "italic", + "border": "#222222", + "borderWidth": "2px", + "borderStyle": "solid", + }, + label: { + text: trans("componentDoc.time"), + position: "column", + align: "left", + }, + }} + compFactory={TimeRangeComp} + /> + <Example + title="Input Field Styling properties" + config={{ + inputFieldStyle: { + "background": "linear-gradient(45deg, #d53369 0%, #daae51 100%)", + "border": "#222222", + "radius": "10px", + "text": "#222222", + "margin": "5px", + "padding": "10px", + "borderStyle": "dashed", + "borderWidth": "3px", + "accent": "#36B389" + }, + label: { + text: trans("componentDoc.time"), + position: "column", + align: "left", + }, + }} + compFactory={TimeRangeComp} + /> + <Example + title="Children Input Field Styling properties" + config={{ + childrenInputFieldStyle: { + "margin": "5px", + "padding": "20px", + "text": "#3377FF", + "textDecoration": "underline", + "textSize": "15px", + "textWeight": "bold", + "fontFamily": "Courier New", + "fontStyle": "italic", + "border": "#36B389", + "borderStyle": "solid", + "radius": "10px", + "borderWidth": "3px", + "background": "#11F7E9" + }, + label: { + text: trans("componentDoc.time"), + position: "column", + align: "left", + }, + }} + compFactory={TimeRangeComp} + /> + </ExampleGroup> + + <ExampleGroup + title="Animation Style" + description="The Following Examples Show different Animation Styles on the Time Range Component." + > + <Example + title="Bounce Animation" + config={{ + showInfo: true, + animationStyle: { + "animation": "bounce", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + label: { + text: trans("componentDoc.time"), + position: "column", + align: "left", + }, + }} + compFactory={TimeRangeComp} + /> + <Example + title="Swing Animation" + config={{ + showInfo: true, + animationStyle: { + "animation": "swing", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + label: { + text: trans("componentDoc.time"), + position: "column", + align: "left", + }, + }} + compFactory={TimeRangeComp} + /> + <Example + title="Tada Animation" + config={{ + showInfo: true, + animationStyle: { + "animation": "tada", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + label: { + text: trans("componentDoc.time"), + position: "column", + align: "left", + }, + }} + compFactory={TimeRangeComp} + /> </ExampleGroup> </> ); diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/CalendarInputComp/Timer.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/CalendarInputComp/Timer.tsx index 50b2f2d39..54fba64d2 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/CalendarInputComp/Timer.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/CalendarInputComp/Timer.tsx @@ -1,12 +1,14 @@ import { TimerComp } from "comps/comps/timerComp"; import Example from "../../common/Example"; import ExampleGroup from "../../common/ExampleGroup"; +import { startButtonStyle } from "@lowcoder-ee/index.sdk"; export default function TimerExample() { return ( <> <ExampleGroup title="Basic Usage" + description="The Following Examples Show the Basic Usage of the Timer Component." > <Example title="Default Value" @@ -23,6 +25,135 @@ export default function TimerExample() { }} compFactory={TimerComp} /> + <Example + title="Hiding the Timer component" + config={{ + defaultValue: "00:00:00:000", + hidden: true, + }} + compFactory={TimerComp} + /> + </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the different Styling properties of the Timer Component." + > + <Example + title="Timer component Styling properties" + config={{ + style: { + "background": "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + "margin": "10px", + "padding": "10px", + "text": "#222222", + "textSize": "20px", + "textWeight": "bold", + "fontStyle": "italic", + "border": "#222222", + "borderStyle": "solid", + "radius": "10px", + "borderWidth": "2px", + }, + }} + compFactory={TimerComp} + /> + <Example + title="Start Button Styling properties" + config={{ + startButtonStyle: { + "background": "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + "margin": "5px", + "padding": "10px", + "text": "#FF0101", + "textSize": "25px", + "textWeight": "bold", + "fontStyle": "italic", + "border": "#222222", + "borderStyle": "dashed", + "radius": "10px", + "borderWidth": "2px" + }, + }} + compFactory={TimerComp} + /> + <Example + title="Reset Button Styling properties" + config={{ + startButtonStyle: { + "background": "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + "margin": "5px", + "padding": "10px", + "text": "#FF0101", + "textSize": "25px", + "textWeight": "bold", + "fontStyle": "italic", + "border": "#222222", + "borderStyle": "dashed", + "radius": "10px", + "borderWidth": "2px" + }, + resetButtonStyle: { + "background": "#FC0101", + "margin": "5px", + "padding": "10px", + "text": "#fff", + "textSize": "25px", + "textWeight": "bold", + "fontStyle": "italic", + "border": "#FFFFFF", + "borderStyle": "dashed", + "radius": "10px", + "borderWidth": "3px", + }, + }} + compFactory={TimerComp} + /> + </ExampleGroup> + + <ExampleGroup + title="Animation Style" + description="The Following Examples Show different Animation Styles on the Timer Component." + > + <Example + title="Bounce Animation" + config={{ + showInfo: true, + animationStyle: { + "animation": "bounce", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={TimerComp} + /> + <Example + title="Swing Animation" + config={{ + showInfo: true, + animationStyle: { + "animation": "swing", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={TimerComp} + /> + <Example + title="Tada Animation" + config={{ + showInfo: true, + animationStyle: { + "animation": "tada", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={TimerComp} + /> </ExampleGroup> </> ); diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/CandleStickChart.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/CandleStickChart.tsx index 544055abe..943c651a7 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/CandleStickChart.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/CandleStickChart.tsx @@ -6,54 +6,45 @@ import ExampleGroup from "../../common/ExampleGroup"; const ChartCompWithDefault = uiCompRegistry["candleStickChart"].comp; -const defaultEchartsJsonOption = { - "xAxis": { - "data": [ - "Day 1", - "Day 2", - "Day 3", - "Day 4", - "Day 5" - ] - }, - "data": [ - [ - 150, - 100, - 50, - 200 - ], - [ - 120, - 220, - 80, - 180 - ], - [ - 80, - 150, - 60, - 130 - ], - [ - 230, - 130, - 110, - 190 - ], - [ - 90, - 180, - 70, - 160 - ] - ] -}; +const chartStyle= { + background: "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + chartBorderColor: "#FDFAFA", + chartBorderStyle: "solid", + chartBorderWidth: "2", + chartBoxShadow: "200", + chartShadowColor: "#3377FF" +} -const echartsOption = JSON.stringify(defaultEchartsJsonOption); +const titleStyle = { + chartBoxShadow: "9", + chartFontStyle: "Italic", + chartShadowColor: "#FFBD01", + chartTextColor: "#36B389", + chartTextSize: "30", + chartTextWeight: "Bold" +} + +const xAxisStyle = { + chartBoxShadow: "5", + chartFontFamily: "serif", + chartFontStyle: "Italic", + chartShadowColor: "#020101", + chartTextColor: "#971827", + chartTextSize: "20", + chartTextWeight: "bold" +} + +const yAxisStyle = { + chartBoxShadow: "5", + chartFontFamily: "serif", + chartFontStyle: "Italic", + chartShadowColor: "#FFD701", + chartTextColor: "#7A7A7B", + chartTextSize: "20", + chartTextWeight: "bold" +} export default function CandleStickChartExample() { - const blackListConfig: string[] = ["echartsOption"]; return ( <> <ExampleGroup @@ -65,7 +56,6 @@ export default function CandleStickChartExample() { width={500} height={300} config={{ - echartsOption: echartsOption, }} compFactory={ChartCompWithDefault} /> @@ -74,7 +64,6 @@ export default function CandleStickChartExample() { width={500} height={300} config={{ - echartsOption: echartsOption, tooltip: false, }} compFactory={ChartCompWithDefault} @@ -90,7 +79,6 @@ export default function CandleStickChartExample() { width={500} height={300} config={{ - echartsOption: echartsOption, top: 20, right: 20, bottom: 20, @@ -109,7 +97,6 @@ export default function CandleStickChartExample() { width={500} height={300} config={{ - echartsOption: echartsOption, echartsTitleConfig: { "position": "left", }, @@ -121,7 +108,6 @@ export default function CandleStickChartExample() { width={500} height={300} config={{ - echartsOption: echartsOption, echartsTitleConfig: { "position": "center", }, @@ -133,7 +119,6 @@ export default function CandleStickChartExample() { width={500} height={300} config={{ - echartsOption: echartsOption, echartsTitleConfig: { "position": "right", }, @@ -145,7 +130,6 @@ export default function CandleStickChartExample() { width={500} height={300} config={{ - echartsOption: echartsOption, echartsLegendConfig: { "position": "bottom", }, @@ -157,7 +141,6 @@ export default function CandleStickChartExample() { width={500} height={300} config={{ - echartsOption: echartsOption, echartsLegendConfig: { "position": "top", }, @@ -165,6 +148,52 @@ export default function CandleStickChartExample() { compFactory={ChartCompWithDefault} /> </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the Styling Properties on the CandleStick Chart Component." + > + <Example + title="Chart Styling - Background Color, Box Shadow, Border" + width={500} + height={350} + hideSettings={true} + config={{ + chartStyle: chartStyle, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Title Styling - Text, Fonts & Box Shadow" + width={500} + height={350} + hideSettings={true} + config={{ + titleStyle: titleStyle, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="X-Axis Styling" + width={500} + height={350} + hideSettings={true} + config={{ + xAxisStyle: xAxisStyle, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Y-Axis Styling" + width={500} + height={350} + hideSettings={true} + config={{ + yAxisStyle: yAxisStyle, + }} + compFactory={ChartCompWithDefault} + /> + </ExampleGroup> </> ); } diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/FunnelChart.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/FunnelChart.tsx index 424b8a102..777f9dcfe 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/FunnelChart.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/FunnelChart.tsx @@ -5,6 +5,43 @@ import Example from "../../common/Example"; import ExampleGroup from "../../common/ExampleGroup"; const ChartCompWithDefault = uiCompRegistry["funnelChart"].comp; +const chartStyle= { + background: "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + chartBorderColor: "#FDFAFA", + chartBorderStyle: "solid", + chartBorderWidth: "2", + chartBoxShadow: "200", + chartShadowColor: "#3377FF" +} + +const titleStyle = { + chartBoxShadow: "9", + chartFontStyle: "Italic", + chartShadowColor: "#FFBD01", + chartTextColor: "#36B389", + chartTextSize: "30", + chartTextWeight: "Bold" +} + +const labelStyle = { + chartBoxShadow: "5", + chartFontFamily: "serif", + chartFontStyle: "Italic", + chartShadowColor: "#020101", + chartTextColor: "#FFFFFF", + chartTextSize: "20", + chartTextWeight: "bold" +} + +const legendStyle = { + chartBoxShadow: "5", + chartFontFamily: "serif", + chartFontStyle: "Italic", + chartShadowColor: "#FFD701", + chartTextColor: "#7A7A7B", + chartTextSize: "20", + chartTextWeight: "bold" +} export default function FunnelChartExample() { return ( @@ -301,6 +338,52 @@ export default function FunnelChartExample() { compFactory={ChartCompWithDefault} /> </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the Styling Properties on the Funnel Chart Component." + > + <Example + title="Chart Styling - Background Color, Box Shadow, Border" + width={500} + height={350} + hideSettings={true} + config={{ + chartStyle: chartStyle, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Title Styling - Text, Fonts & Box Shadow" + width={500} + height={350} + hideSettings={true} + config={{ + titleStyle: titleStyle, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Label Styling - Text, Fonts & Box Shadow" + width={500} + height={350} + hideSettings={true} + config={{ + labelStyle: labelStyle, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Lagend Styling - Text, Fonts & Box Shadow" + width={500} + height={350} + hideSettings={true} + config={{ + legendStyle: legendStyle, + }} + compFactory={ChartCompWithDefault} + /> + </ExampleGroup> </> ); } diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/GanttChart.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/GanttChart.tsx index 5107be785..eac134170 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/GanttChart.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/GanttChart.tsx @@ -11,15 +11,138 @@ export default function GanttChartExample() { <> <ExampleGroup title={trans("componentDoc.basicUsage")} - description={trans("componentDoc.basicDemoDescription")} + description="The Following Examples Show the Basic Usage of the Component." > <Example - title={trans("componentDoc.default")} + title="Default Component" + width={1000} config={{ }} compFactory={ChartCompWithDefault} /> </ExampleGroup> + + <ExampleGroup + title="Advance Usage" + description="The Following Examples Show the Advance Usage of the Gantt Chart Component." + > + <Example + title="View Mode - Hour" + width={1000} + config={{ + headerHeight: "60", + activeViewMode: "Hour", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="View Mode - Quarter Day" + width={1000} + config={{ + headerHeight: "60", + activeViewMode: "Quarter Day", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="View Mode - Half Day" + width={1000} + config={{ + headerHeight: "60", + activeViewMode: "Half Day", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="View Mode - Day" + width={1000} + config={{ + activeViewMode: "Day", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="View Mode - Week" + width={1000} + config={{ + headerHeight: "60", + activeViewMode: "Week", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="View Mode - Month" + width={1000} + config={{ + headerHeight: "60", + activeViewMode: "Month", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="View Mode - Year" + width={1000} + config={{ + headerHeight: "60", + activeViewMode: "Year", + }} + compFactory={ChartCompWithDefault} + /> + </ExampleGroup> + + <ExampleGroup + title="Layout" + description="The Following Examples Show the Layout options on the Gantt Chart Component." + > + <Example + title="Hiding Header" + width={1000} + config={{ + showHeaders: false, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Hiding Table Legend" + width={1000} + config={{ + showLegendTable: false, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Legend Width - 500px" + width={1000} + config={{ + legendWidth: "500px", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Header Height - 50" + width={1000} + config={{ + headerHeight: "50", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Row Height - 70" + width={1000} + config={{ + rowHeight: "70", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Column Width - 100" + width={1000} + config={{ + columnWidth: "100", + }} + compFactory={ChartCompWithDefault} + /> + </ExampleGroup> </> ); } \ No newline at end of file diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/GaugeChart.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/GaugeChart.tsx index 7a57ee549..43d87a45d 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/GaugeChart.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/GaugeChart.tsx @@ -6,6 +6,170 @@ import ExampleGroup from "../../common/ExampleGroup"; const ChartCompWithDefault = uiCompRegistry["gaugeChart"].comp; +const barometerGuageOption = { + "data": [ + { + "formatter": "{value}%", + "value": 58.46, + "name": "PLP", + "outline": { + "color": "#c80707", + "period": [ + 0, + 100 + ], + "splitNumber": 10, + "progressBarWidth": 2, + "axisTickLength": 6, + "axisTickWidth": 2, + "radius": "70%" + }, + "inline": { + "color": "#000000", + "period": [ + 0, + 60 + ], + "progressBarWidth": 2, + "splitNumber": 6, + "axisTickLength": 6, + "axisTickWidth": 2, + "radius": "60%" + } + } + ] +}; + +const clockGuageOption = { + "data": [ + { + "outlineColor": "#aa2a2a", + "anchor": { + "color": "#cfae09", + "size": 10 + }, + "hour": { + "color": "#cfae09", + "width": 4, + "length": 50, + "value": 4 + }, + "minute": { + "color": "#cfae09", + "width": 2.5, + "length": 65, + "value": 30 + }, + "second": { + "color": "#cfae09", + "width": 1, + "length": 90, + "value": 45 + } + } + ] +}; + +const gradeGuageOption = { + "data": [ + { + "value": 80, + "name": "Grade Rating", + "formatter": "{value} %", + "color": [ + [ + 0.25, + "#FF6E76" + ], + [ + 0.5, + "#FDDD60" + ], + [ + 0.75, + "#58D9F9" + ], + [ + 1, + "#7CFFB2" + ] + ] + } + ] +}; + +const multiTitleGuageOption = { + "data": [ + { + "formatter": "{value}%", + "value": [ + { + "color": "#19b1e6", + "title": "Perfect", + "value": 20, + "titlePosition": [ + "-60%", + "60%" + ], + "valuePosition": [ + "-60%", + "80%" + ] + }, + { + "color": "#fac858", + "title": "Good", + "value": 40, + "titlePosition": [ + "0%", + "60%" + ], + "valuePosition": [ + "0%", + "80%" + ] + }, + { + "color": "#09f64d", + "title": "Commonly", + "value": 60, + "titlePosition": [ + "60%", + "60%" + ], + "valuePosition": [ + "60%", + "80%" + ] + } + ] + } + ] +}; + +const stageGuageOption = { + "data": [ + { + "value": 80, + "formatter": "{value} Km/h", + "color": [ + [ + 0.3, + "#67e0e3" + ], + [ + 0.7, + "#37a2da" + ], + [ + 1, + "#fd666d" + ] + ] + } + ] +}; + export default function GaugeChartExample() { return ( <> @@ -26,7 +190,8 @@ export default function GaugeChartExample() { width={500} height={300} config={{ - chartType: "stageGuage", + chartType: "stageGauge", + echartsTitle: "Stage Speed Gauge", }} compFactory={ChartCompWithDefault} /> @@ -35,7 +200,8 @@ export default function GaugeChartExample() { width={500} height={300} config={{ - chartType: "gradeGuage", + chartType: "gradeGauge", + echartsTitle: "Grade Gauge", }} compFactory={ChartCompWithDefault} /> @@ -44,25 +210,230 @@ export default function GaugeChartExample() { width={500} height={300} config={{ - chartType: "temperatureGuage", + chartType: "temperatureGauge", + echartsTitle: "Temperature Gauge Chart", }} compFactory={ChartCompWithDefault} /> <Example - title="Chart Type - Temperature Guage" + title="Chart Type - Multi Title Guage" width={500} height={300} config={{ - chartType: "multiGuage", + chartType: "multiGauge", + echartsTitle: "Multi Title Gauge", }} compFactory={ChartCompWithDefault} /> <Example - title="Chart Type - Temperature Guage" + title="Chart Type - Clock Guage" + width={500} + height={300} + config={{ + chartType: "clockGauge", + echartsTitle: "Clock Gauge", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Chart Type - Ring Guage" + width={500} + height={300} + config={{ + chartType: "ringGauge", + echartsTitle: "Ring Gauge", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Chart Type - Guage Barometer Chart" + width={500} + height={300} + config={{ + chartType: "barometerGauge", + echartsTitle: "Gauge Barometer Chart", + }} + compFactory={ChartCompWithDefault} + /> + </ExampleGroup> + + <ExampleGroup + title="Charts Configuration - Layout & Styling" + description="The Following Examples Show the Layout & Styling options on different Chart components" + > + <Example + title="Radius Configuration - Small Circle" + width={500} + height={300} + config={{ + chartType: "ringGauge", + radius: "50", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Radius Configuration - Large Circle" + width={500} + height={300} + config={{ + chartType: "ringGauge", + radius: "90", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Position Configuration - X and Y axis" + width={500} + height={300} + config={{ + chartType: "ringGauge", + position_x: "20", + position_y: "30", + radius: "60", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Position Configuration - X and Y axis" + width={500} + height={300} + config={{ + chartType: "ringGauge", + position_x: "80", + position_y: "70", + radius: "60", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Progress Bar Width" + width={500} + height={300} + config={{ + chartType: "ringGauge", + ringProgressBarWidth: "20", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Progress Bar Width" + width={500} + height={300} + config={{ + chartType: "ringGauge", + ringProgressBarWidth: "60", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Start Angle" + width={500} + height={300} + config={{ + chartType: "temperatureGauge", + startAngle: "160", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="End Angle" + width={500} + height={300} + config={{ + chartType: "temperatureGauge", + endAngle: "70", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Split Number - 10" + width={500} + height={300} + config={{ + chartType: "temperatureGauge", + splitNumber: "10", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Split Number - 20" + width={500} + height={300} + config={{ + chartType: "temperatureGauge", + splitNumber: "20", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Axis Tick Length" + width={500} + height={300} + config={{ + chartType: "temperatureGauge", + axisTickLength: "20", + position_y: "70", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Axis Tick Width" + width={500} + height={300} + config={{ + chartType: "temperatureGauge", + axisTickWidth: "5", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Axis Tick Color" + width={500} + height={300} + config={{ + chartType: "temperatureGauge", + axisTickColor: "#222222", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Axis Label Distance" + width={500} + height={300} + config={{ + chartType: "temperatureGauge", + axisLabelDistance: "40", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Pointer Length" + width={500} + height={300} + config={{ + chartType: "barometerGauge", + barometerPointerLength: "170", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Pointer Width" + width={500} + height={300} + config={{ + chartType: "barometerGauge", + barometerPointerWidth: "15", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Pointer Position" width={500} height={300} config={{ - chartType: "clockGuage", + chartType: "barometerGauge", + barometerPointer_Y: "30", + barometerPointerLength: "80", }} compFactory={ChartCompWithDefault} /> diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/GeoMapChart.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/GeoMapChart.tsx index dd6bf3fb5..7ce9f66db 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/GeoMapChart.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/GeoMapChart.tsx @@ -6,27 +6,7 @@ import ExampleGroup from "../../common/ExampleGroup"; const ChartCompWithDefault = uiCompRegistry["chartsGeoMap"].comp; -const defaultDataSource = "[\n {\n \"date\": \"2021-09\",\n \"department\": \"Administration\",\n \"spending\": 9003,\n \"budget\": 8000\n },\n {\n \"date\": \"2021-09\",\n \"department\": \"Finance\",\n \"spending\": 3033,\n \"budget\": 4000\n },\n {\n \"date\": \"2021-09\",\n \"department\": \"Sales\",\n \"spending\": 9230,\n \"budget\": 8000\n },\n {\n \"date\": \"2021-10\",\n \"department\": \"Administration\",\n \"spending\": 13032,\n \"budget\": 15000\n },\n {\n \"date\": \"2021-10\",\n \"department\": \"Finance\",\n \"spending\": 2300,\n \"budget\": 5000\n },\n {\n \"date\": \"2021-10\",\n \"department\": \"Sales\",\n \"spending\": 7323.5,\n \"budget\": 8000\n },\n {\n \"date\": \"2021-11\",\n \"department\": \"Administration\",\n \"spending\": 13000,\n \"budget\": 16023\n },\n {\n \"date\": \"2021-11\",\n \"department\": \"Finance\",\n \"spending\": 3569.5,\n \"budget\": 3000\n },\n {\n \"date\": \"2021-11\",\n \"department\": \"Sales\",\n \"spending\": 10000,\n \"budget\": 9932\n },\n {\n \"date\": \"2021-12\",\n \"department\": \"Administration\",\n \"spending\": 18033,\n \"budget\": 20000\n },\n {\n \"date\": \"2021-12\",\n \"department\": \"Finance\",\n \"spending\": 4890,\n \"budget\": 4500\n },\n {\n \"date\": \"2021-12\",\n \"department\": \"Sales\",\n \"spending\": 9322,\n \"budget\": 8000\n }\n]"; - -const defaultEchartsJsonOption = "{\n \"xAxis\": {\n \"data\": [\n \"Day 1\",\n \"Day 2\",\n \"Day 3\",\n \"Day 4\",\n \"Day 5\"\n ]\n },\n \"data\": [\n [\n 100,\n 200,\n 50,\n 150\n ],\n [\n 120,\n 220,\n 80,\n 180\n ],\n [\n 80,\n 150,\n 60,\n 130\n ],\n [\n 130,\n 230,\n 110,\n 190\n ],\n [\n 90,\n 180,\n 70,\n 160\n ]\n ]\n}"; - -const data = JSON.stringify(defaultDataSource); -const echartsOption = JSON.stringify(defaultEchartsJsonOption); - export default function GeoMapChartExample() { - const blackListConfig: string[] = ["data", "echartsOption", "series"]; - const series = [ - { - "columnName": "spending", - "seriesName": "Spending", - "dataIndex": "f011b34c" - }, - { - "columnName": "budget", - "seriesName": "Budget", - "dataIndex": "30e02269" - } -]; return ( <> <ExampleGroup @@ -37,11 +17,76 @@ export default function GeoMapChartExample() { title={trans("componentDoc.default")} width={500} height={300} - blackListConfig={blackListConfig} config={{ - mode: "json", - data: data, - series: series, + }} + compFactory={ChartCompWithDefault} + /> + </ExampleGroup> + + <ExampleGroup + title={trans("componentDoc.basicUsage")} + description={trans("componentDoc.basicDemoDescription")} + > + <Example + title="Zoom Level - 1" + width={500} + height={300} + config={{ + mapZoomLevel: "1", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Zoom Level - 3" + width={500} + height={300} + config={{ + mapZoomLevel: "3", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Zoom Level - 5" + width={500} + height={300} + config={{ + mapZoomLevel: "5", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Center Position ( Lat, Long) - Spain" + width={700} + height={300} + hideSettings={true} + config={{ + mapCenterLng: "-0.5033", + mapCenterLat: "40.5235", + mapZoomLevel: "5", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Center Position ( Lat, Lon) - USA" + width={700} + height={300} + hideSettings={true} + config={{ + mapCenterLng: "-97.5348", + mapCenterLat: "38.7946", + mapZoomLevel: "5", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Center Position ( Lat, Lon) - Turkey" + width={700} + height={300} + hideSettings={true} + config={{ + mapCenterLng: "38.5348", + mapCenterLat: "38.7946", + mapZoomLevel: "5", }} compFactory={ChartCompWithDefault} /> diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/GraphChart.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/GraphChart.tsx index 3024a613b..b19bf5f6e 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/GraphChart.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/GraphChart.tsx @@ -6,27 +6,25 @@ import ExampleGroup from "../../common/ExampleGroup"; const ChartCompWithDefault = uiCompRegistry["graphChart"].comp; -const defaultDataSource = "[\n {\n \"date\": \"2021-09\",\n \"department\": \"Administration\",\n \"spending\": 9003,\n \"budget\": 8000\n },\n {\n \"date\": \"2021-09\",\n \"department\": \"Finance\",\n \"spending\": 3033,\n \"budget\": 4000\n },\n {\n \"date\": \"2021-09\",\n \"department\": \"Sales\",\n \"spending\": 9230,\n \"budget\": 8000\n },\n {\n \"date\": \"2021-10\",\n \"department\": \"Administration\",\n \"spending\": 13032,\n \"budget\": 15000\n },\n {\n \"date\": \"2021-10\",\n \"department\": \"Finance\",\n \"spending\": 2300,\n \"budget\": 5000\n },\n {\n \"date\": \"2021-10\",\n \"department\": \"Sales\",\n \"spending\": 7323.5,\n \"budget\": 8000\n },\n {\n \"date\": \"2021-11\",\n \"department\": \"Administration\",\n \"spending\": 13000,\n \"budget\": 16023\n },\n {\n \"date\": \"2021-11\",\n \"department\": \"Finance\",\n \"spending\": 3569.5,\n \"budget\": 3000\n },\n {\n \"date\": \"2021-11\",\n \"department\": \"Sales\",\n \"spending\": 10000,\n \"budget\": 9932\n },\n {\n \"date\": \"2021-12\",\n \"department\": \"Administration\",\n \"spending\": 18033,\n \"budget\": 20000\n },\n {\n \"date\": \"2021-12\",\n \"department\": \"Finance\",\n \"spending\": 4890,\n \"budget\": 4500\n },\n {\n \"date\": \"2021-12\",\n \"department\": \"Sales\",\n \"spending\": 9322,\n \"budget\": 8000\n }\n]"; - -const defaultEchartsJsonOption = "{\n \"xAxis\": {\n \"data\": [\n \"Day 1\",\n \"Day 2\",\n \"Day 3\",\n \"Day 4\",\n \"Day 5\"\n ]\n },\n \"data\": [\n [\n 100,\n 200,\n 50,\n 150\n ],\n [\n 120,\n 220,\n 80,\n 180\n ],\n [\n 80,\n 150,\n 60,\n 130\n ],\n [\n 130,\n 230,\n 110,\n 190\n ],\n [\n 90,\n 180,\n 70,\n 160\n ]\n ]\n}"; +const chartStyle= { + background: "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + chartBorderColor: "#FDFAFA", + chartBorderStyle: "solid", + chartBorderWidth: "2", + chartBoxShadow: "200", + chartShadowColor: "#3377FF" +} -const data = JSON.stringify(defaultDataSource); -const echartsOption = JSON.stringify(defaultEchartsJsonOption); +const titleStyle = { + chartBoxShadow: "9", + chartFontStyle: "Italic", + chartShadowColor: "#FFBD01", + chartTextColor: "#36B389", + chartTextSize: "30", + chartTextWeight: "Bold" +} export default function GraphChartExample() { - const blackListConfig: string[] = ["data", "echartsOption", "series"]; - const series = [ - { - "columnName": "spending", - "seriesName": "Spending", - "dataIndex": "f011b34c" - }, - { - "columnName": "budget", - "seriesName": "Budget", - "dataIndex": "30e02269" - } -]; return ( <> <ExampleGroup @@ -37,11 +35,34 @@ export default function GraphChartExample() { title={trans("componentDoc.default")} width={500} height={300} - blackListConfig={blackListConfig} + hideSettings={true} + config={{ + }} + compFactory={ChartCompWithDefault} + /> + </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the Styling Properties on the Graph Chart Component." + > + <Example + title="Chart Styling - Background Color, Box Shadow, Border" + width={500} + height={350} + hideSettings={true} + config={{ + chartStyle: chartStyle, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Title Styling - Text, Fonts & Box Shadow" + width={500} + height={350} + hideSettings={true} config={{ - mode: "json", - data: data, - series: series, + titleStyle: titleStyle, }} compFactory={ChartCompWithDefault} /> diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/HeatmapChart.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/HeatmapChart.tsx index c2a60b7eb..0c82cdd08 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/HeatmapChart.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/HeatmapChart.tsx @@ -6,27 +6,45 @@ import ExampleGroup from "../../common/ExampleGroup"; const ChartCompWithDefault = uiCompRegistry["heatmapChart"].comp; -const defaultDataSource = "[\n {\n \"date\": \"2021-09\",\n \"department\": \"Administration\",\n \"spending\": 9003,\n \"budget\": 8000\n },\n {\n \"date\": \"2021-09\",\n \"department\": \"Finance\",\n \"spending\": 3033,\n \"budget\": 4000\n },\n {\n \"date\": \"2021-09\",\n \"department\": \"Sales\",\n \"spending\": 9230,\n \"budget\": 8000\n },\n {\n \"date\": \"2021-10\",\n \"department\": \"Administration\",\n \"spending\": 13032,\n \"budget\": 15000\n },\n {\n \"date\": \"2021-10\",\n \"department\": \"Finance\",\n \"spending\": 2300,\n \"budget\": 5000\n },\n {\n \"date\": \"2021-10\",\n \"department\": \"Sales\",\n \"spending\": 7323.5,\n \"budget\": 8000\n },\n {\n \"date\": \"2021-11\",\n \"department\": \"Administration\",\n \"spending\": 13000,\n \"budget\": 16023\n },\n {\n \"date\": \"2021-11\",\n \"department\": \"Finance\",\n \"spending\": 3569.5,\n \"budget\": 3000\n },\n {\n \"date\": \"2021-11\",\n \"department\": \"Sales\",\n \"spending\": 10000,\n \"budget\": 9932\n },\n {\n \"date\": \"2021-12\",\n \"department\": \"Administration\",\n \"spending\": 18033,\n \"budget\": 20000\n },\n {\n \"date\": \"2021-12\",\n \"department\": \"Finance\",\n \"spending\": 4890,\n \"budget\": 4500\n },\n {\n \"date\": \"2021-12\",\n \"department\": \"Sales\",\n \"spending\": 9322,\n \"budget\": 8000\n }\n]"; +const chartStyle= { + background: "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + chartBorderColor: "#FDFAFA", + chartBorderStyle: "solid", + chartBorderWidth: "2", + chartBoxShadow: "200", + chartShadowColor: "#3377FF" +} -const defaultEchartsJsonOption = "{\n \"xAxis\": {\n \"data\": [\n \"Day 1\",\n \"Day 2\",\n \"Day 3\",\n \"Day 4\",\n \"Day 5\"\n ]\n },\n \"data\": [\n [\n 100,\n 200,\n 50,\n 150\n ],\n [\n 120,\n 220,\n 80,\n 180\n ],\n [\n 80,\n 150,\n 60,\n 130\n ],\n [\n 130,\n 230,\n 110,\n 190\n ],\n [\n 90,\n 180,\n 70,\n 160\n ]\n ]\n}"; +const titleStyle = { + chartBoxShadow: "9", + chartFontStyle: "Italic", + chartShadowColor: "#FFBD01", + chartTextColor: "#36B389", + chartTextSize: "30", + chartTextWeight: "Bold" +} -const data = JSON.stringify(defaultDataSource); -const echartsOption = JSON.stringify(defaultEchartsJsonOption); +const xAxisStyle = { + chartBoxShadow: "5", + chartFontFamily: "serif", + chartFontStyle: "Italic", + chartShadowColor: "#020101", + chartTextColor: "#971827", + chartTextSize: "20", + chartTextWeight: "bold" +} + +const yAxisStyle = { + chartBoxShadow: "5", + chartFontFamily: "serif", + chartFontStyle: "Italic", + chartShadowColor: "#FFD701", + chartTextColor: "#7A7A7B", + chartTextSize: "20", + chartTextWeight: "bold" +} export default function HeatmapChartExample() { - const blackListConfig: string[] = ["data", "echartsOption", "series"]; - const series = [ - { - "columnName": "spending", - "seriesName": "Spending", - "dataIndex": "f011b34c" - }, - { - "columnName": "budget", - "seriesName": "Budget", - "dataIndex": "30e02269" - } -]; return ( <> <ExampleGroup @@ -37,14 +55,191 @@ export default function HeatmapChartExample() { title={trans("componentDoc.default")} width={500} height={300} - blackListConfig={blackListConfig} + hideSettings={true} + config={{ + }} + compFactory={ChartCompWithDefault} + /> + </ExampleGroup> + + <ExampleGroup + title="Alignment & Layout" + description="The Following Examples Show the different alignment option on the Heatmap Chart Component." + > + <Example + title="Title Position - Left" + width={500} + height={350} + config={{ + echartsTitleConfig : { + "position" : "left", + } + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Title Position - Center" + width={500} + height={350} + config={{ + echartsTitleConfig : { + "position" : "center", + } + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Title Position - Right" + width={500} + height={350} config={{ - mode: "json", - data: data, - series: series, + echartsTitleConfig : { + "position" : "right", + } }} compFactory={ChartCompWithDefault} /> + <Example + title="Legend Position - Top" + width={500} + height={350} + config={{ + echartsLegendConfig : { + "position" : "top", + }, + echartsTitleConfig : { + "position" : "left", + }, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Lagend Position - Bottom" + width={500} + height={350} + config={{ + echartsLegendConfig : { + "position" : "bottom", + } + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Legend Orientation + Position - Vertical + Left" + width={500} + height={350} + config={{ + echartsLegendOrientConfig: { + orient: "vertical" + }, + echartsLegendAlignConfig: { + left: "left" + }, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Legend Orientation + Position - Horizontal + Center" + width={500} + height={350} + config={{ + echartsLegendOrientConfig: { + orient: "horizontal" + }, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Legend Orientation + Position - Vertical + Right" + width={500} + height={350} + config={{ + echartsLegendOrientConfig: { + orient: "vertical" + }, + echartsLegendAlignConfig: { + left: "right" + }, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Hiding Labels" + width={500} + height={350} + config={{ + echartsLabelConfig: { + labelVisibility: false, + }, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Chart Position - Top & Left" + width={500} + height={350} + config={{ + top: "0", + left: "0", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Chart Position - Bottom & Right" + width={500} + height={350} + config={{ + bottom: "0", + right: "0", + }} + compFactory={ChartCompWithDefault} + /> + </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the Styling Properties on the HeatMap Chart Component." + > + <Example + title="Chart Styling - Background Color, Box Shadow, Border" + width={500} + height={350} + hideSettings={true} + config={{ + chartStyle: chartStyle, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Title Styling - Text, Fonts & Box Shadow" + width={500} + height={350} + hideSettings={true} + config={{ + titleStyle: titleStyle, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="X-Axis Styling" + width={500} + height={350} + hideSettings={true} + config={{ + xAxisStyle: xAxisStyle, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Y-Axis Styling" + width={500} + height={350} + hideSettings={true} + config={{ + yAxisStyle: yAxisStyle, + }} + compFactory={ChartCompWithDefault} + /> </ExampleGroup> </> ); diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/HillChart.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/HillChart.tsx index 09d371666..f7fd46951 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/HillChart.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/HillChart.tsx @@ -11,10 +11,12 @@ export default function HillChartExample() { <> <ExampleGroup title={trans("componentDoc.basicUsage")} - description={trans("componentDoc.basicDemoDescription")} + description="The Following Examples Show the Basic Usage of the Hill Chart Component." > <Example - title={trans("componentDoc.default")} + title="Default Hill Chart" + hideSettings={true} + width={700} config={{ }} compFactory={ChartCompWithDefault} diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/MermaidChart.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/MermaidChart.tsx index e27c85d4d..4fad532f5 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/MermaidChart.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/MermaidChart.tsx @@ -6,27 +6,7 @@ import ExampleGroup from "../../common/ExampleGroup"; const ChartCompWithDefault = uiCompRegistry["mermaid"].comp; -const defaultDataSource = "[\n {\n \"date\": \"2021-09\",\n \"department\": \"Administration\",\n \"spending\": 9003,\n \"budget\": 8000\n },\n {\n \"date\": \"2021-09\",\n \"department\": \"Finance\",\n \"spending\": 3033,\n \"budget\": 4000\n },\n {\n \"date\": \"2021-09\",\n \"department\": \"Sales\",\n \"spending\": 9230,\n \"budget\": 8000\n },\n {\n \"date\": \"2021-10\",\n \"department\": \"Administration\",\n \"spending\": 13032,\n \"budget\": 15000\n },\n {\n \"date\": \"2021-10\",\n \"department\": \"Finance\",\n \"spending\": 2300,\n \"budget\": 5000\n },\n {\n \"date\": \"2021-10\",\n \"department\": \"Sales\",\n \"spending\": 7323.5,\n \"budget\": 8000\n },\n {\n \"date\": \"2021-11\",\n \"department\": \"Administration\",\n \"spending\": 13000,\n \"budget\": 16023\n },\n {\n \"date\": \"2021-11\",\n \"department\": \"Finance\",\n \"spending\": 3569.5,\n \"budget\": 3000\n },\n {\n \"date\": \"2021-11\",\n \"department\": \"Sales\",\n \"spending\": 10000,\n \"budget\": 9932\n },\n {\n \"date\": \"2021-12\",\n \"department\": \"Administration\",\n \"spending\": 18033,\n \"budget\": 20000\n },\n {\n \"date\": \"2021-12\",\n \"department\": \"Finance\",\n \"spending\": 4890,\n \"budget\": 4500\n },\n {\n \"date\": \"2021-12\",\n \"department\": \"Sales\",\n \"spending\": 9322,\n \"budget\": 8000\n }\n]"; - -const defaultEchartsJsonOption = "{\n \"xAxis\": {\n \"data\": [\n \"Day 1\",\n \"Day 2\",\n \"Day 3\",\n \"Day 4\",\n \"Day 5\"\n ]\n },\n \"data\": [\n [\n 100,\n 200,\n 50,\n 150\n ],\n [\n 120,\n 220,\n 80,\n 180\n ],\n [\n 80,\n 150,\n 60,\n 130\n ],\n [\n 130,\n 230,\n 110,\n 190\n ],\n [\n 90,\n 180,\n 70,\n 160\n ]\n ]\n}"; - -const data = JSON.stringify(defaultDataSource); -const echartsOption = JSON.stringify(defaultEchartsJsonOption); - export default function MermaidChartExample() { - const blackListConfig: string[] = ["data", "echartsOption", "series"]; - const series = [ - { - "columnName": "spending", - "seriesName": "Spending", - "dataIndex": "f011b34c" - }, - { - "columnName": "budget", - "seriesName": "Budget", - "dataIndex": "30e02269" - } -]; return ( <> <ExampleGroup @@ -34,14 +14,19 @@ export default function MermaidChartExample() { description={trans("componentDoc.basicDemoDescription")} > <Example - title={trans("componentDoc.default")} + title="Default Component" + width={500} + height={300} + config={{ + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Custom Component" width={500} height={300} - blackListConfig={blackListConfig} config={{ - mode: "json", - data: data, - series: series, + code: "graph LR\n Planning --> Defining --> Designing --> Building --> Testing --> Deployment --> Planning", }} compFactory={ChartCompWithDefault} /> diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/OpenLayersGeoMap.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/OpenLayersGeoMap.tsx index 306871822..ac8287742 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/OpenLayersGeoMap.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/OpenLayersGeoMap.tsx @@ -6,27 +6,7 @@ import ExampleGroup from "../../common/ExampleGroup"; const ChartCompWithDefault = uiCompRegistry["openLayersGeoMap"].comp; -const defaultDataSource = "[\n {\n \"date\": \"2021-09\",\n \"department\": \"Administration\",\n \"spending\": 9003,\n \"budget\": 8000\n },\n {\n \"date\": \"2021-09\",\n \"department\": \"Finance\",\n \"spending\": 3033,\n \"budget\": 4000\n },\n {\n \"date\": \"2021-09\",\n \"department\": \"Sales\",\n \"spending\": 9230,\n \"budget\": 8000\n },\n {\n \"date\": \"2021-10\",\n \"department\": \"Administration\",\n \"spending\": 13032,\n \"budget\": 15000\n },\n {\n \"date\": \"2021-10\",\n \"department\": \"Finance\",\n \"spending\": 2300,\n \"budget\": 5000\n },\n {\n \"date\": \"2021-10\",\n \"department\": \"Sales\",\n \"spending\": 7323.5,\n \"budget\": 8000\n },\n {\n \"date\": \"2021-11\",\n \"department\": \"Administration\",\n \"spending\": 13000,\n \"budget\": 16023\n },\n {\n \"date\": \"2021-11\",\n \"department\": \"Finance\",\n \"spending\": 3569.5,\n \"budget\": 3000\n },\n {\n \"date\": \"2021-11\",\n \"department\": \"Sales\",\n \"spending\": 10000,\n \"budget\": 9932\n },\n {\n \"date\": \"2021-12\",\n \"department\": \"Administration\",\n \"spending\": 18033,\n \"budget\": 20000\n },\n {\n \"date\": \"2021-12\",\n \"department\": \"Finance\",\n \"spending\": 4890,\n \"budget\": 4500\n },\n {\n \"date\": \"2021-12\",\n \"department\": \"Sales\",\n \"spending\": 9322,\n \"budget\": 8000\n }\n]"; - -const defaultEchartsJsonOption = "{\n \"xAxis\": {\n \"data\": [\n \"Day 1\",\n \"Day 2\",\n \"Day 3\",\n \"Day 4\",\n \"Day 5\"\n ]\n },\n \"data\": [\n [\n 100,\n 200,\n 50,\n 150\n ],\n [\n 120,\n 220,\n 80,\n 180\n ],\n [\n 80,\n 150,\n 60,\n 130\n ],\n [\n 130,\n 230,\n 110,\n 190\n ],\n [\n 90,\n 180,\n 70,\n 160\n ]\n ]\n}"; - -const data = JSON.stringify(defaultDataSource); -const echartsOption = JSON.stringify(defaultEchartsJsonOption); - export default function OpenLayersGeoMapChartExample() { - const blackListConfig: string[] = ["data", "echartsOption", "series"]; - const series = [ - { - "columnName": "spending", - "seriesName": "Spending", - "dataIndex": "f011b34c" - }, - { - "columnName": "budget", - "seriesName": "Budget", - "dataIndex": "30e02269" - } -]; return ( <> <ExampleGroup @@ -37,11 +17,43 @@ export default function OpenLayersGeoMapChartExample() { title={trans("componentDoc.default")} width={500} height={300} - blackListConfig={blackListConfig} config={{ - mode: "json", - data: data, - series: series, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Center Position - USA" + width={500} + height={300} + config={{ + center: "[-92.5348,38.7946]", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Zoom Level - 3" + width={500} + height={300} + config={{ + zoom: "3", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Zoom Level - 7" + width={500} + height={300} + config={{ + zoom: "7", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Zoom Level - 10" + width={500} + height={300} + config={{ + zoom: "10", }} compFactory={ChartCompWithDefault} /> diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/RadarChart.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/RadarChart.tsx index 662ece815..5a211eea9 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/RadarChart.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/RadarChart.tsx @@ -6,27 +6,45 @@ import ExampleGroup from "../../common/ExampleGroup"; const ChartCompWithDefault = uiCompRegistry["radarChart"].comp; -const defaultDataSource = "[\n {\n \"date\": \"2021-09\",\n \"department\": \"Administration\",\n \"spending\": 9003,\n \"budget\": 8000\n },\n {\n \"date\": \"2021-09\",\n \"department\": \"Finance\",\n \"spending\": 3033,\n \"budget\": 4000\n },\n {\n \"date\": \"2021-09\",\n \"department\": \"Sales\",\n \"spending\": 9230,\n \"budget\": 8000\n },\n {\n \"date\": \"2021-10\",\n \"department\": \"Administration\",\n \"spending\": 13032,\n \"budget\": 15000\n },\n {\n \"date\": \"2021-10\",\n \"department\": \"Finance\",\n \"spending\": 2300,\n \"budget\": 5000\n },\n {\n \"date\": \"2021-10\",\n \"department\": \"Sales\",\n \"spending\": 7323.5,\n \"budget\": 8000\n },\n {\n \"date\": \"2021-11\",\n \"department\": \"Administration\",\n \"spending\": 13000,\n \"budget\": 16023\n },\n {\n \"date\": \"2021-11\",\n \"department\": \"Finance\",\n \"spending\": 3569.5,\n \"budget\": 3000\n },\n {\n \"date\": \"2021-11\",\n \"department\": \"Sales\",\n \"spending\": 10000,\n \"budget\": 9932\n },\n {\n \"date\": \"2021-12\",\n \"department\": \"Administration\",\n \"spending\": 18033,\n \"budget\": 20000\n },\n {\n \"date\": \"2021-12\",\n \"department\": \"Finance\",\n \"spending\": 4890,\n \"budget\": 4500\n },\n {\n \"date\": \"2021-12\",\n \"department\": \"Sales\",\n \"spending\": 9322,\n \"budget\": 8000\n }\n]"; +const chartStyle= { + background: "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + chartBorderColor: "#FDFAFA", + chartBorderStyle: "solid", + chartBorderWidth: "2", + chartBoxShadow: "200", + chartShadowColor: "#3377FF" +} + +const titleStyle = { + chartBoxShadow: "9", + chartFontStyle: "Italic", + chartShadowColor: "#FFBD01", + chartTextColor: "#36B389", + chartTextSize: "30", + chartTextWeight: "Bold" +} -const defaultEchartsJsonOption = "{\n \"xAxis\": {\n \"data\": [\n \"Day 1\",\n \"Day 2\",\n \"Day 3\",\n \"Day 4\",\n \"Day 5\"\n ]\n },\n \"data\": [\n [\n 100,\n 200,\n 50,\n 150\n ],\n [\n 120,\n 220,\n 80,\n 180\n ],\n [\n 80,\n 150,\n 60,\n 130\n ],\n [\n 130,\n 230,\n 110,\n 190\n ],\n [\n 90,\n 180,\n 70,\n 160\n ]\n ]\n}"; +const labelStyle = { + chartBoxShadow: "5", + chartFontFamily: "serif", + chartFontStyle: "Italic", + chartShadowColor: "#020101", + chartTextColor: "#FFFFFF", + chartTextSize: "20", + chartTextWeight: "bold" +} -const data = JSON.stringify(defaultDataSource); -const echartsOption = JSON.stringify(defaultEchartsJsonOption); +const legendStyle = { + chartBoxShadow: "5", + chartFontFamily: "serif", + chartFontStyle: "Italic", + chartShadowColor: "#FFD701", + chartTextColor: "#7A7A7B", + chartTextSize: "20", + chartTextWeight: "bold" +} export default function RadarChartExample() { - const blackListConfig: string[] = ["data", "echartsOption", "series"]; - const series = [ - { - "columnName": "spending", - "seriesName": "Spending", - "dataIndex": "f011b34c" - }, - { - "columnName": "budget", - "seriesName": "Budget", - "dataIndex": "30e02269" - } -]; return ( <> <ExampleGroup @@ -37,15 +55,208 @@ export default function RadarChartExample() { title={trans("componentDoc.default")} width={500} height={300} - blackListConfig={blackListConfig} + hideSettings={true} config={{ - mode: "json", - data: data, - series: series, }} compFactory={ChartCompWithDefault} /> </ExampleGroup> + + <ExampleGroup + title="Alignment & Layout" + description="The Following Examples Show the different alignment option on the Radar Chart Component." + > + <Example + title="Title Position - Left" + width={500} + height={350} + config={{ + echartsTitleConfig : { + "position" : "left", + } + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Title Position - Center" + width={500} + height={350} + config={{ + echartsTitleConfig : { + "position" : "center", + } + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Title Position - Right" + width={500} + height={350} + config={{ + echartsTitleConfig : { + "position" : "right", + } + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Legend Position - Top" + width={500} + height={350} + config={{ + echartsLegendConfig : { + "position" : "top", + }, + echartsTitleConfig : { + "position" : "left", + }, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Lagend Position - Bottom" + width={500} + height={350} + config={{ + echartsLegendConfig : { + "position" : "bottom", + } + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Legend Orientation + Position - Vertical + Left" + width={500} + height={350} + config={{ + echartsLegendOrientConfig: { + orient: "vertical" + }, + echartsLegendAlignConfig: { + left: "left" + }, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Legend Orientation + Position - Horizontal + Center" + width={500} + height={350} + config={{ + echartsLegendOrientConfig: { + orient: "horizontal" + }, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Legend Orientation + Position - Vertical + Right" + width={500} + height={350} + config={{ + echartsLegendOrientConfig: { + orient: "vertical" + }, + echartsLegendAlignConfig: { + left: "right" + }, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Hiding Labels" + width={500} + height={350} + config={{ + echartsLabelConfig: { + labelVisibility: false, + }, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="X-Axis Position" + width={500} + height={350} + config={{ + position_x: "25", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Y-Axis Position" + width={500} + height={350} + config={{ + position_y: "30", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Hiding Area Flag" + width={500} + height={350} + config={{ + areaFlag: false, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Hiding Legends" + width={500} + height={350} + config={{ + legendVisibility: false, + }} + compFactory={ChartCompWithDefault} + /> + </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the Styling Properties on the Radar Chart Component." + > + <Example + title="Chart Styling - Background Color, Box Shadow, Border" + width={500} + height={350} + hideSettings={true} + config={{ + chartStyle: chartStyle, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Title Styling - Text, Fonts & Box Shadow" + width={500} + height={350} + hideSettings={true} + config={{ + titleStyle: titleStyle, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Label Styling - Text, Fonts & Box Shadow" + width={500} + height={350} + hideSettings={true} + config={{ + labelStyle: labelStyle, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Lagend Styling - Text, Fonts & Box Shadow" + width={500} + height={350} + hideSettings={true} + config={{ + legendStyle: legendStyle, + }} + compFactory={ChartCompWithDefault} + /> + </ExampleGroup> </> ); } diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/SankeyChart.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/SankeyChart.tsx index c169e7b37..5a2981536 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/SankeyChart.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/SankeyChart.tsx @@ -6,27 +6,42 @@ import ExampleGroup from "../../common/ExampleGroup"; const ChartCompWithDefault = uiCompRegistry["sankeyChart"].comp; -const defaultDataSource = "[\n {\n \"date\": \"2021-09\",\n \"department\": \"Administration\",\n \"spending\": 9003,\n \"budget\": 8000\n },\n {\n \"date\": \"2021-09\",\n \"department\": \"Finance\",\n \"spending\": 3033,\n \"budget\": 4000\n },\n {\n \"date\": \"2021-09\",\n \"department\": \"Sales\",\n \"spending\": 9230,\n \"budget\": 8000\n },\n {\n \"date\": \"2021-10\",\n \"department\": \"Administration\",\n \"spending\": 13032,\n \"budget\": 15000\n },\n {\n \"date\": \"2021-10\",\n \"department\": \"Finance\",\n \"spending\": 2300,\n \"budget\": 5000\n },\n {\n \"date\": \"2021-10\",\n \"department\": \"Sales\",\n \"spending\": 7323.5,\n \"budget\": 8000\n },\n {\n \"date\": \"2021-11\",\n \"department\": \"Administration\",\n \"spending\": 13000,\n \"budget\": 16023\n },\n {\n \"date\": \"2021-11\",\n \"department\": \"Finance\",\n \"spending\": 3569.5,\n \"budget\": 3000\n },\n {\n \"date\": \"2021-11\",\n \"department\": \"Sales\",\n \"spending\": 10000,\n \"budget\": 9932\n },\n {\n \"date\": \"2021-12\",\n \"department\": \"Administration\",\n \"spending\": 18033,\n \"budget\": 20000\n },\n {\n \"date\": \"2021-12\",\n \"department\": \"Finance\",\n \"spending\": 4890,\n \"budget\": 4500\n },\n {\n \"date\": \"2021-12\",\n \"department\": \"Sales\",\n \"spending\": 9322,\n \"budget\": 8000\n }\n]"; +const chartStyle= { + background: "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + chartBorderColor: "#FDFAFA", + chartBorderStyle: "solid", + chartBorderWidth: "2", + chartBoxShadow: "200", + chartShadowColor: "#3377FF" +} -const defaultEchartsJsonOption = "{\n \"xAxis\": {\n \"data\": [\n \"Day 1\",\n \"Day 2\",\n \"Day 3\",\n \"Day 4\",\n \"Day 5\"\n ]\n },\n \"data\": [\n [\n 100,\n 200,\n 50,\n 150\n ],\n [\n 120,\n 220,\n 80,\n 180\n ],\n [\n 80,\n 150,\n 60,\n 130\n ],\n [\n 130,\n 230,\n 110,\n 190\n ],\n [\n 90,\n 180,\n 70,\n 160\n ]\n ]\n}"; +const titleStyle = { + chartBoxShadow: "9", + chartFontStyle: "Italic", + chartShadowColor: "#FFBD01", + chartTextColor: "#36B389", + chartTextSize: "30", + chartTextWeight: "Bold" +} -const data = JSON.stringify(defaultDataSource); -const echartsOption = JSON.stringify(defaultEchartsJsonOption); +const lineStyle = { + chartBoxShadow: "5", + chartShadowColor: "#020101", + chartBorderColor: "#222222", + chartBorderWidth: "3", +} + +const detailStyle = { + chartBoxShadow: "5", + chartFontFamily: "serif", + chartFontStyle: "Italic", + chartShadowColor: "#FFD701", + chartTextColor: "#7A7A7B", + chartTextSize: "20", + chartTextWeight: "bold" +} export default function SankeyChartExample() { - const blackListConfig: string[] = ["data", "echartsOption", "series"]; - const series = [ - { - "columnName": "spending", - "seriesName": "Spending", - "dataIndex": "f011b34c" - }, - { - "columnName": "budget", - "seriesName": "Budget", - "dataIndex": "30e02269" - } -]; return ( <> <ExampleGroup @@ -37,11 +52,222 @@ export default function SankeyChartExample() { title={trans("componentDoc.default")} width={500} height={300} - blackListConfig={blackListConfig} config={{ - mode: "json", - data: data, - series: series, + }} + compFactory={ChartCompWithDefault} + /> + </ExampleGroup> + + <ExampleGroup + title="Alignment & Layout" + description="The Following Examples Show the different alignment option on the Sankey Chart Component." + > + <Example + title="Title Position - Left" + width={500} + height={350} + config={{ + echartsTitleConfig : { + "position" : "left", + } + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Title Position - Center" + width={500} + height={350} + config={{ + echartsTitleConfig : { + "position" : "center", + } + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Title Position - Right" + width={500} + height={350} + config={{ + echartsTitleConfig : { + "position" : "right", + } + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Title Position - Bottom" + width={500} + height={350} + config={{ + echartsTitleVerticalConfig: { + position: "bottom", + }, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Chart Position - Top & Left" + width={500} + height={350} + config={{ + top: "0", + left: "0", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Chart Position - Bottom & Right" + width={500} + height={350} + config={{ + bottom: "0", + right: "0", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Sankey Chart's Curveness - 0.2" + width={500} + height={350} + config={{ + curveness: "0.2", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Sankey Chart's Curveness - 0.8" + width={500} + height={350} + config={{ + curveness: "0.8", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Sankey Chart's Opacity - 0.3" + width={500} + height={350} + config={{ + opacity: "0.1", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Sankey Chart's Opacity - 0.8" + width={500} + height={350} + config={{ + opacity: "0.8", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Node Width - 3" + width={500} + height={350} + config={{ + nodeWidth: "3", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Node Width - 30" + width={500} + height={350} + config={{ + nodeWidth: "30", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Node Gap - 10" + width={500} + height={350} + config={{ + nodeGap: "10", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Node Gap - 70" + width={500} + height={350} + config={{ + nodeGap: "70", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Draggable - Set Node to draggable" + width={500} + height={350} + config={{ + draggable: true, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Draggable - Set Node to non-draggable" + width={500} + height={350} + config={{ + draggable: false, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Hiding the Tooltip" + width={500} + height={350} + config={{ + tooltip: false, + }} + compFactory={ChartCompWithDefault} + /> + </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the Styling Properties on the Sankey Chart Component." + > + <Example + title="Chart Styling - Background Color, Box Shadow, Border" + width={500} + height={350} + hideSettings={true} + config={{ + chartStyle: chartStyle, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Title Styling - Text, Fonts & Box Shadow" + width={500} + height={350} + hideSettings={true} + config={{ + titleStyle: titleStyle, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Line Styling - Border & Box Shadow" + width={500} + height={350} + hideSettings={true} + config={{ + lineStyle: lineStyle, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Details Styling - Text, Fonts & Box Shadow" + width={500} + height={350} + hideSettings={true} + config={{ + detailStyle: detailStyle, }} compFactory={ChartCompWithDefault} /> diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/SunburstChart.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/SunburstChart.tsx index c04aec9d4..468d1ca02 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/SunburstChart.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/SunburstChart.tsx @@ -6,29 +6,36 @@ import ExampleGroup from "../../common/ExampleGroup"; const ChartCompWithDefault = uiCompRegistry["sunburstChart"].comp; -const defaultDataSource = "[\n {\n \"date\": \"2021-09\",\n \"department\": \"Administration\",\n \"spending\": 9003,\n \"budget\": 8000\n },\n {\n \"date\": \"2021-09\",\n \"department\": \"Finance\",\n \"spending\": 3033,\n \"budget\": 4000\n },\n {\n \"date\": \"2021-09\",\n \"department\": \"Sales\",\n \"spending\": 9230,\n \"budget\": 8000\n },\n {\n \"date\": \"2021-10\",\n \"department\": \"Administration\",\n \"spending\": 13032,\n \"budget\": 15000\n },\n {\n \"date\": \"2021-10\",\n \"department\": \"Finance\",\n \"spending\": 2300,\n \"budget\": 5000\n },\n {\n \"date\": \"2021-10\",\n \"department\": \"Sales\",\n \"spending\": 7323.5,\n \"budget\": 8000\n },\n {\n \"date\": \"2021-11\",\n \"department\": \"Administration\",\n \"spending\": 13000,\n \"budget\": 16023\n },\n {\n \"date\": \"2021-11\",\n \"department\": \"Finance\",\n \"spending\": 3569.5,\n \"budget\": 3000\n },\n {\n \"date\": \"2021-11\",\n \"department\": \"Sales\",\n \"spending\": 10000,\n \"budget\": 9932\n },\n {\n \"date\": \"2021-12\",\n \"department\": \"Administration\",\n \"spending\": 18033,\n \"budget\": 20000\n },\n {\n \"date\": \"2021-12\",\n \"department\": \"Finance\",\n \"spending\": 4890,\n \"budget\": 4500\n },\n {\n \"date\": \"2021-12\",\n \"department\": \"Sales\",\n \"spending\": 9322,\n \"budget\": 8000\n }\n]"; +const chartStyle= { + background: "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + chartBorderColor: "#FDFAFA", + chartBorderStyle: "solid", + chartBorderWidth: "2", + chartBoxShadow: "200", + chartShadowColor: "#3377FF" +} -const defaultEchartsJsonOption = "{\n \"xAxis\": {\n \"data\": [\n \"Day 1\",\n \"Day 2\",\n \"Day 3\",\n \"Day 4\",\n \"Day 5\"\n ]\n },\n \"data\": [\n [\n 100,\n 200,\n 50,\n 150\n ],\n [\n 120,\n 220,\n 80,\n 180\n ],\n [\n 80,\n 150,\n 60,\n 130\n ],\n [\n 130,\n 230,\n 110,\n 190\n ],\n [\n 90,\n 180,\n 70,\n 160\n ]\n ]\n}"; +const titleStyle = { + chartBoxShadow: "9", + chartFontStyle: "Italic", + chartShadowColor: "#FFBD01", + chartTextColor: "#36B389", + chartTextSize: "30", + chartTextWeight: "Bold" +} -const data = JSON.stringify(defaultDataSource); -const echartsOption = JSON.stringify(defaultEchartsJsonOption); +const detailStyle = { + chartFontFamily: "serif", + chartFontStyle: "Italic", + chartTextColor: "#7A7A7B", + chartTextSize: "20", + chartTextWeight: "bold" +} export default function SunburstChartExample() { - const blackListConfig: string[] = ["data", "echartsOption", "series"]; - const series = [ - { - "columnName": "spending", - "seriesName": "Spending", - "dataIndex": "f011b34c" - }, - { - "columnName": "budget", - "seriesName": "Budget", - "dataIndex": "30e02269" - } -]; return ( <> + <ExampleGroup title={trans("componentDoc.basicUsage")} description={trans("componentDoc.basicDemoDescription")} @@ -37,11 +44,165 @@ export default function SunburstChartExample() { title={trans("componentDoc.default")} width={500} height={300} - blackListConfig={blackListConfig} config={{ - mode: "json", - data: data, - series: series, + }} + compFactory={ChartCompWithDefault} + /> + </ExampleGroup> + + <ExampleGroup + title="Alignment & Layout" + description="The Following Examples Show the different alignment option on the Sunburst Chart Component." + > + <Example + title="Title Position - Left" + width={500} + height={350} + config={{ + echartsTitleConfig : { + "position" : "left", + } + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Title Position - Center" + width={500} + height={350} + config={{ + echartsTitleConfig : { + "position" : "center", + } + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Title Position - Right" + width={500} + height={350} + config={{ + echartsTitleConfig : { + "position" : "right", + } + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Title Position - Bottom" + width={500} + height={350} + config={{ + echartsTitleVerticalConfig: { + position: "bottom", + }, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Chart Position - Position_X : Extreme Left" + width={500} + height={350} + config={{ + position_x: "25", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Chart Position - Position_X : Center" + width={500} + height={350} + config={{ + position_x: "50", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Chart Position - Position_X : Extreme Right" + width={500} + height={350} + config={{ + position_x: "75", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Inline Radius - 20" + width={500} + height={350} + config={{ + radiusInline: "20", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Inline Radius - 50" + width={500} + height={350} + config={{ + radiusInline: "50", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Outline Radius - 60" + width={500} + height={350} + config={{ + radiusOutline: "40", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Outline Radius - 100" + width={500} + height={350} + config={{ + radiusOutline: "100", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Hiding the Tooltip" + width={500} + height={350} + config={{ + tooltip: false, + }} + compFactory={ChartCompWithDefault} + /> + </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the Styling Properties on the Sunburst Chart Component." + > + <Example + title="Chart Styling - Background Color, Box Shadow, Border" + width={500} + height={350} + hideSettings={true} + config={{ + chartStyle: chartStyle, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Title Styling - Text, Fonts & Box Shadow" + width={500} + height={350} + hideSettings={true} + config={{ + titleStyle: titleStyle, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Details Styling - Text, Fonts & Box Shadow" + width={500} + height={350} + hideSettings={true} + config={{ + detailStyle: detailStyle, }} compFactory={ChartCompWithDefault} /> diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/ThemeRiverChart.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/ThemeRiverChart.tsx index b8dbe29d8..a32d2f479 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/ThemeRiverChart.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/ThemeRiverChart.tsx @@ -6,27 +6,44 @@ import ExampleGroup from "../../common/ExampleGroup"; const ChartCompWithDefault = uiCompRegistry["themeriverChart"].comp; -const defaultDataSource = "[\n {\n \"date\": \"2021-09\",\n \"department\": \"Administration\",\n \"spending\": 9003,\n \"budget\": 8000\n },\n {\n \"date\": \"2021-09\",\n \"department\": \"Finance\",\n \"spending\": 3033,\n \"budget\": 4000\n },\n {\n \"date\": \"2021-09\",\n \"department\": \"Sales\",\n \"spending\": 9230,\n \"budget\": 8000\n },\n {\n \"date\": \"2021-10\",\n \"department\": \"Administration\",\n \"spending\": 13032,\n \"budget\": 15000\n },\n {\n \"date\": \"2021-10\",\n \"department\": \"Finance\",\n \"spending\": 2300,\n \"budget\": 5000\n },\n {\n \"date\": \"2021-10\",\n \"department\": \"Sales\",\n \"spending\": 7323.5,\n \"budget\": 8000\n },\n {\n \"date\": \"2021-11\",\n \"department\": \"Administration\",\n \"spending\": 13000,\n \"budget\": 16023\n },\n {\n \"date\": \"2021-11\",\n \"department\": \"Finance\",\n \"spending\": 3569.5,\n \"budget\": 3000\n },\n {\n \"date\": \"2021-11\",\n \"department\": \"Sales\",\n \"spending\": 10000,\n \"budget\": 9932\n },\n {\n \"date\": \"2021-12\",\n \"department\": \"Administration\",\n \"spending\": 18033,\n \"budget\": 20000\n },\n {\n \"date\": \"2021-12\",\n \"department\": \"Finance\",\n \"spending\": 4890,\n \"budget\": 4500\n },\n {\n \"date\": \"2021-12\",\n \"department\": \"Sales\",\n \"spending\": 9322,\n \"budget\": 8000\n }\n]"; +const chartStyle= { + background: "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + chartBorderColor: "#FDFAFA", + chartBorderStyle: "solid", + chartBorderWidth: "2", + chartBoxShadow: "200", + chartShadowColor: "#3377FF" +} -const defaultEchartsJsonOption = "{\n \"xAxis\": {\n \"data\": [\n \"Day 1\",\n \"Day 2\",\n \"Day 3\",\n \"Day 4\",\n \"Day 5\"\n ]\n },\n \"data\": [\n [\n 100,\n 200,\n 50,\n 150\n ],\n [\n 120,\n 220,\n 80,\n 180\n ],\n [\n 80,\n 150,\n 60,\n 130\n ],\n [\n 130,\n 230,\n 110,\n 190\n ],\n [\n 90,\n 180,\n 70,\n 160\n ]\n ]\n}"; +const titleStyle = { + chartBoxShadow: "9", + chartFontStyle: "Italic", + chartShadowColor: "#FFBD01", + chartTextColor: "#36B389", + chartTextSize: "30", + chartTextWeight: "Bold" +} -const data = JSON.stringify(defaultDataSource); -const echartsOption = JSON.stringify(defaultEchartsJsonOption); +const xAxisStyle = { + chartBoxShadow: "5", + chartFontFamily: "serif", + chartFontStyle: "Italic", + chartShadowColor: "#020101", + chartTextColor: "#971827", + chartTextSize: "20", + chartTextWeight: "bold" +} + +const legendStyle = { + chartBoxShadow: "9", + chartFontStyle: "Italic", + chartShadowColor: "#FFBD01", + chartTextColor: "#36B389", + chartTextSize: "15", + chartTextWeight: "Bold" +} export default function ThemeRiverChartExample() { - const blackListConfig: string[] = ["data", "echartsOption", "series"]; - const series = [ - { - "columnName": "spending", - "seriesName": "Spending", - "dataIndex": "f011b34c" - }, - { - "columnName": "budget", - "seriesName": "Budget", - "dataIndex": "30e02269" - } -]; return ( <> <ExampleGroup @@ -37,15 +54,189 @@ export default function ThemeRiverChartExample() { title={trans("componentDoc.default")} width={500} height={300} - blackListConfig={blackListConfig} config={{ - mode: "json", - data: data, - series: series, }} compFactory={ChartCompWithDefault} /> </ExampleGroup> + + <ExampleGroup + title="Alignment & Layout" + description="The Following Examples Show the different alignment option on the ThemeRiver Chart Component." + > + <Example + title="Title Position - Left" + width={500} + height={350} + config={{ + echartsTitleConfig : { + "position" : "left", + } + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Title Position - Center" + width={500} + height={350} + config={{ + echartsTitleConfig : { + "position" : "center", + } + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Title Position - Right" + width={500} + height={350} + config={{ + echartsTitleConfig : { + "position" : "right", + } + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Legend Position - Top" + width={500} + height={350} + config={{ + echartsLegendConfig : { + "position" : "top", + }, + echartsTitleConfig : { + "position" : "left", + }, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Lagend Position - Bottom" + width={500} + height={350} + config={{ + echartsLegendConfig : { + "position" : "bottom", + } + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Legend Orientation + Position - Vertical + Left" + width={500} + height={350} + config={{ + echartsLegendOrientConfig: { + orient: "vertical" + }, + echartsLegendAlignConfig: { + left: "left" + }, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Legend Orientation + Position - Horizontal + Center" + width={500} + height={350} + config={{ + echartsLegendOrientConfig: { + orient: "horizontal" + }, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Legend Orientation + Position - Vertical + Right" + width={500} + height={350} + config={{ + echartsLegendOrientConfig: { + orient: "vertical" + }, + echartsLegendAlignConfig: { + left: "right" + }, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Hiding Legends" + width={500} + height={350} + config={{ + legendVisibility: false, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Chart Position - Top & Left" + width={500} + height={350} + config={{ + top: "-10", + left: "0", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Chart Position - Bottom & Right" + width={500} + height={350} + config={{ + bottom: "0", + right: "0", + }} + compFactory={ChartCompWithDefault} + /> + </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the Styling Properties on the HeatMap Chart Component." + > + <Example + title="Chart Styling - Background Color, Box Shadow, Border" + width={500} + height={350} + hideSettings={true} + config={{ + chartStyle: chartStyle, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Title Styling - Text, Fonts & Box Shadow" + width={500} + height={350} + hideSettings={true} + config={{ + titleStyle: titleStyle, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="X-Axis Styling" + width={500} + height={350} + hideSettings={true} + config={{ + axisStyle: xAxisStyle, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Legend Styling" + width={500} + height={350} + hideSettings={true} + config={{ + legendStyle: legendStyle, + }} + compFactory={ChartCompWithDefault} + /> + </ExampleGroup> </> ); } diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/TreeChart.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/TreeChart.tsx index b0d10650f..602206f7c 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/TreeChart.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/TreeChart.tsx @@ -6,46 +6,199 @@ import ExampleGroup from "../../common/ExampleGroup"; const ChartCompWithDefault = uiCompRegistry["treeChart"].comp; -const defaultDataSource = "[\n {\n \"date\": \"2021-09\",\n \"department\": \"Administration\",\n \"spending\": 9003,\n \"budget\": 8000\n },\n {\n \"date\": \"2021-09\",\n \"department\": \"Finance\",\n \"spending\": 3033,\n \"budget\": 4000\n },\n {\n \"date\": \"2021-09\",\n \"department\": \"Sales\",\n \"spending\": 9230,\n \"budget\": 8000\n },\n {\n \"date\": \"2021-10\",\n \"department\": \"Administration\",\n \"spending\": 13032,\n \"budget\": 15000\n },\n {\n \"date\": \"2021-10\",\n \"department\": \"Finance\",\n \"spending\": 2300,\n \"budget\": 5000\n },\n {\n \"date\": \"2021-10\",\n \"department\": \"Sales\",\n \"spending\": 7323.5,\n \"budget\": 8000\n },\n {\n \"date\": \"2021-11\",\n \"department\": \"Administration\",\n \"spending\": 13000,\n \"budget\": 16023\n },\n {\n \"date\": \"2021-11\",\n \"department\": \"Finance\",\n \"spending\": 3569.5,\n \"budget\": 3000\n },\n {\n \"date\": \"2021-11\",\n \"department\": \"Sales\",\n \"spending\": 10000,\n \"budget\": 9932\n },\n {\n \"date\": \"2021-12\",\n \"department\": \"Administration\",\n \"spending\": 18033,\n \"budget\": 20000\n },\n {\n \"date\": \"2021-12\",\n \"department\": \"Finance\",\n \"spending\": 4890,\n \"budget\": 4500\n },\n {\n \"date\": \"2021-12\",\n \"department\": \"Sales\",\n \"spending\": 9322,\n \"budget\": 8000\n }\n]"; +const chartStyle= { + background: "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + chartBorderColor: "#FDFAFA", + chartBorderStyle: "solid", + chartBorderWidth: "2", + chartBoxShadow: "200", + chartShadowColor: "#3377FF" +} -const defaultEchartsJsonOption = "{\n \"xAxis\": {\n \"data\": [\n \"Day 1\",\n \"Day 2\",\n \"Day 3\",\n \"Day 4\",\n \"Day 5\"\n ]\n },\n \"data\": [\n [\n 100,\n 200,\n 50,\n 150\n ],\n [\n 120,\n 220,\n 80,\n 180\n ],\n [\n 80,\n 150,\n 60,\n 130\n ],\n [\n 130,\n 230,\n 110,\n 190\n ],\n [\n 90,\n 180,\n 70,\n 160\n ]\n ]\n}"; +const titleStyle = { + chartBoxShadow: "9", + chartFontStyle: "Italic", + chartShadowColor: "#FFBD01", + chartTextColor: "#36B389", + chartTextSize: "30", + chartTextWeight: "Bold" +} -const data = JSON.stringify(defaultDataSource); -const echartsOption = JSON.stringify(defaultEchartsJsonOption); +const detailStyle = { + chartFontFamily: "serif", + chartFontStyle: "Italic", + chartTextColor: "#7A7A7B", + chartTextSize: "20", + chartTextWeight: "bold" +} export default function TreeChartExample() { - const blackListConfig: string[] = ["data", "echartsOption", "series"]; - const series = [ - { - "columnName": "spending", - "seriesName": "Spending", - "dataIndex": "f011b34c" - }, - { - "columnName": "budget", - "seriesName": "Budget", - "dataIndex": "30e02269" - } -]; return ( <> <ExampleGroup title={trans("componentDoc.basicUsage")} - description={trans("componentDoc.basicDemoDescription")} + description="The Following Examples Show the Basic Usage of the Tree Chart Component." > <Example title={trans("componentDoc.default")} width={500} height={300} - blackListConfig={blackListConfig} config={{ - mode: "json", - data: data, - series: series, }} compFactory={ChartCompWithDefault} /> </ExampleGroup> + + <ExampleGroup + title="Alignment & Layout" + description="The Following Examples Show the different alignment option on the Tree Chart Component." + > + <Example + title="Title Position - Left" + width={500} + height={350} + config={{ + echartsTitleConfig : { + "position" : "left", + } + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Title Position - Center" + width={500} + height={350} + config={{ + echartsTitleConfig : { + "position" : "center", + } + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Title Position - Right" + width={500} + height={350} + config={{ + echartsTitleConfig : { + "position" : "right", + } + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Title Position - Bottom" + width={500} + height={350} + config={{ + echartsTitleVerticalConfig: { + position: "bottom", + }, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Hiding Tooltip" + width={500} + height={350} + config={{ + tooltip: false, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Chart Position - Top & Left" + width={500} + height={350} + config={{ + top: "-15", + left: "0", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Chart Position - Bottom & Right" + width={500} + height={350} + config={{ + bottom: "-15", + right: "0", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Point Size - 10" + width={500} + height={350} + config={{ + pointSize: "10", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Point Size - 20" + width={500} + height={350} + config={{ + pointSize: "20", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Line Width - 3" + width={500} + height={350} + config={{ + lineWidth: "3", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Line Width - 6" + width={500} + height={350} + config={{ + lineWidth: "6", + }} + compFactory={ChartCompWithDefault} + /> + </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the Styling Properties on the Sunburst Chart Component." + > + <Example + title="Chart Styling - Background Color, Box Shadow, Border" + width={500} + height={350} + hideSettings={true} + config={{ + chartStyle: chartStyle, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Title Styling - Text, Fonts & Box Shadow" + width={500} + height={350} + hideSettings={true} + config={{ + titleStyle: titleStyle, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Details Styling - Text, Fonts & Box Shadow" + width={500} + height={350} + hideSettings={true} + config={{ + detailStyle: detailStyle, + }} + compFactory={ChartCompWithDefault} + /> + </ExampleGroup> </> ); } diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/TreemapChart.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/TreemapChart.tsx index 35fdc1804..0971b5ef0 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/TreemapChart.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ChartsComp/TreemapChart.tsx @@ -6,46 +6,164 @@ import ExampleGroup from "../../common/ExampleGroup"; const ChartCompWithDefault = uiCompRegistry["treemapChart"].comp; -const defaultDataSource = "[\n {\n \"date\": \"2021-09\",\n \"department\": \"Administration\",\n \"spending\": 9003,\n \"budget\": 8000\n },\n {\n \"date\": \"2021-09\",\n \"department\": \"Finance\",\n \"spending\": 3033,\n \"budget\": 4000\n },\n {\n \"date\": \"2021-09\",\n \"department\": \"Sales\",\n \"spending\": 9230,\n \"budget\": 8000\n },\n {\n \"date\": \"2021-10\",\n \"department\": \"Administration\",\n \"spending\": 13032,\n \"budget\": 15000\n },\n {\n \"date\": \"2021-10\",\n \"department\": \"Finance\",\n \"spending\": 2300,\n \"budget\": 5000\n },\n {\n \"date\": \"2021-10\",\n \"department\": \"Sales\",\n \"spending\": 7323.5,\n \"budget\": 8000\n },\n {\n \"date\": \"2021-11\",\n \"department\": \"Administration\",\n \"spending\": 13000,\n \"budget\": 16023\n },\n {\n \"date\": \"2021-11\",\n \"department\": \"Finance\",\n \"spending\": 3569.5,\n \"budget\": 3000\n },\n {\n \"date\": \"2021-11\",\n \"department\": \"Sales\",\n \"spending\": 10000,\n \"budget\": 9932\n },\n {\n \"date\": \"2021-12\",\n \"department\": \"Administration\",\n \"spending\": 18033,\n \"budget\": 20000\n },\n {\n \"date\": \"2021-12\",\n \"department\": \"Finance\",\n \"spending\": 4890,\n \"budget\": 4500\n },\n {\n \"date\": \"2021-12\",\n \"department\": \"Sales\",\n \"spending\": 9322,\n \"budget\": 8000\n }\n]"; +const chartStyle= { + background: "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + chartBorderColor: "#FDFAFA", + chartBorderStyle: "solid", + chartBorderWidth: "2", + chartBoxShadow: "200", + chartShadowColor: "#3377FF" +} -const defaultEchartsJsonOption = "{\n \"xAxis\": {\n \"data\": [\n \"Day 1\",\n \"Day 2\",\n \"Day 3\",\n \"Day 4\",\n \"Day 5\"\n ]\n },\n \"data\": [\n [\n 100,\n 200,\n 50,\n 150\n ],\n [\n 120,\n 220,\n 80,\n 180\n ],\n [\n 80,\n 150,\n 60,\n 130\n ],\n [\n 130,\n 230,\n 110,\n 190\n ],\n [\n 90,\n 180,\n 70,\n 160\n ]\n ]\n}"; +const titleStyle = { + chartBoxShadow: "9", + chartFontStyle: "Italic", + chartShadowColor: "#FFBD01", + chartTextColor: "#36B389", + chartTextSize: "30", + chartTextWeight: "Bold" +} -const data = JSON.stringify(defaultDataSource); -const echartsOption = JSON.stringify(defaultEchartsJsonOption); +const detailStyle = { + chartFontFamily: "serif", + chartFontStyle: "Italic", + chartTextColor: "#fff", + chartTextSize: "20", + chartTextWeight: "bold" +} export default function TreemapChartExample() { - const blackListConfig: string[] = ["data", "echartsOption", "series"]; - const series = [ - { - "columnName": "spending", - "seriesName": "Spending", - "dataIndex": "f011b34c" - }, - { - "columnName": "budget", - "seriesName": "Budget", - "dataIndex": "30e02269" - } -]; return ( <> <ExampleGroup title={trans("componentDoc.basicUsage")} - description={trans("componentDoc.basicDemoDescription")} + description="The Following Examples Show the Basic Usage of the Treemap Chart Component." + > <Example title={trans("componentDoc.default")} width={500} height={300} - blackListConfig={blackListConfig} config={{ - mode: "json", - data: data, - series: series, }} compFactory={ChartCompWithDefault} /> </ExampleGroup> + + <ExampleGroup + title="Alignment & Layout" + description="The Following Examples Show the different alignment option on the Tree Chart Component." + > + <Example + title="Title Position - Left" + width={500} + height={350} + config={{ + echartsTitleConfig : { + "position" : "left", + } + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Title Position - Center" + width={500} + height={350} + config={{ + echartsTitleConfig : { + "position" : "center", + } + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Title Position - Right" + width={500} + height={350} + config={{ + echartsTitleConfig : { + "position" : "right", + } + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Title Position - Bottom" + width={500} + height={350} + config={{ + echartsTitleVerticalConfig: { + position: "bottom", + }, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Hiding Tooltip" + width={500} + height={350} + config={{ + tooltip: false, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Chart Position - Top & Left" + width={500} + height={350} + config={{ + top: "-15", + left: "0", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Chart Position - Bottom & Right" + width={500} + height={350} + config={{ + bottom: "-15", + right: "0", + }} + compFactory={ChartCompWithDefault} + /> + </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the Styling Properties on the Sunburst Chart Component." + > + <Example + title="Chart Styling - Background Color, Box Shadow, Border" + width={500} + height={350} + hideSettings={true} + config={{ + chartStyle: chartStyle, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Title Styling - Text, Fonts & Box Shadow" + width={500} + height={350} + hideSettings={true} + config={{ + titleStyle: titleStyle, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Details Styling - Text, Fonts & Box Shadow" + width={500} + height={350} + hideSettings={true} + config={{ + detailStyle: detailStyle, + }} + compFactory={ChartCompWithDefault} + /> + </ExampleGroup> </> ); } diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ContainersComp/CollapsibleContainer.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ContainersComp/CollapsibleContainer.tsx new file mode 100644 index 000000000..f7fb4d23c --- /dev/null +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ContainersComp/CollapsibleContainer.tsx @@ -0,0 +1,441 @@ +import { ContainerComp } from "comps/comps/containerComp/containerComp"; +import { trans } from "i18n"; +import { chartColorPalette } from "lowcoder-design"; +import Example from "../../common/Example"; +import ExampleGroup from "../../common/ExampleGroup"; + +const container = { + "header": { + "layout": { + "fedaa62": { + "i": "fedaa62", + "h": 5, + "w": 6, + "x": 0, + "y": 0 + }, + "5661db3a": { + "i": "5661db3a", + "h": 5, + "w": 10, + "x": 14, + "y": 0 + } + }, + "items": { + "fedaa62": { + "compType": "text", + "comp": { + "text": "## Personal Details", + "autoHeight": "auto", + "type": "markdown", + "horizontalAlignment": "left", + "contentScrollBar": true, + "verticalAlignment": "center", + "style": { + "background": "#F5F5F6", + "margin": "3px", + "padding": "3px", + "text": "#222222", + "textSize": "14px", + "border": "#D7D9E0", + "borderStyle": "solid", + "radius": "4px", + "borderWidth": "0", + "lineHeight": "18px", + "links": "#3377FF" + }, + "margin": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "padding": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "preventStyleOverwriting": false, + "appliedThemeId": "default-theme-id", + "version": "latest" + }, + "name": "text6" + }, + "5661db3a": { + "compType": "toggleButton", + "comp": { + "value": "true", + "showText": false, + "trueText": "Hide", + "falseText": "Show", + "trueIcon": "/icon:solid/AngleUp", + "falseIcon": "/icon:solid/AngleDown", + "iconPosition": "right", + "alignment": "right", + "style": { + "background": "#F5F5F6", + "margin": "3px", + "padding": "3px", + "text": "#222222", + "textSize": "14px", + "border": "#D7D9E0", + "borderStyle": "solid", + "radius": "4px", + "borderWidth": "1px", + "lineHeight": "18px" + }, + "showBorder": false, + "preventStyleOverwriting": false, + "appliedThemeId": "default-theme-id", + "version": "latest" + }, + "name": "toggleButton3" + } + } + }, + "body": { + "0": { + "view": { + "layout": { + "c93dc520": { + "i": "c93dc520", + "h": 7, + "w": 10, + "x": 0, + "y": 0, + "pos": 0 + }, + "54dd6cc": { + "i": "54dd6cc", + "h": 10, + "w": 10, + "x": 14, + "y": 0, + "pos": 5 + }, + "aa36926a": { + "i": "aa36926a", + "h": 7, + "w": 10, + "x": 0, + "y": 7, + "pos": 1 + }, + "fc179ca5": { + "i": "fc179ca5", + "h": 7, + "w": 10, + "x": 14, + "y": 14, + "pos": 4 + }, + "99d1503e": { + "i": "99d1503e", + "h": 7, + "w": 10, + "x": 0, + "y": 14, + "pos": 6 + } + }, + "items": { + "c93dc520": { + "compType": "input", + "comp": { + "defaultValue": "", + "value": "", + "label": { + "text": "Full Name", + "width": "33", + "widthUnit": "%", + "position": "row", + "align": "left" + }, + "placeholder": "Full name", + "required": true, + "validationType": "Text", + "style": { + "background": "#00000000", + "border": "#D7D9E0", + "margin": "3px", + "padding": "3px", + "borderStyle": "solid", + "radius": "4px", + "borderWidth": "0px", + "opacity": "1" + }, + "labelStyle": { + "margin": "3px", + "padding": "3px", + "label": "#222222", + "textSize": "14px", + "border": "#D7D9E0", + "borderStyle": "solid", + "borderWidth": "0px", + "accent": "#3377FF" + }, + "prefixIcon": "/icon:solid/file-lines", + "inputFieldStyle": { + "margin": "3px", + "padding": "3px", + "text": "#222222", + "textSize": "14px", + "border": "#D7D9E0", + "borderStyle": "solid", + "radius": "4px", + "borderWidth": "1px", + "accent": "#3377FF" + }, + "preventStyleOverwriting": false, + "appliedThemeId": "default-theme-id", + "version": "latest" + }, + "name": "input1" + }, + "aa36926a": { + "compType": "input", + "comp": { + "defaultValue": "", + "value": "", + "label": { + "text": "Email", + "width": "33", + "widthUnit": "%", + "position": "row", + "align": "left" + }, + "placeholder": "Email Address", + "required": true, + "validationType": "Email", + "style": { + "background": "#00000000", + "border": "#D7D9E0", + "margin": "3px", + "padding": "3px", + "borderStyle": "solid", + "radius": "4px", + "borderWidth": "0px", + "opacity": "1" + }, + "labelStyle": { + "margin": "3px", + "padding": "3px", + "label": "#222222", + "textSize": "14px", + "border": "#D7D9E0", + "borderStyle": "solid", + "borderWidth": "0px", + "accent": "#3377FF" + }, + "prefixIcon": "/icon:solid/inbox", + "inputFieldStyle": { + "margin": "3px", + "padding": "3px", + "text": "#222222", + "textSize": "14px", + "border": "#D7D9E0", + "borderStyle": "solid", + "radius": "4px", + "borderWidth": "1px", + "accent": "#3377FF" + }, + "preventStyleOverwriting": false, + "appliedThemeId": "default-theme-id", + "version": "latest" + }, + "name": "input2" + }, + "54dd6cc": { + "compType": "radio", + "comp": { + "defaultValue": "1", + "value": "", + "label": { + "text": "Gender", + "width": "33", + "widthUnit": "%", + "position": "row", + "align": "left" + }, + "options": { + "optionType": "manual", + "manual": { + "manual": [ + { + "value": "1", + "label": "Male" + }, + { + "value": "2", + "label": "Female" + } + ] + }, + "mapData": { + "data": "[]" + } + }, + "style": { + "background": "#00000000", + "border": "#D7D9E0", + "margin": "3px", + "padding": "3px", + "borderStyle": "solid", + "radius": "4px", + "borderWidth": "0px", + "opacity": "1" + }, + "labelStyle": { + "margin": "3px", + "padding": "3px", + "label": "#222222", + "textSize": "14px", + "border": "#D7D9E0", + "borderStyle": "solid", + "borderWidth": "0px", + "accent": "#3377FF" + }, + "layout": "horizontal", + "inputFieldStyle": { + "margin": "3px", + "padding": "3px", + "staticText": "#222222", + "textSize": "14px", + "borderStyle": "solid", + "borderWidth": "1px", + "checkedBackground": "#3377FF", + "uncheckedBorder": "#D7D9E0", + "checkedBorder": "#3377FF" + }, + "preventStyleOverwriting": false, + "appliedThemeId": "default-theme-id", + "version": "latest" + }, + "name": "radio1" + }, + "fc179ca5": { + "compType": "date", + "comp": { + "defaultValue": "", + "value": "", + "userTimeZone": "Europe/Madrid", + "label": { + "text": "DOB", + "width": "33", + "widthUnit": "%", + "position": "row", + "align": "left" + }, + "placeholder": "Select Date", + "inputFormat": "YYYY-MM-DD", + "style": { + "background": "#00000000", + "border": "#D7D9E0", + "margin": "3px", + "padding": "3px", + "borderStyle": "solid", + "radius": "4px", + "borderWidth": "0px", + "opacity": "1" + }, + "labelStyle": { + "margin": "3px", + "padding": "3px", + "label": "#222222", + "textSize": "14px", + "border": "#D7D9E0", + "borderStyle": "solid", + "borderWidth": "0px" + }, + "suffixIcon": "/icon:regular/calendar", + "minDate": "1960-01-01", + "maxDate": "2010-12-31", + "inputFieldStyle": { + "border": "#D7D9E0", + "radius": "4px", + "text": "#222222", + "margin": "3px", + "padding": "3px", + "borderStyle": "solid", + "borderWidth": "1px", + "accent": "#3377FF" + }, + "timeZone": "Europe/Madrid", + "preventStyleOverwriting": false, + "appliedThemeId": "default-theme-id", + "version": "latest" + }, + "name": "date1" + }, + "99d1503e": { + "compType": "numberInput", + "comp": { + "defaultValue": "", + "value": "", + "placeholder": "+449827222541", + "label": { + "text": "Phone #", + "width": "33", + "widthUnit": "%", + "position": "row", + "align": "left" + }, + "formatter": "standard", + "step": "", + "controls": false, + "thousandsSeparator": false, + "prefixText": "", + "preventStyleOverwriting": false, + "appliedThemeId": "default-theme-id", + "version": "latest" + }, + "name": "numberInput1" + } + } + } + } + }, + "footer": { + "layout": {} + }, + "showHeader": true, + "showBody": true, + "autoHeight": "auto", + "showVerticalScrollbar": false, + "horizontalGridCells": 24, + "scrollbars": false, + "style": { + "border": "#D7D9E0", + "background": "#FFFFFF", + "radius": "4px", + "borderWidth": "1px", + "borderStyle": "solid", + "margin": "3px", + "padding": "3px" + }, + "appliedThemeId": "default-theme-id" +}; + +export default function CollapsibleContainerExample() { + return ( + <> + <ExampleGroup + title={trans("componentDoc.basicUsage")} + description="The Following Examples Show the Basic Usage of the Collapsiable Container Component." + > + <Example + title="Default Container" + hideSettings={true} + height={500} + width={1000} + config={{ + container: container, + }} + compFactory={ContainerComp} + /> + </ExampleGroup> + </> + ); +} \ No newline at end of file diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ContainersComp/ColumnLayout.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ContainersComp/ColumnLayout.tsx index e6a59383c..b86f4ce3b 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ContainersComp/ColumnLayout.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ContainersComp/ColumnLayout.tsx @@ -3,268 +3,235 @@ import Example from "../../common/Example"; import ExampleGroup from "../../common/ExampleGroup"; const columns={ - "manual": [ - { - "id": 0, - "label": "Column1", - "key": "Column1", - "minWidth": "", - "background": "", - "backgroundImage": "", - "border": "", - "radius": "", - "margin": "", - "padding": "" - }, - { - "id": 1, - "label": "Column2", - "key": "Column2", - "minWidth": "", - "background": "", - "backgroundImage": "", - "border": "", - "radius": "", - "margin": "", - "padding": "" - }, - { - "id": 2, - "label": "Add Column1", - "key": "Add Column1", - "minWidth": "", - "background": "", - "backgroundImage": "", - "border": "", - "radius": "", - "margin": "", - "padding": "" - }, - { - "id": 3, - "label": "Add Column2", - "key": "Add Column2", - "minWidth": "", - "background": "", - "backgroundImage": "", - "border": "", - "radius": "", - "margin": "", - "padding": "" - }, - { - "id": 4, - "label": "Add Column3", - "key": "Add Column3", - "minWidth": "", - "background": "", - "backgroundImage": "", - "border": "", - "radius": "", - "margin": "", - "padding": "" - }, - { - "id": 5, - "label": "Add Column4", - "key": "Add Column4", - "minWidth": "", - "background": "", - "backgroundImage": "", - "border": "", - "radius": "", - "margin": "", - "padding": "" - } - ] + "manual": [ + { + "id": 0, + "label": "Column1", + "key": "Column1", + "minWidth": "", + "background": "", + "backgroundImage": "", + "border": "", + "radius": "", + "margin": "", + "padding": "" + }, + { + "id": 1, + "label": "Column2", + "key": "Column2", + "minWidth": "", + "background": "", + "backgroundImage": "", + "border": "", + "radius": "", + "margin": "", + "padding": "" + }, + { + "id": 2, + "label": "Add Column1", + "key": "Add Column1", + "minWidth": "", + "background": "", + "backgroundImage": "", + "border": "", + "radius": "", + "margin": "", + "padding": "" + }, + { + "id": 3, + "label": "Add Column2", + "key": "Add Column2", + "minWidth": "", + "background": "", + "backgroundImage": "", + "border": "", + "radius": "", + "margin": "", + "padding": "" + } + ] }; const container={ "0": { "layout": { - "d131aa12": { - "i": "d131aa12", + "164dcb77": { + "i": "164dcb77", "h": 6, - "w": 17, - "x": 4, - "y": 5, - "pos": 1 + "w": 14, + "x": 5, + "y": 4, + "pos": 0 } }, "items": { - "d131aa12": { - "compType": "progress", + "164dcb77": { + "compType": "text", "comp": { - "value": "60", + "text": "### Row1, Column1", + "autoHeight": "auto", + "type": "markdown", + "horizontalAlignment": "center", + "contentScrollBar": true, + "verticalAlignment": "center", + "margin": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "padding": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, "preventStyleOverwriting": false, "appliedThemeId": "", "version": "latest" }, - "name": "progress1" + "name": "text1" } } }, "1": { "layout": { - "e193cd76": { - "i": "e193cd76", + "6e4f0687": { + "i": "6e4f0687", "h": 6, - "w": 24, - "x": 0, - "y": 5, + "w": 14, + "x": 5, + "y": 4, "pos": 0 } }, "items": { - "e193cd76": { - "compType": "button", + "6e4f0687": { + "compType": "text", "comp": { - "text": "Button", - "type": "", - "form": "", + "text": "### Row1, Column2", + "autoHeight": "auto", + "type": "markdown", + "horizontalAlignment": "center", + "contentScrollBar": true, + "verticalAlignment": "center", + "margin": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "padding": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, "preventStyleOverwriting": false, "appliedThemeId": "", "version": "latest" }, - "name": "button1" + "name": "text3" } } }, "2": { "layout": { - "1d3eac41": { - "i": "1d3eac41", - "h": 7, - "w": 21, - "x": 1, - "y": 5, + "b47baba7": { + "i": "b47baba7", + "h": 6, + "w": 14, + "x": 5, + "y": 4, "pos": 0 } }, "items": { - "1d3eac41": { - "compType": "switch", + "b47baba7": { + "compType": "text", "comp": { - "defaultValue": "", - "value": "", - "label": { - "text": "Switch", - "width": "33", - "widthUnit": "%", - "position": "row", - "align": "left" + "text": "### Row2, Column1", + "autoHeight": "auto", + "type": "markdown", + "horizontalAlignment": "center", + "contentScrollBar": true, + "verticalAlignment": "center", + "margin": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "padding": { + "left": "", + "right": "", + "top": "", + "bottom": "" }, "preventStyleOverwriting": false, "appliedThemeId": "", "version": "latest" }, - "name": "switch1" + "name": "text2" } } }, "3": { "layout": { - "5853c1f5": { - "i": "5853c1f5", - "h": 20, - "w": 15, - "x": 5, - "y": 0, - "pos": 0 - } - }, - "items": { - "5853c1f5": { - "compType": "progressCircle", - "comp": { - "value": "60", - "preventStyleOverwriting": false, - "appliedThemeId": "", - "version": "latest" - }, - "name": "progressCircle1" - } - } - }, - "4": { - "layout": { - "68b3d00f": { - "i": "68b3d00f", + "ce02a8ee": { + "i": "ce02a8ee", "h": 6, - "w": 23, - "x": 1, - "y": 7, - "pos": 0 - } - }, - "items": { - "68b3d00f": { - "compType": "button", - "comp": { - "text": "Button", - "type": "", - "form": "", - "preventStyleOverwriting": false, - "appliedThemeId": "", - "version": "latest" - }, - "name": "button2" - } - } - }, - "5": { - "layout": { - "307f8e6b": { - "i": "307f8e6b", - "h": 10, - "w": 24, - "x": 0, - "y": 6, + "w": 14, + "x": 5, + "y": 3, "pos": 0 } }, "items": { - "307f8e6b": { - "compType": "checkbox", + "ce02a8ee": { + "compType": "text", "comp": { - "defaultValue": "", - "value": "", - "label": { - "text": "Check box", - "width": "33", - "widthUnit": "%", - "position": "row", - "align": "left" - }, - "options": { - "optionType": "manual", - "manual": { - "manual": [ - { - "value": "1", - "label": "Option 1" - }, - { - "value": "2", - "label": "Option 2" - } - ] - }, - "mapData": { - "data": "[]" - } + "text": "### Row2, Column2", + "autoHeight": "auto", + "type": "markdown", + "horizontalAlignment": "center", + "contentScrollBar": true, + "verticalAlignment": "center", + "margin": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "padding": { + "left": "", + "right": "", + "top": "", + "bottom": "" }, - "layout": "horizontal", "preventStyleOverwriting": false, "appliedThemeId": "", "version": "latest" }, - "name": "checkbox1" + "name": "text4" } } } }; +const columnStyle = { + "background": "linear-gradient(45deg, #d53369 0%, #daae51 100%)", + "border": "#222222", + "padding": "0px" +}; + +const style= { + "background": "linear-gradient(135deg, #FFFFFF 0%, rgba(255, 255, 255, 1) 100%)" +}; + export default function ColumnLayoutExample() { return ( <> @@ -275,20 +242,31 @@ export default function ColumnLayoutExample() { <Example title="Hiding the Component" hideSettings={true} + width={1000} config={{ containers: container, columns: columns, hidden: true, + columnStyle: columnStyle, + style: style, + templateRows: "3fr 1fr", + templateColumns: "1fr 3fr", }} compFactory={ColumnLayoutComp} /> <Example title="Disabling the Component" hideSettings={true} + width={1000} config={{ containers: container, columns: columns, disabled: true, + columnStyle: columnStyle, + style: style, + templateRows: "3fr 1fr", + templateColumns: "1fr 3fr", + matchColumnsHeight: true, }} compFactory={ColumnLayoutComp} /> @@ -299,48 +277,865 @@ export default function ColumnLayoutExample() { description="The Following Examples Show the Column Layout options on Column Layout Component." > <Example - title="Column Definition" + title="Column Definition - 3 Columns with different sizes" hideSettings={true} + width={1000} config={{ - containers: container, - columns: columns, + containers: { + "0": { + "layout": { + "164dcb77": { + "i": "164dcb77", + "h": 6, + "w": 14, + "x": 5, + "y": 4, + "pos": 0 + } + }, + "items": { + "164dcb77": { + "compType": "text", + "comp": { + "text": "### Row1, Column1", + "autoHeight": "auto", + "type": "markdown", + "horizontalAlignment": "center", + "contentScrollBar": true, + "verticalAlignment": "center", + "margin": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "padding": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "preventStyleOverwriting": false, + "appliedThemeId": "", + "version": "latest" + }, + "name": "text1" + } + } + }, + "1": { + "layout": { + "6e4f0687": { + "i": "6e4f0687", + "h": 6, + "w": 14, + "x": 5, + "y": 4, + "pos": 0 + } + }, + "items": { + "6e4f0687": { + "compType": "text", + "comp": { + "text": "### Row1, Column2", + "autoHeight": "auto", + "type": "markdown", + "horizontalAlignment": "center", + "contentScrollBar": true, + "verticalAlignment": "center", + "margin": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "padding": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "preventStyleOverwriting": false, + "appliedThemeId": "", + "version": "latest" + }, + "name": "text3" + } + } + }, + "2": { + "layout": { + "b47baba7": { + "i": "b47baba7", + "h": 6, + "w": 14, + "x": 5, + "y": 4, + "pos": 0 + } + }, + "items": { + "b47baba7": { + "compType": "text", + "comp": { + "text": "### Row1, Column3", + "autoHeight": "auto", + "type": "markdown", + "horizontalAlignment": "center", + "contentScrollBar": true, + "verticalAlignment": "center", + "margin": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "padding": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "preventStyleOverwriting": false, + "appliedThemeId": "", + "version": "latest" + }, + "name": "text2" + } + } + }, + "3": { + "layout": { + "ce02a8ee": { + "i": "ce02a8ee", + "h": 6, + "w": 14, + "x": 5, + "y": 3, + "pos": 0 + } + }, + "items": { + "ce02a8ee": { + "compType": "text", + "comp": { + "text": "### Row2, Column1", + "autoHeight": "auto", + "type": "markdown", + "horizontalAlignment": "center", + "contentScrollBar": true, + "verticalAlignment": "center", + "margin": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "padding": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "preventStyleOverwriting": false, + "appliedThemeId": "", + "version": "latest" + }, + "name": "text4" + } + } + }, + "4": { + "layout": { + "7ff66f36": { + "i": "7ff66f36", + "h": 6, + "w": 24, + "x": 0, + "y": 2, + "pos": 0 + } + }, + "items": { + "7ff66f36": { + "compType": "text", + "comp": { + "text": "### Row2, Column2", + "autoHeight": "auto", + "type": "markdown", + "horizontalAlignment": "center", + "contentScrollBar": true, + "verticalAlignment": "center", + "margin": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "padding": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "preventStyleOverwriting": false, + "appliedThemeId": "", + "version": "latest" + }, + "name": "text5" + } + } + }, + "5": { + "layout": { + "8e25033d": { + "i": "8e25033d", + "h": 6, + "w": 14, + "x": 5, + "y": 2, + "pos": 0 + } + }, + "items": { + "8e25033d": { + "compType": "text", + "comp": { + "text": "### Row2, Column3", + "autoHeight": "auto", + "type": "markdown", + "horizontalAlignment": "center", + "contentScrollBar": true, + "verticalAlignment": "center", + "margin": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "padding": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "preventStyleOverwriting": false, + "appliedThemeId": "", + "version": "latest" + }, + "name": "text6" + } + } + } + }, + columns: { + "manual": [ + { + "id": 0, + "label": "Column1", + "key": "Column1", + "minWidth": "", + "background": "", + "backgroundImage": "", + "border": "", + "radius": "", + "margin": "", + "padding": "" + }, + { + "id": 1, + "label": "Column2", + "key": "Column2", + "minWidth": "", + "background": "", + "backgroundImage": "", + "border": "", + "radius": "", + "margin": "", + "padding": "" + }, + { + "id": 2, + "label": "Add Column1", + "key": "Add Column1", + "minWidth": "", + "background": "", + "backgroundImage": "", + "border": "", + "radius": "", + "margin": "", + "padding": "" + }, + { + "id": 3, + "label": "Add Column2", + "key": "Add Column2", + "minWidth": "", + "background": "", + "backgroundImage": "", + "border": "", + "radius": "", + "margin": "", + "padding": "" + }, + { + "id": 4, + "label": "Add Column3", + "key": "Add Column3", + "minWidth": "", + "background": "", + "backgroundImage": "", + "border": "", + "radius": "", + "margin": "", + "padding": "" + }, + { + "id": 5, + "label": "Add Column4", + "key": "Add Column4", + "minWidth": "", + "background": "", + "backgroundImage": "", + "border": "", + "radius": "", + "margin": "", + "padding": "" + } + ] + }, templateColumns: "2fr 1fr 2fr", - templateRows: "1fr", + templateRows: "1fr 1fr", + columnStyle: columnStyle, + style: style, + matchColumnsHeight: true, }} compFactory={ColumnLayoutComp} /> <Example - title="Row Definition" + title="Row Definition - 3 Rows with different sizes" hideSettings={true} + width={1000} config={{ - containers: container, - columns: columns, - templateRows: "1fr 1fr 1fr", - templateColumns: "2fr 1fr 2fr", + containers: { + "0": { + "layout": { + "164dcb77": { + "i": "164dcb77", + "h": 8, + "w": 19, + "x": 3, + "y": 4, + "pos": 0 + } + }, + "items": { + "164dcb77": { + "compType": "text", + "comp": { + "text": "### Row1, Column1", + "autoHeight": "auto", + "type": "markdown", + "horizontalAlignment": "center", + "contentScrollBar": true, + "verticalAlignment": "center", + "margin": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "padding": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "preventStyleOverwriting": false, + "appliedThemeId": "", + "version": "latest" + }, + "name": "text1" + } + } + }, + "1": { + "layout": { + "6e4f0687": { + "i": "6e4f0687", + "h": 6, + "w": 24, + "x": 0, + "y": 5, + "pos": 0 + } + }, + "items": { + "6e4f0687": { + "compType": "text", + "comp": { + "text": "### Row1, Column2", + "autoHeight": "auto", + "type": "markdown", + "horizontalAlignment": "center", + "contentScrollBar": true, + "verticalAlignment": "center", + "margin": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "padding": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "preventStyleOverwriting": false, + "appliedThemeId": "", + "version": "latest" + }, + "name": "text3" + } + } + }, + "2": { + "layout": { + "b47baba7": { + "i": "b47baba7", + "h": 10, + "w": 18, + "x": 5, + "y": 4, + "pos": 0 + } + }, + "items": { + "b47baba7": { + "compType": "text", + "comp": { + "text": "### Row1, Column3", + "autoHeight": "auto", + "type": "markdown", + "horizontalAlignment": "center", + "contentScrollBar": true, + "verticalAlignment": "center", + "margin": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "padding": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "preventStyleOverwriting": false, + "appliedThemeId": "", + "version": "latest" + }, + "name": "text2" + } + } + }, + "3": { + "layout": { + "ce02a8ee": { + "i": "ce02a8ee", + "h": 8, + "w": 17, + "x": 2, + "y": 16, + "pos": 0 + } + }, + "items": { + "ce02a8ee": { + "compType": "text", + "comp": { + "text": "### Row2, Column1", + "autoHeight": "auto", + "type": "markdown", + "horizontalAlignment": "center", + "contentScrollBar": true, + "verticalAlignment": "center", + "margin": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "padding": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "preventStyleOverwriting": false, + "appliedThemeId": "", + "version": "latest" + }, + "name": "text4" + } + } + }, + "4": { + "layout": { + "7ff66f36": { + "i": "7ff66f36", + "h": 6, + "w": 24, + "x": 0, + "y": 16, + "pos": 0 + } + }, + "items": { + "7ff66f36": { + "compType": "text", + "comp": { + "text": "### Row2, Column2", + "autoHeight": "auto", + "type": "markdown", + "horizontalAlignment": "center", + "contentScrollBar": true, + "verticalAlignment": "center", + "margin": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "padding": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "preventStyleOverwriting": false, + "appliedThemeId": "", + "version": "latest" + }, + "name": "text5" + } + } + }, + "5": { + "layout": { + "8e25033d": { + "i": "8e25033d", + "h": 8, + "w": 19, + "x": 3, + "y": 16, + "pos": 0 + } + }, + "items": { + "8e25033d": { + "compType": "text", + "comp": { + "text": "### Row2, Column3", + "autoHeight": "auto", + "type": "markdown", + "horizontalAlignment": "center", + "contentScrollBar": true, + "verticalAlignment": "center", + "margin": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "padding": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "preventStyleOverwriting": false, + "appliedThemeId": "", + "version": "latest" + }, + "name": "text6" + } + } + }, + "6": { + "layout": { + "e92230c": { + "i": "e92230c", + "h": 8, + "w": 19, + "x": 2, + "y": 3, + "pos": 0 + } + }, + "items": { + "e92230c": { + "compType": "text", + "comp": { + "text": "### Row3, Column1", + "autoHeight": "auto", + "type": "markdown", + "horizontalAlignment": "center", + "contentScrollBar": true, + "verticalAlignment": "center", + "margin": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "padding": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "preventStyleOverwriting": false, + "appliedThemeId": "", + "version": "latest" + }, + "name": "text7" + } + } + }, + "7": { + "layout": { + "5e09b262": { + "i": "5e09b262", + "h": 6, + "w": 24, + "x": 0, + "y": 4, + "pos": 0 + } + }, + "items": { + "5e09b262": { + "compType": "text", + "comp": { + "text": "### Row3, Column2", + "autoHeight": "auto", + "type": "markdown", + "horizontalAlignment": "center", + "contentScrollBar": true, + "verticalAlignment": "center", + "margin": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "padding": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "preventStyleOverwriting": false, + "appliedThemeId": "", + "version": "latest" + }, + "name": "text8" + } + } + }, + "8": { + "layout": { + "1bc7c61f": { + "i": "1bc7c61f", + "h": 8, + "w": 20, + "x": 1, + "y": 2, + "pos": 0 + } + }, + "items": { + "1bc7c61f": { + "compType": "text", + "comp": { + "text": "### Row3, Column3", + "autoHeight": "auto", + "type": "markdown", + "horizontalAlignment": "center", + "contentScrollBar": true, + "verticalAlignment": "center", + "margin": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "padding": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "preventStyleOverwriting": false, + "appliedThemeId": "", + "version": "latest" + }, + "name": "text9" + } + } + } + }, + columns: { + "manual": [ + { + "id": 0, + "label": "Column1", + "key": "Column1", + "minWidth": "", + "background": "", + "backgroundImage": "", + "border": "", + "radius": "", + "margin": "", + "padding": "" + }, + { + "id": 1, + "label": "Column2", + "key": "Column2", + "minWidth": "", + "background": "", + "backgroundImage": "", + "border": "", + "radius": "", + "margin": "", + "padding": "" + }, + { + "id": 2, + "label": "Add Column1", + "key": "Add Column1", + "minWidth": "", + "background": "", + "backgroundImage": "", + "border": "", + "radius": "", + "margin": "", + "padding": "" + }, + { + "id": 3, + "label": "Add Column2", + "key": "Add Column2", + "minWidth": "", + "background": "", + "backgroundImage": "", + "border": "", + "radius": "", + "margin": "", + "padding": "" + }, + { + "id": 4, + "label": "Add Column3", + "key": "Add Column3", + "minWidth": "", + "background": "", + "backgroundImage": "", + "border": "", + "radius": "", + "margin": "", + "padding": "" + }, + { + "id": 5, + "label": "Add Column4", + "key": "Add Column4", + "minWidth": "", + "background": "", + "backgroundImage": "", + "border": "", + "radius": "", + "margin": "", + "padding": "" + }, + { + "id": 6, + "label": "Add Column5", + "key": "Add Column5", + "minWidth": "", + "background": "", + "backgroundImage": "", + "border": "", + "radius": "", + "margin": "", + "padding": "" + }, + { + "id": 7, + "label": "Add Column6", + "key": "Add Column6", + "minWidth": "", + "background": "", + "backgroundImage": "", + "border": "", + "radius": "", + "margin": "", + "padding": "" + }, + { + "id": 8, + "label": "Add Column7", + "key": "Add Column7", + "minWidth": "", + "background": "", + "backgroundImage": "", + "border": "", + "radius": "", + "margin": "", + "padding": "" + } + ] + }, + templateRows: "1fr 3fr 1fr", + templateColumns: "1fr 3fr 1fr", + columnStyle: columnStyle, + style: style, + matchColumnsHeight: true, }} compFactory={ColumnLayoutComp} /> <Example title="Column Gap" hideSettings={true} + width={1000} config={{ containers: container, columns: columns, - columnGap: "100px", - templateRows: "1fr", - templateColumns: "2fr 1fr 2fr", + columnGap: "200px", + templateRows: "3fr 1fr", + templateColumns: "1fr 3fr", + columnStyle: columnStyle, + style: style, }} compFactory={ColumnLayoutComp} /> <Example title="Row Gap" hideSettings={true} + width={1000} config={{ containers: container, columns: columns, - rowGap: "100px", - templateRows: "1fr 1fr", - templateColumns: "2fr 1fr 2fr", + rowGap: "200px", + templateRows: "3fr 1fr", + templateColumns: "1fr 3fr", + columnStyle: columnStyle, + style: style, }} compFactory={ColumnLayoutComp} /> diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ContainersComp/FloatTextContainer.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ContainersComp/FloatTextContainer.tsx new file mode 100644 index 000000000..7a1578773 --- /dev/null +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ContainersComp/FloatTextContainer.tsx @@ -0,0 +1,120 @@ +import { ContainerComp } from "comps/comps/containerComp/containerComp"; +import { trans } from "i18n"; +import { chartColorPalette } from "lowcoder-design"; +import Example from "../../common/Example"; +import ExampleGroup from "../../common/ExampleGroup"; + +const container = { + "header": { + "layout": { + "f1e0a72f": { + "i": "f1e0a72f", + "h": 5, + "w": 24, + "x": 0, + "y": 0 + } + }, + "items": { + "f1e0a72f": { + "compType": "text", + "comp": { + "text": "### Displayed Container Title", + "autoHeight": "auto", + "type": "markdown", + "horizontalAlignment": "left", + "contentScrollBar": true, + "verticalAlignment": "center", + "margin": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "padding": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "preventStyleOverwriting": false, + "appliedThemeId": "", + "version": "latest" + }, + "name": "containerTitle1" + } + } + }, + "body": { + "0": { + "view": { + "layout": { + "e13e96e1": { + "i": "e13e96e1", + "h": 20, + "w": 17, + "x": 3, + "y": 1, + "pos": 0 + } + }, + "items": { + "e13e96e1": { + "compType": "image", + "comp": { + "src": "https://temp.im/350x400", + "autoHeight": "fixed", + "restrictPaddingOnRotation": "image", + "preventStyleOverwriting": false, + "appliedThemeId": "", + "version": "latest" + }, + "name": "image1" + } + } + } + } + }, + "footer": { + "layout": {} + }, + "showHeader": true, + "showBody": true, + "showFooter": true, + "autoHeight": "auto", + "showVerticalScrollbar": false, + "horizontalGridCells": 24, + "scrollbars": false, + "style": { + "borderWidth": "1px" + }, + "appliedThemeId": "" +}; + +const text ="Lorem ipsum dolor sit amet, consectetur adipiscing elit. Morbi feugiat faucibus eleifend. Pellentesque eleifend, risus vel sagittis mattis, mauris ipsum tempor sapien, eu lobortis lacus libero a dui. Cras erat felis, rhoncus vestibulum consectetur et, ultrices ut purus. Sed a tortor orci. Vestibulum nec eleifend ante."; + +export default function FloatTextContainerExample() { + return ( + <> + <ExampleGroup + title={trans("componentDoc.basicUsage")} + description="The Following Examples Show the Basic Usage of the Collapsiable Container Component." + > + <Example + title="Default Container" + hideSettings={true} + height={500} + width={1000} + config={{ + container: container, + text: text, + float: "left", + horizontalAlignment: "justify", + width: "60", + }} + compFactory={ContainerComp} + /> + </ExampleGroup> + </> + ); +} \ No newline at end of file diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ContainersComp/ResponsiveLayout.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ContainersComp/ResponsiveLayout.tsx index 926c916df..23152d129 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ContainersComp/ResponsiveLayout.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ContainersComp/ResponsiveLayout.tsx @@ -2,6 +2,341 @@ import { ResponsiveLayoutComp } from "comps/comps/responsiveLayout/responsiveLay import Example from "../../common/Example"; import ExampleGroup from "../../common/ExampleGroup"; +const container= { + "0": { + "layout": { + "2c8159fd": { + "i": "2c8159fd", + "h": 23, + "w": 24, + "x": 0, + "y": 0, + "pos": 0 + } + }, + "items": { + "2c8159fd": { + "compType": "text", + "comp": { + "text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus vehicula quis justo et ornare.", + "autoHeight": "auto", + "type": "markdown", + "horizontalAlignment": "left", + "contentScrollBar": true, + "verticalAlignment": "center", + "margin": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "padding": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "preventStyleOverwriting": false, + "appliedThemeId": "", + "version": "latest" + }, + "name": "text1" + } + } + }, + "1": { + "layout": { + "6b3372d7": { + "i": "6b3372d7", + "h": 26, + "w": 24, + "x": 0, + "y": 0, + "pos": 0 + } + }, + "items": { + "6b3372d7": { + "compType": "text", + "comp": { + "text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus vehicula quis justo et ornare. Pellentesque aliquet libero id scelerisque dapibus. Integer tristique risus a nisl facilisis, vel tincidunt risus venenatis. Ut ut sapien velit. Nunc hendrerit nisi non magna consectetur ullamcorper. ", + "autoHeight": "auto", + "type": "markdown", + "horizontalAlignment": "left", + "contentScrollBar": true, + "verticalAlignment": "center", + "margin": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "padding": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "preventStyleOverwriting": false, + "appliedThemeId": "", + "version": "latest" + }, + "name": "text4" + } + } + }, + "2": { + "layout": { + "fb172507": { + "i": "fb172507", + "h": 30, + "w": 24, + "x": 0, + "y": 0, + "pos": 0 + } + }, + "items": { + "fb172507": { + "compType": "text", + "comp": { + "text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus vehicula quis justo et ornare.", + "autoHeight": "auto", + "type": "markdown", + "horizontalAlignment": "left", + "contentScrollBar": true, + "verticalAlignment": "center", + "margin": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "padding": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "preventStyleOverwriting": false, + "appliedThemeId": "", + "version": "latest" + }, + "name": "text2" + } + } + }, + "3": { + "layout": { + "b66b7903": { + "i": "b66b7903", + "h": 33, + "w": 24, + "x": 0, + "y": 0, + "pos": 0 + } + }, + "items": { + "b66b7903": { + "compType": "text", + "comp": { + "text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus vehicula quis justo et ornare. Pellentesque aliquet libero id scelerisque dapibus. Integer tristique risus a nisl facilisis, vel tincidunt risus venenatis. Ut ut sapien velit. Nunc hendrerit nisi non magna consectetur ullamcorper. ", + "autoHeight": "auto", + "type": "markdown", + "horizontalAlignment": "left", + "contentScrollBar": true, + "verticalAlignment": "center", + "margin": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "padding": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "preventStyleOverwriting": false, + "appliedThemeId": "", + "version": "latest" + }, + "name": "text5" + } + } + }, + "4": { + "layout": { + "43127fff": { + "i": "43127fff", + "h": 26, + "w": 24, + "x": 0, + "y": 2, + "pos": 0 + } + }, + "items": { + "43127fff": { + "compType": "text", + "comp": { + "text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus vehicula quis justo et ornare.", + "autoHeight": "auto", + "type": "markdown", + "horizontalAlignment": "left", + "contentScrollBar": true, + "verticalAlignment": "center", + "margin": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "padding": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "preventStyleOverwriting": false, + "appliedThemeId": "", + "version": "latest" + }, + "name": "text3" + } + } + }, + "5": { + "layout": { + "8274cd26": { + "i": "8274cd26", + "h": 33, + "w": 24, + "x": 0, + "y": 0, + "pos": 0 + } + }, + "items": { + "8274cd26": { + "compType": "text", + "comp": { + "text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus vehicula quis justo et ornare. Pellentesque aliquet libero id scelerisque dapibus. Integer tristique risus a nisl facilisis, vel tincidunt risus venenatis. Ut ut sapien velit. Nunc hendrerit nisi non magna consectetur ullamcorper. ", + "autoHeight": "auto", + "type": "markdown", + "horizontalAlignment": "left", + "contentScrollBar": true, + "verticalAlignment": "center", + "margin": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "padding": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "preventStyleOverwriting": false, + "appliedThemeId": "", + "version": "latest" + }, + "name": "text6" + } + } + } +}; + +const column= { + "manual": [ + { + "id": 0, + "label": "Column1", + "key": "Column1", + "minWidth": "", + "background": "", + "backgroundImage": "", + "border": "", + "radius": "", + "margin": "", + "padding": "" + }, + { + "id": 1, + "label": "Column2", + "key": "Column2", + "minWidth": "", + "background": "", + "backgroundImage": "", + "border": "", + "radius": "", + "margin": "", + "padding": "" + }, + { + "id": 2, + "label": "Column3", + "key": "Column3", + "minWidth": "", + "background": "", + "backgroundImage": "", + "border": "", + "radius": "", + "margin": "", + "padding": "" + }, + { + "id": 3, + "label": "Column4", + "key": "Column4", + "minWidth": "", + "background": "", + "backgroundImage": "", + "border": "", + "radius": "", + "margin": "", + "padding": "" + }, + { + "id": 4, + "label": "Column5", + "key": "Column5", + "minWidth": "", + "background": "", + "backgroundImage": "", + "border": "", + "radius": "", + "margin": "", + "padding": "" + }, + { + "id": 5, + "label": "Column6", + "key": "Column6", + "minWidth": "", + "background": "", + "backgroundImage": "", + "border": "", + "radius": "", + "margin": "", + "padding": "" + } + ] +}; + +const columnStyle= { + "background": "linear-gradient(135deg, #FFFFFF 0%, #FFFFFF 100%)", + "border": "#222222" +}; + +const style= { + "background": "linear-gradient(45deg, #d53369 0%, #daae51 100%)" +}; + export default function ResponsiveLayoutExample() { return ( <> @@ -11,15 +346,29 @@ export default function ResponsiveLayoutExample() { > <Example title="Hiding the Component" + hideSettings={true} + width={1000} config={{ hidden: true, + containers: container, + columns: column, + columnStyle: columnStyle, + style: style, + rowBreak: true, }} compFactory={ResponsiveLayoutComp} /> <Example title="Disabling the Component" + hideSettings={true} + width={1000} config={{ disabled: true, + containers: container, + columns: column, + columnStyle: columnStyle, + style: style, + rowBreak: true, }} compFactory={ResponsiveLayoutComp} /> @@ -30,16 +379,43 @@ export default function ResponsiveLayoutExample() { description="The Following Examples Show the Layout options on Component." > <Example - title="Hiding the Component" + title="Column Height - Matching" + hideSettings={true} + width={1000} + config={{ + containers: container, + columns: column, + columnStyle: columnStyle, + style: style, + rowBreak: true, + }} + compFactory={ResponsiveLayoutComp} + /> + <Example + title="Column Height - Non-Matching" + hideSettings={true} + width={1000} config={{ - hidden: true, + matchColumnsHeight: false, + containers: container, + columns: column, + columnStyle: columnStyle, + style: style, + rowBreak: true, }} compFactory={ResponsiveLayoutComp} /> <Example - title="Disabling the Component" + title="Responsiveness Effect - Responsive Layout adjust itself as per the screen size. Here, 4 columns will be shown per Row on Desktop view, 2 columns on Tablet iew and 1 column on Mobile view. You can change the screen size to see the effect " + hideSettings={true} + width={1000} config={{ - disabled: true, + matchColumnsHeight: false, + containers: container, + columns: column, + columnStyle: columnStyle, + style: style, + rowBreak: true, }} compFactory={ResponsiveLayoutComp} /> diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/ContainersComp/SplitLayout.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ContainersComp/SplitLayout.tsx new file mode 100644 index 000000000..84cade537 --- /dev/null +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/ContainersComp/SplitLayout.tsx @@ -0,0 +1,214 @@ +import { SplitLayoutComp } from "comps/comps/splitLayout/splitLayout"; +import Example from "../../common/Example"; +import ExampleGroup from "../../common/ExampleGroup"; + +const columns= { + "manual": [ + { + "id": 0, + "label": "Area 1", + "key": "Area1", + "minWidth": "10%", + "maxWidth": "90%", + "width": "50%", + "collapsible": false, + "background": "", + "backgroundImage": "", + "padding": "" + }, + { + "id": 1, + "label": "Area 2", + "key": "Area2", + "minWidth": "10%", + "maxWidth": "90%", + "width": "50%", + "collapsible": true, + "background": "", + "backgroundImage": "", + "padding": "" + }, + { + "id": 2, + "label": "Option 1", + "key": "Option 1", + "minWidth": "10%", + "maxWidth": "90%", + "width": "50%", + "collapsible": false, + "background": "", + "backgroundImage": "", + "padding": "" + } + ] +}; + +const bodyStyle= { + background: "#FFFFFF", + border: "#222222", +}; + +const columnStyle= { + background: "#FFFFFF", + border: "#222222", + margin: "10px", +}; + +export default function SplitLayoutExample() { + return ( + <> + <ExampleGroup + title="Basic Usage" + description="The Following Examples Show the Basic Usage of the Split Layout Component." + > + <Example + title="Default Component" + hideSettings={true} + width={1000} + config={{ + bodyStyle: bodyStyle, + columnStyle: columnStyle, + }} + compFactory={SplitLayoutComp} + /> + <Example + title="Multiple Split Layout containers ( Click on the icon at the center on right side ) " + hideSettings={true} + width={1000} + config={{ + columns: columns, + bodyStyle: bodyStyle, + columnStyle: columnStyle, + }} + compFactory={SplitLayoutComp} + /> + <Example + title="Setting Minimum Width - 30%" + hideSettings={true} + width={1000} + config={{ + columns: { + "manual": [ + { + "id": 0, + "label": "Area 1", + "key": "Area1", + "minWidth": "30%", + "maxWidth": "90%", + "width": "50%", + "collapsible": false, + "background": "", + "backgroundImage": "", + "padding": "" + }, + { + "id": 1, + "label": "Area 2", + "key": "Area2", + "minWidth": "30%", + "maxWidth": "90%", + "width": "50%", + "collapsible": true, + "background": "", + "backgroundImage": "", + "padding": "" + }, + { + "id": 2, + "label": "Option 1", + "key": "Option 1", + "minWidth": "30%", + "maxWidth": "90%", + "width": "50%", + "collapsible": false, + "background": "", + "backgroundImage": "", + "padding": "" + } + ] + }, + bodyStyle: bodyStyle, + columnStyle: columnStyle, + }} + compFactory={SplitLayoutComp} + /> + <Example + title="Setting Minimum Width - 10%" + hideSettings={true} + width={1000} + config={{ + columns: columns, + bodyStyle: bodyStyle, + columnStyle: columnStyle, + }} + compFactory={SplitLayoutComp} + /> + </ExampleGroup> + + <ExampleGroup + title="Layout" + description="The Following Examples Show the different layouts of the Split Layout Component." + > + <Example + title="Split Layout Orientation - Vertical" + hideSettings={true} + width={1000} + config={{ + bodyStyle: bodyStyle, + columnStyle: columnStyle, + orientation: "vertical", + }} + compFactory={SplitLayoutComp} + /> + <Example + title="Split Layout Orientation - Horizontal" + hideSettings={true} + width={1000} + config={{ + bodyStyle: bodyStyle, + columnStyle: columnStyle, + orientation: "horizontal", + }} + compFactory={SplitLayoutComp} + /> + </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the different Styling properties on the Split Layout Component." + > + <Example + title="Body Styling - Background Color, Border, Padding" + hideSettings={true} + width={1000} + config={{ + bodyStyle: { + "background": "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + "border": "#222222", + "borderWidth": "2px", + "padding": "10px", + }, + columnStyle: columnStyle, + }} + compFactory={SplitLayoutComp} + /> + <Example + title="Column Styling - Background Color, Border, Margin" + hideSettings={true} + width={1000} + config={{ + bodyStyle: bodyStyle, + columnStyle: { + "background": "linear-gradient(0deg, #f43b47 0%, #453a94 100%)", + "border": "#222222", + "borderWidth": "2px", + "borderStyle": "solid", + "margin": "10px", + }, + }} + compFactory={SplitLayoutComp} + /> + </ExampleGroup> + </> + ); + } \ No newline at end of file diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/Audio.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/Audio.tsx index ac0b62b3c..0b68aa54d 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/Audio.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/Audio.tsx @@ -7,6 +7,7 @@ export default function AudioExample() { <> <ExampleGroup title="Basic Usage" + description="The Following Examples Show the Basic Usage of the Audio Component." > <Example title="Default Audio Component" @@ -30,7 +31,88 @@ export default function AudioExample() { config={{ src: "https://cdn.pixabay.com/audio/2023/07/06/audio_e12e5bea9d.mp3", loop: true, + }} + compFactory={AudioComp} + /> + </ExampleGroup> + <ExampleGroup + title="Styling properties and Animations" + description="The Following Examples Show the Styling properties & Animations of the Audio Component." + > + <Example + title="Margin & Padding" + config={{ + src: "https://cdn.pixabay.com/audio/2023/07/06/audio_e12e5bea9d.mp3", + style: { + margin: "5px", + padding: "10px", + }, + }} + compFactory={AudioComp} + /> + <Example + title="Rotation - 45 Deg" + config={{ + src: "https://cdn.pixabay.com/audio/2023/07/06/audio_e12e5bea9d.mp3", + style: { + rotation: "45deg", + }, + }} + compFactory={AudioComp} + /> + <Example + title="Rotation - 135 Deg" + config={{ + src: "https://cdn.pixabay.com/audio/2023/07/06/audio_e12e5bea9d.mp3", + style: { + rotation: "135deg", + }, + }} + compFactory={AudioComp} + /> + </ExampleGroup> + + <ExampleGroup + title="Animation Style" + description="The Following Examples Show different animations on the Audio Component." + > + <Example + title="Bounce Animation" + config={{ + src: "https://cdn.pixabay.com/audio/2023/07/06/audio_e12e5bea9d.mp3", + animationStyle: { + "animation": "bounce", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={AudioComp} + /> + <Example + title="Swing Animation" + config={{ + src: "https://cdn.pixabay.com/audio/2023/07/06/audio_e12e5bea9d.mp3", + animationStyle: { + "animation": "swing", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={AudioComp} + /> + <Example + title="Tada Animation" + config={{ + src: "https://cdn.pixabay.com/audio/2023/07/06/audio_e12e5bea9d.mp3", + animationStyle: { + "animation": "tada", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, }} compFactory={AudioComp} /> diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/BPMNEditor.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/BPMNEditor.tsx index a32d10c91..e0725ab3c 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/BPMNEditor.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/BPMNEditor.tsx @@ -10,15 +10,72 @@ export default function BPMNEditorExample() { return ( <> <ExampleGroup - title={trans("componentDoc.basicUsage")} - description={trans("componentDoc.basicDemoDescription")} + title="Basic Usage" + description="The Following Examples Show the Basic Usage of the BPMN Editor Component." > <Example - title={trans("componentDoc.default")} + title="Default Component" + height={400} + width={1000} + hideSettings={true} config={{ }} compFactory={ChartCompWithDefault} /> + <Example + title="Designer Mode" + height={400} + width={1000} + hideSettings={true} + config={{ + designer: true, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Hiding the Logo" + height={400} + width={1000} + hideSettings={true} + config={{ + showLogo: false, + designer: true, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Allowing to Download the Image" + height={400} + width={1000} + hideSettings={true} + config={{ + designer: true, + svgDownload: true, + }} + compFactory={ChartCompWithDefault} + /> + </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the Styling properties of the BPMN Editor Component." + > + <Example + title="Body - Background Color, Border, Text Size and Margins" + height={400} + width={1000} + hideSettings={true} + config={{ + designer: true, + styles: { + "margin": "10px", + "textSize": "30px", + "backgroundColor": "#D7D9E0", + "border": "#222222" + }, + }} + compFactory={ChartCompWithDefault} + /> </ExampleGroup> </> ); diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/ColorPicker.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/ColorPicker.tsx index d3db96d3c..0bedb9c43 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/ColorPicker.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/ColorPicker.tsx @@ -66,6 +66,15 @@ export default function ColorPickerExample() { }} compFactory={ColorPickerComp} /> + <Example + title="Label Position - ROW" + config={{ + label:{ + position: "row", + } + }} + compFactory={ColorPickerComp} + /> <Example title="Label Alignment - RIGHT" config={{ @@ -76,6 +85,16 @@ export default function ColorPickerExample() { }} compFactory={ColorPickerComp} /> + <Example + title="Label Alignment - LEFT" + config={{ + label:{ + position: "column", + align: "left", + } + }} + compFactory={ColorPickerComp} + /> </ExampleGroup> <ExampleGroup @@ -111,6 +130,63 @@ export default function ColorPickerExample() { compFactory={ColorPickerComp} /> </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the different Styling properties of the Color Picker Component." + > + <Example + title="Background Color, Margin & Padding" + config={{ + style: { + "background": "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + "margin" : "15px", + "padding" : "15px", + }, + }} + compFactory={ColorPickerComp} + /> + <Example + title="Border Style, Color, Width & Radius" + config={{ + style: { + "background": "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + "margin": "15px", + "padding": "15px", + "border": "#FF0303", + "borderStyle": "dashed", + "radius": "10px", + "borderWidth": "3px" + }, + }} + compFactory={ColorPickerComp} + /> + <Example + title="Label - Text Color, Size, Weight, Font family, Border properties" + config={{ + style: { + "margin": "5px", + "padding": "5px", + "label": "#3377FF", + "textTransform": "Uppercase", + "textDecoration": "underline", + "textWeight": "bold", + "fontFamily": "Courier New", + "fontStyle": "Italic" + }, + }} + compFactory={ColorPickerComp} + /> + <Example + title="Accent color" + config={{ + style: { + "accent": "#fff", + }, + }} + compFactory={ColorPickerComp} + /> + </ExampleGroup> </> ); } \ No newline at end of file diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/Icons.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/Icons.tsx index 3e6190a15..525348dcd 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/Icons.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/Icons.tsx @@ -60,6 +60,138 @@ export default function IconExample() { compFactory={IconComp} /> </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the different Styling properties of the Icon Component." + > + <Example + title="Background & Fill Color" + width={120} + config={{ + icon: "/icon:antd/homefilled", + autoHeight: "fixed", + iconSize: "60", + style: { + "background": "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + "fill": "#E67373", + }, + }} + compFactory={IconComp} + /> + <Example + title="Border Style, Radius & Width" + width={120} + config={{ + icon: "/icon:antd/homefilled", + autoHeight: "fixed", + iconSize: "60", + style:{ + "border": "#E68E50", + "radius": "10px", + "borderWidth": "3px" + }, + }} + compFactory={IconComp} + /> + <Example + title="Margin & Padding" + width={120} + config={{ + icon: "/icon:antd/homefilled", + autoHeight: "fixed", + iconSize: "60", + style:{ + "border": "#E68E50", + "radius": "10px", + "borderWidth": "3px", + "margin": "5px", + "padding": "10px", + }, + }} + compFactory={IconComp} + /> + <Example + title="Rotation - 45 Deg" + width={120} + config={{ + icon: "/icon:antd/homefilled", + autoHeight: "fixed", + iconSize: "60", + style:{ + "rotation": "45deg", + }, + }} + compFactory={IconComp} + /> + <Example + title="Rotation - 135 Deg" + width={120} + config={{ + icon: "/icon:antd/homefilled", + autoHeight: "fixed", + iconSize: "60", + style:{ + "rotation": "135deg", + }, + }} + compFactory={IconComp} + /> + </ExampleGroup> + + <ExampleGroup + title="Animation Style" + description="The Following Examples Show different animations on the Icons Component." + > + <Example + title="Bounce Animation" + width={120} + config={{ + icon: "/icon:antd/homefilled", + autoHeight: "fixed", + iconSize: "60", + animationStyle: { + "animation": "bounce", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={IconComp} + /> + <Example + title="Swing Animation" + width={120} + config={{ + icon: "/icon:antd/homefilled", + autoHeight: "fixed", + iconSize: "60", + animationStyle: { + "animation": "swing", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={IconComp} + /> + <Example + title="Tada Animation" + width={120} + config={{ + icon: "/icon:antd/homefilled", + autoHeight: "fixed", + iconSize: "60", + animationStyle: { + "animation": "tada", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={IconComp} + /> + </ExampleGroup> </> ); } \ No newline at end of file diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/LottieAnimation.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/LottieAnimation.tsx index 1f0dfa614..59e69d79c 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/LottieAnimation.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/LottieAnimation.tsx @@ -7,6 +7,7 @@ export default function JsonLottieAnimationExample() { <> <ExampleGroup title="Basic Usage" + description="The Following Examples Show the Basic Usage of the Lottie Animation Component." > <Example title="An Animated Star Icon" @@ -24,7 +25,8 @@ export default function JsonLottieAnimationExample() { </ExampleGroup> <ExampleGroup - title="Interaction with Animated Icons" + title="Interaction with Lottie Animations" + description="The Following Examples Show other properties of the Lottie Animation Component." > <Example title="Endless Loop" @@ -83,6 +85,91 @@ export default function JsonLottieAnimationExample() { compFactory={JsonLottieComp} /> </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the different Styling properties of the Lottie Animation Component." + > + <Example + title="Background Color" + config={{ + container: { + "background": "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + }, + }} + compFactory={JsonLottieComp} + /> + <Example + title="Margin & Padding" + config={{ + container: { + "margin": "15px", + "padding": "15px", + }, + }} + compFactory={JsonLottieComp} + /> + <Example + title="Rotation - 45 Deg" + config={{ + container: { + "rotation": "45deg" + }, + }} + compFactory={JsonLottieComp} + /> + <Example + title="Rotation - 90 Deg" + config={{ + container: { + "rotation": "90deg" + }, + }} + compFactory={JsonLottieComp} + /> + </ExampleGroup> + + <ExampleGroup + title="Animation Style" + description="The Following Examples Show the different Animations of the Lottie Animation Component." + > + <Example + title="Bounce Animation" + config={{ + animationStyle: { + "animation": "bounce", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={JsonLottieComp} + /> + <Example + title="Swing Animation" + config={{ + animationStyle: { + "animation": "swing", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={JsonLottieComp} + /> + <Example + title="Tada Animation" + config={{ + animationStyle: { + "animation": "tada", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={JsonLottieComp} + /> + </ExampleGroup> </> ); } \ No newline at end of file diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/Mention.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/Mention.tsx index 9edbeb2ab..f6a05c68b 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/Mention.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/Mention.tsx @@ -8,14 +8,119 @@ export default function MentionCompExample() { <> <ExampleGroup title={trans("componentDoc.basicUsage")} - description={trans("componentDoc.basicDemoDescription")} + description="The Following Examples Show the Basic Usage of the Mention Component." > <Example - title={trans("componentDoc.value")} + title="Default Component" config={{ }} compFactory={MentionComp} /> + <Example + title="Placeholder Value" + config={{ + placeholder: "Type @ to see the data", + }} + compFactory={MentionComp} + /> + <Example + title="Default Value" + config={{ + value: "John Doe", + }} + compFactory={MentionComp} + /> + </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the Styling Properties of the Mention Component." + > + <Example + title="Label Name" + config={{ + label: { + "text": "Mention Component", + }, + }} + compFactory={MentionComp} + /> + <Example + title="Label Tooltip" + config={{ + label: { + "text": "Mention Component", + "tooltip": "This is a Mention Component" + }, + }} + compFactory={MentionComp} + /> + <Example + title="Label Position & Alignment - Left & Left" + config={{ + label: { + "text": "Mention Component", + "position": "row", + "align": "left" + }, + }} + compFactory={MentionComp} + /> + <Example + title="Label Position & Alignment - Left & Right" + config={{ + label: { + "text": "Mention Component", + "position": "row", + "align": "right" + }, + }} + compFactory={MentionComp} + /> + <Example + title="Label Position & Alignment - Top & Left" + config={{ + label: { + "text": "Mention Component", + "position": "column", + "align": "left" + }, + }} + compFactory={MentionComp} + /> + <Example + title="Label Position & Alignment - Top & Right" + config={{ + label: { + "text": "Mention Component", + "position": "column", + "align": "right" + }, + }} + compFactory={MentionComp} + /> + <Example + title="Label Width - 10%" + config={{ + label: { + "text": "Mention Component", + "width": "10", + "widthUnit": "%", + }, + }} + compFactory={MentionComp} + /> + <Example + title="Label Width - 30%" + config={{ + label: { + "text": "Mention Component", + "width": "47", + "widthUnit": "%", + }, + }} + compFactory={MentionComp} + /> </ExampleGroup> </> ); diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/QRCode.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/QRCode.tsx index e56cda509..093c65592 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/QRCode.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/QRCode.tsx @@ -7,6 +7,7 @@ export default function QRCodeExample() { <> <ExampleGroup title="Basic Usage" + description="The Following Examples Show the Basic Usage of the QR Code Component." > <Example title="QR Code Component" @@ -30,6 +31,91 @@ export default function QRCodeExample() { compFactory={QRCodeComp} /> </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the different Styling of the QR Code Component." + > + <Example + title="Background Color, Margin & Padding" + config={{ + style: { + "background": "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + "color": "#DC1212", + "margin": "15px", + "padding": "25px", + }, + }} + compFactory={QRCodeComp} + /> + <Example + title="Border Style, Color, Width & Radius" + config={{ + style: { + "border": "#DC1212", + "margin": "15px", + "padding": "25px", + "radius": "10px", + "borderWidth": "3px", + }, + }} + compFactory={QRCodeComp} + /> + </ExampleGroup> + + <ExampleGroup + title="Animation Styles" + description="The Following Examples Show the different Animation Styles of the QR Code Component." + > + <Example + title="Bounce Animation" + config={{ + style: { + "margin": "15px", + "padding": "25px", + }, + animationStyle: { + "animation": "bounce", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={QRCodeComp} + /> + <Example + title="Swing Animation" + config={{ + style: { + "margin": "15px", + "padding": "25px", + }, + animationStyle: { + "animation": "swing", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={QRCodeComp} + /> + <Example + title="Tada Animation" + config={{ + style: { + "margin": "15px", + "padding": "25px", + }, + animationStyle: { + "animation": "tada", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={QRCodeComp} + /> + </ExampleGroup> </> ); } \ No newline at end of file diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/Scanner.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/Scanner.tsx index 6cd6ef8ef..3f3b21f46 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/Scanner.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/Scanner.tsx @@ -47,6 +47,54 @@ export default function ScannerExample() { compFactory={ScannerComp} /> </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the different Styling properties of the Scanner Component." + > + <Example + title="Background Color, Margin & Padding" + config={{ + style: { + "background": "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + "margin" : "15px", + "padding" : "15px", + }, + }} + compFactory={ScannerComp} + /> + <Example + title="Border Style, Color, Width & Radius" + config={{ + style: { + "background": "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + "margin": "15px", + "padding": "15px", + "border": "#FF0303", + "borderStyle": "dashed", + "radius": "10px", + "borderWidth": "3px" + }, + }} + compFactory={ScannerComp} + /> + <Example + title="Label - Text Color, Size, Weight, Font family, Border properties" + config={{ + style: { + "margin": "5px", + "padding": "5px", + "label": "#3377FF", + "textTransform": "Uppercase", + "textDecoration": "underline", + "textWeight": "bold", + "fontFamily": "Courier New", + "fontStyle": "Italic" + }, + }} + compFactory={ScannerComp} + /> + </ExampleGroup> </> ); } diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/Shape.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/Shape.tsx index 1b5259742..ced700365 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/Shape.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/Shape.tsx @@ -7,15 +7,16 @@ export default function ShapeExample() { <> <ExampleGroup title="Basic Usage" + description="The Following Examples Show the Basic Usage of the Shapes Component." > <Example - title="A Simple Shape" + title="A Simple Shape component" config={{ }} compFactory={ShapeComp} /> <Example - title="Hiding Shape Component" + title="Hiding the Shape Component" config={{ hidden: true, icon:"2_misc", @@ -23,7 +24,7 @@ export default function ShapeExample() { compFactory={ShapeComp} /> <Example - title="Disabling Shape Component" + title="Disabling the Shape Component" config={{ disabled: true, icon:"2_polygon", @@ -31,6 +32,176 @@ export default function ShapeExample() { compFactory={ShapeComp} /> </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the different Styling properties of the Shapes Component." + > + <Example + title="Background Color" + width={500} + config={{ + container: { + "style": { + "background": "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + }, + }, + }} + compFactory={ShapeComp} + /> + <Example + title="Border Style, Color, Radius & Width" + width={500} + config={{ + container: { + "style": { + "background": "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + "border" : "#3377FF", + "borderWidth": "2px", + "radius": "10px", + }, + }, + }} + compFactory={ShapeComp} + /> + <Example + title="Margin & Padding" + width={500} + config={{ + container: { + "style": { + "background": "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + "border" : "#3377FF", + "borderWidth": "2px", + "radius": "10px", + "margin": "15px", + "padding": "15px", + }, + }, + }} + compFactory={ShapeComp} + /> + <Example + title="Background Image" + width={600} + height={300} + config={{ + container: { + "style": { + "backgroundImage": "https://photographylife.com/wp-content/uploads/2023/05/Nikon-Z8-Official-Samples-00002.jpg", + }, + }, + }} + compFactory={ShapeComp} + /> + <Example + title="Background Image Size" + width={600} + height={400} + config={{ + container: { + "style": { + "backgroundImage": "https://photographylife.com/wp-content/uploads/2023/05/Nikon-Z8-Official-Samples-00002.jpg", + "backgroundImageSize": "50%", + }, + }, + }} + compFactory={ShapeComp} + /> + <Example + title="Background Image Repeat - No Repeat" + width={600} + height={400} + config={{ + container: { + "style": { + "backgroundImage": "https://photographylife.com/wp-content/uploads/2023/05/Nikon-Z8-Official-Samples-00002.jpg", + "backgroundImageSize": "30%", + "backgroundImageRepeat": "no-repeat", + }, + }, + }} + compFactory={ShapeComp} + /> + <Example + title="Background Image Repeat - Repeat Horizontally" + width={600} + height={400} + config={{ + container: { + "style": { + "backgroundImage": "https://photographylife.com/wp-content/uploads/2023/05/Nikon-Z8-Official-Samples-00002.jpg", + "backgroundImageSize": "30%", + "backgroundImageRepeat": "repeat-x", + }, + }, + }} + compFactory={ShapeComp} + /> + <Example + title="Background Image Repeat - Repeat Vertically" + width={600} + height={400} + config={{ + container: { + "style": { + "backgroundImage": "https://photographylife.com/wp-content/uploads/2023/05/Nikon-Z8-Official-Samples-00002.jpg", + "backgroundImageSize": "30%", + "backgroundImageRepeat": "repeat-y", + }, + }, + }} + compFactory={ShapeComp} + /> + <Example + title="Background Position - Center" + width={600} + height={400} + config={{ + container: { + "style": { + "backgroundImage": "https://photographylife.com/wp-content/uploads/2023/05/Nikon-Z8-Official-Samples-00002.jpg", + "backgroundImageSize": "30%", + "backgroundImageRepeat": "repeat-x", + "backgroundImagePosition": "center", + }, + }, + }} + compFactory={ShapeComp} + /> + <Example + title="Background Position - Top" + width={600} + height={400} + config={{ + container: { + "style": { + "backgroundImage": "https://photographylife.com/wp-content/uploads/2023/05/Nikon-Z8-Official-Samples-00002.jpg", + "backgroundImageSize": "30%", + "backgroundImageRepeat": "repeat-x", + "backgroundImagePosition": "top", + }, + }, + }} + compFactory={ShapeComp} + /> + <Example + title="Background Position - Top" + width={600} + height={400} + config={{ + container: { + "style": { + "backgroundImage": "https://photographylife.com/wp-content/uploads/2023/05/Nikon-Z8-Official-Samples-00002.jpg", + "backgroundImageSize": "30%", + "backgroundImageRepeat": "repeat-x", + "backgroundImagePosition": "bottom", + }, + }, + }} + compFactory={ShapeComp} + /> + </ExampleGroup> </> ); } \ No newline at end of file diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/Signature.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/Signature.tsx index f90c7ef5d..4ca7d8dc7 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/Signature.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/Signature.tsx @@ -11,6 +11,8 @@ export default function SignatureExample() { > <Example title="Showing Hints/Placeholder Text" + height={300} + width={400} config={{ tips: "This is a Signature Component. Please, Sign here", }} @@ -18,6 +20,8 @@ export default function SignatureExample() { /> <Example title="Hiding the Signature Component" + height={300} + width={400} config={{ hidden: true, }} @@ -25,6 +29,8 @@ export default function SignatureExample() { /> <Example title="Show/Hide the Undo Icon" + height={300} + width={400} config={{ showUndo: false, }} @@ -32,6 +38,8 @@ export default function SignatureExample() { /> <Example title="Show/Hide the Clear Icon" + height={300} + width={400} config={{ showClear: false, }} @@ -45,6 +53,8 @@ export default function SignatureExample() { > <Example title="Setting Label Text and ToolTip" + height={300} + width={400} config={{ label:{ text: "Sign Here", @@ -55,6 +65,8 @@ export default function SignatureExample() { /> <Example title="Setting Width of the Label" + height={300} + width={400} config={{ label:{ text: "Sign Here", @@ -65,6 +77,8 @@ export default function SignatureExample() { /> <Example title="Label Position - TOP" + height={300} + width={400} config={{ label:{ text: "Sign Here", @@ -73,8 +87,22 @@ export default function SignatureExample() { }} compFactory={SignatureComp} /> + <Example + title="Label Position - ROW" + height={300} + width={400} + config={{ + label:{ + text: "Sign Here", + position: "row", + } + }} + compFactory={SignatureComp} + /> <Example title="Label Alignment - RIGHT" + height={300} + width={400} config={{ label:{ text: "Sign Here", @@ -84,7 +112,151 @@ export default function SignatureExample() { }} compFactory={SignatureComp} /> + <Example + title="Label Alignment - LEFT" + height={300} + width={400} + config={{ + label:{ + text: "Sign Here", + position: "column", + align: "left", + } + }} + compFactory={SignatureComp} + /> </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the different Styling properties on the Cascader Component." + > + <Example + title="Background Color, Border Radius,Style,Width,Color" + height={300} + width={400} + config={{ + style: { + "background": "#00FFFF", + "border": "#3377FF", + "radius": "10px", + "borderWidth": "3px", + "borderStyle": "solid", + }, + }} + compFactory={SignatureComp} + /> + <Example + title="Margin & Padding" + height={300} + width={400} + config={{ + style: { + "background": "#00FFFF", + "border": "#3377FF", + "radius": "10px", + "borderWidth": "3px", + "margin": "10px", + "padding": "10px", + "borderStyle": "dashed", + }, + }} + compFactory={SignatureComp} + /> + <Example + title="Opacity - 0.2" + height={300} + width={400} + config={{ + style: { + "opacity": "0.2", + }, + }} + compFactory={SignatureComp} + /> + <Example + title="Opacity - 0.5" + height={300} + width={400} + config={{ + style: { + "opacity": "0.5", + }, + }} + compFactory={SignatureComp} + /> + <Example + title="Opacity - 0.7" + height={300} + width={400} + config={{ + style: { + "opacity": "0.7", + }, + }} + compFactory={SignatureComp} + /> + <Example + title="Opacity - 1" + height={300} + width={400} + config={{ + style: { + "opacity": "1", + }, + }} + compFactory={SignatureComp} + /> + <Example + title="Label - Text Color, Size, Weight, Font family, Border properties" + height={300} + width={400} + config={{ + label:{ + text: "Sign Here", + position: "column", + }, + labelStyle: { + "margin": "5px", + "padding": "5px", + "label": "#3377FF", + "textTransform": "Uppercase", + "textDecoration": "underline", + "textSize": "13px", + "textWeight": "bold", + "fontFamily": "Courier New", + "fontStyle": "Italic", + "border": "#36B389", + "borderStyle": "solid", + "borderWidth": "2px" + }, + }} + compFactory={SignatureComp} + /> + <Example + title="Input Field Style" + height={300} + width={400} + config={{ + style: { + "background": "#00FFFF", + "border": "#3377FF", + "radius": "10px", + "borderWidth": "3px", + "margin": "10px", + "padding": "10px", + "borderStyle": "solid", + }, + inputFieldStyle: { + "background": "#00BCA1", + "border": "#013AFF", + "radius": "10px", + "text": "#222222" + }, + }} + compFactory={SignatureComp} + /> + </ExampleGroup> </> ); } \ No newline at end of file diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/Transfer.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/Transfer.tsx index 4b7564fac..a1b22979a 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/Transfer.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/Transfer.tsx @@ -2,15 +2,221 @@ import { transferComp } from "comps/comps/transferComp"; import Example from "../../common/Example"; import ExampleGroup from "../../common/ExampleGroup"; +const items = "[\n {\n \"key\": \"1\",\n \"title\": \"Alice Jones\"\n \"description\" : \"Business Owner\"\n },\n {\n \"key\": \"2\",\n \"title\": \"James Anderson\"\n },\n {\n \"key\": \"3\",\n \"title\": \"Philip Salt\"\n },\n {\n \"key\": \"4\",\n \"title\": \"Martinez\"\n },\n {\n \"key\": \"5\",\n \"title\": \"Chris Harris\"\n },\n {\n \"key\": \"6\",\n \"title\": \"John Smith\"\n },\n {\n \"key\": \"7\",\n \"title\": \"Christina\"\n }\n]"; + export default function TransferExample() { return ( <> <ExampleGroup title="Basic Usage" + description="The Following Examples Show the Basic Usage of the Transfer Component." > <Example - title="Default Audio Component" - config={{ + title="Default Transfer Component" + height={350} + width={700} + hideSettings={true} + config={{ + }} + compFactory={transferComp} + /> + <Example + title="Transfer Component with Custom Data" + height={350} + width={700} + hideSettings={true} + config={{ + items: items, + sourceTitle: "Top Priority Customers", + targetTitle: "Paid Customers", + }} + compFactory={transferComp} + /> + <Example + title="Hiding the Transfer component" + height={350} + width={700} + hideSettings={true} + config={{ + hidden: true, + }} + compFactory={transferComp} + /> + </ExampleGroup> + + <ExampleGroup + title="Advance Usage" + description="The Following Examples Show the Advance Usage of the Transfer Component." + > + <Example + title="Selected Keys" + height={350} + width={700} + hideSettings={true} + config={{ + targetKeys: "[3,5,2]", + items: items, + sourceTitle: "Top Priority Customers", + targetTitle: "Paid Customers", + }} + compFactory={transferComp} + /> + <Example + title="Allow Search - False" + height={350} + width={700} + hideSettings={true} + config={{ + items: items, + sourceTitle: "Top Priority Customers", + targetTitle: "Paid Customers", + showSearch: false, + }} + compFactory={transferComp} + /> + <Example + title="Allow Search - True" + height={350} + width={700} + hideSettings={true} + config={{ + items: items, + sourceTitle: "Top Priority Customers", + targetTitle: "Paid Customers", + showSearch: true, + }} + compFactory={transferComp} + /> + <Example + title="Data Transfer - One Way" + height={350} + width={700} + hideSettings={true} + config={{ + items: items, + sourceTitle: "Top Priority Customers", + targetTitle: "Paid Customers", + oneWay: true, + }} + compFactory={transferComp} + /> + <Example + title="Pagination" + height={350} + width={700} + hideSettings={true} + config={{ + items: items, + sourceTitle: "Top Priority Customers", + targetTitle: "Paid Customers", + pagination: true, + pageSize: "5", + }} + compFactory={transferComp} + /> + </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the different Styling properties of the Transfer Component." + > + <Example + title="Background Color, Border Radius,Style,Width,Color" + height={350} + width={700} + hideSettings={true} + config={{ + items: items, + sourceTitle: "Top Priority Customers", + targetTitle: "Paid Customers", + style: { + "background": "#00FFFF", + "border": "#3377FF", + "radius": "10px", + "borderWidth": "3px", + "borderStyle": "solid", + }, + }} + compFactory={transferComp} + /> + <Example + title="Margin & Padding" + height={550} + width={700} + hideSettings={true} + config={{ + items: items, + sourceTitle: "Top Priority Customers", + targetTitle: "Paid Customers", + style: { + "background": "#00FFFF", + "border": "#3377FF", + "radius": "10px", + "borderWidth": "3px", + "margin": "10px", + "padding": "10px", + "borderStyle": "dashed", + }, + }} + compFactory={transferComp} + /> + <Example + title="Opacity - 0.2" + height={350} + width={700} + hideSettings={true} + config={{ + items: items, + sourceTitle: "Top Priority Customers", + targetTitle: "Paid Customers", + style: { + "opacity": "0.2", + }, + }} + compFactory={transferComp} + /> + <Example + title="Opacity - 0.5" + height={350} + width={700} + hideSettings={true} + config={{ + items: items, + sourceTitle: "Top Priority Customers", + targetTitle: "Paid Customers", + style: { + "opacity": "0.5", + }, + }} + compFactory={transferComp} + /> + <Example + title="Opacity - 0.7" + height={350} + width={700} + hideSettings={true} + config={{ + items: items, + sourceTitle: "Top Priority Customers", + targetTitle: "Paid Customers", + style: { + "opacity": "0.7", + }, + }} + compFactory={transferComp} + /> + <Example + title="Opacity - 1" + height={350} + width={700} + hideSettings={true} + config={{ + items: items, + sourceTitle: "Top Priority Customers", + targetTitle: "Paid Customers", + style: { + "opacity": "1", + }, }} compFactory={transferComp} /> diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/Video.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/Video.tsx index c62153911..3aa86d297 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/Video.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/MediaComp/Video.tsx @@ -6,17 +6,38 @@ export default function VideoExample() { return ( <> <ExampleGroup - title="Video Component Usage" + title="Basic Usage" + description="The Following Examples Show the Basic Usage of the Video Component." > <Example title="Default View" + width={500} + height={400} config={{ src: "https://www.youtube.com/watch?v=pRpeEdMmmQ0", }} compFactory={VideoComp} /> <Example - title="Poster URL" + title="Hiding the Video component" + width={500} + height={400} + config={{ + src: "https://www.youtube.com/watch?v=pRpeEdMmmQ0", + hidden: true, + }} + compFactory={VideoComp} + /> + </ExampleGroup> + + <ExampleGroup + title="Advance Usage" + description="The Following Examples Show the Advance Usage of the Video Component." + > + <Example + title="Poster URL " + width={500} + height={400} config={{ src: "https://www.youtube.com/watch?v=pRpeEdMmmQ0", poster: "https://www.youtube.com/watch?v=pRpeEdMmmQ0", @@ -24,7 +45,19 @@ export default function VideoExample() { compFactory={VideoComp} /> <Example - title="Volume Control" + title="Volume Control - 0" + width={500} + height={400} + config={{ + src: "https://www.youtube.com/watch?v=pRpeEdMmmQ0", + volume: "0", + }} + compFactory={VideoComp} + /> + <Example + title="Volume Control - 1" + width={500} + height={400} config={{ src: "https://www.youtube.com/watch?v=pRpeEdMmmQ0", volume: "1", @@ -32,7 +65,19 @@ export default function VideoExample() { compFactory={VideoComp} /> <Example - title="Playback Rate" + title="Playback Rate - 1" + width={500} + height={400} + config={{ + src: "https://www.youtube.com/watch?v=pRpeEdMmmQ0", + playbackRate: "0.5", + }} + compFactory={VideoComp} + /> + <Example + title="Playback Rate - 2X" + width={500} + height={400} config={{ src: "https://www.youtube.com/watch?v=pRpeEdMmmQ0", playbackRate: "2", @@ -41,14 +86,28 @@ export default function VideoExample() { /> <Example title="Auto Play - True" + width={500} + height={400} config={{ src: "https://www.youtube.com/watch?v=pRpeEdMmmQ0", autoPlay: true, }} compFactory={VideoComp} /> + <Example + title="Auto Play - False" + width={500} + height={400} + config={{ + src: "https://www.youtube.com/watch?v=pRpeEdMmmQ0", + autoPlay: false, + }} + compFactory={VideoComp} + /> <Example title="Video on Loop - True" + width={500} + height={400} config={{ src: "https://www.youtube.com/watch?v=pRpeEdMmmQ0", loop: true, @@ -57,6 +116,8 @@ export default function VideoExample() { /> <Example title="Hide Controls - True" + width={500} + height={400} config={{ src: "https://www.youtube.com/watch?v=pRpeEdMmmQ0", controls: true, @@ -64,6 +125,25 @@ export default function VideoExample() { compFactory={VideoComp} /> </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the Styling properties of the Video Component." + > + <Example + title="Margin & Padding" + width={500} + height={400} + config={{ + src: "https://www.youtube.com/watch?v=pRpeEdMmmQ0", + style: { + margin: "5px", + padding: "10px", + }, + }} + compFactory={VideoComp} + /> + </ExampleGroup> </> ); } \ No newline at end of file diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/Navigation.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/Navigation.tsx index b94f1a73f..c110581b6 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/Navigation.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/Navigation.tsx @@ -368,7 +368,182 @@ export default function NavigationExample() { }} compFactory={NavComp} /> + <Example + title={trans("componentDoc.default")} + blackListConfig={blackListConfig} + nameMap={nameMap} + config={{ + hidden: true, + style: { + backgroundColor: "#00000000", + borderColor: "#00000000", + color: "#333333", + accentColor: "#1890ff", + }, + items: [ + { + label: trans("componentDoc.menuItem", { num: 1 }), + hidden: "", + active: "", + onEvent: [ + { + name: "click", + handler: { + compType: "openAppPage", + comp: { + applicationId: { + applicationId: "", + }, + query: [{ key: "", value: "" }], + hash: [{ key: "", value: "" }], + inNewTab: false, + }, + condition: "", + slowdown: "debounce", + delay: "", + }, + }, + ], + items: [ + { + label: trans("componentDoc.subMenuItem", { num: 1 }), + hidden: "", + active: "", + onEvent: [ + { + name: "click", + handler: { + compType: "openAppPage", + comp: { + applicationId: { + applicationId: "", + }, + query: [ + { + key: "", + value: "", + }, + ], + hash: [ + { + key: "", + value: "", + }, + ], + inNewTab: false, + }, + condition: "", + slowdown: "debounce", + delay: "", + }, + }, + ], + items: [], + }, + { + label: trans("componentDoc.subMenuItem", { num: 2 }), + hidden: "", + active: "", + onEvent: [ + { + name: "click", + handler: { + compType: "openAppPage", + comp: { + applicationId: { + applicationId: "", + }, + query: [ + { + key: "", + value: "", + }, + ], + hash: [ + { + key: "", + value: "", + }, + ], + inNewTab: false, + }, + condition: "", + slowdown: "debounce", + delay: "", + }, + }, + ], + items: [], + }, + ], + }, + { + label: trans("componentDoc.menuItem", { num: 2 }), + hidden: "", + active: "", + onEvent: [ + { + name: "click", + handler: { + compType: "openAppPage", + comp: { + applicationId: { + applicationId: "", + }, + query: [{ key: "", value: "" }], + hash: [{ key: "", value: "" }], + inNewTab: false, + }, + condition: "", + slowdown: "debounce", + delay: "", + }, + }, + ], + items: [ + { + label: trans("componentDoc.subMenuItem", { num: 1 }), + hidden: "", + active: "", + onEvent: [ + { + name: "click", + handler: { + compType: "openAppPage", + comp: { + applicationId: { + applicationId: "", + }, + query: [ + { + key: "", + value: "", + }, + ], + hash: [ + { + key: "", + value: "", + }, + ], + inNewTab: false, + }, + condition: "", + slowdown: "debounce", + delay: "", + }, + }, + ], + items: [], + }, + ], + }, + ], + }} + compFactory={NavComp} + /> </ExampleGroup> + <ExampleGroup title={trans("componentDoc.hAlignType")}> <Example title={trans("componentDoc.left")} @@ -1067,6 +1242,715 @@ export default function NavigationExample() { compFactory={NavComp} /> </ExampleGroup> + + <ExampleGroup + title="Styling Properties & Animation" + description="The Following Examples Show the different Styling properties of the Navigation Component." + > + <Example + title="Different Styling properties" + blackListConfig={blackListConfig} + nameMap={nameMap} + config={{ + style: { + "margin": "5px", + "padding": "5px", + "text": "#FFFFFF", + "accent": "#36B389", + "background": "#3377FF", + "textTransform": "Uppercase", + "textDecoration": "underline", + "textSize": "20px", + "textWeight": "bold", + "fontFamily": "Courier New", + "fontStyle": "italic", + "border": "#36B389", + "borderStyle": "solid", + "radius": "10px", + "borderWidth": "3px" + }, + items: [ + { + label: trans("componentDoc.menuItem", { num: 1 }), + hidden: "", + active: "", + onEvent: [ + { + name: "click", + handler: { + compType: "openAppPage", + comp: { + applicationId: { + applicationId: "", + }, + query: [{ key: "", value: "" }], + hash: [{ key: "", value: "" }], + inNewTab: false, + }, + condition: "", + slowdown: "debounce", + delay: "", + }, + }, + ], + items: [ + { + label: trans("componentDoc.subMenuItem", { num: 1 }), + hidden: "", + active: "", + onEvent: [ + { + name: "click", + handler: { + compType: "openAppPage", + comp: { + applicationId: { + applicationId: "", + }, + query: [ + { + key: "", + value: "", + }, + ], + hash: [ + { + key: "", + value: "", + }, + ], + inNewTab: false, + }, + condition: "", + slowdown: "debounce", + delay: "", + }, + }, + ], + items: [], + }, + { + label: trans("componentDoc.subMenuItem", { num: 2 }), + hidden: "", + active: "", + onEvent: [ + { + name: "click", + handler: { + compType: "openAppPage", + comp: { + applicationId: { + applicationId: "", + }, + query: [ + { + key: "", + value: "", + }, + ], + hash: [ + { + key: "", + value: "", + }, + ], + inNewTab: false, + }, + condition: "", + slowdown: "debounce", + delay: "", + }, + }, + ], + items: [], + }, + ], + }, + { + label: trans("componentDoc.menuItem", { num: 2 }), + hidden: "", + active: "", + onEvent: [ + { + name: "click", + handler: { + compType: "openAppPage", + comp: { + applicationId: { + applicationId: "", + }, + query: [{ key: "", value: "" }], + hash: [{ key: "", value: "" }], + inNewTab: false, + }, + condition: "", + slowdown: "debounce", + delay: "", + }, + }, + ], + items: [ + { + label: trans("componentDoc.subMenuItem", { num: 1 }), + hidden: "", + active: "", + onEvent: [ + { + name: "click", + handler: { + compType: "openAppPage", + comp: { + applicationId: { + applicationId: "", + }, + query: [ + { + key: "", + value: "", + }, + ], + hash: [ + { + key: "", + value: "", + }, + ], + inNewTab: false, + }, + condition: "", + slowdown: "debounce", + delay: "", + }, + }, + ], + items: [], + }, + ], + }, + ], + }} + compFactory={NavComp} + /> + <Example + title="Bounce Animation" + blackListConfig={blackListConfig} + nameMap={nameMap} + config={{ + animationStyle: { + "animation": "bounce", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + items: [ + { + label: trans("componentDoc.menuItem", { num: 1 }), + hidden: "", + active: "", + onEvent: [ + { + name: "click", + handler: { + compType: "openAppPage", + comp: { + applicationId: { + applicationId: "", + }, + query: [{ key: "", value: "" }], + hash: [{ key: "", value: "" }], + inNewTab: false, + }, + condition: "", + slowdown: "debounce", + delay: "", + }, + }, + ], + items: [ + { + label: trans("componentDoc.subMenuItem", { num: 1 }), + hidden: "", + active: "", + onEvent: [ + { + name: "click", + handler: { + compType: "openAppPage", + comp: { + applicationId: { + applicationId: "", + }, + query: [ + { + key: "", + value: "", + }, + ], + hash: [ + { + key: "", + value: "", + }, + ], + inNewTab: false, + }, + condition: "", + slowdown: "debounce", + delay: "", + }, + }, + ], + items: [], + }, + { + label: trans("componentDoc.subMenuItem", { num: 2 }), + hidden: "", + active: "", + onEvent: [ + { + name: "click", + handler: { + compType: "openAppPage", + comp: { + applicationId: { + applicationId: "", + }, + query: [ + { + key: "", + value: "", + }, + ], + hash: [ + { + key: "", + value: "", + }, + ], + inNewTab: false, + }, + condition: "", + slowdown: "debounce", + delay: "", + }, + }, + ], + items: [], + }, + ], + }, + { + label: trans("componentDoc.menuItem", { num: 2 }), + hidden: "", + active: "", + onEvent: [ + { + name: "click", + handler: { + compType: "openAppPage", + comp: { + applicationId: { + applicationId: "", + }, + query: [{ key: "", value: "" }], + hash: [{ key: "", value: "" }], + inNewTab: false, + }, + condition: "", + slowdown: "debounce", + delay: "", + }, + }, + ], + items: [ + { + label: trans("componentDoc.subMenuItem", { num: 1 }), + hidden: "", + active: "", + onEvent: [ + { + name: "click", + handler: { + compType: "openAppPage", + comp: { + applicationId: { + applicationId: "", + }, + query: [ + { + key: "", + value: "", + }, + ], + hash: [ + { + key: "", + value: "", + }, + ], + inNewTab: false, + }, + condition: "", + slowdown: "debounce", + delay: "", + }, + }, + ], + items: [], + }, + ], + }, + ], + }} + compFactory={NavComp} + /> + <Example + title="Swing Animation" + blackListConfig={blackListConfig} + nameMap={nameMap} + config={{ + animationStyle: { + "animation": "swing", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + items: [ + { + label: trans("componentDoc.menuItem", { num: 1 }), + hidden: "", + active: "", + onEvent: [ + { + name: "click", + handler: { + compType: "openAppPage", + comp: { + applicationId: { + applicationId: "", + }, + query: [{ key: "", value: "" }], + hash: [{ key: "", value: "" }], + inNewTab: false, + }, + condition: "", + slowdown: "debounce", + delay: "", + }, + }, + ], + items: [ + { + label: trans("componentDoc.subMenuItem", { num: 1 }), + hidden: "", + active: "", + onEvent: [ + { + name: "click", + handler: { + compType: "openAppPage", + comp: { + applicationId: { + applicationId: "", + }, + query: [ + { + key: "", + value: "", + }, + ], + hash: [ + { + key: "", + value: "", + }, + ], + inNewTab: false, + }, + condition: "", + slowdown: "debounce", + delay: "", + }, + }, + ], + items: [], + }, + { + label: trans("componentDoc.subMenuItem", { num: 2 }), + hidden: "", + active: "", + onEvent: [ + { + name: "click", + handler: { + compType: "openAppPage", + comp: { + applicationId: { + applicationId: "", + }, + query: [ + { + key: "", + value: "", + }, + ], + hash: [ + { + key: "", + value: "", + }, + ], + inNewTab: false, + }, + condition: "", + slowdown: "debounce", + delay: "", + }, + }, + ], + items: [], + }, + ], + }, + { + label: trans("componentDoc.menuItem", { num: 2 }), + hidden: "", + active: "", + onEvent: [ + { + name: "click", + handler: { + compType: "openAppPage", + comp: { + applicationId: { + applicationId: "", + }, + query: [{ key: "", value: "" }], + hash: [{ key: "", value: "" }], + inNewTab: false, + }, + condition: "", + slowdown: "debounce", + delay: "", + }, + }, + ], + items: [ + { + label: trans("componentDoc.subMenuItem", { num: 1 }), + hidden: "", + active: "", + onEvent: [ + { + name: "click", + handler: { + compType: "openAppPage", + comp: { + applicationId: { + applicationId: "", + }, + query: [ + { + key: "", + value: "", + }, + ], + hash: [ + { + key: "", + value: "", + }, + ], + inNewTab: false, + }, + condition: "", + slowdown: "debounce", + delay: "", + }, + }, + ], + items: [], + }, + ], + }, + ], + }} + compFactory={NavComp} + /> + <Example + title="Tada Animation" + blackListConfig={blackListConfig} + nameMap={nameMap} + config={{ + animationStyle: { + "animation": "tada", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + items: [ + { + label: trans("componentDoc.menuItem", { num: 1 }), + hidden: "", + active: "", + onEvent: [ + { + name: "click", + handler: { + compType: "openAppPage", + comp: { + applicationId: { + applicationId: "", + }, + query: [{ key: "", value: "" }], + hash: [{ key: "", value: "" }], + inNewTab: false, + }, + condition: "", + slowdown: "debounce", + delay: "", + }, + }, + ], + items: [ + { + label: trans("componentDoc.subMenuItem", { num: 1 }), + hidden: "", + active: "", + onEvent: [ + { + name: "click", + handler: { + compType: "openAppPage", + comp: { + applicationId: { + applicationId: "", + }, + query: [ + { + key: "", + value: "", + }, + ], + hash: [ + { + key: "", + value: "", + }, + ], + inNewTab: false, + }, + condition: "", + slowdown: "debounce", + delay: "", + }, + }, + ], + items: [], + }, + { + label: trans("componentDoc.subMenuItem", { num: 2 }), + hidden: "", + active: "", + onEvent: [ + { + name: "click", + handler: { + compType: "openAppPage", + comp: { + applicationId: { + applicationId: "", + }, + query: [ + { + key: "", + value: "", + }, + ], + hash: [ + { + key: "", + value: "", + }, + ], + inNewTab: false, + }, + condition: "", + slowdown: "debounce", + delay: "", + }, + }, + ], + items: [], + }, + ], + }, + { + label: trans("componentDoc.menuItem", { num: 2 }), + hidden: "", + active: "", + onEvent: [ + { + name: "click", + handler: { + compType: "openAppPage", + comp: { + applicationId: { + applicationId: "", + }, + query: [{ key: "", value: "" }], + hash: [{ key: "", value: "" }], + inNewTab: false, + }, + condition: "", + slowdown: "debounce", + delay: "", + }, + }, + ], + items: [ + { + label: trans("componentDoc.subMenuItem", { num: 1 }), + hidden: "", + active: "", + onEvent: [ + { + name: "click", + handler: { + compType: "openAppPage", + comp: { + applicationId: { + applicationId: "", + }, + query: [ + { + key: "", + value: "", + }, + ], + hash: [ + { + key: "", + value: "", + }, + ], + inNewTab: false, + }, + condition: "", + slowdown: "debounce", + delay: "", + }, + }, + ], + items: [], + }, + ], + }, + ], + }} + compFactory={NavComp} + /> + </ExampleGroup> </> ); } diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/index.ts b/client/packages/lowcoder/src/pages/ComponentDoc/examples/index.ts index 007750d93..ca2388e95 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/index.ts +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/index.ts @@ -94,6 +94,9 @@ import HillChartExample from "./ChartsComp/HillChart"; import BPMNEditorExample from "./MediaComp/BPMNEditor"; import ImageEditorExample from "./presentationComp/imageEditor"; import DrawerExample from "./ChartsComp/Drawer"; +import CollapsibleContainerExample from "./ContainersComp/CollapsibleContainer"; +import FloatTextContainerExample from "./ContainersComp/FloatTextContainer"; +import SplitLayoutExample from "./ContainersComp/SplitLayout"; const examples: { [key in UICompType]?: React.FunctionComponent } = { button: ButtonExample, @@ -191,6 +194,9 @@ const examples: { [key in UICompType]?: React.FunctionComponent } = { bpmnEditor: BPMNEditorExample, imageEditor: ImageEditorExample, drawer: DrawerExample, + collapsibleContainer: CollapsibleContainerExample, + floatTextContainer: FloatTextContainerExample, + splitLayout: SplitLayoutExample, }; export default examples; diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/numberInputComp/NumberInput.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/numberInputComp/NumberInput.tsx index 27745477d..ed6988a5a 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/numberInputComp/NumberInput.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/numberInputComp/NumberInput.tsx @@ -8,7 +8,7 @@ export default function NumberInputExample() { <> <ExampleGroup title={trans("componentDoc.basicUsage")} - description={trans("componentDoc.basicDemoDescription")} + description="The Following Examples Show the Basic Usage of the Number Input Component." > <Example title={trans("componentDoc.placeholder")} @@ -19,43 +19,69 @@ export default function NumberInputExample() { compFactory={NumberInputComp} /> <Example - title={trans("componentDoc.disabled")} + title="Default Value" config={{ - placeholder: trans("componentDoc.pleaseInputName"), - disabled: true, + defaultValue: "20", }} compFactory={NumberInputComp} /> - </ExampleGroup> - - <ExampleGroup title={trans("componentDoc.labelText")} description=""> <Example - title={trans("componentDoc.left")} + title={trans("componentDoc.disabled")} config={{ - label: { text: trans("componentDoc.labelText"), position: "row" }, - placeholder: trans("componentDoc.pleaseInputName"), + disabled: true, }} compFactory={NumberInputComp} /> <Example - title={trans("componentDoc.column")} + title="Hiding the Number Input component" config={{ - label: { text: trans("componentDoc.labelText"), position: "column" }, - placeholder: trans("componentDoc.pleaseInputName"), + hidden: true, }} compFactory={NumberInputComp} /> + </ExampleGroup> + + <ExampleGroup title={trans("componentDoc.labelText")} description=""> <Example - title={trans("componentDoc.textAlign")} - config={{ - label: { text: trans("componentDoc.labelText"), align: "right" }, - placeholder: trans("componentDoc.pleaseInputName"), - }} - compFactory={NumberInputComp} - /> + title="Left- Left Alignment" + config={{ + label: { position: "row" }, + }} + compFactory={NumberInputComp} + /> + <Example + title="Left- Right Alignment" + config={{ + label: { align: "right" }, + }} + compFactory={NumberInputComp} + /> + <Example + title="Top - Left Alignment" + config={{ + label: { position: "column" }, + }} + compFactory={NumberInputComp} + /> + <Example + title="Top - Right Alignment" + config={{ + label: { position: "column", align: "right" }, + }} + compFactory={NumberInputComp} + /> + <Example + title="Tooltip" + config={{ + label: { tooltip:"This is a Tooltip" }, + }} + compFactory={NumberInputComp} + /> </ExampleGroup> - <ExampleGroup title={trans("componentDoc.format")} description=""> + <ExampleGroup + title= "Advance Usage" + description="The Following Examples Show the Advance Usage of the Number Input Component."> <Example title={trans("componentDoc.percent")} config={{ @@ -81,13 +107,21 @@ export default function NumberInputExample() { compFactory={NumberInputComp} /> <Example - title="Step" + title="Step - 10" config={{ value: "1", step: "10", }} compFactory={NumberInputComp} /> + <Example + title="Step - 50" + config={{ + value: "1", + step: "50", + }} + compFactory={NumberInputComp} + /> <Example title="Hide Increment/Decrement buttons" config={{ @@ -101,7 +135,7 @@ export default function NumberInputExample() { <ExampleGroup title={trans("componentDoc.validation")}> <Example - title={trans("componentDoc.mostValue")} + title="Minimum and Maximum Value ( 1 - 10 )" config={{ min: "1", max: "10", @@ -116,6 +150,114 @@ export default function NumberInputExample() { compFactory={NumberInputComp} /> </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the different Styling properties of the Checkbox Component." + > + <Example + title="Select component Styling properties" + config={{ + style: { + "background": "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + "margin": "10px", + "padding": "10px", + "text": "#222222", + "textSize": "20px", + "textWeight": "bold", + "fontStyle": "italic", + "border": "#222222", + "borderStyle": "solid", + "radius": "10px", + "borderWidth": "2px", + }, + }} + compFactory={NumberInputComp} + /> + <Example + title="Label Styling properties" + config={{ + labelStyle: { + "margin": "5px", + "padding": "5px", + "label": "#01865B", + "textTransform": "Uppercase", + "textDecoration": "underline", + "textSize": "18px", + "textWeight": "bold", + "fontStyle": "italic", + "border": "#222222", + "borderWidth": "2px", + "borderStyle": "solid", + }, + }} + compFactory={NumberInputComp} + /> + <Example + title="Input Field Styling properties" + config={{ + inputFieldStyle: { + "background": "#F20B0B", + "padding": "10px", + "textTransform": "Uppercase", + "textDecoration": "underline", + "textSize": "20px", + "textWeight": "bold", + "fontStyle": "italic", + "border": "#222222", + "borderStyle": "dashed", + "radius": "11px", + "borderWidth": "3px", + "accent": "#0EDF99", + "validate": "#36B389", + "text": "#FFF", + }, + }} + compFactory={NumberInputComp} + /> + </ExampleGroup> + + <ExampleGroup + title="Animation Style" + description="The Following Examples Show different animations on the CheckBox Component." + > + <Example + title="Bounce Animation" + config={{ + animationStyle: { + "animation": "bounce", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={NumberInputComp} + /> + <Example + title="Swing Animation" + config={{ + animationStyle: { + "animation": "swing", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={NumberInputComp} + /> + <Example + title="Tada Animation" + config={{ + animationStyle: { + "animation": "tada", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={NumberInputComp} + /> + </ExampleGroup> </> ); } diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/numberInputComp/Rating.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/numberInputComp/Rating.tsx index 540602bf5..3736be495 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/numberInputComp/Rating.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/numberInputComp/Rating.tsx @@ -37,6 +37,14 @@ export default function RatingExample() { }} compFactory={RatingComp} /> + <Example + title="Hiding the Rating component" + config={{ + hidden: "true", + defaultValue: "2", + }} + compFactory={RatingComp} + /> </ExampleGroup> <ExampleGroup title={trans("componentDoc.labelText")} description=""> @@ -88,6 +96,17 @@ export default function RatingExample() { }} compFactory={RatingComp} /> + <Example + title="Tooltip" + config={{ + label: { + text: trans("componentDoc.labelText"), + tooltip: "This is a Tooltip on Rating component" + }, + defaultValue: "4", + }} + compFactory={RatingComp} + /> </ExampleGroup> <ExampleGroup title={trans("componentDoc.style")}> @@ -110,6 +129,109 @@ export default function RatingExample() { compFactory={RatingComp} /> </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the different Styling properties of the Checkbox Component." + > + <Example + title="Select component Styling properties" + config={{ + defaultValue: "2", + style: { + "background": "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + "margin": "10px", + "padding": "10px", + "text": "#222222", + "textSize": "20px", + "textWeight": "bold", + "fontStyle": "italic", + "border": "#222222", + "borderStyle": "solid", + "radius": "10px", + "borderWidth": "2px", + }, + }} + compFactory={RatingComp} + /> + <Example + title="Label Styling properties" + config={{ + defaultValue: "3", + labelStyle: { + "margin": "5px", + "padding": "5px", + "label": "#01865B", + "textTransform": "Uppercase", + "textDecoration": "underline", + "textSize": "18px", + "textWeight": "bold", + "fontStyle": "italic", + "border": "#222222", + "borderWidth": "2px", + "borderStyle": "solid", + }, + }} + compFactory={RatingComp} + /> + <Example + title="Input Field Styling properties" + config={{ + defaultValue: "4", + inputFieldStyle: { + "checked": "#36B389", + "unchecked": "#D7D9E0", + "margin": "5px" + }, + }} + compFactory={RatingComp} + /> + </ExampleGroup> + + <ExampleGroup + title="Animation Style" + description="The Following Examples Show different animations on the CheckBox Component." + > + <Example + title="Bounce Animation" + config={{ + defaultValue: "2", + animationStyle: { + "animation": "bounce", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={RatingComp} + /> + <Example + title="Swing Animation" + config={{ + defaultValue: "3", + animationStyle: { + "animation": "swing", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={RatingComp} + /> + <Example + title="Tada Animation" + config={{ + defaultValue: "4", + animationStyle: { + "animation": "tada", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={RatingComp} + /> + </ExampleGroup> </> ); } diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/Kanban.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/Kanban.tsx index a811f8412..40e21298b 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/Kanban.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/Kanban.tsx @@ -6,16 +6,154 @@ import ExampleGroup from "../../common/ExampleGroup"; const ChartCompWithDefault = uiCompRegistry["kanban"].comp; +const assigneeOptions = "[\n {\n \"id\": \"1\",\n \"name\": \"Nancy Davloio\"\n },\n {\n \"id\": \"2\",\n \"name\": \"Andrew Fuller\"\n },\n {\n \"id\": \"3\",\n \"name\": \"James Wilson\"\n },\n {\n \"id\": \"4\",\n \"name\": \"George Linde\"\n }\n]"; + +const data = { + "optionType": "manual", + "manual": { + "manual": [ + { + "label": "Task - 29001", + "status": "Open", + "summary": "Analyze customer requirements.", + "priority": "High", + "tags": "Bug, Release Bug", + "estimate": "0", + "assignee": "Nancy Davloio", + "rankId": "1", + "id": "0" + }, + { + "label": "Task - 29002", + "status": "InProgress", + "summary": "Add responsive support to applicaton", + "priority": "Low", + "tags": "Story, Kanban", + "estimate": "0", + "assignee": "Nancy Davloio", + "rankId": "1", + "id": "1" + }, + { + "label": "Task - 29003", + "status": "Open", + "summary": "Resolve Frontend issues", + "priority": "Medium", + "tags": "Frontend, UI/UX", + "estimate": "2", + "assignee": "Andrew Fuller", + "rankId": "1", + "id": "2" + }, + { + "label": "Task - 29004", + "status": "Open", + "summary": "Setup Docker", + "priority": "1", + "tags": "Docker, Setup", + "estimate": "2", + "assignee": "James Wilson", + "rankId": "0", + "id": "3" + }, + { + "label": "Task - 29005", + "status": "Open", + "summary": "Setup Staging Server", + "priority": "High", + "tags": "Testing, BE", + "estimate": "0", + "assignee": "George Linde", + "rankId": "0", + "id": "4" + }, + { + "label": "Task - 29006", + "status": "InProgress", + "summary": "Implment Payment module", + "priority": "High", + "tags": "Subscription, BE", + "estimate": "2", + "assignee": "James Wilson", + "rankId": "0", + "id": "5" + }, + { + "label": "Task - 29007", + "status": "InProgress", + "summary": "Setup Project Documentation", + "priority": "High", + "tags": "Docs, Requirements", + "estimate": "3", + "assignee": "George Linde", + "rankId": "0", + "id": "6" + }, + { + "label": "Task - 29008", + "status": "Review", + "summary": "Setup MySQL DB", + "priority": "High", + "tags": "DB Setup", + "estimate": "0", + "assignee": "Andrew Fuller", + "rankId": "0", + "id": "7" + }, + { + "label": "Task - 29009", + "status": "Review", + "summary": "Project Setup", + "priority": "High", + "tags": "Setup", + "estimate": "0", + "assignee": "James Wilson", + "rankId": "0", + "id": "8" + }, + { + "label": "Task - 29010", + "status": "Close", + "summary": "Finalize Project Timelines", + "priority": "High", + "tags": "Setup, Timeline", + "estimate": "0", + "assignee": "Nancy Davloio", + "rankId": "0", + "id": "9" + } + ] + }, + "mapData": { + "data": "[{\"label\":\"Task - 29001\",\"status\":\"Open\",\"summary\":\"Analyze customer requirements.\",\"type\":\"\",\"priority\":\"High\",\"tags\":\"Bug, Release Bug\",\"estimate\":0,\"assignee\":\"Nancy Davloio\",\"rankId\":1,\"id\":0},{\"label\":\"Task - 29002\",\"status\":\"InProgress\",\"summary\":\"Add responsive support to applicaton\",\"type\":\"\",\"priority\":\"Low\",\"tags\":\"Story, Kanban\",\"estimate\":0,\"assignee\":\"Nancy Davloio\",\"rankId\":1,\"id\":1},{\"label\":\"Option 1\",\"status\":\"Open\",\"summary\":\"\",\"type\":\"\",\"priority\":\"\",\"tags\":\"\",\"estimate\":0,\"assignee\":\"\",\"rankId\":0,\"id\":2},{\"label\":\"Option 2\",\"status\":\"Open\",\"summary\":\"\",\"type\":\"\",\"priority\":\"\",\"tags\":\"\",\"estimate\":0,\"assignee\":\"\",\"rankId\":0,\"id\":3},{\"label\":\"Option 3\",\"status\":\"Open\",\"summary\":\"\",\"type\":\"\",\"priority\":\"\",\"tags\":\"\",\"estimate\":0,\"assignee\":\"\",\"rankId\":0,\"id\":4},{\"label\":\"Option 4\",\"status\":\"InProgress\",\"summary\":\"\",\"type\":\"\",\"priority\":\"\",\"tags\":\"\",\"estimate\":0,\"assignee\":\"\",\"rankId\":0,\"id\":5},{\"label\":\"Option 5\",\"status\":\"InProgress\",\"summary\":\"\",\"type\":\"\",\"priority\":\"\",\"tags\":\"\",\"estimate\":0,\"assignee\":\"\",\"rankId\":0,\"id\":6},{\"label\":\"Option 6\",\"status\":\"Review\",\"summary\":\"\",\"type\":\"\",\"priority\":\"\",\"tags\":\"\",\"estimate\":0,\"assignee\":\"\",\"rankId\":0,\"id\":7},{\"label\":\"Option 7\",\"status\":\"Review\",\"summary\":\"\",\"type\":\"\",\"priority\":\"\",\"tags\":\"\",\"estimate\":0,\"assignee\":\"\",\"rankId\":0,\"id\":8},{\"label\":\"Option 8\",\"status\":\"Close\",\"summary\":\"\",\"type\":\"\",\"priority\":\"\",\"tags\":\"\",\"estimate\":0,\"assignee\":\"\",\"rankId\":0,\"id\":9}]", + "mapData": { + "status": "Open" + } + } +}; + export default function KanbanExample() { return ( <> <ExampleGroup title={trans("componentDoc.basicUsage")} - description={trans("componentDoc.basicDemoDescription")} + description="The Following Examples Show the Basic Usage of the Kanban Component." > <Example - title={trans("componentDoc.default")} + title="Default View" + hideSettings={true} + width={1000} + config={{ + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Custom View" + hideSettings={true} + width={1000} config={{ + data: data, + assigneeOptions: assigneeOptions, }} compFactory={ChartCompWithDefault} /> diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/avatar.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/avatar.tsx index c0949dc26..5ff405e2c 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/avatar.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/avatar.tsx @@ -36,12 +36,30 @@ export default function AvatarExample(){ compFactory={AvatarComp} /> <Example - title="Avatar with Image" + title="Hiding the Avatar component" config={{ avatarCatption: "user@email.com", avatarLabel: "User", icon: "/icon:solid/user-secret", - shape:"square", + hidden: true, + }} + compFactory={AvatarComp} + /> + <Example + title="Avatar with Image" + config={{ + avatarCatption: "user@email.com", + avatarLabel: "User", + src: "https://i.pravatar.cc/300?u=a029026704a", + }} + compFactory={AvatarComp} + /> + <Example + title="Avatar with Title" + config={{ + avatarCatption: "user@email.com", + avatarLabel: "User", + title: "John", }} compFactory={AvatarComp} /> @@ -50,8 +68,7 @@ export default function AvatarExample(){ config={{ avatarCatption: "user@email.com", avatarLabel: "User", - icon: "/icon:solid/user", - shape:"cirlce", + src: "https://i.pravatar.cc/300?u=a029026704a", iconSize: "60", }} compFactory={AvatarComp} @@ -169,6 +186,201 @@ export default function AvatarExample(){ compFactory={AvatarComp} /> </ExampleGroup> + + <ExampleGroup + title={"Styling Properties"} + > + <Example + title="Different Styling properties on the Avatar component" + config={{ + avatarCatption: "user@email.com", + avatarLabel: "User", + src: "https://i.pravatar.cc/300?u=a029026704a", + iconSize: "60", + style: { + "background": "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + "margin": "5px", + "padding": "10px", + "border": "#3377FF", + "borderStyle": "solid", + "radius": "10px", + "borderWidth": "2px" + }, + }} + compFactory={AvatarComp} + /> + <Example + title="Opacity - 0.25" + config={{ + avatarCatption: "user@email.com", + avatarLabel: "User", + src: "https://i.pravatar.cc/300?u=a029026704a", + iconSize: "60", + style: { + "background": "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + "margin": "5px", + "padding": "10px", + "border": "#3377FF", + "borderStyle": "solid", + "radius": "10px", + "borderWidth": "2px", + "opacity": "0.25", + }, + }} + compFactory={AvatarComp} + /> + <Example + title="Opacity - 0.5" + config={{ + avatarCatption: "user@email.com", + avatarLabel: "User", + src: "https://i.pravatar.cc/300?u=a029026704a", + iconSize: "60", + style: { + "background": "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + "margin": "5px", + "padding": "10px", + "border": "#3377FF", + "borderStyle": "solid", + "radius": "10px", + "borderWidth": "2px", + "opacity": "0.5", + }, + }} + compFactory={AvatarComp} + /> + <Example + title="Opacity - 0.8" + config={{ + avatarCatption: "user@email.com", + avatarLabel: "User", + src: "https://i.pravatar.cc/300?u=a029026704a", + iconSize: "60", + style: { + "background": "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + "margin": "5px", + "padding": "10px", + "border": "#3377FF", + "borderStyle": "solid", + "radius": "10px", + "borderWidth": "2px", + "opacity": "0.8", + }, + }} + compFactory={AvatarComp} + /> + <Example + title="Avatar Styling" + config={{ + avatarCatption: "user@email.com", + avatarLabel: "User", + iconSize: "60", + avatarStyle: { + "background": "#FA0101", + "fill": "#36B389" + }, + }} + compFactory={AvatarComp} + /> + <Example + title="Label Styling" + config={{ + avatarCatption: "user@email.com", + avatarLabel: "User", + iconSize: "40", + labelStyle: { + "background": "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + "margin": "0px", + "padding": "0px", + "text": "#FF0505", + "textTransform": "Uppercase", + "textDecoration": "line-through", + "textSize": "15px", + "fontStyle": "italic", + "border": "#3377FF", + "borderStyle": "solid", + "radius": "10px", + "borderWidth": "2px", + }, + }} + compFactory={AvatarComp} + /> + <Example + title="Caption Styling" + config={{ + avatarCatption: "user@email.com", + avatarLabel: "User", + iconSize: "60", + captionStyle: { + "background": "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + "margin": "0px", + "padding": "0px", + "text": "#FF0505", + "textTransform": "lowercase", + "textDecoration": "underline", + "textSize": "15px", + "fontStyle": "italic", + "border": "#3377FF", + "borderStyle": "solid", + "radius": "10px", + "borderWidth": "2px", + }, + }} + compFactory={AvatarComp} + /> + <Example + title="Complete Styling of the Avatar component" + hideSettings={true} + config={{ + avatarCatption: "user@email.com", + avatarLabel: "User", + src: "https://i.pravatar.cc/300?u=a029026704a", + iconSize: "60", + style: { + "background": "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + "margin": "5px", + "padding": "10px", + "border": "#3377FF", + "borderStyle": "solid", + "radius": "10px", + "borderWidth": "2px" + }, + avatarStyle: { + "background": "#FA0101", + "fill": "#36B389" + }, + labelStyle: { + "background": "linear-gradient(90deg, #fa709a 0%, #fee140 100%)", + "margin": "0px", + "padding": "0px", + "text": "#FFF", + "textTransform": "Uppercase", + "textDecoration": "line-through", + "textSize": "15px", + "fontStyle": "italic", + "border": "#3377FF", + "borderStyle": "solid", + "radius": "10px", + "borderWidth": "2px", + }, + captionStyle: { + "background": "linear-gradient(0deg, #f43b47 0%, #453a94 100%)", + "margin": "0px", + "padding": "0px", + "text": "#FFF", + "textTransform": "lowercase", + "textDecoration": "underline", + "textSize": "15px", + "fontStyle": "italic", + "border": "#3377FF", + "borderStyle": "solid", + "radius": "10px", + "borderWidth": "2px", + }, + }} + compFactory={AvatarComp} + /> + </ExampleGroup> </> ); } \ No newline at end of file diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/avatarGroup.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/avatarGroup.tsx index 5e0995cf4..093c3a6e9 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/avatarGroup.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/avatarGroup.tsx @@ -3,6 +3,35 @@ import Example from "../../common/Example"; import ExampleGroup from "../../common/ExampleGroup"; import { trans } from "i18n/design"; +const avatars = { + "optionType": "manual", + "manual": { + "manual": [ + { + "src": "https:\\/\\/reqres.in\\/img\\/faces\\/3-image.jpg", + "label": "Ellis", + "Tooltip": "Ellis" + }, + { + "src": "https:\\/\\/reqres.in\\/img\\/faces\\/5-image.jpg", + "AvatarIcon": "/icon:antd/startwotone", + "label": "Javas", + "Tooltip": "Javas" + }, + { + "src": "https:\\/\\/i.pravatar.cc\\/300?u=a029026704a", + "label": "Kirk", + "Tooltip": "Kirk" + }, + { + "src": "https:\\/\\/i.pravatar.cc\\/300?u=a042581f4e4a", + "label": "Gray", + "Tooltip": "Gray" + } + ] + }, +}; + export default function AvatarGroupExample(){ const nameMap: Record<string, string> = { title: "title", @@ -29,6 +58,14 @@ export default function AvatarGroupExample(){ }} compFactory={AvatarGroupComp} /> + <Example + title="Avatar Group component with custom images" + config={{ + avatarSize: "60", + avatars: avatars, + }} + compFactory={AvatarGroupComp} + /> <Example title="Avatar Size" config={{ @@ -36,6 +73,13 @@ export default function AvatarGroupExample(){ }} compFactory={AvatarGroupComp} /> + <Example + title="Hiding Avatar Group component" + config={{ + hidden: true, + }} + compFactory={AvatarGroupComp} + /> </ExampleGroup> <ExampleGroup @@ -65,10 +109,10 @@ export default function AvatarGroupExample(){ </ExampleGroup> <ExampleGroup - title={"Avatar Group Styling"} + title={"Styling properties on Avatar Group component"} > <Example - title="" + title="Avatar Style" config={{ autoColor: false, avatar: { @@ -78,6 +122,21 @@ export default function AvatarGroupExample(){ }} compFactory={AvatarGroupComp} /> + <Example + title="Avatar Group component styling" + config={{ + style: { + "background": "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + "margin": "5px", + "padding": "10px", + "border": "#3377FF", + "borderStyle": "dashed", + "radius": "10px", + "borderWidth": "2px" + }, + }} + compFactory={AvatarGroupComp} + /> </ExampleGroup> </> ); diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/divider.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/divider.tsx index 10c65f83b..00071dae1 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/divider.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/divider.tsx @@ -17,10 +17,26 @@ export default function DividerExample() { description={trans("componentDoc.basicDemoDescription")} > <Example - title="" + title="Default Divider component" config={{ - style: {borderStyle: "solid", border: "#000",borderWidth: "2px"}, - }} + style: { + borderStyle: "solid", + border: "#000", + borderWidth: "2px" + }, + }} + compFactory={DividerComp} + /> + <Example + title="Hiding Divider component" + config={{ + style: { + borderStyle: "solid", + border: "#000", + borderWidth: "2px", + hidden: "true", + }, + }} compFactory={DividerComp} /> </ExampleGroup> @@ -58,7 +74,7 @@ export default function DividerExample() { /> </ExampleGroup> - <ExampleGroup title={trans("componentDoc.style")}> + <ExampleGroup title="Styling Properties"> <Example title="Dashed Border" nameMap={nameMap} @@ -79,15 +95,107 @@ export default function DividerExample() { }} compFactory={DividerComp} /> + <Example + title="Border Width & Border Color" + nameMap={nameMap} + config={{ + title: "Divider", + align: "center", + style: {borderStyle: "solid", border: "#00FFFF",borderWidth: "10px"}, + }} + compFactory={DividerComp} + /> + <Example + title="Text Transform - Uppercase" + nameMap={nameMap} + config={{ + title: trans("componentDoc.imADivider"), + align: "center", + style: {borderStyle: "solid", border: "#000",borderWidth: "3px", textTransform: "uppercase"}, + }} + compFactory={DividerComp} + /> + <Example + title="Text Transform - Capitalize" + nameMap={nameMap} + config={{ + title: trans("componentDoc.imADivider"), + align: "center", + style: {borderStyle: "solid", border: "#000",borderWidth: "3px", textTransform: "capitalize"}, + }} + compFactory={DividerComp} + /> + <Example + title="Text Decoration - Underline" + nameMap={nameMap} + config={{ + title: trans("componentDoc.imADivider"), + align: "center", + style: {borderStyle: "solid", border: "#000",borderWidth: "3px", textDecoration: "underline"}, + }} + compFactory={DividerComp} + /> + <Example + title="Text Decoration - Line through" + nameMap={nameMap} + config={{ + title: trans("componentDoc.imADivider"), + align: "center", + style: {borderStyle: "solid", border: "#000",borderWidth: "3px", textDecoration: "line-through"}, + }} + compFactory={DividerComp} + /> + <Example + title="Other Text Properties" + nameMap={nameMap} + config={{ + title: trans("componentDoc.imADivider"), + align: "center", + style: { + text: "#E67373", + textSize: "10px", + textWeight: "bold", + fontFamily: "Courier New", + fontStyle: "italic", + border: "#000", + borderWidth: "3px", + borderStyle: "solid", + } + }} + compFactory={DividerComp} + /> <Example title="Vertical Divider" nameMap={nameMap} + height={400} config={{ + title: trans("componentDoc.imADivider"), + align: "center", style: {borderStyle: "solid", border: "#000",borderWidth: "2px"}, type: true, }} compFactory={DividerComp} /> + <Example + title="Component Rotation - 90deg" + nameMap={nameMap} + config={{ + title: trans("componentDoc.imADivider"), + align: "center", + style: {borderStyle: "solid", border: "#000",borderWidth: "3px", rotation: "90deg"}, + }} + compFactory={DividerComp} + /> + <Example + title="Component Rotation - 180deg" + nameMap={nameMap} + config={{ + title: trans("componentDoc.imADivider"), + align: "center", + style: {borderStyle: "solid", border: "#000",borderWidth: "3px", rotation: "180deg"}, + }} + compFactory={DividerComp} + /> </ExampleGroup> </> ); diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/image.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/image.tsx index f9836f559..807086b86 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/image.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/image.tsx @@ -8,30 +8,30 @@ export default function ImageExample() { <> <ExampleGroup title={trans("componentDoc.basicUsage")} - description={trans("componentDoc.basicDemoDescription")} + description="The Following Examples Show the Basic Usage of the Image Component." > <Example - title="HTTP URL" - width={100} - height={100} + title="Image Source - HTTP URL" + width={400} + height={300} config={{ src: "https://photographylife.com/wp-content/uploads/2023/05/Nikon-Z8-Official-Samples-00002.jpg", }} compFactory={ImageComp} /> <Example - title="Data URL" - width={100} - height={100} + title="Image Source - Data URL" + width={400} + height={300} config={{ src: "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAYABgAAD//gA7Q1JFQVRPUjogZ2QtanBlZyB2MS4wICh1c2luZyBJSkcgSlBFRyB2ODApLCBxdWFsaXR5ID0gNjUK/9sAQwALCAgKCAcLCgkKDQwLDREcEhEPDxEiGRoUHCkkKyooJCcnLTJANy0wPTAnJzhMOT1DRUhJSCs2T1VORlRAR0hF/9sAQwEMDQ0RDxEhEhIhRS4nLkVFRUVFRUVFRUVFRUVFRUVFRUVFRUVFRUVFRUVFRUVFRUVFRUVFRUVFRUVFRUVFRUVF/8AAEQgBLAGQAwEiAAIRAQMRAf/EAB8AAAEFAQEBAQEBAAAAAAAAAAABAgMEBQYHCAkKC//EALUQAAIBAwMCBAMFBQQEAAABfQECAwAEEQUSITFBBhNRYQcicRQygZGhCCNCscEVUtHwJDNicoIJChYXGBkaJSYnKCkqNDU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6g4SFhoeIiYqSk5SVlpeYmZqio6Slpqeoqaqys7S1tre4ubrCw8TFxsfIycrS09TV1tfY2drh4uPk5ebn6Onq8fLz9PX29/j5+v/EAB8BAAMBAQEBAQEBAQEAAAAAAAABAgMEBQYHCAkKC//EALURAAIBAgQEAwQHBQQEAAECdwABAgMRBAUhMQYSQVEHYXETIjKBCBRCkaGxwQkjM1LwFWJy0QoWJDThJfEXGBkaJicoKSo1Njc4OTpDREVGR0hJSlNUVVZXWFlaY2RlZmdoaWpzdHV2d3h5eoKDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uLj5OXm5+jp6vLz9PX29/j5+v/aAAwDAQACEQMRAD8AzrroaxLocmty56GsW6HWuaZ69BlE0UGkrA9FC0UUhoKDNNJoJpKZDCmmlzTSaZLENMNONNqjNhnmp4Wwar1LERnmhii9S/Gvc/d9amUliAOB6VVRmPHpWjbR4XJxUpXZdSryRuySAiCTdUk2oLJycfjTHRXPXHtVOa1HYvj2Ga3ikjx6tRzdxj3EQkb0bqKu2EoiA54/mDWZJbJkbWYe7Lx+masWwkzt2hwOhU5/TrVNXMludTp12GDRO3HYnqKdLeMN0a/Lg446DuD+IrIj+VHcZBA5pUuGlRlI+fBK+/t/X86Vhs3LLUw6bs4KOCCfcdP0NW9SvI7tWMbrjArjLa7dHkB+6EBP4MKoPqUil8MRkfrScWGh0FvMIJ90hygx06/5zS6pq0l8uzdmIcKgFc+dVlCFSQc+tNhuJJ2Yg7QBz/hRYOpcgOJMHAHU4q28QcZBqgCFXIPH161NHMVAJPWk43N6VaVN3QvlkHJHFN71aWRZRgn8aiMZBrCULHt0MTGqrjBTxTT1pQag6b9SQdKeoqIMKcJMkDqfSmK5MKkC02O3nflYXbjPCk1J9nnT78Tj2xTsQ6ke4BaXZTPOReCefSpUYP0osNTTGbKNlT7aXZRYu5W200rVrZTClFh3KhWmEVaaOomSlYZDSZp5WmkUhgGpwao6M0BYnDU8PVcNTw1FybFq5HWsa6Xk1tT85rMnTOa6Zs8ShBmSVOaTbVsw803yqwPSjEr7aTbVny6PK9qVy+QqFaQrVsxU0xUXF7Mqhc8U0rVry6VoSy7lGfUelPmJdMplabsNWTHSeXT5iHSZWMZHOKeq56dam2FWxTlTD4YYz0YVVzJwaJbXaTtfI9CKub3XKqx2+tNigyuRj6iqdxPLbyFSOBWkEcOJkXt0gAO4n0OasxsxHPUdc1h/2lJ2HFLHq0sbZYZq7M4rm5IuV+4D3GB/hUItA8gIYoc455BqGHVobgbWO1j2rUtJQ42ADr1PJxRsIkUHaVlB9n6n/wCvVa4RreWKWPjadynPBq7OVtRkEMv8Yz+oq/Z6fBe2TmT5oyN6N/d9aaE9Dl508m6nGDgxOQPRSOP5isNmGfpzW3q0ii8mhgO5mhWMY9cr/Rax9RtGs5VRj8xUEimITb5vQHPfFWBtjXavBA5A709EFpa4fBmb9PpVWKVVkyeV64Pegdy2JQkfr6e9SBtv3uXPb0qruYtv6dwPSlMggBJ+aRh37UDLsUnzsF/hqeO5zw7ZA71BBB/ojNng/rWlpFjAGNxeDein5I8/eNQ9S1Jx1RAAspxAGc+gGasx6PqEyhltyoPTzCFxVq514wcW0YiBPyqiYyPWnWE15fuPMdwCe/GKycUdaxlW1izY+F1bLXl0M91jHT8TXR2Gj6dZENBaeY399vmP61NZWaxqDtO71zWnEmBjI/KmomE605bsEyuAiAL9QAKnUbhtdUIPUHmmEdz+dRPLIh+Uiq5TAp6t4W0/UIXdYEjmA4ZBiuINo1q5jP8ACcV6He6gtlp7SzYBYYA9a4C6uFkmJQAZ9KmVj08BGTbfQFxTsZqJGqUNUHr2F2ikKZp4paBXIGjqJo6uYppTNFh3KDRVEyVotFUTRe1TYpMzmWmEVdeKoGTFTYq5DSigjFJ0oGXZGzVV1zUxJNNIrRu5wwgkVjHTDHVkimFahnQivso2VNto20iyEx00x1YxSbaRVisY6Ty8HI4NWtlGygLFfajcSL/wJev/ANej7GWG6PDr6jt9RU+0DtmjYc5RuRQJx7EIs/NGMgMOhp0do6NsljyPepwzZ/eoH9zwfzH9atQuhACuf91zgj6N/jiqVjGcXYjjtxAdxzt9+1Z2qvCXG0Ag9CO1bc0UhiIcfL2bH865i8t5YpiuOD09DXRA8LE35tRiwfui4wfaoZHQAZSrVhI29oWQkN1B6iql+AjlO61qjkH21it7IqxA5bjjtW3d2MuhQQqbgy3TkbY8Z49KoeELxbXXIvOICP8AKM9M9q1dSb7R4quPM5EY+QZoYiS1vINQdYZh9muehRuVb6GpL2/l0jT3s48+aXIUd8HmqN7D9quSiIUjQfexjJ9q3dHhXU7Jb66i3zW42Bs9WHGf5UWsJO5lafZx6Zai9vADMoJGfXHFYcvnanf+e6NszjIHXArYhE2rX5iZWlETBTn7o9f1rrbbw6pgXEbABenT8KBtnnM5aRwxXnGFHt6/59aZaWT3D8Llc8muq1zTYYRIsIAYEbyB+n/1u/PrXMXVw+/7NAMIp7dSe9NgiGeURO8aFTg4yDn9agPzctT3tHt/LMmQWGTmkwWB4465qSja07FzaGLGWXn61bsILhnK8oo4Jz09qo6RvhYOgwM8noK622RZsOPvDqAOSah3RaVzPt9K8yUM4yQc554rprO1RAAu38RVQJcqMxRH3pv2yaE42gn3FTYp9kdPCBGB0FWgSR0/75rmrbXChxJEhX1VsH8q0YtRtp1+UmM9OeMVojNxZouxXlSSO470xFEjbt3yjk5qKKWVDhyJk7MOoqPU7yCC3aETCGZxkkjOPrQxxi27I5bxDqT3V4UO5EThARwR61ihsHrVvVRKrn5uepXPX3B7iswSHvXNLc+lw8UoJRLqvUqvVJXqZXpXNrFxXqQNVRXqQPTuS0WQaeBmq6vUqtVEtEm2mmPNSKc1IFyKZNyk8NVpIfatYx5FQyQ8dKTiNSMR48VCy1qTQVTkjxWbRomLTTT6aaoxQ00wipCKaRUmiGYpKfSUi0NxSYp1JSKACnYpKXNADSKaVp5ooGIrsvfP1qQMjfeXafVaZijAouFkzSspXi+UFZYz1Uj+lJf6ZHcxtJbAkDlkPJX/ABFVYT8wAPNXiZoyrjcCvIYdq2hI8rGUL+8tzAMfluGCgSR9/UVkaq3mSrKuCG6kdq7b7NHqJ+XEdz3UcB/p7+35elcxrGlNb3GId3P3k9DXRE8SSKFjDh0kwQQRyK3/ABJay2l3b6jB8yyICzDkZ7is7T45fs/BPXsP1/z713enT2D6A0GoyRhFB++RVMhbHHfbpLiH5AoyOWJrsLSEaP4NRZm2yy857kscgfrXL6NYWeoeICIWJtYzu68ED1rtyF1nVoIwM2lscqf77+o9hRp0C1ibw14aW3tUlcEOx3YrppIBHCQOD61YhQIgA7CsrxBfxWljLukCttOBQ9Cdzh/EKhZX8slpWYmMDHHGB+Pf2rJ0zQ/7OsnvrpvmI+XHWi1tdS1G9MwD7DnljgHnuak1JrnUbyLS7dt0UYAldMAZ/wAKh6mq0MEW0upzS3ADGPOQqjJH4nj8s1NFZrER+5hJxkmSQMR+GQP0ruorax0rTxAzRhyPXvWPNGpcsZJNhxhxyP0/rTBamVFbS5Vvs+/HQjcQP1rYsJfLb/j3AbHXJH86cijIYtGyD07VoQ7JCrLlgOnAIH6VDZZbgHnYLM6jHQEYqVvJAxsLj0yM1LGqY6mM4654qrfRLsO6cuO2TgUCW41rGOYEwfeH8PcfhUcdtc+Z5ZjJ/lVjTFEkZEcvmY7Zzirtxff2dbtLc5KjoD1Joui7taFXUNQj8PaeJHO6d+ET1/8ArVxF/qH9oSm6Ysk3cq2P8/pVzVrlNZnaYylXHRH9PasSSLZ0NZyuz0MM6cFfqSG9kZBHIdwHQ+lRiTmoSGHakDYNYu56sJx6FxZKnSSs9ZKmWSka7mgr1IHqislSrJVXFYuq9TI9UFkqdJKaZLRoI9WENZ8clWY5KtMyki8vIpWjyKjjfNWFORVmT0KM0NUJoetbbpkVTmh61LRUZmJSZpM0ZqC0LTaXPFNqS0IaSlNJSLEpKWikUhKWpI4WcZ4Cjqx6CpYwN4SBN7n+Jh/IdqLA2QrCxAZsIp7tx/8ArqaK280nykklx1I4A/z+FTmNIfnlIkkPOW5H4Dv/ACqOS5L4BG4Dpu6D6AcCqsluRzOWxILdl6vaxn0L5P8AWpFtJXGUkt39gB/hVIzSj7rbf9z5f5UYZjmWRh9Tk07onkl1ZpRaffHkRRn6bM1pwW12qYmtmZfUpj+VY9mZWbbboCf9okmuhsZ7pcLPDtP94HFbU7Hn4tyS1t+X6lO40+MMJFVo2+lVdaaCRNsjKLjGAwP+s9j6H610khLKTgE+5H/665TWZxDvmRVlhI2TxnGV9/WtHoeLe5zFrcmYTCNcc4IxyKguYri4/wCPm48uPOFDdT+FbVtoE8DzXCOTA670cnrVKw06TVNTXccgkBc0OaGoNmhoNmbWMrbRtLI/BYjtXonh/TZYVE9yNrgYA7VPo2h22nxqQN0mOSe30q/qcn2exdlO0gcGhJpXZMmm7IivtUW2jxEvmSsdqIOrGsie2trKF9S1ydXkRdxJ+6nsB3PaqF/4ht9KMbynzJ3Vii9+TXIeKbnUdTjE8rEwIOUAIAJ7+9JPmHy2RdvvF95qe5dJs1itB/y0k+8R+HSqlh4it0uD/aFigDHBuI2JwfeqejyJc6SYI5Aj4wfY1JJZwWVi8ck6rFjkEcv9Pei6WgtzbbTJvtRmSQPBINynduB/WnzW6BQyttPT5P8A69Z+jz3uj6fbretiCc/utx+77VpTTJOC2z8RSk9SkMhVMrgBHB4rRgkXA+VSR3Xoa5S7uXiIA3hPZs4p6XUzwebuORySB1pFHbRSxRqS7gf7wxVC51KCabassTewzWfY3wvrdY5EDOo4yDzVCSVrG4LyKpHXb6UtQVjr9PtoIkNxgIMZOa5fxLqb3zgRKPsy/dPrWfea5eakEt0XyYAf4Ccn606cFbIqSTxkg/zoSsVe+pjGYscDAqRN3rmqjN85HQ05ZGXvViuW8bu1Bt8jNMSbiniYetS4pm1OvKPUiaMqaZvK9aslg1MMat2rGUbHr0K6khqzVMsoqBoQOlM5U1mdqaZeWSpkkrNWWpVlouOxqpLVlJayEm96nSb3qkyWjaimq7FLmsGO4xVyK5960UjCUTZDAiopcEVVS5GOtK1wCOtXcys0zBopKKxNkLSUtFItCGm0+kxSLQ2nRjnOzd/Kk704bpGCjJJ4AoGSbXmYAsM9AB2/AVKZ1gTyoQCf4n65/wA/59ahZhGpjjOSfvMO/sPaoqL2Fa++xISWOSSSepNJSxI80ipGpZ2OABWkIrfTsNKVmn/ujkA/1+tNK4Sko6dStb2U8g3gbFx1I5x7CplgsoTmWZSR/dG8n6dh+NQzXM16x82Xag52jp+Xc0sUbYzCojX/AJ6Oefz/AMKpW6IykpP4nb0/zNizWB/uxSlT/wA9H2j64WtqBVAAVR+C5rG0lUSTlt5PU10cYGOOldMNjw8ZK0rBt44AzXP3emxvds5QMzcMD/EK6TbUU1usgyR8w6GnJXRwxdmZaWSRaS8MOdoU7Qe3tXI+D75bTV/JuFAK5UH3rtW3QPnOB3HY1yS2Yl1+/W1tXkB/eK6rkBiOlTFWNYrmdmz1C3mVkVsgZ6VyXjLxEqBba1YSOcjaD1NYVnH4ptgzyI8uT/qy/wB3/wCtUk2jNYqt9qbKj7umc4J9PU1M5dAjBLU5+/L3utwCT5flUEE8Dua9Ha+0Z9LEFwU8soFYEZxx3FcHdT2f9oI8bCRz8+5W5qvqUrODNEzg569Mf5/zimlsKRoX2gaJ9o82z1PyVf5uM/jjpU1jY+G7WXzrzU1uJUOQHfp+FcNLqE2CobGe2KqYeQ5IOPpWljM73xNq1rrkXkwuFjh5iPvXPafrVxaMI7jLLn72apW1uxX72F9qtzWgNtnnOOM1OmxaR0Mt3bXcOV4P0zUEYEUZCEg9eO34Vz9jdm3bZJnae1bsDxsMZ69Oe1Q1Ypal21nZSAOM9AO1aN3Zpfwbtnz+v/1qxd3ktgHJHzCuit7oS2e+NQWxTAwv7NWBiDlG9ayr29kSQow+76Vu3V6JMhs5965jUyWl3A0luU9ERuRJh0HX/OKFJI5pIDxg9Dwf8alKlic8MOo9aogaMg8U9Vz1pNpFN3NnFMCwCBxUyHIxVIO2elTJIQetS1c1pVHB3Rc8nIqJ4cdRVq3YMtTGHcK55I+goy5o3MZ48dKiyVNa0tvVOS3PpWZ0WK6ykVKs/vULxEVHyKYm2tzQW496nS6x3rJDmniQ0yW0bS3nvSm9461jecaa05p3M2kbFGaKKYkLRSUUi0OoxnpSA0u44x2pFINh78fWl3bAQvU8E+1JSUFDafHG0rBUGTTanttqszyZ8sDkD+L2oG3ZF1ZI9OtMphppRw3t6/T+dZ+Xlckklj1NLLI00pkk5J7DoPanZMSj++Rx/sj/ABpt3IjG2vVkgKW/QB5PU9F/xo80ytukJJ9TUAqSM80XHbqbmlKzEBGFdFCkgHNYOk5GMCuliICjJrrp7HzuOleoOVW70uKeCD0pcVZwFa4t0ljIbvVG1tfsLnA4JzketapAqNsHqKl3LUtLEX28RgtJnAHUVz2uTzaghhe0S8tfvDy2wwx1/Hmt+SGNyMHaw/WoTpiiRZM7XBAUrxzz/UVk4u9y00kcpB4b0w+XPieFhx5br8y+x7H8fzp934feGB/KRpVI4IGc/UV18jMyHcoYKM9Oox/+v8qxbrVWtXZHXgHoP6UO/UaZ59NpUlpNiSASQtyV7j8anSy063XzQzkd426/h611NxeW92BxktwpI6n0+tYs0CAlkYNG3Yind9Qshbe90faF8sfiMGm3ptPs58lRKh6AcMKybvTnJ3wqCPaooYZSp4PHUU9AIZrcg70X8O9aFo7NFyMepxmr9rHBc2mxWVpAPuuKzY3ksJ2V4zs+vSi9wtY0otrEBx8o7g9RVu1ne0f5GyueVNUba5V2G0fKexq7MQoJwMVJQl4o3uR0zXN3rHcee9bE90fM+72HH4Vk3gVslR+FNBLYrwzYPNW94cBvwNUI8NkHqKnhfAZc8GrIRMW54oLACmMSCPSnkAgUAOQbuaQjBp6ptHFMYHNAE9vOUYCteGUMornxkGtK0kPQ1nOPU9DB1+V8rNMgMKieAGnq3FPzmsD20zPltvaqUttjtW4UBqCSDNS0Xuc+8RU1GSRWxLbe1UJbcjtQmZyh2K26kJodStRlqtI55Sa3OjopBS0FoKKKKRSClpKWkWhaWkFKKRSDFOLEqB2HQUlKMDk/lQMVRtwzD6D1pCSxJPJNGSx5pwWmALUsSbmFCR569KuWsYEgGKpIznOyN3TbdVjXGa2oowBy1U7RV8tcCr6J6V2RVkfLV5uU22SAAUuRQFpdopmA1hnvULD2qc8dKidz0A5pjK5jzIPrU7KTFuzyCD+ppI1O7Jqbb+6x7UmguVyhU5XsTj+f9TVG+02OYDcuR/Tt/h+FawTIH4fyo2bowD6VLQ7nLf2DEGK7flfqP5H61BceHgWLDOT1Hqe9dWUAxx3p0iKVB7jrU8pXMzgJfD08OZLdzxyVPNNgAXPmRgkfe4rtJ4du7HHp7VyuphJZSIzsuE6jpupcpSmUZLeJmLxp5eOcetMZUdNxAcDqrc/kapNeyRk5+VgeRnrTI9QEykD5XBwR2PvRylXuWFhhZi1tkMOsfcf41HJd/eRx+lVZD9oJIGyRTz2qRZ2kBW4GSON/eiwJjZZFxkHnFZTz5kOQP8au3cJRQVbcuOo7VjSko1UkJsfL+7k3L0ojk5pgfcMGgIVPHSmSaULq64aldCv3TVWFwOtWDID3pDGBmzyaeG9TzQoU8mnbATQMcvPNWIZQjUxVCrTOQ2aRUXZ3NiKTeOKnBrOtZegq+prnkrM9/DVeeJKKKQc07FSdZG8Yaqs1vntV6msM0mijCntuvFZ00JGa6WWEGs+e2zniknYidNSRYBpc0wGnCrMEOpabS0i0LRRS0i0ApwFIKUUDFooooGhaVetNpwoGTxkZ5JFbenWgkww+YVhxkDrW7o85EgA6VrC1zixXNyNxNuG0dSCpIHpWjEpC4NEJBUcVNxXUj5mTbeo3FGKdRTEMIphWpTTTQAxRzUrD5TTUFOJ+WhgAGAue3NGQNoHcYpHcITnsABSfxL9RSAiUjJVjimknLEcjiob5wI9wyGHpTLS8Qr85wSKQFpoxjP8AC1ct4g04M6yJlWzwwroLi+EPylflboayL28EivGSAyc4PcUDRxeqqCFZgobuff1rHMLxTEg/KevNbmsIQpKnKsQcdgaoR/vPvDkHFJmiJI4vNXOeSOcUx2MSkMeRU6KsT/IeGHAqrczLIAT9MVJZWnmKYKtyO9VJkEy5GA36Glujg4HSokk42tVmdyLaQfepFb1qRI9xpTDg0hgpBpxJHanJCW6U8QPnpSGEfNXYIt3eq4hI56VNCxB4NIZce3JXioPszDrVje23rTWY45NAyOMFWxV+NjgVnhiGq/C2VFZzR6ODlrYspzUgqJKkzWR68WKaTFFLmkWMZageMGrJqMikyjNWnio1p4qjlQ6lpopRSLQ6lptLSKQtLSUooGLSgUAU4CgYYpwFJSg4oGSpgHpWpprETLhfyrLRhnmtSxuFjYHoK0huc1e7i0dhbPlBkVYzWXbXYZRt5q4hZhknFddz5icWnqWcikLVEXVRyaTfnpQSSFqdjApi4BBNOY5NAhCccU9TnA9Kq+buc4qRGIj68n9KYgmbL49Dk05GAC7uMDJqs7jePQUM+4H1A6UANuCJD04rKnAtic8Y5H4nH9a02KlMk4xxVLWYvN08lMbsgilcaRk3up+TA6swbyzlee3pWNqF0JRE8T9tpPsatW1g+oGRCSCOKqz6Q8Xyt6npU8xoolAo8ySK7crge1N2qiE5wH7HsavXsaw545IGfesaSR5Lfbg5RuvpUlkdzcs3yjPHINRqN3Ld6M8c80LNtABAPtTEU7sbWyORVQNWjcRlkLfpWaw59KpEMtwS1LnmqSHFWovmHWkUXLcgHBrQTy9vIFZgXHINTxu3Q80mUi07JtIxUcQjLYFOVGZfu0wLsb0pDNDyUEec4qnMyg4BzU2P3eWbiqZZS+BQA9Dk1oQEYrPGAa0LcgipnsdWFdplhafikUCn4rBnuRdxBS0UlI1QGmkU6jFAzGU1IKhU1IKZzoeKcKaKUUih9LTRTgKBi0oFApQaB3FFOpmacDQMWkzSk5pMUhirzU0bNuHzcVFjtUie1NCaNqz1ERADmtWK9nlHAwO2aw9PiQNvk7VswzgsFQda6YN21PCxsYqXuo0YEOMucmrQ9qgTJAAqRpVhHzGtTzCVjggd6z7/AFSO1kEW7524wO1JPqXlQu4HPauakd7m8Ex5cnHPQCk2NI6ezfdntg9fWrIfKkdADVCCeOCEndzjqaU3IEQbOB1x3NO5NiWdwi7m9cVRuNTFqpducdfcVn3Oph3dT+FVLudREhPzAHJ9xScilE25rtZIt0bBWYZXNL9rURRlzgEhT9e9YUMzPhguRHwQatPuksemTnvWdy+UvWZjhuJGUBSDj+tZ2q3AXccjG8j86qx6iEnZHY7gdrD+RqG4AmRgzcs3B7H0NNAZtxObhhHMQARgN6GqeyWMEMPu8MPUVbjtQsrfaMgE1PNASpIwygZDeopjMNo2G4LytIIWbuOOxqefJO+IH0YVRup2IBxgjimSMuZyp2ZyBVNiDzSu7MMtyaiDdjTAmQBuKtxR4HAqpEcN0rSt2BpMaBUc9sVPEpUjvVmNQV9Ka0OD8tSUWBcIkeCOarK4eXIFRzq6dabA+G+Y0WAuzqzJgH8qri22LuNPebH3ajkuXK4xQMaCN1adqBtrMiG7Ga04BhRUy2OrDRvItjAqQc8VAM1IrYNYs9qC0JSgqMjBp++mE5NJmyEpaMUUhmChqVTUCmpVNBzolBpwpgpwoKJBS0wGlzQMfmjNMFOFBQ6lBptGaQx+aXdimZooGP3ZqVXCDHeoRxTl60xPUuxSE9D+Fb2loSQzH5jWBCAvzk81taXOxclj8o71tDc87GRvB2OhBEa5Pas6aR7iYhDwKZdXu5gimrFkoMZI5rXc8O1tyjeW+9QrEhe4HeqqQgPlVIArWeIyyYpJYhGmFHJpDTMeaQqC7kkDoD0qoNU8ySTc4Hy8VZvYzIhGM+1ZCwRJJubJI7UrlWJjas7NITnP6VHcKVgBPBxjn0qzdzCKFV34ZucD0rMkuZZGSFmBUcjHWgZPb6ibRlbaGjbCtnrSnV3MbrEyspJ61EdOlmDEYxis+HT0V2UykfNg+o96ehJaWBblvOWR8gj5W/xqxEDBGUnYnnI44qGyt2jLxyOMkcHsadOWtnw+WB5IoAkuJVuBiMfNj86gVpPLKg7SvJU05bi2kXBjII6YqNrnezASHAGCD1piKc2+GQuDgH8jWXdN5hJA/KtS4uY9hQs2PWsidkXpISfWqRLKDgg9aQKSfWntuYk5FNB565+lMETopGKuW6kkFTg1WhbIwatxMI2GDUlGrGzrGM4NDF1G8dKiSZWUDPNPkkKRkcGpKK8tysxw2QaasJxkMCKgwXbO2rKDaMYIpgIEOakEJPapIVYnpmr0abfvCkMqxQhTzV6NQBxSvGpGQKEXFTI7MJ8RKBQBQCRQBWDPbjsLilxSUopFi0hpaKAOcU1KtQrUq0GCJhTgaYtOFBQ8U6mCnA0FDqKTNGaQDqWmA0uaBjs0ZpuaWgY7NPU1GKevPWmIsIS5x2FaEU3lxqi8Cs5COnRRVhHz83QVcTCouZWNATAKWY1saVMGsye+a5cSFyT2FbOmz4gx2zWsXqeXiaKUbm3HwCxpjpuQk9TTFmDR9alLhVGep6CtDzTOuIgkR45NZE9oowcYHUn1rcu2yeayJ23yADoO1QzSJkT2zzz5J4/kKgFq6vkdhWs8kUIYueQOagilSYJtP3gaBluBkWJWPUDaw9qytQtVjkaSIgsgyPcVdQIk+JWwG/woktlMgfqnqO1Mk5xLxpC/GB0oL3c0uyPLgHGDXTtpOnXCiUbY2BySppV8Pxxp51rcAnrgHrTuI5r+zLwHcQ6qeoY5xUZtiWw0gDjoyf1roZlkkQoZijDs1c1qAkgYk/ez+dNCZTmtXJIGSfaqsqNGMFd31q0L0BSGU7vrULEzdiTTEZ8kmD8y00SHPFWpIl6PkGovsxDZHK1Qie2UkZqclV6GnWoCDDd6le2VuVIqDSw2CU7h6VeePzVBDfhUVtbKGG/Aq6iorcdKQEMa+WuCOaeo3tVgbenWnrFzlQB7UDJIYhjk1KEG7huKYr4XBGKmWPcM5pDJSoMfaofummuGXODULT4HPWla5pTnyO5Y8wZp4YEVky3GDSRXxB5NZuDPShjImtS5qiuoJ3p4vYz3qLM7I4iD6lvNGaqm9QdxTTeqe9KzK9tDuY6GplqBKmWkSiZadUYNPBoLJBRTRThQMWlpBS0DFFLTc0uaAFxS03NG6gB1OBxTM0m6gCwG4x+dK02eB0FV9/FAancVi2knGM1ftptgCg+9ZKNg1ctm+bPqauLOWvFOJ0cEwjiUue2af9r3EOTjP3RWJLdgDJPAqs+prFGZpG9lWug8KUbM2bm6BO0GoFIALntWPZ3v2iQkng1oiXzflHQVNhGNqkhDYzgE54qrDJLHMgUkAiti4sftMgyAAO9DWEUQBJycUDMu8vZGmfHYDFUJ7u4hJdJWAY5GD0rZkst/JGPSqEmns8ZXB4NMTRlTajNv37yu4HIB4NRR6jdRndb3Dr3wDVibTJCu0KeORUdroN1LIMAqP71VoRYY3iO93Zkw+ep70wajLdthQTnsa1JPD0UbAyyKx77anSC3tI8JGF980XQ7My0jkPDxBj7DmpTbpGu6Quo9BU0lzs/5aqD6CqM90pHJLE9yaBkM8iA/IhPuxp1ujSnn5RVUyqz9DWlZbSQOQaBFuLSnKbgQy+1OFkyvwcCteyiEi/uzhh/D60+5iVU3MCD61JZl/JEMPg04bAQVPymo5XDZXGcd6ZvRAMZNArliTGMqPyp8cmV6nIqGNg3Spo48tlSM0AWIh5vGcGrscLRr61DBFyCeCKuNIFGKRSGrGGPIqrf2Y25UVcEw2+9U7i5c5FJDMGdShwTVRiwPBq7eMwbJHFUJJU7cVZFxd7GlUv61D5nPBqRXzSsNNk244600yMOlKoJpypzzSsVzMVKmWq6mplNcx9BEmFPFRg09aRoiQUopKUUDFzS02loAWikzRmgBaKTNGaAuLmkpM0maYrj6TOKbmm5oFclD88VfjYRqM9cVmoQDk1KZWY5zVRMampcZvMQ1iXySPLlj8i9BWrC2eKjng8xvmGBW8XoeNXVpFKymMSkmtayucIWY9az5I0TCimm4CjavarOY20uwX4Oash0EZZuSawbeQuRitM/KgzSsMmXEpyfwpZIgtqzj7ymq32hU5z0pGvd6mPs3egRpW0cUiozqOelPuHhslJACg+tYjagYInjJwycg1n3evvdFY2UEYweKVhkOpXw84tDj61jyXsjE5INaEjRMQmcg9FXjFRzW8IAK5Deh5qhGcSzDP8qQI8nFWjGq8kZ+tLEAx4U/hQMrLAQ3IrWtItyjHUVGIQvzbangkwwwMUBY2rGQRYzw3rV+4bzrduhIrNtmWTgnBFSzs0AJByp7ipGYt1G6uSpwaqhyW+arNxcEyMPyqqQXOcVQi1FKY+nSrcThjletUo43A45FXLeJiM7fxFSykjRhmDAKeDVgpmqKdfcVcjclRSGKw4wOtVZyyg5WrLsVYGoppRIh45oQzDu3bnIrJkGTWteN8xBqiYgxzVGZTVTmpk3CrAjUUYWkOwqMaeZtvWoDJg0x2yKAuWVNTLVdTUyGuU+hiTrTwajU08UjVEoNLTAadQMWlzSUooAM0maDSUALmkzRSYpgLmkJoxRQSFFJSE0Eti5pd1MJoBxVIiRdt2CcmmztJMfk4FVlclgO1XFuAo2gVtE8nErW5Ta2kGWJ5qARBD87VdnmdhxwKzpEaRuvFaI42XoZ44z8vJpt3qTBgoNVlj8sA96nh0uS6beQdvrQwQG5xGo3c9TRFchihPrUc9i8ZJH0FRRW0oQOVOM0ATTMsl4DI+EPGaqarthcGMBVxwR3qrfLPHPlSQCKgaR5owhJY+/agCFmO4tnGasQ3W0YPzGmLZEcyGn5hTgAE0DRbhkLHO0Mfeta3gDpuKgn2qhYWu/DN0rVMqxJtjXGO9SURSwcY24qmI9rYqWa7fvmqv2kZ5piLiSGNhuOKZLfbGCscg1B9rVwAwyKinRG2levpTJJmKztlQMip0iVoiMYYVHbQjIY9601hAXOO1JspIoRkxmtOxmUqeOtU3izGSO1S2xxjFIot+WFck96sxoEAIoGJYiP4hVWaXYAM4xSGaTLHKuCMGsy5QRtgHFEV2Q3Jpl9KrpuB5FCEzLvED5x1qhtZasSS7mPNRK2Tg1TYKDZGQTTScDrU7JkZFV3U1HMjdUJPYaRmmE4p2GFIykjpT5kJ4ea6FlamWoFPFTIa5mevB6Ey1IKiBp4NI2RIKeDUYpwNBQ/NFAooAKWig9KYgpKKDQITNITSmkoEwzTTSmmGmSxCcUbqQmmE0yGSq+KmDfLmqe/mp0bKkVpFnDiI3RDLctI+xanEe1RmiOFVO7HNErFjgcCtkeax8MRmkGeEFdTbKnkhYx2rE062Mw6cDtWrZs8UmxlPJobEjP1FlinCY5xmq/29Y1RFQHeO/rV3VbMz6iHRvuise5tJ4snaWAPapQytcs08uGXDL29aymXyZTxn2FaFyZS6lQVf1qObTXuX3owDY5qhGdJKzttAIFWbS1BYbupqUWEkZGeSKsW4Ky9OBSbKSNNU8mAAYHFUppHJ6im3d27cLnFVo45ZGBGaQN3LO7eNrDmoZLBn5Wr8Fo24FhV+CIBsEcUXKsc61nImCB0qaKFpNueCK3PLUzFcUr2G1gyDmi4rEMNtmPHpVyKImMq1OhGHAIwasNGUGSOKRRmPHsQoe9MhG1hmrNyysvuKoliuRTEaEcg3Eg9qqTne5BqGKZlDEmkmfo3rQIYZQjEE1nT3kiSlQcg1LdEkgiq+zeQTQ3YuMHJ2RCXZjkCpF3HHFWlhUDpUyRL6VjKZ6dLDPqyuisRT/Jz2q2sY9KkWMZrJu53wpqJQNv7U37P7VpGKjyfap1NrIxF6VKlQIamWtZbnnUXdE608VGpqQVB1IeKetRinigoeKWmilzQAtGaBSUxC0hNGKQigQZpKKKCWBppp1MY0yWMNROaexp0MayOAe9NESditk5q3Ch2ZPFdRp3h2KWMOy1Jf+HcREw9R2raMWjza9eL0RyL3G04BqS1VriUDrVe9sJ4JT5ikAH0rT0CHfNk9BWhwm/bwizgBxzU6OjuuQBVe9uAmAelUkuurdOajcoSa5CapIAcgc1ajZXfBIKMDWE26S8mkHJK1Gl86hoxnOMimInu5oklw6gY71nT6h5L5QCqdzcPI3z5qs+S25DkdxVCL/22SZxtjU5rYsrXA3yIBurO0zTmusORtUda6OKxztUMTUstaEaafBJwFBzVqLSY16IK29M0VNoLda2F0xEHSkTexyD6Y4PyrVG7t57bDbCcV6CtgPSkm01HXDIDTsHMeagl5A4OD3FX4rlc7W7VvX/h6NstENre1c5d2M1tKcg4oKTLErRsAyn5qlWdDDhjWSGdCQailuShxRYdwv5PLb5TxUXmo4XdwTUEs2ZBnlTUD/60Y+7VWJuW5lEZAB61WmnBIQU2V3LjJyKgMZWbdUOSRvClKZPjzF5pqR84qVQTyKMYasZzueph8Oo7jgpqVFNCjFSrWR3qNhVFSAUAU8CgYq4FOxupBTgcGmFjlU61ODVdetWBWkzy8OyVTUqmoVqVazO5EgpwNMFOFBQ8UuaaKWgQ7NLQKWmMTFFLSUEiU0040xqBDSaiZqe1RN1oEJkk1r6FZC5vFzzisbJrpPCf/H5Vw1Zz13aDaO9t4FiiVQO1K6DFPU/LTCc11HgMzLuxhnBEiA59qzI9MitHZoxgGt244rMunKrxUsaMHUQfOxzjFZsbkyqh6GtYkyXmG5GDVNo1WVSB3NJFsigiWG5Zj3pHgiidmIGQehp9x8oYjqKgaVmjQnnPFMRVmtYrhsoPwqrHp4jmxtPXpVkMRcDHGTW1aosjDeM4pNlRRasIFhtlAA+atqxtAzA44rOhQebj0rpLBB5QpIUmaVrBtUYFXjGCopLdRsFTEfMKszuRrFjtStGMdKmwKa/Q07CM26jAUmuO1a+t1kKFhuFdJ4gupLezcxkA4rx68uZZrt3dyTmok7HTSpuZ0yTQSv1FTy6bBJHuUjNclHI4OQxzWvbXk2wDdxSUkbPDPuLcWKKDzzVQQKe9XJZWfrVOViOlTKRvSw6Gval2Gzk+gqOSFkba4IPvVvT5G+1pz1OK0dbiQsrYwfasW7ndCKjJRMNBil25NOIxT0UcVmdqikKo4qZFpoAzUg6ZpjHgU4UgqQAUyQAp2KSnigD/2Q==", }} compFactory={ImageComp} /> <Example - title="Support Preview" - width={100} - height={100} + title="Support Preview for the Image on Click " + width={400} + height={300} config={{ src: "https://photographylife.com/wp-content/uploads/2023/05/Nikon-Z8-Official-Samples-00002.jpg", supportPreview: true, @@ -39,6 +39,204 @@ export default function ImageExample() { compFactory={ImageComp} /> </ExampleGroup> + + <ExampleGroup + title="Layout & Alignment" + description="The Following Examples Show the different Layout option of the Image Component." + > + <Example + title="Image Placement - Top" + width={400} + height={500} + config={{ + src: "https://photographylife.com/wp-content/uploads/2023/05/Nikon-Z8-Official-Samples-00002.jpg", + placement: "top", + }} + compFactory={ImageComp} + /> + <Example + title="Image Placement - Bottom" + width={400} + height={500} + config={{ + src: "https://photographylife.com/wp-content/uploads/2023/05/Nikon-Z8-Official-Samples-00002.jpg", + placement: "bottom", + }} + compFactory={ImageComp} + /> + <Example + title="Image Placement - Left" + width={600} + height={300} + config={{ + src: "https://photographylife.com/wp-content/uploads/2023/05/Nikon-Z8-Official-Samples-00002.jpg", + placement: "left", + }} + compFactory={ImageComp} + /> + <Example + title="Image Placement - Right" + width={600} + height={300} + config={{ + src: "https://photographylife.com/wp-content/uploads/2023/05/Nikon-Z8-Official-Samples-00002.jpg", + placement: "right", + }} + compFactory={ImageComp} + /> + </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the different Styling properties on the Image Component." + > + <Example + title="Background Color, Border Radius,Style,Width,Color" + width={400} + height={300} + config={{ + src: "https://photographylife.com/wp-content/uploads/2023/05/Nikon-Z8-Official-Samples-00002.jpg", + style: { + "margin": "20px", + "background": "#00FFFF", + "border": "#3377FF", + "radius": "10px", + "borderWidth": "3px", + "borderStyle": "solid", + }, + }} + compFactory={ImageComp} + /> + <Example + title="Margin & Padding" + width={400} + height={300} + config={{ + src: "https://photographylife.com/wp-content/uploads/2023/05/Nikon-Z8-Official-Samples-00002.jpg", + style: { + "background": "#00FFFF", + "border": "#3377FF", + "radius": "10px", + "borderWidth": "3px", + "margin": "10px", + "padding": "10px", + "borderStyle": "dashed", + }, + }} + compFactory={ImageComp} + /> + <Example + title="Opacity - 0.2" + width={400} + height={300} + config={{ + src: "https://photographylife.com/wp-content/uploads/2023/05/Nikon-Z8-Official-Samples-00002.jpg", + style: { + "opacity": "0.2", + }, + }} + compFactory={ImageComp} + /> + <Example + title="Opacity - 0.5" + width={400} + height={300} + config={{ + src: "https://photographylife.com/wp-content/uploads/2023/05/Nikon-Z8-Official-Samples-00002.jpg", + style: { + "opacity": "0.5", + }, + }} + compFactory={ImageComp} + /> + <Example + title="Opacity - 0.7" + width={400} + height={300} + config={{ + src: "https://photographylife.com/wp-content/uploads/2023/05/Nikon-Z8-Official-Samples-00002.jpg", + style: { + "opacity": "0.7", + }, + }} + compFactory={ImageComp} + /> + <Example + title="Opacity - 1" + width={400} + height={300} + config={{ + src: "https://photographylife.com/wp-content/uploads/2023/05/Nikon-Z8-Official-Samples-00002.jpg", + style: { + "opacity": "1", + }, + }} + compFactory={ImageComp} + /> + <Example + title="Rotation - 20deg" + width={400} + height={300} + config={{ + src: "https://photographylife.com/wp-content/uploads/2023/05/Nikon-Z8-Official-Samples-00002.jpg", + style: { + "rotation": "20deg", + }, + }} + compFactory={ImageComp} + /> + </ExampleGroup> + + <ExampleGroup + title="Animation Style" + description="The Following Examples Show different animations on the Cascader Component." + > + <Example + title="Bounce Animation" + width={400} + height={300} + config={{ + src: "https://photographylife.com/wp-content/uploads/2023/05/Nikon-Z8-Official-Samples-00002.jpg", + animationStyle: { + "animation": "bounce", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={ImageComp} + /> + <Example + title="Swing Animation" + width={400} + height={300} + config={{ + src: "https://photographylife.com/wp-content/uploads/2023/05/Nikon-Z8-Official-Samples-00002.jpg", + animationStyle: { + "animation": "swing", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={ImageComp} + /> + <Example + title="Tada Animation" + width={400} + height={300} + config={{ + src: "https://photographylife.com/wp-content/uploads/2023/05/Nikon-Z8-Official-Samples-00002.jpg", + animationStyle: { + "animation": "tada", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={ImageComp} + /> + </ExampleGroup> </> ); } diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/imageCarousel.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/imageCarousel.tsx index a90e5e3f1..eb5fbbe88 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/imageCarousel.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/imageCarousel.tsx @@ -30,7 +30,7 @@ export default function ImageCarouselExample() { compFactory={CarouselComp} /> <Example - title="Hiding the Image Carousel Component" + title="Auto Play - False" width={500} height={500} config={{ @@ -39,6 +39,16 @@ export default function ImageCarouselExample() { }} compFactory={CarouselComp} /> + <Example + title="Auto Play - True" + width={500} + height={500} + config={{ + data: "[\"https://media.istockphoto.com/id/1632091356/photo/happy-thanksgiving-holiday-greeting-card-handwriting-calligraphy-text-design-with-fall.jpg?s=1024x1024&w=is&k=20&c=l_-55iKmFpA3KxHaeMYdjOOb0F2ADYwFS-IJuc9si4U=\", \"https://media.istockphoto.com/id/1713107584/photo/airplane-with-banner-at-sunset-time.webp?a=1&b=1&s=612x612&w=0&k=20&c=a9x2vG4gEI8mHKTJi2DfPmW8Dc82qNdFoXRq6dRiF1Q=\", \"https://plus.unsplash.com/premium_photo-1682125748265-d362c809ba04?w=800&auto=format&fit=crop&q=60&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8MTN8fGJhbm5lcnxlbnwwfHwwfHx8MA%3D%3D\",\"https://plus.unsplash.com/premium_photo-1667912925305-629794bdb691?w=800&auto=format&fit=crop&q=60&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8MTd8fGJhbm5lcnxlbnwwfHwwfHx8MA%3D%3D\"]", + autoPlay: true, + }} + compFactory={CarouselComp} + /> </ExampleGroup> <ExampleGroup @@ -56,12 +66,12 @@ export default function ImageCarouselExample() { compFactory={CarouselComp} /> <Example - title="Dots Position - Right" + title="Dots Position - Bottom" width={500} height={500} config={{ data: "[\"https://media.istockphoto.com/id/1632091356/photo/happy-thanksgiving-holiday-greeting-card-handwriting-calligraphy-text-design-with-fall.jpg?s=1024x1024&w=is&k=20&c=l_-55iKmFpA3KxHaeMYdjOOb0F2ADYwFS-IJuc9si4U=\", \"https://media.istockphoto.com/id/1713107584/photo/airplane-with-banner-at-sunset-time.webp?a=1&b=1&s=612x612&w=0&k=20&c=a9x2vG4gEI8mHKTJi2DfPmW8Dc82qNdFoXRq6dRiF1Q=\", \"https://plus.unsplash.com/premium_photo-1682125748265-d362c809ba04?w=800&auto=format&fit=crop&q=60&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8MTN8fGJhbm5lcnxlbnwwfHwwfHx8MA%3D%3D\",\"https://plus.unsplash.com/premium_photo-1667912925305-629794bdb691?w=800&auto=format&fit=crop&q=60&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8MTd8fGJhbm5lcnxlbnwwfHwwfHx8MA%3D%3D\"]", - dotPostion: "right", + dotPostion: "bottom", }} compFactory={CarouselComp} /> @@ -75,6 +85,79 @@ export default function ImageCarouselExample() { }} compFactory={CarouselComp} /> + <Example + title="Dots Position - Right" + width={500} + height={500} + config={{ + data: "[\"https://media.istockphoto.com/id/1632091356/photo/happy-thanksgiving-holiday-greeting-card-handwriting-calligraphy-text-design-with-fall.jpg?s=1024x1024&w=is&k=20&c=l_-55iKmFpA3KxHaeMYdjOOb0F2ADYwFS-IJuc9si4U=\", \"https://media.istockphoto.com/id/1713107584/photo/airplane-with-banner-at-sunset-time.webp?a=1&b=1&s=612x612&w=0&k=20&c=a9x2vG4gEI8mHKTJi2DfPmW8Dc82qNdFoXRq6dRiF1Q=\", \"https://plus.unsplash.com/premium_photo-1682125748265-d362c809ba04?w=800&auto=format&fit=crop&q=60&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8MTN8fGJhbm5lcnxlbnwwfHwwfHx8MA%3D%3D\",\"https://plus.unsplash.com/premium_photo-1667912925305-629794bdb691?w=800&auto=format&fit=crop&q=60&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8MTd8fGJhbm5lcnxlbnwwfHwwfHx8MA%3D%3D\"]", + dotPosition: "right", + }} + compFactory={CarouselComp} + /> + </ExampleGroup> + + <ExampleGroup + title="Styling & Animations" + description="The Following Examples Show the Styling & Animation options on the Image Carousel Component." + > + <Example + title="Background Color" + width={500} + height={500} + config={{ + data: "[\"https://media.istockphoto.com/id/1632091356/photo/happy-thanksgiving-holiday-greeting-card-handwriting-calligraphy-text-design-with-fall.jpg?s=1024x1024&w=is&k=20&c=l_-55iKmFpA3KxHaeMYdjOOb0F2ADYwFS-IJuc9si4U=\", \"https://media.istockphoto.com/id/1713107584/photo/airplane-with-banner-at-sunset-time.webp?a=1&b=1&s=612x612&w=0&k=20&c=a9x2vG4gEI8mHKTJi2DfPmW8Dc82qNdFoXRq6dRiF1Q=\", \"https://plus.unsplash.com/premium_photo-1682125748265-d362c809ba04?w=800&auto=format&fit=crop&q=60&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8MTN8fGJhbm5lcnxlbnwwfHwwfHx8MA%3D%3D\",\"https://plus.unsplash.com/premium_photo-1667912925305-629794bdb691?w=800&auto=format&fit=crop&q=60&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8MTd8fGJhbm5lcnxlbnwwfHwwfHx8MA%3D%3D\"]", + style: { + "background": "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)" + }, + }} + compFactory={CarouselComp} + /> + <Example + title="Bounce Animation" + width={500} + height={500} + config={{ + data: "[\"https://media.istockphoto.com/id/1632091356/photo/happy-thanksgiving-holiday-greeting-card-handwriting-calligraphy-text-design-with-fall.jpg?s=1024x1024&w=is&k=20&c=l_-55iKmFpA3KxHaeMYdjOOb0F2ADYwFS-IJuc9si4U=\", \"https://media.istockphoto.com/id/1713107584/photo/airplane-with-banner-at-sunset-time.webp?a=1&b=1&s=612x612&w=0&k=20&c=a9x2vG4gEI8mHKTJi2DfPmW8Dc82qNdFoXRq6dRiF1Q=\", \"https://plus.unsplash.com/premium_photo-1682125748265-d362c809ba04?w=800&auto=format&fit=crop&q=60&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8MTN8fGJhbm5lcnxlbnwwfHwwfHx8MA%3D%3D\",\"https://plus.unsplash.com/premium_photo-1667912925305-629794bdb691?w=800&auto=format&fit=crop&q=60&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8MTd8fGJhbm5lcnxlbnwwfHwwfHx8MA%3D%3D\"]", + animationStyle: { + "animation": "bounce", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={CarouselComp} + /> + <Example + title="Swing Animation" + width={500} + height={500} + config={{ + data: "[\"https://media.istockphoto.com/id/1632091356/photo/happy-thanksgiving-holiday-greeting-card-handwriting-calligraphy-text-design-with-fall.jpg?s=1024x1024&w=is&k=20&c=l_-55iKmFpA3KxHaeMYdjOOb0F2ADYwFS-IJuc9si4U=\", \"https://media.istockphoto.com/id/1713107584/photo/airplane-with-banner-at-sunset-time.webp?a=1&b=1&s=612x612&w=0&k=20&c=a9x2vG4gEI8mHKTJi2DfPmW8Dc82qNdFoXRq6dRiF1Q=\", \"https://plus.unsplash.com/premium_photo-1682125748265-d362c809ba04?w=800&auto=format&fit=crop&q=60&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8MTN8fGJhbm5lcnxlbnwwfHwwfHx8MA%3D%3D\",\"https://plus.unsplash.com/premium_photo-1667912925305-629794bdb691?w=800&auto=format&fit=crop&q=60&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8MTd8fGJhbm5lcnxlbnwwfHwwfHx8MA%3D%3D\"]", + animationStyle: { + "animation": "swing", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={CarouselComp} + /> + <Example + title="Tada Animation" + width={500} + height={500} + config={{ + data: "[\"https://media.istockphoto.com/id/1632091356/photo/happy-thanksgiving-holiday-greeting-card-handwriting-calligraphy-text-design-with-fall.jpg?s=1024x1024&w=is&k=20&c=l_-55iKmFpA3KxHaeMYdjOOb0F2ADYwFS-IJuc9si4U=\", \"https://media.istockphoto.com/id/1713107584/photo/airplane-with-banner-at-sunset-time.webp?a=1&b=1&s=612x612&w=0&k=20&c=a9x2vG4gEI8mHKTJi2DfPmW8Dc82qNdFoXRq6dRiF1Q=\", \"https://plus.unsplash.com/premium_photo-1682125748265-d362c809ba04?w=800&auto=format&fit=crop&q=60&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8MTN8fGJhbm5lcnxlbnwwfHwwfHx8MA%3D%3D\",\"https://plus.unsplash.com/premium_photo-1667912925305-629794bdb691?w=800&auto=format&fit=crop&q=60&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8MTd8fGJhbm5lcnxlbnwwfHwwfHx8MA%3D%3D\"]", + animationStyle: { + "animation": "tada", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={CarouselComp} + /> </ExampleGroup> </> ); diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/imageEditor.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/imageEditor.tsx index 62981a0f4..bfd332b5c 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/imageEditor.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/imageEditor.tsx @@ -11,11 +11,66 @@ export default function ImageEditorExample() { <> <ExampleGroup title={trans("componentDoc.basicUsage")} - description={trans("componentDoc.basicDemoDescription")} + description="The Following Examples Show the Basic Usage of the Image Editor Component." > <Example title={trans("componentDoc.default")} + height={500} + width={500} config={{ + src: "https://photographylife.com/wp-content/uploads/2023/05/Nikon-Z8-Official-Samples-00002.jpg", + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Hiding the Image Editor component" + height={500} + width={500} + config={{ + src: "https://photographylife.com/wp-content/uploads/2023/05/Nikon-Z8-Official-Samples-00002.jpg", + hidden: true, + }} + compFactory={ChartCompWithDefault} + /> + </ExampleGroup> + + <ExampleGroup + title="Advanced Options" + description="The Following Examples Show the Advance Usage of the Image Editor Component." + > + <Example + title="Hiding Crop, Flip and Rotate options from Toolbar" + height={500} + width={500} + config={{ + src: "https://photographylife.com/wp-content/uploads/2023/05/Nikon-Z8-Official-Samples-00002.jpg", + crop: false, + flip: false, + rotate: false, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Hiding Text, Mask and Filter options from Toolbar" + height={500} + width={500} + config={{ + src: "https://photographylife.com/wp-content/uploads/2023/05/Nikon-Z8-Official-Samples-00002.jpg", + text: false, + mask: false, + filter: false, + }} + compFactory={ChartCompWithDefault} + /> + <Example + title="Hiding Draw, Shape, Icon options from Toolbar" + height={500} + width={500} + config={{ + src: "https://photographylife.com/wp-content/uploads/2023/05/Nikon-Z8-Official-Samples-00002.jpg", + draw: false, + icon: false, + shape: false, }} compFactory={ChartCompWithDefault} /> diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/progress.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/progress.tsx index d7919bb9a..4b9cb2c50 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/progress.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/progress.tsx @@ -8,8 +8,35 @@ export default function ProgressExample() { <> <ExampleGroup title={trans("componentDoc.basicUsage")} - description={trans("componentDoc.basicDemoDescription")} + description="The Following Examples Show the Basic Usage of the Progress Bar Component." > + <Example + title="Default Component" + config={{ + }} + compFactory={ProgressComp} + /> + <Example + title="Showing Progress Value" + config={{ + value: "80", + showInfo: true, + }} + compFactory={ProgressComp} + /> + </ExampleGroup> + + <ExampleGroup + title="Other Examples" + description="The Following Examples Show the different examples on the Progress Bar Component." + > + <Example + title="Hiding the Progress Bar component" + config={{ + hidden: true, + }} + compFactory={ProgressComp} + /> <Example title={trans("componentDoc.notComplete")} config={{ @@ -27,6 +54,114 @@ export default function ProgressExample() { compFactory={ProgressComp} /> </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the different Styling properties on the Progress Bar Component." + > + <Example + title="Margin & Padding" + config={{ + showInfo: true, + style:{ + "margin": "10px", + "padding": "50px", + }, + }} + compFactory={ProgressComp} + /> + <Example + title="Text Properties" + config={{ + showInfo: true, + style:{ + "text": "#E67373", + "textSize": "25px", + "textWeight": "bold", + "fontStyle": "italic", + }, + }} + compFactory={ProgressComp} + /> + <Example + title="Track Color" + config={{ + showInfo: true, + value: "20", + style:{ + "track": "#E68E50", + }, + }} + compFactory={ProgressComp} + /> + <Example + title="Fill Color" + config={{ + showInfo: true, + value: "70", + style:{ + "fill": "#36b389", + }, + }} + compFactory={ProgressComp} + /> + <Example + title="Success Color" + config={{ + showInfo: true, + value: "100", + style:{ + "success": "#D7D9E0", + }, + }} + compFactory={ProgressComp} + /> + </ExampleGroup> + + <ExampleGroup + title="Animation Style" + description="The Following Examples Show different animations on the Progress Bar Component." + > + <Example + title="Bounce Animation" + config={{ + showInfo: true, + animationStyle: { + "animation": "bounce", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={ProgressComp} + /> + <Example + title="Swing Animation" + config={{ + showInfo: true, + animationStyle: { + "animation": "swing", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={ProgressComp} + /> + <Example + title="Tada Animation" + config={{ + showInfo: true, + animationStyle: { + "animation": "tada", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={ProgressComp} + /> + </ExampleGroup> </> ); } diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/progressCircle.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/progressCircle.tsx index b264f83ef..5b85cda90 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/progressCircle.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/progressCircle.tsx @@ -12,8 +12,6 @@ export default function ProgressCircleExample() { > <Example title={trans("componentDoc.notComplete")} - width={100} - height={100} config={{ value: "60", }} @@ -21,13 +19,121 @@ export default function ProgressCircleExample() { /> <Example title={trans("componentDoc.complete")} - width={100} - height={100} config={{ value: "100", }} compFactory={ProgressCircleComp} /> + <Example + title="Hiding the Progress Circle component" + config={{ + hidden: true, + }} + compFactory={ProgressCircleComp} + /> + </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the different Styling properties on the Progress Bar Component." + > + <Example + title="Margin & Padding" + config={{ + style:{ + "margin": "10px", + "padding": "50px", + }, + }} + compFactory={ProgressCircleComp} + /> + <Example + title="Text Properties" + config={{ + style:{ + "text": "#E67373", + "textSize": "50px", + "textWeight": "bold", + "fontStyle": "italic", + }, + }} + compFactory={ProgressCircleComp} + /> + <Example + title="Track Color" + config={{ + value: "20", + style:{ + "track": "#E68E50", + }, + }} + compFactory={ProgressCircleComp} + /> + <Example + title="Fill Color" + config={{ + value: "70", + style:{ + "fill": "#36b389", + }, + }} + compFactory={ProgressCircleComp} + /> + <Example + title="Success Color" + config={{ + value: "100", + style:{ + "success": "#D7D9E0", + }, + }} + compFactory={ProgressCircleComp} + /> + </ExampleGroup> + + <ExampleGroup + title="Animation Style" + description="The Following Examples Show different animations on the Progress Bar Component." + > + <Example + title="Bounce Animation" + config={{ + showInfo: true, + animationStyle: { + "animation": "bounce", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={ProgressCircleComp} + /> + <Example + title="Swing Animation" + config={{ + showInfo: true, + animationStyle: { + "animation": "swing", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={ProgressCircleComp} + /> + <Example + title="Tada Animation" + config={{ + showInfo: true, + animationStyle: { + "animation": "tada", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={ProgressCircleComp} + /> </ExampleGroup> </> ); diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/table.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/table.tsx index 4a050d0a7..c6b05a3bf 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/table.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/table.tsx @@ -5,6 +5,540 @@ import ExampleGroup from "../../common/ExampleGroup"; const data = JSON.stringify(i18nObjs.table.defaultData); +const data2 = "[\n {\n \"id\": 1,\n \"name\": \"4\",\n \"date\": \"https://api.dicebear.com/7.x/miniavs/svg?seed=1\",\n \"department\": \"true\"\n },\n {\n \"id\": 2,\n \"name\": \"2\",,\n \"date\": \"https://api.dicebear.com/7.x/miniavs/svg?seed=1\",\n \"department\": \"true\"\n },\n {\n \"id\": 3,\n \"name\": \"1\",\n \"date\": \"https://api.dicebear.com/7.x/miniavs/svg?seed=1\",\n \"department\": \"false\"\n },\n {\n \"id\": 4,\n \"name\": \"3\",\n \"date\": \"https://api.dicebear.com/7.x/miniavs/svg?seed=1\",\n },\n {\n \"id\": 5,\n \"name\": \"5\",\n \"date\": \"https://api.dicebear.com/7.x/miniavs/svg?seed=1\",\n \"department\": \"true\"\n },\n {\n \"id\": 6,\n \"name\": \"2\",\n \"date\": \"https://api.dicebear.com/7.x/miniavs/svg?seed=1\",\n \"department\": \"\"\n },\n {\n \"id\": 7,\n \"name\": \"4\",\n \"date\": \"https://api.dicebear.com/7.x/miniavs/svg?seed=1\",\n \"department\": \"true\"\n },\n {\n \"id\": 8,\n \"name\": \"3\",\n \"date\": \"https://api.dicebear.com/7.x/miniavs/svg?seed=1\",\n \"department\": \"true\"\n },\n {\n \"id\": 9,\n \"name\": \"5\",\n \"date\": \"https://api.dicebear.com/7.x/miniavs/svg?seed=1\",\n \"department\": \"true\"\n },\n {\n \"id\": 10,\n \"name\": \"2\",\n \"date\": \"https://api.dicebear.com/7.x/miniavs/svg?seed=1\",\n \"department\": \"false\"\n }\n]"; + +const data3 = "[\n {\n \"id\": 1,\n \"name\": \"Reagen Gilberthorpe\",\n \"date\": \"Completed\",\n \"department\": \"100\"\n },\n {\n \"id\": 2,\n \"name\": \"Haroun Lortzing\",\n \"date\": \"To Do\",\n \"department\": \"0\"\n },\n {\n \"id\": 2,\n \"name\": \"Garret Kilmaster\",\n \"date\": \"In Progress\",\n \"department\": \"45\"\n },\n {\n \"id\": 3,\n \"name\": \"Israel Harrowsmith\",\n \"date\": \"Closed\",\n \"department\": \"100\"\n },\n {\n \"id\": 1,\n \"name\": \"Loren O'Lagen\",\n \"date\": \"Backlog\",\n \"department\": \"0\"\n },\n {\n \"id\": 2,\n \"name\": \"Wallis Hothersall\",\n \"date\": \"Partially Completed\",\n \"department\": \"85\"\n },\n {\n \"id\": 1,\n \"name\": \"Kaia Biskup\",\n \"date\": \"To Do\",\n \"department\": \"0\"\n },\n {\n \"id\": 3,\n \"name\": \"Travers Saterweyte\",\n \"date\": \"Done\",\n \"department\": \"100\"\n },\n {\n \"id\": 3,\n \"name\": \"Mikey Niemetz\",\n \"date\": \"In Progress\",\n \"department\": \"45\"\n },\n {\n \"id\": 1,\n \"name\": \"Mano Meckiff\",\n \"date\": \"Completed\",\n \"department\": \"100\"\n }\n]"; + +const data4 = "[\n {\n \"id\": \"https://www.google.com\",\n \"name\": \"Reagen Gilberthorpe\",\n \"date\": \"7/5/2022\",\n },\n {\n \"id\": \"https://www.linkedin.com\",\n \"name\": \"Haroun Lortzing\",\n \"date\": \"11/6/2022\",\n },\n {\n \"id\": \"http://lowcoder.cloud/\",\n \"name\": \"Garret Kilmaster\",\n \"date\": \"11/14/2021\",\n },\n {\n \"id\": \"https://docs.lowcoder.cloud/\",\n \"name\": \"Israel Harrowsmith\",\n \"date\": \"4/3/2022\",\n },\n {\n \"id\": \"https://app.lowcoder.cloud\",\n \"name\": \"Loren O'Lagen\",\n \"date\": \"9/10/2022\",\n },\n {\n \"id\": \"https://www.espncricinfo.com/\",\n \"name\": \"Wallis Hothersall\",\n \"date\": \"4/18/2022\",\n },\n {\n \"id\": \"https://techcrunch.com/\",\n \"name\": \"Kaia Biskup\",\n \"date\": \"3/4/2022\",\n },\n {\n \"id\": \"https://www.apple.com/\",\n \"name\": \"Travers Saterweyte\",\n \"date\": \"1/9/2022\",\n },\n {\n \"id\": \"https://www.amazon.com/\",\n \"name\": \"Mikey Niemetz\",\n \"date\": \"1/4/2022\",\n },\n {\n \"id\": \"https://www.etsy.com/\",\n \"name\": \"Mano Meckiff\",\n \"date\": \"2/19/2022\",\n }\n]"; + +const columns = [ + { + "title": "ID", + "showTitle": true, + "isCustom": false, + "dataIndex": "id", + "width": "55", + "autoWidth": "fixed", + "render": { + "compType": "text", + "comp": { + "text": "{{currentCell}}" + } + }, + "align": "left", + "fixed": "close", + "editable": true, + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + }, + { + "title": "Name", + "showTitle": true, + "isCustom": false, + "dataIndex": "name", + "width": "200", + "autoWidth": "fixed", + "render": { + "compType": "text", + "comp": { + "text": "{{currentCell}}" + } + }, + "align": "left", + "fixed": "close", + "editable": true, + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + }, + { + "title": "Date", + "showTitle": true, + "isCustom": false, + "dataIndex": "date", + "width": "110", + "autoWidth": "fixed", + "render": { + "compType": "text", + "comp": { + "text": "{{currentCell}}" + } + }, + "align": "left", + "fixed": "close", + "editable": true, + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + }, + { + "title": "Department", + "showTitle": true, + "isCustom": false, + "dataIndex": "department", + "width": "250", + "autoWidth": "fixed", + "render": { + "compType": "tag", + "comp": { + "text": "{{currentCell}}", + "tagColors": { + "optionType": "manual", + "manual": { + "manual": [ + { + "label": "Tag1", + "icon": "/icon:solid/tag", + "color": "#f50" + }, + { + "label": "Tag2", + "icon": "/icon:solid/tag", + "color": "#2db7f5" + } + ] + }, + "mapData": { + "data": "[]", + "mapData": { + "color": "" + } + } + } + } + }, + "align": "left", + "fixed": "close", + "editable": true, + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + } +]; +const expansion = { + "expandable": true, + "slot": { + "container": { + "layout": { + "d7274235": { + "i": "d7274235", + "h": 8, + "w": 24, + "x": 0, + "y": 0, + "pos": 0 + } + }, + "items": { + "d7274235": { + "compType": "text", + "comp": { + "text": "### You can configure/add any component inside the Exapandable Table View", + "autoHeight": "auto", + "type": "markdown", + "horizontalAlignment": "center", + "contentScrollBar": true, + "verticalAlignment": "center", + "margin": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "padding": { + "left": "", + "right": "", + "top": "", + "bottom": "" + }, + "showDataLoadingIndicators": false, + "preventStyleOverwriting": false, + "appliedThemeId": "", + "version": "latest" + }, + "name": "text1" + } + } + } + } +}; +const style= { + "margin": "10px", + "padding": "20px", + "borderStyle": "dashed", + "borderWidth": "3px", + "background": "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + "border": "#000", + "radius": "10px" +}; +const headerStyle = { + "margin": "10px", + "fontFamily": "Courier New", + "fontStyle": "italic", + "text": "#222222", + "headerBackground": "#F7A007", + "border": "#E67373", + "borderWidth": "7px", + "textSize": "25px" +}; +const toolbarStyle = { + "margin": "0px", + "background": "#F7A007", + "border": "#E67373", + "toolbarText": "#FFFFFF" +}; +const rowStyle = { + "borderWidth": "10px", + "borderStyle": "dashed", + "background": "linear-gradient(0deg, #fdfbfb 0%, #ebedee 100%)", + "border": "#222222", + "radius": "10px", + "selectedRowBackground": "#3377FF", + "hoverRowBackground": "#FFF6E6", + "alternateBackground": "linear-gradient(0deg, #FFFFFF 0%, rgba(235, 237, 238, 1) 100%)" +}; +const columnStyle = { + "background": "linear-gradient(90deg, RGBA(247, 160, 7, 1) 0%, rgba(254,225,64,1) 100%)", + "border": "#222222", + "margin": "10px", + "radius": "10px", + "text": "#000000", + "textSize": "15px", + "textWeight": "bold", + "fontFamily": "Courier New", + "fontStyle": "italic" +}; +const summaryRowStyle = { + "borderWidth": "5px", + "borderStyle": "dashed", + "background": "#D7D9E0", + "border": "#222222", + "radius": "10px", + "margin": "1px", + "text": "#FFFFFF", + "textSize": "15px", + "textWeight": "bold", + "fontFamily": "Courier New", + "fontStyle": "italic" +}; + export default function TableExample() { const blackListConfig: string[] = ["data", "size"]; const nameMap: Record<string, string> = { @@ -51,7 +585,7 @@ export default function TableExample() { /> </ExampleGroup> - <ExampleGroup title={trans("componentDoc.style")}> + <ExampleGroup title="Layout"> <Example title={trans("componentDoc.hideHeader")} width={400} @@ -59,6 +593,13 @@ export default function TableExample() { blackListConfig={blackListConfig} compFactory={TableComp} /> + <Example + title="Hide Footer" + width={400} + config={{ data: data, hideToolbar: true }} + blackListConfig={blackListConfig} + compFactory={TableComp} + /> <Example title={trans("componentDoc.hideBordered")} width={400} @@ -70,23 +611,84 @@ export default function TableExample() { <ExampleGroup title={trans("componentDoc.selectionMode")}> <Example - title={trans("componentDoc.single")} - width={400} - config={{ data: data, hideHeader: true, selection: { mode: "single" } }} + title="Single - Only single Row can be selected" + width={800} + hideSettings={true} + config={{ + data: data, + rowStyle: rowStyle, + selection: + { + mode: "single", + } + }} + blackListConfig={blackListConfig} + compFactory={TableComp} + /> + <Example + title="Multiple - Multiple Rows can be selected" + width={800} + hideSettings={true} + config={{ + data: data, + rowStyle: rowStyle, + selection: + { + mode: "multi", + } + }} + blackListConfig={blackListConfig} + compFactory={TableComp} + /> + <Example + title="Close - No Row can be selected" + width={800} + hideSettings={true} + config={{ + data: data, + rowStyle: rowStyle, + selection: + { + mode: "close", + } + }} + blackListConfig={blackListConfig} + compFactory={TableComp} + /> + <Example + title="Showing Loading bars" + width={800} + hideSettings={true} + config={{ + data: data, + hideBordered: true, + loading: true, + }} blackListConfig={blackListConfig} compFactory={TableComp} /> + </ExampleGroup> + + <ExampleGroup title="Editable Table & Edit modes"> <Example - title={trans("componentDoc.multi")} + title="Edit Mode - Single Click" width={400} - config={{ data: data, hideBordered: true, selection: { mode: "multi" } }} + config={{ + data: data, + columns: columns, + editModeClicks: "single", + }} blackListConfig={blackListConfig} compFactory={TableComp} /> <Example - title={trans("componentDoc.close")} + title="Edit Mode - Double Click" width={400} - config={{ data: data, hideBordered: true, selection: { mode: "close" } }} + config={{ + data: data, + columns: columns, + editModeClicks: "double", + }} blackListConfig={blackListConfig} compFactory={TableComp} /> @@ -154,6 +756,46 @@ export default function TableExample() { blackListConfig={blackListConfig} compFactory={TableComp} /> + <Example + title="Hiding Filter icon" + width={400} + config={{ + data: data, + toolbar:{position:"below", showFilter:false, showDownload:true,showRefresh:true,columnSetting:true}, + }} + blackListConfig={blackListConfig} + compFactory={TableComp} + /> + <Example + title="Hiding Download Icon" + width={400} + config={{ + data: data, + toolbar:{position:"below", showFilter:true, showDownload:false,showRefresh:true,columnSetting:true}, + }} + blackListConfig={blackListConfig} + compFactory={TableComp} + /> + <Example + title="Hiding Refresh Icon" + width={400} + config={{ + data: data, + toolbar:{position:"below", showFilter:true, showDownload:true,showRefresh:false,columnSetting:true}, + }} + blackListConfig={blackListConfig} + compFactory={TableComp} + /> + <Example + title="Hiding Column Visibility Icon" + width={400} + config={{ + data: data, + toolbar:{position:"below", showFilter:true, showDownload:true,showRefresh:true,columnSetting:false}, + }} + blackListConfig={blackListConfig} + compFactory={TableComp} + /> </ExampleGroup> <ExampleGroup title="Summary and Inline Rows"> @@ -202,6 +844,6036 @@ export default function TableExample() { compFactory={TableComp} /> </ExampleGroup> + + <ExampleGroup title="Expandable View"> + <Example + title="Expandable View" + width={800} + hideSettings={true} + config={{ + data: data, + expansion: expansion, + }} + blackListConfig={blackListConfig} + compFactory={TableComp} + /> + </ExampleGroup> + + <ExampleGroup title="Styling Properties"> + <Example + title="Table Styling" + width={800} + hideSettings={true} + config={{ + data: data, + style: style, + toolbar:{position:"below", showFilter:true, showDownload:true,showRefresh:true,columnSetting:true}, + }} + blackListConfig={blackListConfig} + compFactory={TableComp} + /> + <Example + title="Header Styling" + width={800} + hideSettings={true} + config={{ + data: data, + headerStyle: headerStyle, + toolbar:{position:"below", showFilter:true, showDownload:true,showRefresh:true,columnSetting:true}, + }} + blackListConfig={blackListConfig} + compFactory={TableComp} + /> + <Example + title="Toolbar Styling" + width={800} + hideSettings={true} + config={{ + data: data, + toolbarStyle: toolbarStyle, + toolbar:{position:"below", showFilter:true, showDownload:true,showRefresh:true,columnSetting:true}, + }} + blackListConfig={blackListConfig} + compFactory={TableComp} + /> + <Example + title="Row Styling" + width={800} + hideSettings={true} + config={{ + data: data, + rowStyle: rowStyle, + toolbar:{position:"below", showFilter:true, showDownload:true,showRefresh:true,columnSetting:true}, + }} + blackListConfig={blackListConfig} + compFactory={TableComp} + /> + <Example + title="Column Styling" + width={800} + hideSettings={true} + config={{ + data: data, + columnsStyle: columnStyle, + toolbar:{position:"below", showFilter:true, showDownload:true,showRefresh:true,columnSetting:true}, + }} + blackListConfig={blackListConfig} + compFactory={TableComp} + /> + <Example + title="Summary Rows Styling" + width={800} + hideSettings={true} + config={{ + data: data, + showSummary: true, + summaryRows: "2", + columns: [ + { + "title": "ID", + "showTitle": true, + "isCustom": false, + "dataIndex": "id", + "width": "68", + "autoWidth": "fixed", + "render": { + "compType": "text", + "comp": { + "text": "{{currentCell}}" + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": { + "text": "10" + } + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": { + "text": "20" + } + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + }, + { + "title": "Name", + "showTitle": true, + "isCustom": false, + "dataIndex": "name", + "width": "200", + "autoWidth": "fixed", + "render": { + "compType": "text", + "comp": { + "text": "{{currentCell}}" + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": { + "text": "John" + } + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": { + "text": "Daniel" + } + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + }, + { + "title": "Date", + "showTitle": true, + "isCustom": false, + "dataIndex": "date", + "width": "110", + "autoWidth": "fixed", + "render": { + "compType": "text", + "comp": { + "text": "{{currentCell}}" + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": { + "text": "{{Date()}}" + } + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": { + "text": "{{Date()}}" + } + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + }, + { + "title": "Department", + "showTitle": true, + "isCustom": false, + "dataIndex": "department", + "width": "250", + "autoWidth": "fixed", + "render": { + "compType": "tag", + "comp": { + "text": "{{currentCell}}", + "tagColors": { + "optionType": "manual", + "manual": { + "manual": [ + { + "label": "Tag1", + "icon": "/icon:solid/tag", + "color": "#f50" + }, + { + "label": "Tag2", + "icon": "/icon:solid/tag", + "color": "#2db7f5" + } + ] + }, + "mapData": { + "data": "[]", + "mapData": { + "color": "" + } + } + } + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "tag", + "comp": { + "text": "TAX", + "tagColors": { + "optionType": "manual", + "manual": { + "manual": [ + { + "label": "Tag1", + "icon": "/icon:solid/tag", + "color": "#f50" + }, + { + "label": "Tag2", + "icon": "/icon:solid/tag", + "color": "#2db7f5" + } + ] + }, + "mapData": { + "data": "[]", + "mapData": { + "color": "" + } + } + } + } + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "tag", + "comp": { + "text": "TAX", + "tagColors": { + "optionType": "manual", + "manual": { + "manual": [ + { + "label": "Tag1", + "icon": "/icon:solid/tag", + "color": "#f50" + }, + { + "label": "Tag2", + "icon": "/icon:solid/tag", + "color": "#2db7f5" + } + ] + }, + "mapData": { + "data": "[]", + "mapData": { + "color": "" + } + } + } + } + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + } + ], + summaryRowStyle: summaryRowStyle, + toolbar:{position:"below", showFilter:true, showDownload:true,showRefresh:true,columnSetting:true}, + }} + blackListConfig={blackListConfig} + compFactory={TableComp} + /> + </ExampleGroup> + + + <ExampleGroup title="Column Types"> + <Example + title="Column Types : Number, Text, Date, Date & Time, Tag" + width={800} + hideSettings={true} + config={{ + columns: [ + { + "title": "Number", + "showTitle": true, + "isCustom": false, + "dataIndex": "id", + "width": "55", + "autoWidth": "fixed", + "render": { + "compType": "number", + "comp": { + "text": "{{currentCell}}", + "step": "1" + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + }, + { + "title": "Text", + "showTitle": true, + "isCustom": false, + "dataIndex": "name", + "width": "200", + "autoWidth": "fixed", + "render": { + "compType": "text", + "comp": { + "text": "{{currentCell}}" + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + }, + { + "title": "Date", + "showTitle": true, + "isCustom": false, + "dataIndex": "date", + "width": "110", + "autoWidth": "fixed", + "render": { + "compType": "date", + "comp": { + "text": "{{currentCell}}", + "format": "YYYY-MM-DD", + "inputFormat": "YYYY-MM-DD" + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + }, + { + "title": "Date Time", + "showTitle": true, + "isCustom": true, + "dataIndex": "4be1c6fe", + "autoWidth": "auto", + "render": { + "compType": "dateTime", + "comp": { + "text": "{{Date()}}", + "format": "YYYY-MM-DD HH:mm:ss", + "inputFormat": "YYYY-MM-DD HH:mm:ss" + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + }, + { + "title": "Tag", + "showTitle": true, + "isCustom": false, + "dataIndex": "department", + "width": "250", + "autoWidth": "fixed", + "render": { + "compType": "tag", + "comp": { + "text": "{{currentCell}}", + "tagColors": { + "optionType": "manual", + "manual": { + "manual": [ + { + "label": "Tag1", + "icon": "/icon:solid/tag", + "color": "#f50" + }, + { + "label": "Tag2", + "icon": "/icon:solid/tag", + "color": "#2db7f5" + } + ] + }, + "mapData": { + "data": "[]", + "mapData": { + "color": "" + } + } + } + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + }, + ], + data: data, + }} + blackListConfig={blackListConfig} + compFactory={TableComp} + /> + <Example + title="Column Types : Avatar, Ratings, Image, Markdown, Boolean, Switch" + width={800} + hideSettings={true} + config={{ + data: data2, + columns: [ + { + "title": "Avatars", + "showTitle": true, + "isCustom": false, + "dataIndex": "id", + "width": "144", + "autoWidth": "fixed", + "render": { + "compType": "avatars", + "comp": { + "maxCount": "3", + "avatarSize": "40", + "alignment": "center", + "autoColor": true, + "avatars": { + "optionType": "manual", + "manual": { + "manual": [ + { + "src": "https://api.dicebear.com/7.x/miniavs/svg?seed=1", + "label": "I" + }, + { + "AvatarIcon": "/icon:antd/startwotone" + }, + { + "label": "R" + }, + { + "label": "M" + } + ] + }, + "mapData": { + "data": "[]" + } + } + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + }, + { + "title": "Ratings", + "showTitle": true, + "isCustom": false, + "dataIndex": "name", + "width": "107", + "autoWidth": "fixed", + "render": { + "compType": "rating", + "comp": { + "text": "{{currentCell}}" + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + }, + { + "title": "Image", + "showTitle": true, + "isCustom": false, + "dataIndex": "date", + "width": "110", + "autoWidth": "fixed", + "render": { + "compType": "image", + "comp": { + "src": "{{currentCell}}", + "size": "50" + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + }, + { + "title": "Markdown", + "showTitle": true, + "isCustom": true, + "dataIndex": "4be1c6fe", + "width": "249.796875", + "autoWidth": "fixed", + "render": { + "compType": "markdown", + "comp": { + "text": "{{Date()}}" + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + }, + { + "title": "Boolean", + "showTitle": true, + "isCustom": false, + "dataIndex": "department", + "width": "89.3984375", + "autoWidth": "fixed", + "render": { + "compType": "boolean", + "comp": { + "text": "{{currentCell}}", + "falseValues": "x", + "iconNull": "/icon:antd/dashoutlined" + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + }, + { + "title": "Switch", + "showTitle": true, + "isCustom": true, + "dataIndex": "9f0b04b5", + "autoWidth": "auto", + "render": { + "compType": "switch", + "comp": { + "value": "", + "switchState": "{{currentRow.department}}" + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + } + ], + }} + blackListConfig={blackListConfig} + compFactory={TableComp} + /> + <Example + title="Column Types : Select, Dropdown, Status, Progress" + width={800} + hideSettings={true} + config={{ + data: data3, + columns: [ + { + "title": "Select", + "showTitle": true, + "isCustom": false, + "dataIndex": "id", + "width": "85", + "autoWidth": "fixed", + "render": { + "compType": "select", + "comp": { + "text": "{{currentCell}}", + "options": { + "optionType": "manual", + "manual": { + "manual": [ + { + "value": "1", + "label": "Option 1" + }, + { + "value": "2", + "label": "Option 2" + }, + { + "value": "3", + "label": "Option 3" + } + ] + }, + "mapData": { + "data": "[]" + } + } + } + }, + "align": "left", + "fixed": "close", + "editable": true, + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + }, + { + "title": "Dropdown", + "showTitle": true, + "isCustom": false, + "dataIndex": "name", + "width": "82.2421875", + "autoWidth": "fixed", + "render": { + "compType": "dropdown", + "comp": { + "buttonType": "primary", + "label": "", + "prefixIcon": "/icon:solid/ellipsis-vertical", + "options": { + "optionType": "manual", + "manual": { + "manual": [ + { + "label": "Option 1" + }, + { + "label": "Option 2" + } + ] + }, + "mapData": { + "data": "[]" + } + } + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + }, + { + "title": "Status", + "showTitle": true, + "isCustom": false, + "dataIndex": "date", + "width": "110", + "autoWidth": "fixed", + "render": { + "compType": "badgeStatus", + "comp": { + "text": "{{currentCell}}" + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + }, + { + "title": "Progress", + "showTitle": true, + "isCustom": false, + "dataIndex": "department", + "width": "250", + "autoWidth": "fixed", + "render": { + "compType": "progress", + "comp": { + "text": "{{currentCell}}" + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + } + ], + }} + blackListConfig={blackListConfig} + compFactory={TableComp} + /> + <Example + title="Column Types: Link, Links, Button," + width={800} + hideSettings={true} + config={{ + data: data4, + columns: [ + { + "title": "Link", + "showTitle": true, + "isCustom": false, + "dataIndex": "id", + "width": "143", + "autoWidth": "fixed", + "render": { + "compType": "link", + "comp": { + "text": "{{currentCell}}", + "onClick": { + "compType": "goToURL", + "comp": { + "url": "{{currentCell}}", + "query": [ + {} + ], + "hash": [ + {} + ], + "inNewTab": true + }, + "condition": "", + "slowdown": "debounce", + "delay": "" + } + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + }, + { + "title": "Links", + "showTitle": true, + "isCustom": false, + "dataIndex": "name", + "width": "200", + "autoWidth": "fixed", + "render": { + "compType": "links", + "comp": { + "options": { + "manual": [ + { + "label": "Google", + "onClick": { + "compType": "goToURL", + "comp": { + "url": "https://www.google.com", + "query": [ + {} + ], + "hash": [ + {} + ], + "inNewTab": true + }, + "condition": "", + "slowdown": "debounce", + "delay": "" + } + }, + { + "label": "Facebook", + "onClick": { + "compType": "goToURL", + "comp": { + "url": "https://www.facebook.com", + "query": [ + {} + ], + "hash": [ + {} + ], + "inNewTab": true + }, + "condition": "", + "slowdown": "debounce", + "delay": "" + } + }, + { + "label": "Linkedin", + "onClick": { + "compType": "goToURL", + "comp": { + "url": "https://www.linkedin.com", + "query": [ + {} + ], + "hash": [ + {} + ], + "inNewTab": true + }, + "condition": "", + "slowdown": "debounce", + "delay": "" + } + } + ] + } + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + }, + { + "title": "Button", + "showTitle": true, + "isCustom": false, + "dataIndex": "date", + "width": "110", + "autoWidth": "fixed", + "render": { + "compType": "button", + "comp": { + "text": "{{currentRow.id}}", + "buttonType": "primary", + "onClick": { + "compType": "goToURL", + "comp": { + "url": "{{currentRow.id}}", + "query": [ + {} + ], + "hash": [ + {} + ], + "inNewTab": true + }, + "condition": "", + "slowdown": "debounce", + "delay": "" + } + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + } + ], + }} + blackListConfig={blackListConfig} + compFactory={TableComp} + /> + </ExampleGroup> + + <ExampleGroup title="Individual Column Properties"> + <Example + title="Fixed Column - Left side ( scroll to right to see the effect )" + width={400} + hideSettings={true} + config={{ + data: data, + columns : [ + { + "title": "ID", + "showTitle": true, + "isCustom": false, + "dataIndex": "id", + "width": "55", + "autoWidth": "fixed", + "render": { + "compType": "text", + "comp": { + "text": "{{currentCell}}" + } + }, + "align": "left", + "fixed": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + }, + { + "title": "Name", + "showTitle": true, + "isCustom": false, + "dataIndex": "name", + "width": "200", + "autoWidth": "fixed", + "render": { + "compType": "text", + "comp": { + "text": "{{currentCell}}" + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + }, + { + "title": "Date", + "showTitle": true, + "isCustom": false, + "dataIndex": "date", + "width": "110", + "autoWidth": "fixed", + "render": { + "compType": "text", + "comp": { + "text": "{{currentCell}}" + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + }, + { + "title": "Department", + "showTitle": true, + "isCustom": false, + "dataIndex": "department", + "width": "250", + "autoWidth": "fixed", + "render": { + "compType": "tag", + "comp": { + "text": "{{currentCell}}", + "tagColors": { + "optionType": "manual", + "manual": { + "manual": [ + { + "label": "Tag1", + "icon": "/icon:solid/tag", + "color": "#f50" + }, + { + "label": "Tag2", + "icon": "/icon:solid/tag", + "color": "#2db7f5" + } + ] + }, + "mapData": { + "data": "[]", + "mapData": { + "color": "" + } + } + } + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + } + ], + }} + blackListConfig={blackListConfig} + compFactory={TableComp} + /> + <Example + title="Fixed Column - Right side ( scroll to left to see the effect )" + width={400} + hideSettings={true} + config={{ + data: data, + columns : [ + { + "title": "ID", + "showTitle": true, + "isCustom": false, + "dataIndex": "id", + "width": "55", + "autoWidth": "fixed", + "render": { + "compType": "text", + "comp": { + "text": "{{currentCell}}" + } + }, + "align": "left", + "fixed": "right", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + }, + { + "title": "Name", + "showTitle": true, + "isCustom": false, + "dataIndex": "name", + "width": "200", + "autoWidth": "fixed", + "render": { + "compType": "text", + "comp": { + "text": "{{currentCell}}" + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + }, + { + "title": "Date", + "showTitle": true, + "isCustom": false, + "dataIndex": "date", + "width": "110", + "autoWidth": "fixed", + "render": { + "compType": "text", + "comp": { + "text": "{{currentCell}}" + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + }, + { + "title": "Department", + "showTitle": true, + "isCustom": false, + "dataIndex": "department", + "width": "250", + "autoWidth": "fixed", + "render": { + "compType": "tag", + "comp": { + "text": "{{currentCell}}", + "tagColors": { + "optionType": "manual", + "manual": { + "manual": [ + { + "label": "Tag1", + "icon": "/icon:solid/tag", + "color": "#f50" + }, + { + "label": "Tag2", + "icon": "/icon:solid/tag", + "color": "#2db7f5" + } + ] + }, + "mapData": { + "data": "[]", + "mapData": { + "color": "" + } + } + } + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + } + ], + }} + blackListConfig={blackListConfig} + compFactory={TableComp} + /> + <Example + title="Sortable Columns" + width={800} + hideSettings={true} + config={{ + data: data, + columns: [ + { + "title": "ID", + "showTitle": true, + "isCustom": false, + "dataIndex": "id", + "sortable": true, + "width": "55", + "autoWidth": "fixed", + "render": { + "compType": "text", + "comp": { + "text": "{{currentCell}}" + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + }, + { + "title": "Name", + "showTitle": true, + "isCustom": false, + "dataIndex": "name", + "sortable": true, + "width": "200", + "autoWidth": "fixed", + "render": { + "compType": "text", + "comp": { + "text": "{{currentCell}}" + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + }, + { + "title": "Date", + "showTitle": true, + "isCustom": false, + "dataIndex": "date", + "sortable": true, + "width": "110", + "autoWidth": "fixed", + "render": { + "compType": "text", + "comp": { + "text": "{{currentCell}}" + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + }, + { + "title": "Department", + "showTitle": true, + "isCustom": false, + "dataIndex": "department", + "sortable": true, + "width": "250", + "autoWidth": "fixed", + "render": { + "compType": "tag", + "comp": { + "text": "{{currentCell}}", + "tagColors": { + "optionType": "manual", + "manual": { + "manual": [ + { + "label": "Tag1", + "icon": "/icon:solid/tag", + "color": "#f50" + }, + { + "label": "Tag2", + "icon": "/icon:solid/tag", + "color": "#2db7f5" + } + ] + }, + "mapData": { + "data": "[]", + "mapData": { + "color": "" + } + } + } + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + } + ], + }} + blackListConfig={blackListConfig} + compFactory={TableComp} + /> + <Example + title="Individual Columns Styling" + width={800} + hideSettings={true} + config={{ + data: data, + rowStyle: { + "selectedRowBackground": "#E68E50", + "hoverRowBackground": "#36B389", + "alternateBackground": "#36B389", + }, + columns:[ + { + "title": "ID", + "showTitle": true, + "isCustom": false, + "dataIndex": "id", + "width": "55", + "autoWidth": "fixed", + "render": { + "compType": "text", + "comp": { + "text": "{{currentCell}}" + } + }, + "align": "left", + "fixed": "close", + "background": "#D7D9E0", + "margin": "", + "text": "#FFFFFF", + "border": "#222222", + "borderWidth": "", + "radius": "5px", + "textSize": "20px", + "textWeight": "bold", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + }, + { + "title": "Name", + "showTitle": true, + "isCustom": false, + "dataIndex": "name", + "width": "200", + "autoWidth": "fixed", + "render": { + "compType": "text", + "comp": { + "text": "{{currentCell}}" + } + }, + "align": "left", + "fixed": "close", + "background": "#5589F2", + "margin": "", + "text": "#FFFFFF", + "border": "#222222", + "borderWidth": "", + "radius": "5px", + "textSize": "20px", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + }, + { + "title": "Date", + "showTitle": true, + "isCustom": false, + "dataIndex": "date", + "width": "110", + "autoWidth": "fixed", + "render": { + "compType": "text", + "comp": { + "text": "{{currentCell}}" + } + }, + "align": "left", + "fixed": "close", + "background": "#E68E50", + "margin": "", + "text": "#FFFFFF", + "border": "#222222", + "borderWidth": "", + "radius": "5px", + "textSize": "20px", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + }, + { + "title": "Department", + "showTitle": true, + "isCustom": false, + "dataIndex": "department", + "width": "250", + "autoWidth": "fixed", + "render": { + "compType": "tag", + "comp": { + "text": "{{currentCell}}", + "tagColors": { + "optionType": "manual", + "manual": { + "manual": [ + { + "label": "Tag1", + "icon": "/icon:solid/tag", + "color": "#f50" + }, + { + "label": "Tag2", + "icon": "/icon:solid/tag", + "color": "#2db7f5" + } + ] + }, + "mapData": { + "data": "[]", + "mapData": { + "color": "" + } + } + } + } + }, + "align": "left", + "fixed": "close", + "background": "#36B389", + "margin": "", + "text": "#FFFFFF", + "border": "#222222", + "borderWidth": "", + "radius": "5px", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + } + ], + }} + blackListConfig={blackListConfig} + compFactory={TableComp} + /> + <Example + title="Prefix Icons on Columns" + width={800} + hideSettings={true} + config={{ + data: data, + columns: [ + { + "title": "ID", + "showTitle": true, + "isCustom": false, + "dataIndex": "id", + "width": "55", + "autoWidth": "fixed", + "render": { + "compType": "text", + "comp": { + "text": "{{currentCell}}", + "prefixIcon": "/icon:solid/angles-right" + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + }, + { + "title": "Name", + "showTitle": true, + "isCustom": false, + "dataIndex": "name", + "width": "200", + "autoWidth": "fixed", + "render": { + "compType": "text", + "comp": { + "text": "{{currentCell}}", + "prefixIcon": "/icon:solid/person" + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + }, + { + "title": "Date", + "showTitle": true, + "isCustom": false, + "dataIndex": "date", + "width": "110", + "autoWidth": "fixed", + "render": { + "compType": "text", + "comp": { + "text": "{{currentCell}}", + "prefixIcon": "/icon:solid/business-time" + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + }, + { + "title": "Department", + "showTitle": true, + "isCustom": false, + "dataIndex": "department", + "width": "250", + "autoWidth": "fixed", + "render": { + "compType": "tag", + "comp": { + "text": "{{currentCell}}", + "tagColors": { + "optionType": "manual", + "manual": { + "manual": [ + { + "label": "Tag1", + "icon": "/icon:solid/tag", + "color": "#f50" + }, + { + "label": "Tag2", + "icon": "/icon:solid/tag", + "color": "#2db7f5" + } + ] + }, + "mapData": { + "data": "[]", + "mapData": { + "color": "" + } + } + } + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + } + ], + }} + blackListConfig={blackListConfig} + compFactory={TableComp} + /> + <Example + title="Suffix Icons on Columns" + width={800} + hideSettings={true} + config={{ + data: data, + columns: [ + { + "title": "ID", + "showTitle": true, + "isCustom": false, + "dataIndex": "id", + "width": "55", + "autoWidth": "fixed", + "render": { + "compType": "text", + "comp": { + "text": "{{currentCell}}", + "suffixIcon": "/icon:solid/ellipsis-vertical" + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + }, + { + "title": "Name", + "showTitle": true, + "isCustom": false, + "dataIndex": "name", + "width": "200", + "autoWidth": "fixed", + "render": { + "compType": "text", + "comp": { + "text": "{{currentCell}}", + "suffixIcon": "/icon:solid/person-circle-check" + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + }, + { + "title": "Date", + "showTitle": true, + "isCustom": false, + "dataIndex": "date", + "width": "110", + "autoWidth": "fixed", + "render": { + "compType": "text", + "comp": { + "text": "{{currentCell}}", + "suffixIcon": "/icon:solid/calendar-days" + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + }, + { + "title": "Department", + "showTitle": true, + "isCustom": false, + "dataIndex": "department", + "width": "250", + "autoWidth": "fixed", + "render": { + "compType": "tag", + "comp": { + "text": "{{currentCell}}", + "tagColors": { + "optionType": "manual", + "manual": { + "manual": [ + { + "label": "Tag1", + "icon": "/icon:solid/tag", + "color": "#f50" + }, + { + "label": "Tag2", + "icon": "/icon:solid/tag", + "color": "#2db7f5" + } + ] + }, + "mapData": { + "data": "[]", + "mapData": { + "color": "" + } + } + } + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + } + ], + }} + blackListConfig={blackListConfig} + compFactory={TableComp} + /> + <Example + title="Column Tooltip" + width={800} + hideSettings={true} + config={{ + data: data, + columns: [ + { + "title": "ID", + "titleTooltip": "ID", + "showTitle": true, + "isCustom": false, + "dataIndex": "id", + "width": "55", + "autoWidth": "fixed", + "render": { + "compType": "text", + "comp": { + "text": "{{currentCell}}" + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + }, + { + "title": "Name", + "titleTooltip": "Name", + "showTitle": true, + "isCustom": false, + "dataIndex": "name", + "width": "200", + "autoWidth": "fixed", + "render": { + "compType": "text", + "comp": { + "text": "{{currentCell}}" + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + }, + { + "title": "Date", + "titleTooltip": "Date", + "showTitle": true, + "isCustom": false, + "dataIndex": "date", + "width": "110", + "autoWidth": "fixed", + "render": { + "compType": "text", + "comp": { + "text": "{{currentCell}}" + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + }, + { + "title": "Department", + "titleTooltip": "Department", + "showTitle": true, + "isCustom": false, + "dataIndex": "department", + "width": "250", + "autoWidth": "fixed", + "render": { + "compType": "tag", + "comp": { + "text": "{{currentCell}}", + "tagColors": { + "optionType": "manual", + "manual": { + "manual": [ + { + "label": "Tag1", + "icon": "/icon:solid/tag", + "color": "#f50" + }, + { + "label": "Tag2", + "icon": "/icon:solid/tag", + "color": "#2db7f5" + } + ] + }, + "mapData": { + "data": "[]", + "mapData": { + "color": "" + } + } + } + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + } + ], + }} + blackListConfig={blackListConfig} + compFactory={TableComp} + /> + <Example + title="Title Tooltip" + width={800} + hideSettings={true} + config={{ + data: data, + columns: [ + { + "title": "ID", + "titleTooltip": "ID", + "showTitle": true, + "cellTooltip": { + "tooltip": "{{currentCell}}" + }, + "isCustom": false, + "dataIndex": "id", + "width": "55", + "autoWidth": "fixed", + "render": { + "compType": "text", + "comp": { + "text": "{{currentCell}}" + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + }, + { + "title": "Name", + "titleTooltip": "Name", + "showTitle": true, + "cellTooltip": { + "tooltip": "{{currentCell}}" + }, + "isCustom": false, + "dataIndex": "name", + "width": "200", + "autoWidth": "fixed", + "render": { + "compType": "text", + "comp": { + "text": "{{currentCell}}" + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + }, + { + "title": "Date", + "titleTooltip": "Date", + "showTitle": true, + "cellTooltip": { + "tooltip": "{{currentCell}}" + }, + "isCustom": false, + "dataIndex": "date", + "width": "110", + "autoWidth": "fixed", + "render": { + "compType": "text", + "comp": { + "text": "{{currentCell}}" + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + }, + { + "title": "Department", + "titleTooltip": "Department", + "showTitle": true, + "cellTooltip": { + "tooltip": "{{currentCell}}" + }, + "isCustom": false, + "dataIndex": "department", + "width": "250", + "autoWidth": "fixed", + "render": { + "compType": "tag", + "comp": { + "text": "{{currentCell}}", + "tagColors": { + "optionType": "manual", + "manual": { + "manual": [ + { + "label": "Tag1", + "icon": "/icon:solid/tag", + "color": "#f50" + }, + { + "label": "Tag2", + "icon": "/icon:solid/tag", + "color": "#2db7f5" + } + ] + }, + "mapData": { + "data": "[]", + "mapData": { + "color": "" + } + } + } + } + }, + "align": "left", + "fixed": "close", + "background": "", + "margin": "", + "text": "", + "border": "", + "borderWidth": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "", + "summaryColumns": [ + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + }, + { + "isCustom": false, + "dataIndex": "", + "render": { + "compType": "text", + "comp": {} + }, + "align": "left", + "background": "", + "margin": "", + "text": "", + "border": "", + "radius": "", + "textSize": "", + "textWeight": "normal", + "fontFamily": "sans-serif", + "fontStyle": "normal", + "textOverflow": "ellipsis", + "linkColor": "#3377ff", + "linkHoverColor": "", + "linkActiveColor": "" + } + ] + } + ], + }} + blackListConfig={blackListConfig} + compFactory={TableComp} + /> + </ExampleGroup> </> ); } diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/text.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/text.tsx index 16f3ee3f4..fab465482 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/text.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/text.tsx @@ -33,6 +33,16 @@ export default function TextExample() { nameMap={nameMap} compFactory={TextComp} /> + <Example + title="Hiding the Text component" + config={{ + text: trans("componentDoc.markdownDemoText"), + type: "markdown", + hidden: true, + }} + nameMap={nameMap} + compFactory={TextComp} + /> </ExampleGroup> <ExampleGroup @@ -80,6 +90,133 @@ export default function TextExample() { compFactory={TextComp} /> </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the different Styling properties on the Progress Bar Component." + > + <Example + title="Margin & Padding" + width={500} + config={{ + text: trans("componentDoc.markdownDemoText"), + type: "markdown", + style:{ + "margin": "10px", + "padding": "10px", + "border": "#222222", + "borderStyle": "solid", + "borderWidth": "2px", + }, + }} + compFactory={TextComp} + /> + <Example + title="Text Properties" + width={500} + config={{ + text: trans("componentDoc.markdownDemoText"), + type: "markdown", + style:{ + "text": "#E67373", + "textSize": "20px", + "textWeight": "bold", + "fontStyle": "italic", + "fontFamily": "Courier New", + }, + }} + compFactory={TextComp} + /> + <Example + title="Border Properties" + width={500} + config={{ + text: trans("componentDoc.markdownDemoText"), + type: "markdown", + style:{ + "borderStyle": "solid", + "border": "#00FFFF", + "borderWidth": "3px", + "radius": "10px", + "padding": "10px", + }, + }} + compFactory={TextComp} + /> + <Example + title="Text Rotation - 90 deg" + width={500} + config={{ + text: trans("componentDoc.markdownDemoText"), + type: "markdown", + style:{ + "rotation": "90deg", + }, + }} + compFactory={TextComp} + /> + + <Example + title="Text Rotation - 180 deg" + width={500} + config={{ + text: trans("componentDoc.markdownDemoText"), + type: "markdown", + style:{ + "rotation": "180deg", + }, + }} + compFactory={TextComp} + /> + </ExampleGroup> + + <ExampleGroup + title="Animation Style" + description="The Following Examples Show different animations on the Progress Bar Component." + > + <Example + title="Bounce Animation" + config={{ + text: "### 👋 Hello! Welcome to Lowcoder", + showInfo: true, + animationStyle: { + "animation": "bounce", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={TextComp} + /> + <Example + title="Swing Animation" + config={{ + text: "### 👋 Hello! Welcome to Lowcoder", + showInfo: true, + animationStyle: { + "animation": "swing", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={TextComp} + /> + <Example + title="Tada Animation" + config={{ + text: "### 👋 Hello! Welcome to Lowcoder", + showInfo: true, + animationStyle: { + "animation": "tada", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={TextComp} + /> + </ExampleGroup> </> ); } diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/timeline.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/timeline.tsx index 34f87e1a9..a5c916911 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/timeline.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/presentationComp/timeline.tsx @@ -10,15 +10,31 @@ export default function TimeLineExample() { title={trans("componentDoc.basicUsage")} description="The Following Examples Show the Basic Usage of the TimeLine Component." > + <Example + title="Default Timeline Component" + width={500} + hideSettings={true} + config={{ + }} + compFactory={TimeLineComp} + /> <Example title="Hiding the TimeLine Component" + width={500} config={{ hidden: true, }} compFactory={TimeLineComp} /> + </ExampleGroup> + + <ExampleGroup + title="Layout Options" + description="The Following Examples Show the different Layout options of the TimeLine Component." + > <Example title="Display Order - Alternate Content Order" + width={500} config={{ mode: "alternate", }} @@ -26,6 +42,7 @@ export default function TimeLineExample() { /> <Example title="Display Order - Content Right" + width={500} config={{ mode: "left", }} @@ -33,6 +50,7 @@ export default function TimeLineExample() { /> <Example title="Display Order - Content Left" + width={500} config={{ mode: "right", }} @@ -40,6 +58,7 @@ export default function TimeLineExample() { /> <Example title="Pending Node Text - Empty [ When Set, Then a Last Node With the Text and a Waiting Indicator Will Be Displayed. ]" + width={500} config={{ pending: "", }} @@ -47,12 +66,73 @@ export default function TimeLineExample() { /> <Example title="Newest Event First" + width={500} config={{ reverse: true, }} compFactory={TimeLineComp} /> </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the different Styling properties of the TimeLine Component." + > + <Example + title="Background Color" + width={500} + config={{ + style:{ + "background": "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + }, + }} + compFactory={TimeLineComp} + /> + <Example + title="Title and Sub-Title Color" + width={500} + config={{ + style:{ + "titleColor": "#E68E50", + "subTitleColor": "#36B389", + }, + }} + compFactory={TimeLineComp} + /> + <Example + title="Label Color" + width={500} + config={{ + style:{ + "labelColor": "#FF01B8", + }, + }} + compFactory={TimeLineComp} + /> + <Example + title="Margin & Padding" + width={500} + config={{ + style:{ + "background": "linear-gradient(135deg, #00FFFF 0%, #00FFFF 100%)", + "margin": "10px", + "padding": "50px", + }, + }} + compFactory={TimeLineComp} + /> + <Example + title="Border Radius" + width={500} + config={{ + style:{ + "background": "linear-gradient(135deg, #00FFFF 0%, #00FFFF 100%)", + "radius": "15px" + }, + }} + compFactory={TimeLineComp} + /> + </ExampleGroup> </> ); } diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/selectInputComp/AutoComplete.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/selectInputComp/AutoComplete.tsx index 65e3a7f72..ff6c0a38d 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/selectInputComp/AutoComplete.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/selectInputComp/AutoComplete.tsx @@ -93,6 +93,147 @@ export default function AutoCompleteExample() { }} compFactory={AutoCompleteComp} /> + <Example + title="Tooltip" + config={{ + items: items, + label:{ + tooltip: "This is a Tooltip on Auto-Complete component", + } + }} + compFactory={AutoCompleteComp} + /> + </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the different Styling properties of the Auto-Complete Component." + > + <Example + title="Select component Styling properties" + config={{ + items: items, + style: { + "background": "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + "margin": "10px", + "padding": "10px", + "text": "#222222", + "textSize": "20px", + "textWeight": "bold", + "fontStyle": "italic", + "border": "#222222", + "borderStyle": "solid", + "radius": "10px", + "borderWidth": "2px", + }, + }} + compFactory={AutoCompleteComp} + /> + <Example + title="Label Styling properties" + config={{ + items: items, + labelStyle: { + "margin": "5px", + "padding": "5px", + "label": "#01865B", + "textTransform": "Uppercase", + "textDecoration": "underline", + "textSize": "18px", + "textWeight": "bold", + "fontStyle": "italic", + "border": "#222222", + "borderWidth": "2px", + "borderStyle": "solid", + }, + }} + compFactory={AutoCompleteComp} + /> + <Example + title="Input Field Styling properties" + config={{ + items: items, + inputFieldStyle: { + "background": "linear-gradient(45deg, #d53369 0%, #daae51 100%)", + "border": "#222222", + "radius": "10px", + "text": "#222222", + "margin": "5px", + "padding": "10px", + "borderStyle": "dashed", + "borderWidth": "3px", + "accent": "#36B389" + }, + }} + compFactory={AutoCompleteComp} + /> + <Example + title="Children Input Field Styling properties" + config={{ + items: items, + childrenInputFieldStyle: { + "margin": "5px", + "padding": "20px", + "text": "#3377FF", + "textDecoration": "underline", + "textSize": "15px", + "textWeight": "bold", + "fontFamily": "Courier New", + "fontStyle": "italic", + "border": "#36B389", + "borderStyle": "solid", + "radius": "10px", + "borderWidth": "3px", + "background": "#11F7E9" + }, + }} + compFactory={AutoCompleteComp} + /> + </ExampleGroup> + + <ExampleGroup + title="Animation Style" + description="The Following Examples Show different animations on the CheckBox Component." + > + <Example + title="Bounce Animation" + config={{ + items: items, + animationStyle: { + "animation": "bounce", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={AutoCompleteComp} + /> + <Example + title="Swing Animation" + config={{ + items: items, + animationStyle: { + "animation": "swing", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={AutoCompleteComp} + /> + <Example + title="Tada Animation" + config={{ + items: items, + animationStyle: { + "animation": "tada", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={AutoCompleteComp} + /> </ExampleGroup> </> ); diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/selectInputComp/Cascader.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/selectInputComp/Cascader.tsx index c64abd6fd..d7a8a9dc8 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/selectInputComp/Cascader.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/selectInputComp/Cascader.tsx @@ -3,10 +3,11 @@ import { trans, i18nObjs } from "i18n"; import Example from "../../common/Example"; import ExampleGroup from "../../common/ExampleGroup"; -const options = JSON.stringify(i18nObjs.cascaderDefult); +const options = '[\n {\n "value": "California",\n "label": "California",\n "children": [\n {\n "value": "San Francisco",\n "label": "San Francisco",\n "children": [\n {\n "value": "The Golden Gate Bridge",\n "label": "The Golden Gate Bridge"\n }\n ]\n }\n ]\n },\n {\n "value": "New South Wales",\n "label": "New South Wales",\n "children": [\n {\n "value": "Sydney",\n "label": "Sydney",\n "children": [\n {\n "value": "Sydney Opera House",\n "label": "Sydney Opera House"\n }\n ]\n }\n ]\n }\n]'; export default function CascaderExample() { const blackListConfig: string[] = ["options"]; + return ( <> <ExampleGroup @@ -66,7 +67,21 @@ export default function CascaderExample() { blackListConfig={blackListConfig} compFactory={CascaderWithDefault} /> + <Example + title="Hiding the Cascader component" + config={{ + value: trans("componentDoc.noValue"), + hidden: true, + options: options, + label: { + text: trans("componentDoc.pleaseSelectCity"), + }, + }} + blackListConfig={blackListConfig} + compFactory={CascaderWithDefault} + /> </ExampleGroup> + <ExampleGroup title={trans("componentDoc.labelText")} description=""> <Example title={trans("componentDoc.leftLeftAlign")} @@ -124,7 +139,21 @@ export default function CascaderExample() { blackListConfig={blackListConfig} compFactory={CascaderWithDefault} /> + <Example + title="Tooltip" + config={{ + value: `["zhejiang","hangzhou","xihu"]`, + options: options, + label: { + text: trans("componentDoc.pleaseSelectCity"), + tooltip: "This is a Tooltip on Cascader component" + }, + }} + blackListConfig={blackListConfig} + compFactory={CascaderWithDefault} + /> </ExampleGroup> + <ExampleGroup title={trans("componentDoc.advanced")}> <Example title={trans("componentDoc.allowClear")} @@ -139,6 +168,286 @@ export default function CascaderExample() { blackListConfig={blackListConfig} compFactory={CascaderWithDefault} /> + <Example + title="Searchable Options - True" + config={{ + value: `["zhejiang","hangzhou","xihu"]`, + options: options, + label: { + text: trans("componentDoc.pleaseSelectCity"), + }, + showSearch: true, + }} + blackListConfig={blackListConfig} + compFactory={CascaderWithDefault} + /> + <Example + title="Searchable Options - False" + config={{ + value: `["zhejiang","hangzhou","xihu"]`, + options: options, + label: { + text: trans("componentDoc.pleaseSelectCity"), + }, + showSearch: false, + }} + blackListConfig={blackListConfig} + compFactory={CascaderWithDefault} + /> + </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the different Styling properties on the Cascader Component." + > + <Example + title="Background Color, Border Radius,Style,Width,Color" + width={500} + config={{ + value: `["zhejiang","hangzhou","xihu"]`, + options: options, + label: { + text: trans("componentDoc.pleaseSelectCity"), + }, + style: { + "background": "#00FFFF", + "border": "#3377FF", + "radius": "10px", + "borderWidth": "3px", + "borderStyle": "solid", + }, + }} + compFactory={CascaderWithDefault} + /> + <Example + title="Margin & Padding" + width={500} + config={{ + value: `["zhejiang","hangzhou","xihu"]`, + options: options, + label: { + text: trans("componentDoc.pleaseSelectCity"), + }, + style: { + "background": "#00FFFF", + "border": "#3377FF", + "radius": "10px", + "borderWidth": "3px", + "margin": "10px", + "padding": "10px", + "borderStyle": "dashed", + }, + }} + compFactory={CascaderWithDefault} + /> + <Example + title="Opacity - 0.2" + width={500} + config={{ + value: `["zhejiang","hangzhou","xihu"]`, + options: options, + label: { + text: trans("componentDoc.pleaseSelectCity"), + }, + style: { + "opacity": "0.2", + }, + }} + compFactory={CascaderWithDefault} + /> + <Example + title="Opacity - 0.5" + width={500} + config={{ + value: `["zhejiang","hangzhou","xihu"]`, + options: options, + label: { + text: trans("componentDoc.pleaseSelectCity"), + }, + style: { + "opacity": "0.5", + }, + }} + compFactory={CascaderWithDefault} + /> + <Example + title="Opacity - 0.7" + width={500} + config={{ + value: `["zhejiang","hangzhou","xihu"]`, + options: options, + label: { + text: trans("componentDoc.pleaseSelectCity"), + }, + style: { + "opacity": "0.7", + }, + }} + compFactory={CascaderWithDefault} + /> + <Example + title="Opacity - 1" + width={500} + config={{ + value: `["zhejiang","hangzhou","xihu"]`, + options: options, + label: { + text: trans("componentDoc.pleaseSelectCity"), + }, + style: { + "opacity": "1", + }, + }} + compFactory={CascaderWithDefault} + /> + <Example + title="Rotation - 90deg" + width={500} + config={{ + value: `["zhejiang","hangzhou","xihu"]`, + options: options, + label: { + text: trans("componentDoc.pleaseSelectCity"), + }, + style: { + "rotation": "90deg", + }, + }} + compFactory={CascaderWithDefault} + /> + <Example + title="Label - Text Color, Size, Weight, Font family, Border properties" + width={500} + config={{ + value: `["zhejiang","hangzhou","xihu"]`, + options: options, + label: { + text: trans("componentDoc.pleaseSelectCity"), + }, + labelStyle: { + "margin": "5px", + "padding": "5px", + "label": "#3377FF", + "textTransform": "Uppercase", + "textDecoration": "underline", + "textSize": "13px", + "textWeight": "bold", + "fontFamily": "Courier New", + "fontStyle": "Italic", + "border": "#36B389", + "borderStyle": "solid", + "borderWidth": "2px" + }, + }} + compFactory={CascaderWithDefault} + /> + <Example + title="Input Field Style" + width={500} + config={{ + value: `["zhejiang","hangzhou","xihu"]`, + options: options, + label: { + text: trans("componentDoc.pleaseSelectCity"), + }, + style: { + "background": "#00FFFF", + "border": "#3377FF", + "radius": "10px", + "borderWidth": "3px", + "margin": "10px", + "padding": "10px", + "borderStyle": "solid", + }, + inputFieldStyle: { + "background": "#00BCA1", + "border": "#013AFF", + "radius": "10px", + "text": "#222222" + }, + }} + compFactory={CascaderWithDefault} + /> + <Example + title="Children Input Field Styling properties" + config={{ + value: `["zhejiang","hangzhou","xihu"]`, + options: options, + label: { + text: trans("componentDoc.pleaseSelectCity"), + }, + childrenInputFieldStyle: { + "margin": "5px", + "padding": "20px", + "text": "#3377FF", + "textDecoration": "underline", + "textSize": "15px", + "textWeight": "bold", + "fontFamily": "Courier New", + "fontStyle": "italic", + "border": "#36B389", + "borderStyle": "solid", + "radius": "10px", + "borderWidth": "3px", + "background": "#11F7E9" + }, + }} + compFactory={CascaderWithDefault} + /> + </ExampleGroup> + + <ExampleGroup + title="Animation Style" + description="The Following Examples Show different animations on the Cascader Component." + > + <Example + title="Bounce Animation" + config={{ + options: options, + label: { + text: trans("componentDoc.pleaseSelectCity"), + }, + animationStyle: { + "animation": "bounce", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={CascaderWithDefault} + /> + <Example + title="Swing Animation" + config={{ + options: options, + label: { + text: trans("componentDoc.pleaseSelectCity"), + }, + animationStyle: { + "animation": "swing", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={CascaderWithDefault} + /> + <Example + title="Tada Animation" + config={{ + options: options, + label: { + text: trans("componentDoc.pleaseSelectCity"), + }, + animationStyle: { + "animation": "tada", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={CascaderWithDefault} + /> </ExampleGroup> </> ); diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/selectInputComp/CheckBox.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/selectInputComp/CheckBox.tsx index a9f2d7bf7..d1c0ba828 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/selectInputComp/CheckBox.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/selectInputComp/CheckBox.tsx @@ -44,6 +44,7 @@ export default function CheckboxExample() { }; return ( <> + <ExampleGroup title={trans("componentDoc.basicUsage")} description={trans("componentDoc.basicDemoDescription")} @@ -94,8 +95,29 @@ export default function CheckboxExample() { blackListConfig={blackListConfig} compFactory={CheckboxComp} /> + <Example + title="Hiding the Checkbox component" + config={{ + value: JSON.stringify([ + trans("componentDoc.appleOptionLabel"), + trans("componentDoc.waterMelonOptionLabel"), + trans("componentDoc.lemonOptionLabel"), + ]), + hidden: true, + options: options, + label: { + text: trans("componentDoc.likedFruits"), + }, + }} + blackListConfig={blackListConfig} + compFactory={CheckboxComp} + /> </ExampleGroup> - <ExampleGroup title={trans("componentDoc.labelText")} description=""> + + <ExampleGroup + title={trans("componentDoc.labelText")} + description="The Following Examples Show the differnet alignment positions on the Checkbox Component." + > <Example title={trans("componentDoc.leftLeftAlign")} config={{ @@ -167,7 +189,84 @@ export default function CheckboxExample() { blackListConfig={blackListConfig} compFactory={CheckboxComp} /> + <Example + title="Display Tooltip on Hover" + config={{ + value: JSON.stringify([ + trans("componentDoc.appleOptionLabel"), + trans("componentDoc.waterMelonOptionLabel"), + ]), + options: options, + label: { + text: trans("componentDoc.likedFruits"), + tooltip: "Checkmark your favorite Fruits", + }, + }} + blackListConfig={blackListConfig} + compFactory={CheckboxComp} + /> + </ExampleGroup> + + <ExampleGroup + title="Layout Options" + description="The Following Examples Show the different Layout options on the Checkbox Component." + > + <Example + title="Horizontal Layout" + width={600} + config={{ + value: JSON.stringify([ + trans("componentDoc.appleOptionLabel"), + trans("componentDoc.waterMelonOptionLabel"), + trans("componentDoc.lemonOptionLabel"), + ]), + options: options, + label: { + text: trans("componentDoc.likedFruits"), + }, + layout: "horizontal", + }} + blackListConfig={blackListConfig} + compFactory={CheckboxComp} + /> + <Example + title="Vertical Layout" + width={600} + config={{ + value: JSON.stringify([ + trans("componentDoc.appleOptionLabel"), + trans("componentDoc.waterMelonOptionLabel"), + trans("componentDoc.lemonOptionLabel"), + ]), + options: options, + label: { + text: trans("componentDoc.likedFruits"), + }, + layout: "vertical", + }} + blackListConfig={blackListConfig} + compFactory={CheckboxComp} + /> + <Example + title="Auto Column Layout" + width={600} + config={{ + value: JSON.stringify([ + trans("componentDoc.appleOptionLabel"), + trans("componentDoc.waterMelonOptionLabel"), + trans("componentDoc.lemonOptionLabel"), + ]), + options: options, + label: { + text: trans("componentDoc.likedFruits"), + }, + layout: "auto_columns", + }} + blackListConfig={blackListConfig} + compFactory={CheckboxComp} + /> </ExampleGroup> + <ExampleGroup title={trans("componentDoc.validation")}> <Example title={trans("componentDoc.required")} @@ -183,6 +282,136 @@ export default function CheckboxExample() { compFactory={CheckboxComp} /> </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the different Styling properties of the Checkbox Component." + > + <Example + title="Select component Styling properties" + config={{ + options: options, + label: { + text: trans("componentDoc.favoriteFruits"), + }, + style: { + "background": "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + "margin": "10px", + "padding": "10px", + "text": "#222222", + "textSize": "20px", + "textWeight": "bold", + "fontStyle": "italic", + "border": "#222222", + "borderStyle": "solid", + "radius": "10px", + "borderWidth": "2px", + }, + }} + compFactory={CheckboxComp} + /> + <Example + title="Label Styling properties" + config={{ + options: options, + label: { + text: trans("componentDoc.favoriteFruits"), + }, + labelStyle: { + "margin": "5px", + "padding": "5px", + "label": "#01865B", + "textTransform": "Uppercase", + "textDecoration": "underline", + "textSize": "18px", + "textWeight": "bold", + "fontStyle": "italic", + "border": "#222222", + "borderWidth": "2px", + "borderStyle": "solid", + }, + }} + compFactory={CheckboxComp} + /> + <Example + title="Input Field Styling properties" + config={{ + options: options, + label: { + text: trans("componentDoc.favoriteFruits"), + }, + inputFieldStyle: { + "background": "linear-gradient(45deg, #d53369 0%, #daae51 100%)", + "border": "#222222", + "radius": "10px", + "text": "#222222", + "checkedBackground": "#36B389", + "uncheckedBackground": "#F99F01", + "uncheckedBorder": "#FCA101", + "hoverBackground": "#C3C6D1", + "textSize": "15px", + "textWeight": "bold", + "fontFamily": "Courier New", + "fontStyle": "italic", + }, + }} + compFactory={CheckboxComp} + /> + </ExampleGroup> + + <ExampleGroup + title="Animation Style" + description="The Following Examples Show different animations on the CheckBox Component." + > + <Example + title="Bounce Animation" + config={{ + options: options, + label: { + text: trans("componentDoc.favoriteFruits"), + }, + animationStyle: { + "animation": "bounce", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={CheckboxComp} + /> + <Example + title="Swing Animation" + config={{ + options: options, + label: { + text: trans("componentDoc.favoriteFruits"), + }, + animationStyle: { + "animation": "swing", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={CheckboxComp} + /> + <Example + title="Tada Animation" + config={{ + options: options, + label: { + text: trans("componentDoc.favoriteFruits"), + }, + animationStyle: { + "animation": "tada", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={CheckboxComp} + /> + </ExampleGroup> </> ); } diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/selectInputComp/File.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/selectInputComp/File.tsx index b383bffea..be97c5bdb 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/selectInputComp/File.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/selectInputComp/File.tsx @@ -8,30 +8,35 @@ export default function FileExample() { <> <ExampleGroup title={trans("componentDoc.basicUsage")} - description={trans("componentDoc.basicDemoDescription")} + description="The Following Examples Show the Basic Usage of the File Component." > <Example - title={trans("componentDoc.default")} + title="Default File Upload component" config={{ - disabled: false, }} compFactory={FileComp} /> <Example - title={trans("componentDoc.disabled")} + title="Disabling the File Upload component" config={{ disabled: true, }} compFactory={FileComp} /> + <Example + title="Hiding the File Upload component" + config={{ + hidden: true, + }} + compFactory={FileComp} + /> </ExampleGroup> + <ExampleGroup title={trans("componentDoc.option")}> <Example title={trans("componentDoc.singleFileUpload")} config={{ - disabled: false, filetype: '[".png", ".pdf", ".word"]', - showUploadList: false, uploadType: "single", }} compFactory={FileComp} @@ -39,7 +44,6 @@ export default function FileExample() { <Example title={trans("componentDoc.multiFileUpload")} config={{ - disabled: false, filetype: '[".png", ".pdf", ".word"]', uploadType: "multiple", }} @@ -48,16 +52,16 @@ export default function FileExample() { <Example title={trans("componentDoc.folderUpload")} config={{ - disabled: false, filetype: '[".png", ".pdf", ".word"]', uploadType: "directory", }} compFactory={FileComp} /> </ExampleGroup> + <ExampleGroup title={trans("componentDoc.validation")} description=""> <Example - title={trans("componentDoc.singleFile")} + title="File Size" width={340} config={{ minSize: "100KB", @@ -66,7 +70,7 @@ export default function FileExample() { compFactory={FileComp} /> <Example - title={trans("componentDoc.multiple")} + title="Maximum File number - 5" width={340} config={{ maxFiles: "5", @@ -76,7 +80,7 @@ export default function FileExample() { compFactory={FileComp} /> <Example - title={trans("componentDoc.directory")} + title="Maximum File number - 10" width={340} config={{ maxFiles: "10", @@ -86,6 +90,55 @@ export default function FileExample() { compFactory={FileComp} /> </ExampleGroup> + + <ExampleGroup + title="Advanced Options" + description="The Following Examples Show the Advance Usage of the File Component." + > + <Example + title="File Upload Type - .png" + config={{ + fileType: "[\".png\"]", + }} + compFactory={FileComp} + /> + <Example + title="Multiple File Upload Type - .png" + config={{ + fileType: "[\".png\",\".pdf\",\".word\"]", + }} + compFactory={FileComp} + /> + <Example + title="Prefix and Postfix Icons" + config={{ + prefixIcon: "/icon:solid/angles-up", + suffixIcon: "/icon:solid/angles-down", + }} + compFactory={FileComp} + /> + <Example + title="Force Capture - Take a picture and Upload" + config={{ + forceCapture: true, + text: "Capture & Upload", + }} + compFactory={FileComp} + /> + <Example + title="Hide Upload List - Uploaded File won't be shown" + config={{ + showUploadList: false, + }} + compFactory={FileComp} + /> + <Example + title="Show Upload List - Uploaded File will be shown" + config={{ + }} + compFactory={FileComp} + /> + </ExampleGroup> </> ); } diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/selectInputComp/MultiSelect.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/selectInputComp/MultiSelect.tsx index 293317832..1070870b1 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/selectInputComp/MultiSelect.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/selectInputComp/MultiSelect.tsx @@ -44,6 +44,7 @@ export default function MultiSelectExample() { }; return ( <> + <ExampleGroup title={trans("componentDoc.basicUsage")} description={trans("componentDoc.basicDemoDescription")} @@ -108,6 +109,7 @@ export default function MultiSelectExample() { compFactory={MultiSelectComp} /> </ExampleGroup> + <ExampleGroup title={trans("componentDoc.labelText")} description=""> <Example title={trans("componentDoc.leftLeftAlign")} @@ -177,7 +179,24 @@ export default function MultiSelectExample() { blackListConfig={blackListConfig} compFactory={MultiSelectComp} /> + <Example + title="Display Tooltip on Hover" + config={{ + value: JSON.stringify([ + trans("componentDoc.coconutOptionLabel"), + trans("componentDoc.lemonOptionLabel"), + ]), + options: options, + label: { + text: trans("componentDoc.favoriteFruits"), + tooltip: "Select your favorite Fruits", + }, + }} + blackListConfig={blackListConfig} + compFactory={MultiSelectComp} + /> </ExampleGroup> + <ExampleGroup title={trans("componentDoc.advanced")}> <Example title={trans("componentDoc.allowClear")} @@ -193,7 +212,7 @@ export default function MultiSelectExample() { compFactory={MultiSelectComp} /> <Example - title="Not Search-able" + title="Options : Non Searchable" config={{ value: trans("componentDoc.noValue"), options: options, @@ -206,7 +225,22 @@ export default function MultiSelectExample() { blackListConfig={blackListConfig} compFactory={MultiSelectComp} /> + <Example + title="Options : Searchable" + config={{ + value: trans("componentDoc.noValue"), + options: options, + label: { + text: trans("componentDoc.favoriteFruits"), + }, + allowClear: true, + showSearch: true, + }} + blackListConfig={blackListConfig} + compFactory={MultiSelectComp} + /> </ExampleGroup> + <ExampleGroup title={trans("componentDoc.validation")}> <Example title={trans("componentDoc.required")} @@ -222,6 +256,104 @@ export default function MultiSelectExample() { compFactory={MultiSelectComp} /> </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the different Styling properties of the Multi-Select Component." + > + <Example + title="Multi-Select component Styling properties" + config={{ + options: options, + label: { + text: trans("componentDoc.favoriteFruits"), + }, + style: { + "background": "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + "margin": "10px", + "padding": "10px", + "text": "#222222", + "textSize": "20px", + "textWeight": "bold", + "fontStyle": "italic", + "border": "#222222", + "borderStyle": "solid", + "radius": "10px", + "borderWidth": "2px", + }, + }} + compFactory={MultiSelectComp} + /> + <Example + title="Label Styling properties" + config={{ + options: options, + label: { + text: trans("componentDoc.favoriteFruits"), + }, + labelStyle: { + "margin": "5px", + "padding": "5px", + "label": "#01865B", + "textTransform": "Uppercase", + "textDecoration": "underline", + "textSize": "18px", + "textWeight": "bold", + "fontStyle": "italic", + "border": "#222222", + "borderWidth": "2px", + "borderStyle": "solid", + }, + }} + compFactory={MultiSelectComp} + /> + <Example + title="Input Field Styling properties" + config={{ + options: options, + label: { + text: trans("componentDoc.favoriteFruits"), + }, + inputFieldStyle: { + "background": "linear-gradient(45deg, #d53369 0%, #daae51 100%)", + "border": "#222222", + "radius": "10px", + "text": "#222222", + "margin": "5px", + "padding": "10px", + "borderStyle": "dashed", + "borderWidth": "3px", + "accent": "#36B389" + }, + }} + compFactory={MultiSelectComp} + /> + <Example + title="Children Input Field Styling properties" + config={{ + options: options, + label: { + text: trans("componentDoc.favoriteFruits"), + }, + childrenInputFieldStyle: { + "margin": "5px", + "padding": "20px", + "text": "#3377FF", + "textDecoration": "underline", + "textSize": "15px", + "textWeight": "bold", + "fontFamily": "Courier New", + "fontStyle": "italic", + "border": "#36B389", + "borderStyle": "solid", + "radius": "10px", + "borderWidth": "3px", + "background": "#11F7E9" + }, + }} + compFactory={MultiSelectComp} + /> + </ExampleGroup> </> ); } diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/selectInputComp/Radio.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/selectInputComp/Radio.tsx index bb6233d34..9cb93046f 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/selectInputComp/Radio.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/selectInputComp/Radio.tsx @@ -88,7 +88,21 @@ export default function RadioExample() { blackListConfig={blackListConfig} compFactory={RadioComp} /> + <Example + title="Hiding the Radio button component" + config={{ + value: trans("componentDoc.appleOptionLabel"), + hidden: true, + options: options, + label: { + text: trans("componentDoc.likedFruits"), + }, + }} + blackListConfig={blackListConfig} + compFactory={RadioComp} + /> </ExampleGroup> + <ExampleGroup title={trans("componentDoc.labelText")} description=""> <Example title={trans("componentDoc.leftLeftAlign")} @@ -146,7 +160,21 @@ export default function RadioExample() { blackListConfig={blackListConfig} compFactory={RadioComp} /> + <Example + title="Showing Tooltip on Hover" + config={{ + value: trans("componentDoc.appleOptionLabel"), + options: options, + label: { + text: trans("componentDoc.likedFruits"), + tooltip: "This is a Tooltip on Radio button component", + }, + }} + blackListConfig={blackListConfig} + compFactory={RadioComp} + /> </ExampleGroup> + <ExampleGroup title={trans("componentDoc.validation")}> <Example title={trans("componentDoc.required")} @@ -161,6 +189,181 @@ export default function RadioExample() { compFactory={RadioComp} /> </ExampleGroup> + + <ExampleGroup + title="Layout Options" + description="The Following Examples Show the different Layout options on the Checkbox Component." + > + <Example + title="Horizontal Layout" + width={600} + config={{ + options: options, + label: { + text: trans("componentDoc.likedFruits"), + }, + layout: "horizontal", + }} + blackListConfig={blackListConfig} + compFactory={RadioComp} + /> + <Example + title="Vertical Layout" + width={600} + config={{ + options: options, + label: { + text: trans("componentDoc.likedFruits"), + }, + layout: "vertical", + }} + blackListConfig={blackListConfig} + compFactory={RadioComp} + /> + <Example + title="Auto Column Layout" + width={600} + config={{ + options: options, + label: { + text: trans("componentDoc.likedFruits"), + }, + layout: "auto_columns", + }} + blackListConfig={blackListConfig} + compFactory={RadioComp} + /> + </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the different Styling properties of the Radio button Component." + > + <Example + title="Radio component Styling properties" + config={{ + options: options, + label: { + text: trans("componentDoc.favoriteFruits"), + }, + style: { + "background": "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + "margin": "10px", + "padding": "10px", + "text": "#222222", + "textSize": "20px", + "textWeight": "bold", + "fontStyle": "italic", + "border": "#222222", + "borderStyle": "solid", + "radius": "10px", + "borderWidth": "2px", + }, + }} + compFactory={RadioComp} + /> + <Example + title="Label Styling properties" + config={{ + options: options, + label: { + text: trans("componentDoc.favoriteFruits"), + }, + labelStyle: { + "margin": "5px", + "padding": "5px", + "label": "#01865B", + "textTransform": "Uppercase", + "textDecoration": "underline", + "textSize": "18px", + "textWeight": "bold", + "fontStyle": "italic", + "border": "#222222", + "borderWidth": "2px", + "borderStyle": "solid", + }, + }} + compFactory={RadioComp} + /> + <Example + title="Input Field Styling properties" + config={{ + options: options, + label: { + text: trans("componentDoc.favoriteFruits"), + }, + inputFieldStyle: { + "background": "linear-gradient(45deg, #d53369 0%, #daae51 100%)", + "border": "#222222", + "radius": "10px", + "text": "#222222", + "checkedBackground": "#36B389", + "uncheckedBackground": "#F99F01", + "uncheckedBorder": "#FCA101", + "hoverBackground": "#C3C6D1", + "textSize": "15px", + "textWeight": "bold", + "fontFamily": "Courier New", + "fontStyle": "italic", + }, + }} + compFactory={RadioComp} + /> + </ExampleGroup> + + <ExampleGroup + title="Animation Style" + description="The Following Examples Show different animations on the Radio button Component." + > + <Example + title="Bounce Animation" + config={{ + options: options, + label: { + text: trans("componentDoc.favoriteFruits"), + }, + animationStyle: { + "animation": "bounce", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={RadioComp} + /> + <Example + title="Swing Animation" + config={{ + options: options, + label: { + text: trans("componentDoc.favoriteFruits"), + }, + animationStyle: { + "animation": "swing", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={RadioComp} + /> + <Example + title="Tada Animation" + config={{ + options: options, + label: { + text: trans("componentDoc.favoriteFruits"), + }, + animationStyle: { + "animation": "tada", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={RadioComp} + /> + </ExampleGroup> </> ); } diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/selectInputComp/Select.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/selectInputComp/Select.tsx index a08b855cd..192ccb811 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/selectInputComp/Select.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/selectInputComp/Select.tsx @@ -44,6 +44,7 @@ export default function SelectExample() { }; return ( <> + <ExampleGroup title={trans("componentDoc.basicUsage")} description={trans("componentDoc.basicDemoDescription")} @@ -102,6 +103,7 @@ export default function SelectExample() { compFactory={SelectComp} /> </ExampleGroup> + <ExampleGroup title={trans("componentDoc.labelText")} description=""> <Example title={trans("componentDoc.leftLeftAlign")} @@ -159,7 +161,20 @@ export default function SelectExample() { blackListConfig={blackListConfig} compFactory={SelectComp} /> + <Example + title="Tooltip display on Hover" + config={{ + options: options, + label: { + text: trans("componentDoc.favoriteFruits"), + tooltip: "Select your Favorite Fruit", + }, + }} + blackListConfig={blackListConfig} + compFactory={SelectComp} + /> </ExampleGroup> + <ExampleGroup title={trans("componentDoc.advanced")}> <Example title={trans("componentDoc.allowClear")} @@ -175,7 +190,7 @@ export default function SelectExample() { compFactory={SelectComp} /> <Example - title="Not Search-able" + title="Options : Non Searchable" config={{ value: trans("componentDoc.noValue"), options: options, @@ -188,7 +203,22 @@ export default function SelectExample() { blackListConfig={blackListConfig} compFactory={SelectComp} /> + <Example + title="Options : Searchable" + config={{ + value: trans("componentDoc.noValue"), + options: options, + label: { + text: trans("componentDoc.favoriteFruits"), + }, + allowClear: true, + showSearch: true, + }} + blackListConfig={blackListConfig} + compFactory={SelectComp} + /> </ExampleGroup> + <ExampleGroup title={trans("componentDoc.validation")}> <Example title={trans("componentDoc.required")} @@ -198,11 +228,110 @@ export default function SelectExample() { text: trans("componentDoc.favoriteFruits"), }, required: true, + showValidationWhenEmpty: true, }} blackListConfig={blackListConfig} compFactory={SelectComp} /> </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the different Styling properties of the Select Component." + > + <Example + title="Select component Styling properties" + config={{ + options: options, + label: { + text: trans("componentDoc.favoriteFruits"), + }, + style: { + "background": "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + "margin": "10px", + "padding": "10px", + "text": "#222222", + "textSize": "20px", + "textWeight": "bold", + "fontStyle": "italic", + "border": "#222222", + "borderStyle": "solid", + "radius": "10px", + "borderWidth": "2px", + }, + }} + compFactory={SelectComp} + /> + <Example + title="Label Styling properties" + config={{ + options: options, + label: { + text: trans("componentDoc.favoriteFruits"), + }, + labelStyle: { + "margin": "5px", + "padding": "5px", + "label": "#01865B", + "textTransform": "Uppercase", + "textDecoration": "underline", + "textSize": "18px", + "textWeight": "bold", + "fontStyle": "italic", + "border": "#222222", + "borderWidth": "2px", + "borderStyle": "solid", + }, + }} + compFactory={SelectComp} + /> + <Example + title="Input Field Styling properties" + config={{ + options: options, + label: { + text: trans("componentDoc.favoriteFruits"), + }, + inputFieldStyle: { + "background": "linear-gradient(45deg, #d53369 0%, #daae51 100%)", + "border": "#222222", + "radius": "10px", + "text": "#222222", + "margin": "5px", + "padding": "10px", + "borderStyle": "dashed", + "borderWidth": "3px", + "accent": "#36B389" + }, + }} + compFactory={SelectComp} + /> + <Example + title="Children Input Field Styling properties" + config={{ + options: options, + label: { + text: trans("componentDoc.favoriteFruits"), + }, + childrenInputFieldStyle: { + "margin": "5px", + "padding": "20px", + "text": "#3377FF", + "textDecoration": "underline", + "textSize": "15px", + "textWeight": "bold", + "fontFamily": "Courier New", + "fontStyle": "italic", + "border": "#36B389", + "borderStyle": "solid", + "radius": "10px", + "borderWidth": "3px", + "background": "#11F7E9" + }, + }} + compFactory={SelectComp} + /> + </ExampleGroup> </> ); } diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/selectInputComp/Tree.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/selectInputComp/Tree.tsx index 556cb637d..376cc16e5 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/selectInputComp/Tree.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/selectInputComp/Tree.tsx @@ -2,6 +2,7 @@ import { TreeComp } from "comps/comps/treeComp/treeComp"; import { trans } from "i18n"; import Example from "../../common/Example"; import ExampleGroup from "../../common/ExampleGroup"; +import { InputFieldStyle } from "@lowcoder-ee/index.sdk"; export default function TreeExample() { const blackListConfig: string[] = ["options.manual.manual"]; @@ -263,6 +264,180 @@ export default function TreeExample() { compFactory={TreeComp} /> </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the different Styling properties on Tree Component." + > + <Example + title="Background Color, Border Radius,Style,Width,Color" + width={500} + config={{ + defaultExpandAll: true, + label: { + text: "Select Your Place", + position: "row", + }, + style: { + "background": "#00FFFF", + "border": "#3377FF", + "radius": "10px", + "borderWidth": "3px", + "borderStyle": "solid", + }, + }} + compFactory={TreeComp} + /> + <Example + title="Margin & Padding" + width={500} + config={{ + defaultExpandAll: true, + label: { + text: "Select Your Place", + position: "row", + }, + style: { + "background": "#00FFFF", + "border": "#3377FF", + "radius": "10px", + "borderWidth": "3px", + "margin": "10px", + "padding": "10px", + "borderStyle": "dashed", + }, + }} + compFactory={TreeComp} + /> + <Example + title="Opacity - 0.2" + width={500} + config={{ + defaultExpandAll: true, + label: { + text: "Select Your Place", + position: "row", + }, + style: { + "opacity": "0.2", + }, + }} + compFactory={TreeComp} + /> + <Example + title="Opacity - 0.5" + width={500} + config={{ + defaultExpandAll: true, + label: { + text: "Select Your Place", + position: "row", + }, + style: { + "opacity": "0.5", + }, + }} + compFactory={TreeComp} + /> + <Example + title="Opacity - 0.7" + width={500} + config={{ + defaultExpandAll: true, + label: { + text: "Select Your Place", + position: "row", + }, + style: { + "opacity": "0.7", + }, + }} + compFactory={TreeComp} + /> + <Example + title="Opacity - 1" + width={500} + config={{ + defaultExpandAll: true, + label: { + text: "Select Your Place", + position: "row", + }, + style: { + "opacity": "1", + }, + }} + compFactory={TreeComp} + /> + <Example + title="Rotation - 90deg" + width={500} + config={{ + defaultExpandAll: true, + label: { + text: "Select Your Place", + position: "row", + }, + style: { + "rotation": "90deg", + }, + }} + compFactory={TreeComp} + /> + <Example + title="Label - Text Color, Size, Weight, Font family, Border properties" + width={500} + config={{ + defaultExpandAll: true, + label: { + text: "Select Your Place", + position: "row", + }, + labelStyle: { + "margin": "5px", + "padding": "5px", + "label": "#3377FF", + "textTransform": "Uppercase", + "textDecoration": "underline", + "textSize": "13px", + "textWeight": "bold", + "fontFamily": "Courier New", + "fontStyle": "Italic", + "border": "#36B389", + "borderStyle": "solid", + "borderWidth": "2px" + }, + }} + compFactory={TreeComp} + /> + <Example + title="Input Field Style" + width={500} + config={{ + defaultExpandAll: true, + label: { + text: "Select Your Place", + position: "row", + }, + style: { + "background": "#00FFFF", + "border": "#3377FF", + "radius": "10px", + "borderWidth": "3px", + "margin": "10px", + "padding": "10px", + "borderStyle": "solid", + }, + inputFieldStyle: { + "background": "#00BCA1", + "border": "#013AFF", + "radius": "10px", + "text": "#222222" + }, + }} + compFactory={TreeComp} + /> + </ExampleGroup> </> ); diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/selectInputComp/TreeSelect.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/selectInputComp/TreeSelect.tsx index 0458b9cce..afd7a541f 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/selectInputComp/TreeSelect.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/selectInputComp/TreeSelect.tsx @@ -294,6 +294,180 @@ export default function TreeSelectExample() { compFactory={TreeSelectComp} /> </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the different Styling properties on Tree Select Component." + > + <Example + title="Background Color, Border Radius,Style,Width,Color" + width={500} + config={{ + defaultExpandAll: true, + label: { + text: "Select Your Place", + position: "row", + }, + style: { + "background": "#00FFFF", + "border": "#3377FF", + "radius": "10px", + "borderWidth": "3px", + "borderStyle": "solid", + }, + }} + compFactory={TreeSelectComp} + /> + <Example + title="Margin & Padding" + width={500} + config={{ + defaultExpandAll: true, + label: { + text: "Select Your Place", + position: "row", + }, + style: { + "background": "#00FFFF", + "border": "#3377FF", + "radius": "10px", + "borderWidth": "3px", + "margin": "10px", + "padding": "10px", + "borderStyle": "dashed", + }, + }} + compFactory={TreeSelectComp} + /> + <Example + title="Opacity - 0.2" + width={500} + config={{ + defaultExpandAll: true, + label: { + text: "Select Your Place", + position: "row", + }, + style: { + "opacity": "0.2", + }, + }} + compFactory={TreeSelectComp} + /> + <Example + title="Opacity - 0.5" + width={500} + config={{ + defaultExpandAll: true, + label: { + text: "Select Your Place", + position: "row", + }, + style: { + "opacity": "0.5", + }, + }} + compFactory={TreeSelectComp} + /> + <Example + title="Opacity - 0.7" + width={500} + config={{ + defaultExpandAll: true, + label: { + text: "Select Your Place", + position: "row", + }, + style: { + "opacity": "0.7", + }, + }} + compFactory={TreeSelectComp} + /> + <Example + title="Opacity - 1" + width={500} + config={{ + defaultExpandAll: true, + label: { + text: "Select Your Place", + position: "row", + }, + style: { + "opacity": "1", + }, + }} + compFactory={TreeSelectComp} + /> + <Example + title="Rotation - 90deg" + width={500} + config={{ + defaultExpandAll: true, + label: { + text: "Select Your Place", + position: "row", + }, + style: { + "rotation": "90deg", + }, + }} + compFactory={TreeSelectComp} + /> + <Example + title="Label - Text Color, Size, Weight, Font family, Border properties" + width={500} + config={{ + defaultExpandAll: true, + label: { + text: "Select Your Place", + position: "row", + }, + labelStyle: { + "margin": "5px", + "padding": "5px", + "label": "#3377FF", + "textTransform": "Uppercase", + "textDecoration": "underline", + "textSize": "13px", + "textWeight": "bold", + "fontFamily": "Courier New", + "fontStyle": "Italic", + "border": "#36B389", + "borderStyle": "solid", + "borderWidth": "2px" + }, + }} + compFactory={TreeSelectComp} + /> + <Example + title="Input Field Style" + width={500} + config={{ + defaultExpandAll: true, + label: { + text: "Select Your Place", + position: "row", + }, + style: { + "background": "#00FFFF", + "border": "#3377FF", + "radius": "10px", + "borderWidth": "3px", + "margin": "10px", + "padding": "10px", + "borderStyle": "solid", + }, + inputFieldStyle: { + "background": "#00BCA1", + "border": "#013AFF", + "radius": "10px", + "text": "#222222" + }, + }} + compFactory={TreeSelectComp} + /> + </ExampleGroup> </> ); } diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/textInputComp/Input.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/textInputComp/Input.tsx index 1426ac789..ced66f5a3 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/textInputComp/Input.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/textInputComp/Input.tsx @@ -14,7 +14,6 @@ export default function InputExample() { title={trans("componentDoc.placeholder")} config={{ placeholder: trans("componentDoc.pleaseInputName"), - disabled: false, }} compFactory={InputComp} /> @@ -22,7 +21,6 @@ export default function InputExample() { title="Default Value" config={{ placeholder: trans("componentDoc.pleaseInputName"), - disabled: false, defaultValue: "Default Text", }} compFactory={InputComp} @@ -35,11 +33,19 @@ export default function InputExample() { }} compFactory={InputComp} /> + <Example + title="Hiding the Input component" + config={{ + placeholder: trans("componentDoc.pleaseInputName"), + hidden: true, + }} + compFactory={InputComp} + /> </ExampleGroup> <ExampleGroup title={trans("componentDoc.labelText")} description=""> <Example - title={trans("componentDoc.left")} + title="Left- Left Alignment" config={{ label: { text: trans("componentDoc.userName"), position: "row" }, placeholder: trans("componentDoc.pleaseInputName"), @@ -47,7 +53,15 @@ export default function InputExample() { compFactory={InputComp} /> <Example - title={trans("componentDoc.column")} + title="Left- Right Alignment" + config={{ + label: { text: trans("componentDoc.userName"), align: "right" }, + placeholder: trans("componentDoc.pleaseInputName"), + }} + compFactory={InputComp} + /> + <Example + title="Top - Left Alignment" config={{ label: { text: trans("componentDoc.userName"), position: "column" }, placeholder: trans("componentDoc.pleaseInputName"), @@ -55,9 +69,9 @@ export default function InputExample() { compFactory={InputComp} /> <Example - title={trans("componentDoc.textAlign")} + title="Top - Right Alignment" config={{ - label: { text: trans("componentDoc.userName"), align: "right" }, + label: { text: trans("componentDoc.userName"), position: "column", align: "right" }, placeholder: trans("componentDoc.pleaseInputName"), }} compFactory={InputComp} @@ -77,6 +91,20 @@ export default function InputExample() { }} compFactory={InputComp} /> + <Example + title="Show Prefix Icon" + config={{ + prefixIcon: "/icon:solid/align-center", + }} + compFactory={InputComp} + /> + <Example + title="Show suffix Icon" + config={{ + suffixIcon: "/icon:solid/arrow-down-long", + }} + compFactory={InputComp} + /> </ExampleGroup> <ExampleGroup title={trans("componentDoc.validation")} description=""> @@ -113,6 +141,28 @@ export default function InputExample() { }} compFactory={InputComp} /> + <Example + title="Check for Maximum Length ( 5 characters )" + width={340} + config={{ + label: { text: trans("componentDoc.userName") }, + required: true, + showValidationWhenEmpty: true, + minLength: 3, + }} + compFactory={InputComp} + /> + <Example + title="Check for Maximum Length ( 5 characters )" + width={340} + config={{ + label: { text: trans("componentDoc.userName") }, + required: true, + showValidationWhenEmpty: true, + maxLength: 5, + }} + compFactory={InputComp} + /> <Example title="Custom Rule" width={340} @@ -162,6 +212,114 @@ export default function InputExample() { compFactory={InputComp} /> </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the different Styling properties of the Checkbox Component." + > + <Example + title="Select component Styling properties" + config={{ + style: { + "background": "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + "margin": "10px", + "padding": "10px", + "text": "#222222", + "textSize": "20px", + "textWeight": "bold", + "fontStyle": "italic", + "border": "#222222", + "borderStyle": "solid", + "radius": "10px", + "borderWidth": "2px", + }, + }} + compFactory={InputComp} + /> + <Example + title="Label Styling properties" + config={{ + labelStyle: { + "margin": "5px", + "padding": "5px", + "label": "#01865B", + "textTransform": "Uppercase", + "textDecoration": "underline", + "textSize": "18px", + "textWeight": "bold", + "fontStyle": "italic", + "border": "#222222", + "borderWidth": "2px", + "borderStyle": "solid", + }, + }} + compFactory={InputComp} + /> + <Example + title="Input Field Styling properties" + config={{ + inputFieldStyle: { + "background": "#F20B0B", + "padding": "10px", + "textTransform": "Uppercase", + "textDecoration": "underline", + "textSize": "20px", + "textWeight": "bold", + "fontStyle": "italic", + "border": "#222222", + "borderStyle": "dashed", + "radius": "11px", + "borderWidth": "3px", + "accent": "#0EDF99", + "validate": "#36B389", + "text": "#FFF", + }, + }} + compFactory={InputComp} + /> + </ExampleGroup> + + <ExampleGroup + title="Animation Style" + description="The Following Examples Show different animations on the CheckBox Component." + > + <Example + title="Bounce Animation" + config={{ + animationStyle: { + "animation": "bounce", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={InputComp} + /> + <Example + title="Swing Animation" + config={{ + animationStyle: { + "animation": "swing", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={InputComp} + /> + <Example + title="Tada Animation" + config={{ + animationStyle: { + "animation": "tada", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={InputComp} + /> + </ExampleGroup> </> ); } diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/textInputComp/Password.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/textInputComp/Password.tsx index 099aa3793..ba5c6d353 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/textInputComp/Password.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/textInputComp/Password.tsx @@ -26,11 +26,19 @@ export default function PasswordExample() { }} compFactory={PasswordComp} /> + <Example + title="Hiding the Password" + config={{ + placeholder: trans("componentDoc.pleaseInputPassword"), + hidden: true, + }} + compFactory={PasswordComp} + /> </ExampleGroup> <ExampleGroup title={trans("componentDoc.labelText")} description=""> <Example - title={trans("componentDoc.left")} + title="Left - Left Alignment" config={{ label: { text: trans("componentDoc.password"), position: "row" }, placeholder: trans("componentDoc.pleaseInputPassword"), @@ -38,17 +46,25 @@ export default function PasswordExample() { compFactory={PasswordComp} /> <Example - title={trans("componentDoc.column")} + title="Left - Right Alignment" + config={{ + label: { text: trans("componentDoc.password"), align: "right" }, + placeholder: trans("componentDoc.pleaseInputPassword"), + }} + compFactory={PasswordComp} + /> + <Example + title="Top - Left Alignment" config={{ label: { text: trans("componentDoc.password"), position: "column" }, placeholder: trans("componentDoc.pleaseInputPassword"), }} compFactory={PasswordComp} /> - <Example - title={trans("componentDoc.textAlign")} + <Example + title="Top - Rightt Alignment" config={{ - label: { text: trans("componentDoc.password"), align: "right" }, + label: { text: trans("componentDoc.password"), position: "column", align: "right" }, placeholder: trans("componentDoc.pleaseInputPassword"), }} compFactory={PasswordComp} @@ -71,6 +87,7 @@ export default function PasswordExample() { compFactory={PasswordComp} /> </ExampleGroup> + <ExampleGroup title={trans("componentDoc.validation")} description=""> <Example title={trans("componentDoc.required")} @@ -105,6 +122,114 @@ export default function PasswordExample() { compFactory={PasswordComp} /> </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the different Styling properties of the Checkbox Component." + > + <Example + title="Select component Styling properties" + config={{ + style: { + "background": "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + "margin": "10px", + "padding": "10px", + "text": "#222222", + "textSize": "20px", + "textWeight": "bold", + "fontStyle": "italic", + "border": "#222222", + "borderStyle": "solid", + "radius": "10px", + "borderWidth": "2px", + }, + }} + compFactory={PasswordComp} + /> + <Example + title="Label Styling properties" + config={{ + labelStyle: { + "margin": "5px", + "padding": "5px", + "label": "#01865B", + "textTransform": "Uppercase", + "textDecoration": "underline", + "textSize": "18px", + "textWeight": "bold", + "fontStyle": "italic", + "border": "#222222", + "borderWidth": "2px", + "borderStyle": "solid", + }, + }} + compFactory={PasswordComp} + /> + <Example + title="Input Field Styling properties" + config={{ + inputFieldStyle: { + "background": "#F20B0B", + "padding": "10px", + "textTransform": "Uppercase", + "textDecoration": "underline", + "textSize": "20px", + "textWeight": "bold", + "fontStyle": "italic", + "border": "#222222", + "borderStyle": "dashed", + "radius": "11px", + "borderWidth": "3px", + "accent": "#0EDF99", + "validate": "#36B389", + "text": "#FFF", + }, + }} + compFactory={PasswordComp} + /> + </ExampleGroup> + + <ExampleGroup + title="Animation Style" + description="The Following Examples Show different animations on the CheckBox Component." + > + <Example + title="Bounce Animation" + config={{ + animationStyle: { + "animation": "bounce", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={PasswordComp} + /> + <Example + title="Swing Animation" + config={{ + animationStyle: { + "animation": "swing", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={PasswordComp} + /> + <Example + title="Tada Animation" + config={{ + animationStyle: { + "animation": "tada", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={PasswordComp} + /> + </ExampleGroup> </> ); } diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/textInputComp/RichTextEditor.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/textInputComp/RichTextEditor.tsx index ffbaab53b..184f793a4 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/textInputComp/RichTextEditor.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/textInputComp/RichTextEditor.tsx @@ -8,10 +8,12 @@ export default function InputExample() { <> <ExampleGroup title={trans("componentDoc.basicUsage")} - description={trans("componentDoc.basicDemoDescription")} + description="The Following Examples Show the Basic Usage of the Rich Text Editor Component." > <Example title={trans("componentDoc.placeholder")} + width={500} + height={400} config={{ placeholder: "Let us know about yourself!", }} @@ -19,6 +21,8 @@ export default function InputExample() { /> <Example title="Default Value" + width={500} + height={400} config={{ placeholder: "Let us know about yourself!", value: "I am an Experienced FullStack Web Developer ...", @@ -27,10 +31,12 @@ export default function InputExample() { /> </ExampleGroup> - <ExampleGroup title="Layout" description=""> + <ExampleGroup + title="Layout Options" + description="The Following Examples Show the different Layout options of the Rich Text Edito Component."> <Example title={trans("componentDoc.fixed")} - width={340} + width={500} config={{ placeholder: "Let us know about yourself!", autoHeight: "fixed", @@ -40,7 +46,7 @@ export default function InputExample() { /> <Example title={trans("componentDoc.auto")} - width={340} + width={500} config={{ placeholder: "Let us know about yourself!", autoHeight: "auto", @@ -50,7 +56,8 @@ export default function InputExample() { /> <Example title= "Hide Toolbar" - width={340} + width={500} + height={400} config={{ placeholder: "Let us know about yourself!", hideToolbar: true, @@ -58,6 +65,27 @@ export default function InputExample() { compFactory={RichTextEditorComp} /> </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the different Styling properties of the Rich Text Editor Component." + > + <Example + title="Different Styling Properties" + width={500} + height={400} + config={{ + placeholder: "Let us know about yourself!", + style: { + "border": "#013AFF", + "background": "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + "radius": "10px", + "borderWidth": "2px" + }, + }} + compFactory={RichTextEditorComp} + /> + </ExampleGroup> </> ); } diff --git a/client/packages/lowcoder/src/pages/ComponentDoc/examples/textInputComp/TextArea.tsx b/client/packages/lowcoder/src/pages/ComponentDoc/examples/textInputComp/TextArea.tsx index a26f0391a..dbf3bb1e4 100644 --- a/client/packages/lowcoder/src/pages/ComponentDoc/examples/textInputComp/TextArea.tsx +++ b/client/packages/lowcoder/src/pages/ComponentDoc/examples/textInputComp/TextArea.tsx @@ -35,11 +35,19 @@ export default function ButtonExample() { }} compFactory={TextAreaComp} /> + <Example + title="Hiding the Text Area component" + config={{ + placeholder: trans("componentDoc.pleaseInputName"), + hidden: true, + }} + compFactory={TextAreaComp} + /> </ExampleGroup> <ExampleGroup title={trans("componentDoc.labelText")} description=""> <Example - title={trans("componentDoc.left")} + title="Left - Left Alignment" config={{ label: { text: trans("componentDoc.userName"), position: "row" }, placeholder: trans("componentDoc.pleaseInputName"), @@ -47,7 +55,15 @@ export default function ButtonExample() { compFactory={TextAreaComp} /> <Example - title={trans("componentDoc.column")} + title="Left - Rightt Alignment" + config={{ + placeholder: trans("componentDoc.pleaseInputName"), + label: { text: trans("componentDoc.userName"), align: "right" }, + }} + compFactory={TextAreaComp} + /> + <Example + title="Top - Left Alignment" config={{ label: { text: trans("componentDoc.userName"), position: "column" }, placeholder: trans("componentDoc.pleaseInputName"), @@ -55,10 +71,18 @@ export default function ButtonExample() { compFactory={TextAreaComp} /> <Example - title={trans("componentDoc.textAlign")} + title="Top - Rightt Alignment" config={{ + label: { text: trans("componentDoc.userName"), position: "column", align: "right" }, + placeholder: trans("componentDoc.pleaseInputName"), + }} + compFactory={TextAreaComp} + /> + <Example + title="Tooltip" + config={{ + label: { text: trans("componentDoc.userName"), tooltip:"This is Tooltip on Text Area component" }, placeholder: trans("componentDoc.pleaseInputName"), - label: { text: trans("componentDoc.userName"), align: "right" }, }} compFactory={TextAreaComp} /> @@ -121,6 +145,114 @@ export default function ButtonExample() { compFactory={TextAreaComp} /> </ExampleGroup> + + <ExampleGroup + title="Styling Properties" + description="The Following Examples Show the different Styling properties of the Checkbox Component." + > + <Example + title="Select component Styling properties" + config={{ + style: { + "background": "linear-gradient(135deg, #72afd3 0%, #96e6a1 100%)", + "margin": "10px", + "padding": "10px", + "text": "#222222", + "textSize": "20px", + "textWeight": "bold", + "fontStyle": "italic", + "border": "#222222", + "borderStyle": "solid", + "radius": "10px", + "borderWidth": "2px", + }, + }} + compFactory={TextAreaComp} + /> + <Example + title="Label Styling properties" + config={{ + labelStyle: { + "margin": "5px", + "padding": "5px", + "label": "#01865B", + "textTransform": "Uppercase", + "textDecoration": "underline", + "textSize": "18px", + "textWeight": "bold", + "fontStyle": "italic", + "border": "#222222", + "borderWidth": "2px", + "borderStyle": "solid", + }, + }} + compFactory={TextAreaComp} + /> + <Example + title="Input Field Styling properties" + config={{ + inputFieldStyle: { + "background": "#F20B0B", + "padding": "10px", + "textTransform": "Uppercase", + "textDecoration": "underline", + "textSize": "20px", + "textWeight": "bold", + "fontStyle": "italic", + "border": "#222222", + "borderStyle": "dashed", + "radius": "11px", + "borderWidth": "3px", + "accent": "#0EDF99", + "validate": "#36B389", + "text": "#FFF", + }, + }} + compFactory={TextAreaComp} + /> + </ExampleGroup> + + <ExampleGroup + title="Animation Style" + description="The Following Examples Show different animations on the CheckBox Component." + > + <Example + title="Bounce Animation" + config={{ + animationStyle: { + "animation": "bounce", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={TextAreaComp} + /> + <Example + title="Swing Animation" + config={{ + animationStyle: { + "animation": "swing", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={TextAreaComp} + /> + <Example + title="Tada Animation" + config={{ + animationStyle: { + "animation": "tada", + "animationDelay": "1s", + "animationDuration": "3s", + "animationIterationCount": "infinite" + }, + }} + compFactory={TextAreaComp} + /> + </ExampleGroup> </> ); } diff --git a/client/packages/lowcoder/src/pages/common/headerStartDropdown.tsx b/client/packages/lowcoder/src/pages/common/headerStartDropdown.tsx index bb7d41b5a..3170f9871 100644 --- a/client/packages/lowcoder/src/pages/common/headerStartDropdown.tsx +++ b/client/packages/lowcoder/src/pages/common/headerStartDropdown.tsx @@ -100,7 +100,7 @@ export function HeaderStartDropdown(props: { setEdit: () => void, isViewMarketpl })} </CommonTextLabel> ), - visible: true, + visible: !isPublicApp, }, ]; diff --git a/client/packages/lowcoder/src/pages/common/previewHeader.tsx b/client/packages/lowcoder/src/pages/common/previewHeader.tsx index 89aafa153..f8d4cba2e 100644 --- a/client/packages/lowcoder/src/pages/common/previewHeader.tsx +++ b/client/packages/lowcoder/src/pages/common/previewHeader.tsx @@ -115,6 +115,8 @@ export function HeaderProfile(props: { user: User }) { const { user } = props; const fetchingUser = useSelector(isFetchingUser); const templateId = useSelector(getTemplateId); + const isPublicApp = useSelector(isPublicApplication); + if (fetchingUser) { return <Skeleton.Avatar shape="circle" size={28} />; } @@ -122,7 +124,13 @@ export function HeaderProfile(props: { user: User }) { <div> {user.isAnonymous ? ( !templateId ? ( - <LoginBtn buttonType="primary" onClick={() => history.push(AUTH_LOGIN_URL)}> + <LoginBtn buttonType="primary" onClick={() => { + if (isPublicApp) { + window.top?.open('https://app.lowcoder.cloud/user/auth/login'); + } else { + history.push(AUTH_LOGIN_URL) + } + }}> {trans("userAuth.login")} </LoginBtn> ) : null @@ -147,7 +155,7 @@ const PreviewHeaderComp = () => { const headerStart = ( <> - <StyledLink onClick={() => history.push(ALL_APPLICATIONS_URL)}> + <StyledLink onClick={() => !isPublicApp && history.push(ALL_APPLICATIONS_URL)}> <LogoIcon branding={true} /> </StyledLink> {isViewMarketplaceMode && ( @@ -204,36 +212,44 @@ const PreviewHeaderComp = () => { </Wrapper> ); - const headerMiddle = ( - <> - {/* Devices */} - <Segmented<DeviceType> - options={[ - { value: 'mobile', icon: <MobileOutlined /> }, - { value: 'tablet', icon: <TabletOutlined /> }, - { value: 'desktop', icon: <DesktopOutlined /> }, - ]} - value={editorState.deviceType} - onChange={(value) => { - editorState.setDeviceType(value); - }} - /> - - {/* Orientation */} - {editorState.deviceType !== 'desktop' && ( - <Segmented<DeviceOrientation> + const headerMiddle = useMemo(() => { + if (isPublicApp) return null; + + return ( + <> + {/* Devices */} + <Segmented<DeviceType> options={[ - { value: 'portrait', label: "Portrait" }, - { value: 'landscape', label: "Landscape" }, + { value: 'mobile', icon: <MobileOutlined /> }, + { value: 'tablet', icon: <TabletOutlined /> }, + { value: 'desktop', icon: <DesktopOutlined /> }, ]} - value={editorState.deviceOrientation} + value={editorState.deviceType} onChange={(value) => { - editorState.setDeviceOrientation(value); + editorState.setDeviceType(value); }} /> - )} - </> - ); + + {/* Orientation */} + {editorState.deviceType !== 'desktop' && ( + <Segmented<DeviceOrientation> + options={[ + { value: 'portrait', label: "Portrait" }, + { value: 'landscape', label: "Landscape" }, + ]} + value={editorState.deviceOrientation} + onChange={(value) => { + editorState.setDeviceOrientation(value); + }} + /> + )} + </> + ); + }, [ + isPublicApp, + editorState.deviceType, + editorState.deviceOrientation, + ]); return ( <Header diff --git a/client/packages/lowcoder/src/pages/editor/editorConstants.tsx b/client/packages/lowcoder/src/pages/editor/editorConstants.tsx index d0c96070a..0ff544d1c 100644 --- a/client/packages/lowcoder/src/pages/editor/editorConstants.tsx +++ b/client/packages/lowcoder/src/pages/editor/editorConstants.tsx @@ -208,6 +208,11 @@ export const CompStateIcon: { themeriverChart : <ThemeriverChartCompIconSmall />, basicChart : <ChartCompIconSmall />, + barChart : <ChartCompIconSmall />, + lineChart : <ChartCompIconSmall />, + pieChart : <ChartCompIconSmall />, + scatterChart : <ChartCompIconSmall />, + avatar: <AvatarCompIconSmall />, avatarGroup: <AvatarGroupCompIconSmall />, colorPicker: <ColorPickerCompIconSmall />, diff --git a/client/packages/lowcoder/src/pages/editor/right/PluginPanel/index.tsx b/client/packages/lowcoder/src/pages/editor/right/PluginPanel/index.tsx index ea4781c75..ade61d984 100644 --- a/client/packages/lowcoder/src/pages/editor/right/PluginPanel/index.tsx +++ b/client/packages/lowcoder/src/pages/editor/right/PluginPanel/index.tsx @@ -97,6 +97,8 @@ export default function PluginPanel() { </Footer> <CustomModal centered + showOkButton + showCancelButton title={trans("npm.addPluginModalTitle")} open={isAddModalShow} onOk={handleAddNewPlugin} diff --git a/client/packages/lowcoder/src/pages/queryLibrary/QueryLibraryEditor.tsx b/client/packages/lowcoder/src/pages/queryLibrary/QueryLibraryEditor.tsx index d331b568a..48e8f2e29 100644 --- a/client/packages/lowcoder/src/pages/queryLibrary/QueryLibraryEditor.tsx +++ b/client/packages/lowcoder/src/pages/queryLibrary/QueryLibraryEditor.tsx @@ -47,6 +47,7 @@ import { registryDataSourcePlugin } from "constants/queryConstants"; import { messageInstance } from "lowcoder-design/src/components/GlobalInstances"; import { Helmet } from "react-helmet"; import {fetchQLPaginationByOrg} from "@lowcoder-ee/util/pagination/axios"; +import { isEmpty } from "lodash"; const Wrapper = styled.div` display: flex; @@ -393,16 +394,38 @@ function useSaveQueryLibrary( const dispatch = useDispatch(); const [prevComp, setPrevComp] = useState<Comp>(); const [prevJsonStr, setPrevJsonStr] = useState<string>(); + const [prevQueryId, setPrevQueryId] = useState<string>(); + const queryId = query?.id; useEffect(() => { - if (!comp || comp === prevComp || !query || !comp?.children.query.children.id.getView()) { + if (!comp || comp === prevComp) { return; } + const curJson = comp.toJsonValue(); const curJsonStr = JSON.stringify(curJson); + + if (isEmpty(curJson?.query?.comp)) { + return; + } + if (!Boolean(prevQueryId) && Boolean(queryId)) { + setPrevComp(comp); + setPrevJsonStr(curJsonStr); + return setPrevQueryId(queryId); + } + if (prevQueryId !== queryId) { + setPrevComp(comp); + setPrevJsonStr(curJsonStr); + return setPrevQueryId(queryId); + } + if (!Boolean(prevJsonStr) && Boolean(curJsonStr)) { + setPrevComp(comp) + return setPrevJsonStr(curJsonStr); + } if (prevJsonStr === curJsonStr) { return; } + // the first time is a normal change, the latter is the manual update if (prevComp) { query.name = comp.children.query.children.name.getView(); @@ -411,5 +434,6 @@ function useSaveQueryLibrary( } setPrevComp(comp); setPrevJsonStr(curJsonStr); - }, [comp, query, prevComp, prevJsonStr, dispatch]); + setPrevQueryId(queryId); + }, [comp, queryId, dispatch]); } diff --git a/client/packages/lowcoder/src/pages/support/supportDetail.tsx b/client/packages/lowcoder/src/pages/support/supportDetail.tsx index cb1021f8f..8048c0ae6 100644 --- a/client/packages/lowcoder/src/pages/support/supportDetail.tsx +++ b/client/packages/lowcoder/src/pages/support/supportDetail.tsx @@ -15,6 +15,7 @@ import remarkGfm from 'remark-gfm'; import { contrastColor } from "comps/controls/styleControlConstants"; import ReactQuill from 'react-quill'; import 'react-quill/dist/quill.snow.css'; +import { useCurrentUser } from "util/currentUser"; const { Title, Text } = Typography; const { TextArea } = Input; @@ -270,7 +271,7 @@ export function SupportDetail() { const [isAddingComment, setIsAddingComment] = useState<boolean>(false); const [isUploading, setIsUploading] = useState<boolean>(false); const [fileList, setFileList] = useState<any[]>([]); - + const user = useCurrentUser(); // State for description edit const [isEditingDescription, setIsEditingDescription] = useState<boolean>(false); @@ -538,8 +539,8 @@ export function SupportDetail() { renderItem={(comment: any) => ( <List.Item> <List.Item.Meta - avatar={<Avatar src={comment.author.avatarUrls['48x48']} />} - title={comment.author.displayName} + avatar={<Avatar src={comment.author.accountId == "712020:a25c863c-bd24-456e-aa3f-2335c18e0235" ? user.avatarUrl : comment.author.avatarUrls['48x48']} />} + title={comment.author.accountId == "712020:a25c863c-bd24-456e-aa3f-2335c18e0235" ? trans("support.selfUser") : comment.author.displayName} description={ <> <div> diff --git a/client/packages/lowcoder/src/redux/sagas/subscriptionSagas.ts b/client/packages/lowcoder/src/redux/sagas/subscriptionSagas.ts index 8f43b9fc1..1e94116d7 100644 --- a/client/packages/lowcoder/src/redux/sagas/subscriptionSagas.ts +++ b/client/packages/lowcoder/src/redux/sagas/subscriptionSagas.ts @@ -11,9 +11,7 @@ import { Subscription, LowcoderSearchCustomer } from '@lowcoder-ee/constants/sub function* fetchSubscriptionsSaga(action: ReturnType<typeof fetchSubscriptionsAction>) { try { const user: User = yield select(getUser); - const currentUser: CurrentUser = yield select(getCurrentUser); const orgID = user.currentOrgId; - const domain = `${window.location.protocol}//${window.location.hostname}${window.location.port ? `:${window.location.port}` : ''}`; const deploymentId: string = yield select(getDeploymentId); const subscriptionSearchCustomer: LowcoderSearchCustomer = { diff --git a/client/packages/lowcoder/src/util/context/SubscriptionContext.tsx b/client/packages/lowcoder/src/util/context/SubscriptionContext.tsx index f89e5ff77..1d1b16d93 100644 --- a/client/packages/lowcoder/src/util/context/SubscriptionContext.tsx +++ b/client/packages/lowcoder/src/util/context/SubscriptionContext.tsx @@ -1,4 +1,4 @@ -import { createCheckoutLink, createCustomer, getProducts, searchCustomer } from "@lowcoder-ee/api/subscriptionApi"; +import { createCheckoutLink, cleanupCustomer } from "@lowcoder-ee/api/subscriptionApi"; import { StripeCustomer, SubscriptionProduct, InitSubscriptionProducts, LowcoderSearchCustomer, LowcoderNewCustomer, Subscription } from "@lowcoder-ee/constants/subscriptionConstants"; import { getDeploymentId } from "@lowcoder-ee/redux/selectors/configSelectors"; import { getFetchSubscriptionsFinished, getSubscriptions, getSubscriptionsError } from "@lowcoder-ee/redux/selectors/subscriptionSelectors"; @@ -78,17 +78,6 @@ export const SubscriptionContextProvider = (props: { userId: user.id, }; - const subscriptionNewCustomer: LowcoderNewCustomer = { - hostname: domain, - hostId: deploymentId, - email: currentUser.email, - orgId: orgID, - userId: user.id, - userName: user.username, - type: admin, - companyName: currentOrg?.name || "Unknown", - }; - useEffect(() => { // If products are already loaded in the outer context, reuse them if (productsLoaded) { @@ -104,28 +93,11 @@ export const SubscriptionContextProvider = (props: { const initializeCustomer = async () => { if (existingCustomer) { setCustomer(existingCustomer); + + cleanupCustomer(subscriptionSearchCustomer); + return; } - - /* try { - setIsCreatingCustomer(true); - const subscriptionSearchCustomer: LowcoderSearchCustomer = { - hostId: deploymentId, - orgId: orgID, - userId: user.id, - }; - const existingCustomer = await searchCustomer(subscriptionSearchCustomer); - if (existingCustomer) { - setCustomer(existingCustomer); - } else { - const newCustomer = await createCustomer(subscriptionNewCustomer); - setCustomer(newCustomer); - } - } catch (error) { - setCustomerDataError(true); - } finally { - setIsCreatingCustomer(false); - } */ }; if (!customer && isCustomerInitializationComplete) { diff --git a/client/packages/lowcoder/src/util/currentUser.tsx b/client/packages/lowcoder/src/util/currentUser.tsx index b638343ef..506032eda 100644 --- a/client/packages/lowcoder/src/util/currentUser.tsx +++ b/client/packages/lowcoder/src/util/currentUser.tsx @@ -1,7 +1,8 @@ import { useSelector } from "react-redux"; -import { getCurrentUser } from "redux/selectors/usersSelectors"; +import { getCurrentUser, getUser } from "redux/selectors/usersSelectors"; export function useCurrentUser() { const currentUser = useSelector(getCurrentUser); - return currentUser; + const { hasPassword } = useSelector(getUser); + return {...currentUser, hasPassword}; } diff --git a/client/packages/lowcoder/vite.config.mts b/client/packages/lowcoder/vite.config.mts index 9699e15db..1350607c1 100644 --- a/client/packages/lowcoder/vite.config.mts +++ b/client/packages/lowcoder/vite.config.mts @@ -1,5 +1,5 @@ import dotenv from "dotenv"; -import { defineConfig, ServerOptions, UserConfig } from "vite"; +import { defineConfig, PluginOption, ServerOptions, UserConfig } from "vite"; import react from "@vitejs/plugin-react"; import viteTsconfigPaths from "vite-tsconfig-paths"; import svgrPlugin from "vite-plugin-svgr"; @@ -12,6 +12,7 @@ import dynamicImport from 'vite-plugin-dynamic-import'; import { ensureLastSlash } from "./src/dev-utils/util"; import { buildVars } from "./src/dev-utils/buildVars"; import { globalDepPlugin } from "./src/dev-utils/globalDepPlguin"; +import { terser } from 'rollup-plugin-terser'; // import { nodePolyfills } from 'vite-plugin-node-polyfills' dotenv.config(); @@ -66,6 +67,7 @@ export const viteConfig: UserConfig = { }, base, build: { + minify: "terser", manifest: true, target: "es2020", cssTarget: "chrome87", @@ -73,9 +75,117 @@ export const viteConfig: UserConfig = { assetsDir: "static", emptyOutDir: false, rollupOptions: { + treeshake: { + moduleSideEffects: true, + propertyReadSideEffects: false, + tryCatchDeoptimization: false, + unknownGlobalSideEffects: false, + }, output: { - chunkFileNames: "[hash].js", + inlineDynamicImports: false, + chunkFileNames: "[name]-[hash].js", + manualChunks: (id) => { + if (id.includes("node_modules")) { + // UI LIBRARIES + if (id.includes("@ant-design/icons")) return "ant-design-icons"; + if (id.includes("node_modules/antd")) return "antd"; + if (id.includes("styled-components")) return "styled-components"; + + // 🔹 BARCODE & QR CODE PROCESSING + if (id.includes("react-qr-barcode-scanner")) return "barcode"; + + // TEXT EDITORS & PARSERS + if (id.includes("codemirror")) return "codemirror"; + if (id.includes("quill")) return "quill"; + if (id.includes("react-json-view")) return "react-json-view"; + if (id.includes("react-quill")) return "react-quill"; + if (id.includes("remark-gfm")) return "remark-gfm"; + if (id.includes("rehype-raw")) return "rehype-raw"; + if (id.includes("rehype-sanitize")) return "rehype-sanitize"; + + // DRAG & DROP + if (id.includes("@dnd-kit")) return "dnd-kit"; + if (id.includes("react-draggable")) return "react-draggable"; + if (id.includes("react-grid-layout")) return "react-grid-layout"; + if (id.includes("react-sortable-hoc")) return "react-sortable-hoc"; + + // ICONS & FONTS + if (id.includes("@fortawesome")) return "fontawesome"; + if (id.includes("@remixicon")) return "remixicon"; + + // DATE/TIME HANDLING + if (id.includes("moment")) return "moment"; + if (id.includes("date-fns")) return "date-fns"; + if (id.includes("dayjs")) return "dayjs"; + + // UTILITIES & HELPERS + if (id.includes("clsx")) return "clsx"; + if (id.includes("immer")) return "immer"; + if (id.includes("lodash")) return "lodash"; + if (id.includes("lodash-es")) return "lodash-es"; + if (id.includes("uuid")) return "uuid"; + if (id.includes("ua-parser-js")) return "ua-parser-js"; + if (id.includes("html2canvas")) return "ua-parser-js"; + if (id.includes("numbro")) return "numbro"; + + // FILE & DATA PROCESSING + if (id.includes("buffer")) return "buffer"; + if (id.includes("file-saver")) return "file-saver"; + if (id.includes("papaparse")) return "papaparse"; + if (id.includes("parse5")) return "parse5"; + if (id.includes("xlsx")) return "xlsx"; + if (id.includes("alasql")) return "alasql"; + if (id.includes("sql-formatter")) return "sql-formatter"; + + // NETWORK & HTTP + if (id.includes("axios")) return "axios"; + if (id.includes("fetch")) return "fetch"; + if (id.includes("http")) return "http-modules"; + if (id.includes("https")) return "https-modules"; + + // WEB SOCKETS & STREAMING + if (id.includes("sockjs")) return "websockets"; + if (id.includes("websocket")) return "websockets"; + + // STATE MANAGEMENT + if (id.includes("react-error-boundary")) return "react-error-boundary"; + if (id.includes("redux-devtools-extension")) return "redux-devtools"; + + // POLYFILLS & BROWSER COMPATIBILITY + // if (id.includes("core-js")) return "core-js"; + if (id.includes("regenerator-runtime")) return "regenerator-runtime"; + if (id.includes("eslint4b-prebuilt-2")) return "eslint4b-prebuilt-2"; + + // MISCELLANEOUS + if (id.includes("cnchar")) return "cnchar"; + if (id.includes("hotkeys-js")) return "hotkeys-js"; + if (id.includes("loglevel")) return "loglevel"; + if (id.includes("qrcode.react")) return "qrcode-react"; + if (id.includes("react-joyride")) return "react-joyride"; + if (id.includes("rc-trigger")) return "rc-trigger"; + if (id.includes("really-relaxed-json")) return "really-relaxed-json"; + if (id.includes("simplebar-react")) return "simplebar-react"; + if (id.includes("react-documents")) return "react-documents"; + if (id.includes("react-colorful")) return "react-colorful"; + if (id.includes("react-best-gradient-color-picker")) return "react-best-gradient-color-picker"; + if (id.includes("@supabase/supabase-js")) return "supabase"; + return null; + } + return null; + }, }, + plugins: [ + terser({ + compress: { + drop_console: true, + drop_debugger: true, + pure_funcs: ["console.info", "console.debug", "console.log"], + }, + format: { + comments: /(@vite-ignore|webpackIgnore)/ + }, + }) as PluginOption, + ], onwarn: (warning, warn) => { if (warning.code === 'MODULE_LEVEL_DIRECTIVE') { return @@ -84,6 +194,7 @@ export const viteConfig: UserConfig = { }, }, commonjsOptions: { + transformMixedEsModules : true, defaultIsModuleExports: (id) => { if (id.indexOf("antd/lib") !== -1) { return false; @@ -178,7 +289,7 @@ const browserCheckConfig: UserConfig = { copyPublicDir: true, emptyOutDir: true, lib: { - formats: ["iife"], + formats: ["es"], name: "BrowserCheck", entry: "./src/browser-check.ts", fileName: () => { diff --git a/client/yarn.lock b/client/yarn.lock index 1589f0bb7..7fae135fa 100644 --- a/client/yarn.lock +++ b/client/yarn.lock @@ -1785,6 +1785,15 @@ __metadata: languageName: node linkType: hard +"@babel/runtime@npm:^7.13.9": + version: 7.26.9 + resolution: "@babel/runtime@npm:7.26.9" + dependencies: + regenerator-runtime: ^0.14.0 + checksum: 838492d8a925092f9ccfbd82ec183a54f430af3a4ce88fb1337a4570629202d5123bad3097a5b8df53822504d12ccb29f45c0f6842e86094f0164f17a51eec92 + languageName: node + linkType: hard + "@babel/runtime@npm:^7.25.7, @babel/runtime@npm:^7.26.0": version: 7.26.7 resolution: "@babel/runtime@npm:7.26.7" @@ -4484,7 +4493,7 @@ __metadata: languageName: node linkType: hard -"@types/babel__core@npm:^7.1.14": +"@types/babel__core@npm:^7.1.12, @types/babel__core@npm:^7.1.14": version: 7.20.5 resolution: "@types/babel__core@npm:7.20.5" dependencies: @@ -6652,6 +6661,37 @@ __metadata: languageName: node linkType: hard +"babel-plugin-transform-vite-meta-env@npm:1.0.3": + version: 1.0.3 + resolution: "babel-plugin-transform-vite-meta-env@npm:1.0.3" + dependencies: + "@babel/runtime": ^7.13.9 + "@types/babel__core": ^7.1.12 + checksum: 781b4f7d9e7497e869d87749a6d0a13a882c19995e3d97262622d6bfaab0d6da1a182f8440facab8316f1360070bbd7ca6898b1c70400645d1f52990f960b801 + languageName: node + linkType: hard + +"babel-plugin-transform-vite-meta-glob@npm:1.1.2": + version: 1.1.2 + resolution: "babel-plugin-transform-vite-meta-glob@npm:1.1.2" + dependencies: + "@babel/runtime": ^7.13.9 + "@types/babel__core": ^7.1.12 + glob: ^10.3.10 + checksum: 8a73f38a0827f07f2e5cd8f41066eb7fac08ec2ce900adc671cae817a55faf349f4f17946971d3fd80eb5f31657cd58c44e6da8f5a47668e39da0d90facd64bd + languageName: node + linkType: hard + +"babel-plugin-transform-vite-meta-hot@npm:1.0.0": + version: 1.0.0 + resolution: "babel-plugin-transform-vite-meta-hot@npm:1.0.0" + dependencies: + "@babel/runtime": ^7.13.9 + "@types/babel__core": ^7.1.12 + checksum: bcaeecbe89f6f279c8bf90afa2cec0f3e86576179b268cefba9acac4070799a243e66d6e31ec6283068df964a5beb746390ed025b52bb6fc651e69a1610ccaa5 + languageName: node + linkType: hard + "babel-preset-current-node-syntax@npm:^1.0.0": version: 1.0.1 resolution: "babel-preset-current-node-syntax@npm:1.0.1" @@ -6710,6 +6750,19 @@ __metadata: languageName: node linkType: hard +"babel-preset-vite@npm:^1.1.3": + version: 1.1.3 + resolution: "babel-preset-vite@npm:1.1.3" + dependencies: + "@babel/runtime": ^7.13.9 + "@types/babel__core": ^7.1.12 + babel-plugin-transform-vite-meta-env: 1.0.3 + babel-plugin-transform-vite-meta-glob: 1.1.2 + babel-plugin-transform-vite-meta-hot: 1.0.0 + checksum: 243b43c25846a597a03cf36b1b0e6b39d209f5a13207a238bdc9a03b61fcdd450abe2a26595cde17513c321ba63071868def875a54664e45058b5c532f8306a4 + languageName: node + linkType: hard + "bail@npm:^2.0.0": version: 2.0.2 resolution: "bail@npm:2.0.2" @@ -7339,6 +7392,13 @@ __metadata: languageName: node linkType: hard +"claygl@npm:^1.2.1": + version: 1.3.0 + resolution: "claygl@npm:1.3.0" + checksum: cbf3c4788b426ecc183e0fc5f7e3f88fae15d616ebf39467cb719c1f78efbef8bbe92f8def22c927a9d3cbb2a3ae6d1194755edae96d5f623b4dca0b78bdefa8 + languageName: node + linkType: hard + "clean-css@npm:^5.2.2": version: 5.3.3 resolution: "clean-css@npm:5.3.3" @@ -9234,6 +9294,18 @@ coolshapes-react@lowcoder-org/coolshapes-react: languageName: node linkType: hard +"echarts-gl@npm:^2.0.9": + version: 2.0.9 + resolution: "echarts-gl@npm:2.0.9" + dependencies: + claygl: ^1.2.1 + zrender: ^5.1.1 + peerDependencies: + echarts: ^5.1.2 + checksum: d07dfeb093c5ca05a671317a8f4f4be7fffaa12fb91d485ab19c65d740bbf3c08b02b57c4d7b772bc3ce025184843f1a44ba8bdfc3d48257a46684a5d10fb941 + languageName: node + linkType: hard + "echarts-wordcloud@npm:^2.1.0": version: 2.1.0 resolution: "echarts-wordcloud@npm:2.1.0" @@ -13932,6 +14004,7 @@ coolshapes-react@lowcoder-org/coolshapes-react: agora-rtm-sdk: ^1.5.1 big.js: ^6.2.1 echarts-extension-gmap: ^1.6.0 + echarts-gl: ^2.0.9 echarts-wordcloud: ^2.1.0 jest: 29.3.0 lowcoder-cli: "workspace:^" @@ -14035,6 +14108,7 @@ coolshapes-react@lowcoder-org/coolshapes-react: antd-mobile: ^5.34.0 babel-jest: ^29.3.0 babel-preset-react-app: ^10.0.1 + babel-preset-vite: ^1.1.3 chalk: 4 flag-icons: ^7.2.1 husky: ^8.0.1 @@ -14242,6 +14316,7 @@ coolshapes-react@lowcoder-org/coolshapes-react: rehype-sanitize: ^5.0.1 remark-gfm: ^4.0.0 resize-observer-polyfill: ^1.5.1 + rollup-plugin-terser: ^7.0.2 rollup-plugin-visualizer: ^5.9.2 simplebar-react: ^3.2.4 sql-formatter: ^8.2.0 @@ -22680,6 +22755,15 @@ coolshapes-react@lowcoder-org/coolshapes-react: languageName: node linkType: hard +"zrender@npm:^5.1.1": + version: 5.6.1 + resolution: "zrender@npm:5.6.1" + dependencies: + tslib: 2.3.0 + checksum: 01caeac2d30f0083009aafa531ccb7fe991b6ac0ddd8134dc7b0015f794ed7e3d4fbfe5d32f61cb591014245eca15aeebcfc962cdebfe3829598f0c94ba3dc29 + languageName: node + linkType: hard + "zwitch@npm:^2.0.0": version: 2.0.4 resolution: "zwitch@npm:2.0.4" diff --git a/docs/lowcoder-extension/opensource-contribution/develop-data-source-plugins.md b/docs/lowcoder-extension/opensource-contribution/develop-data-source-plugins.md index edd912076..7ff5814e8 100644 --- a/docs/lowcoder-extension/opensource-contribution/develop-data-source-plugins.md +++ b/docs/lowcoder-extension/opensource-contribution/develop-data-source-plugins.md @@ -1,6 +1,6 @@ # Develop Data Source Plugins -This document provides basic information and guides for developing data source plugins. Developers are highly welcomed to make contributions to [Lowcoder](https://github.com/Lowcoder-dev/Lowcoder)--the open source project. +This document provides basic information and guides for developing data source plugins. Developers are highly welcomed to make contributions to [Lowcoder](https://github.com/lowcoder-org/lowcoder)--the open source project. ## Basics @@ -12,7 +12,7 @@ A data source plugin is described by a **JavaScript Object** which mainly consis * Definition of the **Action list** for data source queries and the configuration form for each Action. * Definition of the **execution logic** for Actions. -Currently, all data source plugins are maintained in the `src/plugins` directory of the `node-service` project. Click to view [the project](https://github.com/Lowcoder-dev/Lowcoder/tree/develop/server/node-service), and you might take a quick look at the [S3 plugin](https://github.com/Lowcoder-dev/Lowcoder/tree/develop/server/node-service/src/plugins/s3). +Currently, all data source plugins are maintained in the `src/plugins` directory of the `node-service` project. Click to view [the project](https://github.com/lowcoder-org/lowcoder/tree/main/server/node-service), and you might take a quick look at the [S3 plugin](https://github.com/lowcoder-org/lowcoder/tree/main/server/node-service/src/plugins/s3). ## Overall definition of a plugin @@ -268,7 +268,7 @@ Due to various reasons, the generated plugin code needs to be correctly validate ## Testing -Necessary testing should be done before publishing the plugin. Testing a data source plugin requires a backend environment. You can start a local environment by following the documentation [Start a local backend server](https://github.com/Lowcoder-dev/Lowcoder/tree/develop/client#readme) and test the data source plugin in following aspects: +Necessary testing should be done before publishing the plugin. Testing a data source plugin requires a backend environment. You can start a local environment by following the documentation [Start a local backend server](https://github.com/lowcoder-org/lowcoder/tree/main/server/api-service#readme) and test the data source plugin in following aspects: 1. Make sure the data source plugin has been added to the plugin list in the file `src/plugins/index.ts`. 2. Start the node-service server in the `node-service` directory by executing `yarn dev`. @@ -292,4 +292,4 @@ You can then use the data source plugin just developed in this environment. ## What's next -Congrats! After testing the data source plugin, you can submit a [Pull Request](https://github.com/Lowcoder-dev/Lowcoder/pulls) now. +Congrats! After testing the data source plugin, you can submit a [Pull Request](https://github.com/lowcoder-org/lowcoder/pulls) now. diff --git a/docs/setup-and-run/self-hosting/heroku.md b/docs/setup-and-run/self-hosting/heroku.md index 460850231..133252d19 100644 --- a/docs/setup-and-run/self-hosting/heroku.md +++ b/docs/setup-and-run/self-hosting/heroku.md @@ -3,7 +3,7 @@ ## Deploy 1. [Sign up](https://signup.heroku.com/) for a new Heroku account, or [log in](https://id.heroku.com/login) to get started. -2. Click to start Heroku [one-click deployment](https://heroku.com/deploy?template=https://github.com/Lowcoder-dev/Lowcoder). +2. Click to start Heroku [one-click deployment](https://heroku.com/deploy?template=https://github.com/lowcoder-org/lowcoder). 3. Set the **App name** which will be part of the app URL later, and choose a region. 4. (Not required) Fill in the **Config Vars** according to the descriptions. These are all optional variables used for environment-specific configuration. You can skip this step and manage environment variables later. 5. Click the **Deploy app** button. diff --git a/server/api-service/lowcoder-dependencies/pom.xml b/server/api-service/lowcoder-dependencies/pom.xml index 3f8b6b703..0787bcfcf 100644 --- a/server/api-service/lowcoder-dependencies/pom.xml +++ b/server/api-service/lowcoder-dependencies/pom.xml @@ -26,7 +26,7 @@ <dependency> <groupId>org.lowcoder.plugin</groupId> <artifactId>lowcoder-plugin-api</artifactId> - <version>2.3.0</version> + <version>2.3.1</version> </dependency> <dependency> diff --git a/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/application/model/Application.java b/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/application/model/Application.java index 84d0264e6..3e15e9aa9 100644 --- a/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/application/model/Application.java +++ b/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/application/model/Application.java @@ -47,6 +47,7 @@ public class Application extends HasIdAndAuditing { private Integer applicationType; private ApplicationStatus applicationStatus; + @Setter private Map<String, Object> editingApplicationDSL; @Setter diff --git a/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/bundle/repository/BundleRepository.java b/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/bundle/repository/BundleRepository.java index 70180fb06..9670cc525 100644 --- a/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/bundle/repository/BundleRepository.java +++ b/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/bundle/repository/BundleRepository.java @@ -13,6 +13,7 @@ public interface BundleRepository extends ReactiveMongoRepository<Bundle, String> { Mono<Void> deleteAllByGid(Collection<String> gids); Flux<Bundle> findByGid(@Nonnull String gid); + Flux<Bundle> findAllByGid(Collection<String> gids); Flux<Bundle> findByCreatedBy(String userId); /** diff --git a/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/bundle/service/BundleService.java b/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/bundle/service/BundleService.java index 646d2eff1..5518d82fd 100644 --- a/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/bundle/service/BundleService.java +++ b/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/bundle/service/BundleService.java @@ -16,6 +16,7 @@ public interface BundleService { Mono<Boolean> updateById(String id, Bundle resource); Mono<Bundle> findById(String id); + Flux<Bundle> findByIdIn(Collection<String> ids); Mono<Bundle> findByIdWithoutDsl(String id); diff --git a/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/bundle/service/BundleServiceImpl.java b/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/bundle/service/BundleServiceImpl.java index 611f74d4c..48550aec3 100644 --- a/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/bundle/service/BundleServiceImpl.java +++ b/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/bundle/service/BundleServiceImpl.java @@ -20,6 +20,7 @@ import java.util.Collection; import java.util.Map; +import java.util.Optional; import java.util.Set; import java.util.stream.Collectors; @@ -56,6 +57,15 @@ public Mono<Bundle> findById(String id) { .switchIfEmpty(Mono.error(new BizException(BizError.NO_RESOURCE_FOUND, "BUNDLE_NOT_FOUND", id))); } + @Override + public Flux<Bundle> findByIdIn(Collection<String> ids) { + Optional<String> first = ids.stream().findFirst(); + if(first.isPresent() && FieldName.isGID(first.get())) + return repository.findAllByGid(ids); + + return repository.findAllById(ids); + } + @Override public Mono<Bundle> findByIdWithoutDsl(String id) { if (id == null) { diff --git a/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/datasource/repository/DatasourceRepository.java b/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/datasource/repository/DatasourceRepository.java index 71e6eca55..351e3be48 100644 --- a/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/datasource/repository/DatasourceRepository.java +++ b/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/datasource/repository/DatasourceRepository.java @@ -62,6 +62,15 @@ public Mono<Datasource> findById(String datasourceId) { .flatMap(this::convertToDomainObjectAndDecrypt); } + public Flux<Datasource> findByIds(Collection<String> datasourceIds) { + Optional<String> first = datasourceIds.stream().findAny(); + if(first.isPresent() && FieldName.isGID(first.get())) + return repository.findAllByGidIn(datasourceIds) + .flatMap(this::convertToDomainObjectAndDecrypt); + return repository.findAllById(datasourceIds) + .flatMap(this::convertToDomainObjectAndDecrypt); + } + public Mono<Datasource> findWorkspacePredefinedDatasourceByOrgIdAndType(String organizationId, String type) { return repository.findByOrganizationIdAndTypeAndCreationSource(organizationId, type, DatasourceCreationSource.LEGACY_WORKSPACE_PREDEFINED.getValue()) diff --git a/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/datasource/service/DatasourceService.java b/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/datasource/service/DatasourceService.java index 8f25eab8e..ccb1e2219 100644 --- a/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/datasource/service/DatasourceService.java +++ b/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/datasource/service/DatasourceService.java @@ -15,6 +15,7 @@ public interface DatasourceService { Mono<Datasource> update(String id, Datasource resource); Mono<Datasource> getById(String id); + Flux<Datasource> getByIds(Collection<String> ids); Mono<Boolean> delete(String id); diff --git a/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/datasource/service/impl/DatasourceServiceImpl.java b/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/datasource/service/impl/DatasourceServiceImpl.java index cd488cd10..52914c4cd 100644 --- a/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/datasource/service/impl/DatasourceServiceImpl.java +++ b/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/datasource/service/impl/DatasourceServiceImpl.java @@ -101,6 +101,32 @@ public Mono<Datasource> getById(String id) { return repository.findById(id); } + @Override + public Flux<Datasource> getByIds(Collection<String> ids) { + Flux<Datasource> builtDatasourceFlux = Flux.fromStream(ids.stream().filter(id-> StringUtils.equals(id, Datasource.QUICK_REST_API_ID) + || StringUtils.equals(id, Datasource.QUICK_GRAPHQL_ID) + || StringUtils.equals(id, Datasource.LOWCODER_API_ID) + ).map(id-> { + if (StringUtils.equals(id, Datasource.QUICK_REST_API_ID)) { + return Datasource.QUICK_REST_API; + } + + if (StringUtils.equals(id, Datasource.QUICK_GRAPHQL_ID)) { + return Datasource.QUICK_GRAPHQL_API; + } + + if (StringUtils.equals(id, Datasource.LOWCODER_API_ID)) { + return Datasource.LOWCODER_API; + } + return Datasource.LOWCODER_API; + })); + + return Flux.concat(builtDatasourceFlux, repository.findByIds(ids.stream().filter(id-> !(StringUtils.equals(id, Datasource.QUICK_REST_API_ID) + || StringUtils.equals(id, Datasource.QUICK_GRAPHQL_ID) + || StringUtils.equals(id, Datasource.LOWCODER_API_ID)) + ).toList())); + } + private Mono<Datasource> validateDatasource(Datasource datasource) { if (datasource.getOrganizationId() == null) { diff --git a/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/folder/repository/FolderRepository.java b/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/folder/repository/FolderRepository.java index aa6734af7..9be68ed63 100644 --- a/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/folder/repository/FolderRepository.java +++ b/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/folder/repository/FolderRepository.java @@ -14,5 +14,6 @@ public interface FolderRepository extends ReactiveMongoRepository<Folder, String Flux<Folder> findByOrganizationId(String organizationId); Flux<Folder> findByGid(String organizationGid); + Flux<Folder> findByGidIn(Collection<String> ids); Mono<Void> deleteAllByGid(Collection<String> gids); } diff --git a/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/folder/service/FolderService.java b/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/folder/service/FolderService.java index 1ac2d5e6f..1b17507c6 100644 --- a/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/folder/service/FolderService.java +++ b/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/folder/service/FolderService.java @@ -11,6 +11,8 @@ public interface FolderService { Mono<Folder> findById(String id); + Flux<Folder> findByIds(Collection<String> ids); + Mono<Folder> create(Folder folder); Flux<Folder> findByOrganizationId(String organizationId); diff --git a/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/folder/service/FolderServiceImpl.java b/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/folder/service/FolderServiceImpl.java index f297de101..27157f516 100644 --- a/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/folder/service/FolderServiceImpl.java +++ b/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/folder/service/FolderServiceImpl.java @@ -1,5 +1,6 @@ package org.lowcoder.domain.folder.service; +import static org.lowcoder.domain.organization.model.OrganizationState.ACTIVE; import static org.lowcoder.sdk.exception.BizError.NO_RESOURCE_FOUND; import java.util.Collection; @@ -46,6 +47,13 @@ public Mono<Folder> findById(String id) { .switchIfEmpty(Mono.error(new BizException(BizError.NO_RESOURCE_FOUND, "FOLDER_NOT_FOUND", id))); } + @Override + public Flux<Folder> findByIds(Collection<String> ids) { + if(!ids.isEmpty() && FieldName.isGID(ids.stream().findFirst().get())) + return repository.findByGidIn(ids); + return repository.findAllById(ids); + } + @Override public Mono<Folder> create(Folder folder) { return repository.save(folder); diff --git a/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/query/repository/LibraryQueryRepository.java b/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/query/repository/LibraryQueryRepository.java index 41cdca0c5..17cb8fe71 100644 --- a/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/query/repository/LibraryQueryRepository.java +++ b/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/query/repository/LibraryQueryRepository.java @@ -6,6 +6,8 @@ import reactor.core.publisher.Flux; import reactor.core.publisher.Mono; +import java.util.Collection; + @Repository public interface LibraryQueryRepository extends ReactiveMongoRepository<LibraryQuery, String> { @@ -14,4 +16,5 @@ public interface LibraryQueryRepository extends ReactiveMongoRepository<LibraryQ Mono<LibraryQuery> findByName(String name); Mono<Void> deleteByGid(String gid); Flux<LibraryQuery> findByGid(String gid); + Flux<LibraryQuery> findByGidIn(Collection<String> gids); } diff --git a/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/query/service/LibraryQueryService.java b/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/query/service/LibraryQueryService.java index 2f1193d9f..618377300 100644 --- a/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/query/service/LibraryQueryService.java +++ b/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/query/service/LibraryQueryService.java @@ -5,10 +5,12 @@ import reactor.core.publisher.Flux; import reactor.core.publisher.Mono; +import java.util.Collection; import java.util.Map; public interface LibraryQueryService { Mono<LibraryQuery> getById(String libraryQueryId); + Flux<LibraryQuery> getByIds(Collection<String> libraryQueryIds); Mono<LibraryQuery> getByName(String libraryQueryName); diff --git a/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/query/service/LibraryQueryServiceImpl.java b/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/query/service/LibraryQueryServiceImpl.java index 67595dd04..fbd175ecf 100644 --- a/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/query/service/LibraryQueryServiceImpl.java +++ b/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/query/service/LibraryQueryServiceImpl.java @@ -13,7 +13,9 @@ import reactor.core.publisher.Flux; import reactor.core.publisher.Mono; +import java.util.Collection; import java.util.Map; +import java.util.Optional; import static org.lowcoder.sdk.exception.BizError.LIBRARY_QUERY_NOT_FOUND; import static org.lowcoder.sdk.util.ExceptionUtils.deferredError; @@ -35,6 +37,14 @@ public Mono<LibraryQuery> getById(String libraryQueryId) { .switchIfEmpty(deferredError(LIBRARY_QUERY_NOT_FOUND, "LIBRARY_QUERY_NOT_FOUND")); } + @Override + public Flux<LibraryQuery> getByIds(Collection<String> libraryQueryIds) { + Optional<String> first = libraryQueryIds.stream().findFirst(); + if(first.isPresent() && FieldName.isGID(first.get())) + return libraryQueryRepository.findByGidIn(libraryQueryIds); + return libraryQueryRepository.findAllById(libraryQueryIds); + } + @Override public Mono<LibraryQuery> getByName(String libraryQueryName) { return libraryQueryRepository.findByName(libraryQueryName) diff --git a/server/api-service/lowcoder-infra/src/main/java/org/lowcoder/infra/constant/NewUrl.java b/server/api-service/lowcoder-infra/src/main/java/org/lowcoder/infra/constant/NewUrl.java index ba5d39975..5f14ca234 100644 --- a/server/api-service/lowcoder-infra/src/main/java/org/lowcoder/infra/constant/NewUrl.java +++ b/server/api-service/lowcoder-infra/src/main/java/org/lowcoder/infra/constant/NewUrl.java @@ -37,4 +37,5 @@ private NewUrl() { public static final String NPM_REGISTRY = PREFIX + "/npm"; public static final String PLUGINS_URL = PREFIX + "/plugins"; + public static final String META_URL = PREFIX + "/meta"; } diff --git a/server/api-service/lowcoder-infra/src/main/java/org/lowcoder/infra/constant/Url.java b/server/api-service/lowcoder-infra/src/main/java/org/lowcoder/infra/constant/Url.java index 8ec972167..985f90ec7 100644 --- a/server/api-service/lowcoder-infra/src/main/java/org/lowcoder/infra/constant/Url.java +++ b/server/api-service/lowcoder-infra/src/main/java/org/lowcoder/infra/constant/Url.java @@ -17,5 +17,6 @@ public final class Url { public static final String APPLICATION_URL = BASE_URL + VERSION + "/applications"; public static final String QUERY_URL = BASE_URL + VERSION + "/query"; public static final String STATE_URL = BASE_URL + VERSION + "/state"; + public static final String META_URL = BASE_URL + VERSION + "/meta"; } diff --git a/server/api-service/lowcoder-infra/src/main/java/org/lowcoder/infra/event/AbstractEvent.java b/server/api-service/lowcoder-infra/src/main/java/org/lowcoder/infra/event/AbstractEvent.java index 8514624a2..131da031c 100644 --- a/server/api-service/lowcoder-infra/src/main/java/org/lowcoder/infra/event/AbstractEvent.java +++ b/server/api-service/lowcoder-infra/src/main/java/org/lowcoder/infra/event/AbstractEvent.java @@ -4,6 +4,8 @@ import lombok.Setter; import lombok.experimental.SuperBuilder; import org.lowcoder.plugin.api.event.LowcoderEvent; +import org.lowcoder.sdk.constants.GlobalContext; +import reactor.util.context.ContextView; import java.lang.reflect.Field; import java.util.HashMap; @@ -19,6 +21,7 @@ public abstract class AbstractEvent implements LowcoderEvent protected final Boolean isAnonymous; private final String ipAddress; protected Map<String, Object> details; + protected Map<String, String> eventHeaders; @Setter private static String environmentID; @@ -42,7 +45,10 @@ public B detail(String name, String value) } } - public void populateDetails() { + public void populateDetails(ContextView contextView) { + //populate eventHeaders field + eventHeaders = contextView.get(GlobalContext.HEADERS); + if (details == null) { details = new HashMap<>(); } @@ -57,5 +63,8 @@ public void populateDetails() { } details.put("environmentId", environmentID); + if(!details.containsKey("headers")) { + details.put("headers", eventHeaders); + } } -} +} \ No newline at end of file diff --git a/server/api-service/lowcoder-infra/src/main/java/org/lowcoder/infra/event/ApplicationCommonEvent.java b/server/api-service/lowcoder-infra/src/main/java/org/lowcoder/infra/event/ApplicationCommonEvent.java index 3adb8d7d1..a53879bfe 100644 --- a/server/api-service/lowcoder-infra/src/main/java/org/lowcoder/infra/event/ApplicationCommonEvent.java +++ b/server/api-service/lowcoder-infra/src/main/java/org/lowcoder/infra/event/ApplicationCommonEvent.java @@ -5,6 +5,8 @@ import lombok.Getter; import lombok.experimental.SuperBuilder; +import java.util.Set; + @Getter @SuperBuilder public class ApplicationCommonEvent extends AbstractEvent { @@ -23,6 +25,13 @@ public class ApplicationCommonEvent extends AbstractEvent { private final String oldFolderId; @Nullable private final String oldFolderName; + private final String permissionId; + private final String role; + private final Set<String> userIds; + private final Set<String> groupIds; + private final String shareType; + private final String tag; + private final String commitMessage; @Override public EventType getEventType() { diff --git a/server/api-service/lowcoder-plugins/oraclePlugin/pom.xml b/server/api-service/lowcoder-plugins/oraclePlugin/pom.xml index 03ae32762..a109e8a7a 100644 --- a/server/api-service/lowcoder-plugins/oraclePlugin/pom.xml +++ b/server/api-service/lowcoder-plugins/oraclePlugin/pom.xml @@ -31,8 +31,8 @@ <!-- https://mvnrepository.com/artifact/com.oracle.database.jdbc/ojdbc6 --> <dependency> <groupId>com.oracle.database.jdbc</groupId> - <artifactId>ojdbc6</artifactId> - <version>11.2.0.4</version> + <artifactId>ojdbc11</artifactId> + <version>23.7.0.25.01</version> </dependency> <dependency> <groupId>org.testcontainers</groupId> diff --git a/server/api-service/lowcoder-plugins/sqlBasedPlugin/src/main/java/org/lowcoder/plugin/sql/GeneralSqlExecutor.java b/server/api-service/lowcoder-plugins/sqlBasedPlugin/src/main/java/org/lowcoder/plugin/sql/GeneralSqlExecutor.java index d4b202c1b..0c417c585 100644 --- a/server/api-service/lowcoder-plugins/sqlBasedPlugin/src/main/java/org/lowcoder/plugin/sql/GeneralSqlExecutor.java +++ b/server/api-service/lowcoder-plugins/sqlBasedPlugin/src/main/java/org/lowcoder/plugin/sql/GeneralSqlExecutor.java @@ -148,6 +148,50 @@ private Pair<Statement, Boolean> getStatementAndExecute(Connection connection, S if (statementInput.isPreparedStatement()) { String sql = statementInput.getSql(); List<Object> params = statementInput.getParams(); + + int orderByIndex; + String sortValue; + do { + orderByIndex = -1; + sortValue = null; + for (int i = 0; i < params.size(); i++) { + Object param = params.get(i); + if (param instanceof Map<?, ?> map && map.containsKey("sort")) { + orderByIndex = i; // Index of the ? to replace (0-based) + sortValue = String.valueOf(map.get("sort")); // e.g., "ASC" or "DESC" + break; + } + } + + if (orderByIndex >= 0 && sortValue != null) { + // Validate sortValue to prevent SQL injection + if (!sortValue.equalsIgnoreCase("ASC") && !sortValue.equalsIgnoreCase("DESC")) { + sortValue = "ASC"; // Default to ASC if invalid + } + + // Split the SQL at the ? placeholders + String[] sqlParts = sql.split("\\?", -1); + if (orderByIndex < sqlParts.length - 1) { + // Rebuild the SQL, replacing the ? at orderByIndex with sortValue + StringBuilder newSql = new StringBuilder(); + for (int i = 0; i < sqlParts.length; i++) { + newSql.append(sqlParts[i]); + if (i < sqlParts.length - 1) { + if (i == orderByIndex) { + newSql.append(sortValue); // Insert ASC or DESC + } else { + newSql.append("?"); // Keep other placeholders + } + } + } + sql = newSql.toString(); + + // Remove the Map from params since it's no longer a bind parameter + params.remove(orderByIndex); + } + } + } while(orderByIndex >= 0); + var statement = connection.prepareStatement(sql, Statement.RETURN_GENERATED_KEYS); bindPreparedStatementParams(statement, params); diff --git a/server/api-service/lowcoder-sdk/src/main/java/org/lowcoder/sdk/constants/GlobalContext.java b/server/api-service/lowcoder-sdk/src/main/java/org/lowcoder/sdk/constants/GlobalContext.java index e52624cec..6bded8efb 100644 --- a/server/api-service/lowcoder-sdk/src/main/java/org/lowcoder/sdk/constants/GlobalContext.java +++ b/server/api-service/lowcoder-sdk/src/main/java/org/lowcoder/sdk/constants/GlobalContext.java @@ -16,4 +16,5 @@ public class GlobalContext { public static final String CURRENT_ORG_MEMBER = "currentOrgMember"; public static final String DOMAIN = "domain"; -} + public static final String HEADERS = "headers"; +} \ No newline at end of file diff --git a/server/api-service/lowcoder-sdk/src/main/java/org/lowcoder/sdk/exception/BizError.java b/server/api-service/lowcoder-sdk/src/main/java/org/lowcoder/sdk/exception/BizError.java index af8773c09..631923766 100644 --- a/server/api-service/lowcoder-sdk/src/main/java/org/lowcoder/sdk/exception/BizError.java +++ b/server/api-service/lowcoder-sdk/src/main/java/org/lowcoder/sdk/exception/BizError.java @@ -158,7 +158,10 @@ public enum BizError { SLUG_INVALID(403, 6502), //flow 6601 - 6601 - FLOW_ERROR(500, 6601); + FLOW_ERROR(500, 6601), + + //organization related 6701 - 6701 + ORGANIZATION_NOT_FOUND(400, 6701); static { checkDuplicates(values(), BizError::getBizErrorCode); diff --git a/server/api-service/lowcoder-sdk/src/main/resources/locale_de.properties b/server/api-service/lowcoder-sdk/src/main/resources/locale_de.properties new file mode 100644 index 000000000..ed265a080 --- /dev/null +++ b/server/api-service/lowcoder-sdk/src/main/resources/locale_de.properties @@ -0,0 +1,105 @@ +## Allgemein +INTERNAL_SERVER_ERROR=Oops! Der Dienst ist ausgelastet, bitte versuchen Sie es später erneut. +NOT_AUTHORIZED=Entschuldigung, es scheint, dass Sie keine Berechtigung haben. +INVALID_PARAMETER=Ungültiger Parameter gefunden: {0}, bitte überprüfen und erneut versuchen. +INFRA_REDIS_TIMEOUT=Verbindungszeitüberschreitung, bitte versuchen Sie es später erneut. +INFRA_MONGODB_TIMEOUT=Verbindungszeitüberschreitung, bitte versuchen Sie es später erneut. +INVALID_PERMISSION_OPERATION=Ungültige Berechtigung für Ressource: {0} +REQUEST_THROTTLED=Entschuldigung, die Anfrage erfolgt zu häufig, bitte versuchen Sie es später erneut. +SERVER_NOT_READY=Entschuldigung, der Server ist noch nicht bereit. +INVALID_ORG_ID=Ungültige Workspace-ID, sie könnte gelöscht worden sein oder existiert nicht. +SWITCH_CURRENT_ORG_ERROR=Entschuldigung, Wechsel des Workspaces fehlgeschlagen, bitte versuchen Sie es später erneut. +LAST_ADMIN_CANNOT_LEAVE_ORG=Entschuldigung, der letzte Administrator des Workspaces kann nicht verlassen. +INVALID_GROUP_ID=Ungültige Gruppen-ID, bitte überprüfen und erneut versuchen. +CANNOT_REMOVE_MYSELF=Entschuldigung, Gruppenadministratoren können sich nicht selbst löschen. +CANNOT_LEAVE_GROUP=Entschuldigung, eine Gruppe muss mindestens einen Administrator enthalten. +CANNOT_DELETE_SYSTEM_GROUP=Systemgruppen können nicht gelöscht werden. +NEED_DEV_TO_CREATE_RESOURCE=Ungültige Aktion, Workspace-Entwickler oder Administrator erforderlich. +UNABLE_TO_FIND_VALID_ORG=Kein gültiger Workspace für den aktuellen Benutzer gefunden. +USER_BANNED=Dieses Konto ist gesperrt. +SENDING_EMAIL_FAILED=E-Mail konnte nicht gesendet werden. Bitte überprüfen Sie die SMTP-Einstellungen für den Workspace. +TOKEN_EXPIRED=Das Token zum Zurücksetzen des Passworts ist abgelaufen. +INVALID_TOKEN=Ungültiges Token für die Anfrage zum Zurücksetzen des Passworts erhalten. + +# Einladung +INVALID_INVITATION_CODE=Einladungscode nicht gefunden. +ALREADY_IN_ORGANIZATION=Sie sind bereits in diesem Workspace. +INVITED_ORG_DELETED=Oops! Der eingeladene Workspace wurde bereits gelöscht. +APPLICATION_NOT_FOUND=Anwendung {0} konnte nicht gefunden werden. +ILLEGAL_APPLICATION_PERMISSION_ID=Entschuldigung, es scheint, dass Sie keine Berechtigung haben. +FETCH_HISTORY_SNAPSHOT_FAILURE=Fehler beim Abrufen des Anwendungsverlaufs, bitte versuchen Sie es später erneut. +FETCH_HISTORY_SNAPSHOT_COUNT_FAILURE=Fehler beim Abrufen der Anzahl der Anwendungsverlaufsschnappschüsse, bitte versuchen Sie es später erneut. +INVALID_HISTORY_SNAPSHOT=Verlaufsschnappschuss {0} konnte nicht gefunden werden. + +## Datenquelle +DATASOURCE_NOT_FOUND=Datenquelle {0} konnte nicht gefunden werden. +INVALID_DATASOURCE_CONFIGURATION=Ungültige Datenquellenkonfiguration: {0}, bitte erneut überprüfen. +DATASOURCE_DELETE_FAIL_DUE_TO_REMAINING_QUERIES=Löschen der Datenquelle fehlgeschlagen, da sie noch in Abfragen verwendet wird. +PLUGIN_CREATE_CONNECTION_FAILED=Entschuldigung, Verbindung zur Datenquelle fehlgeschlagen, Fehlermeldung: {0}. +DATASOURCE_PLUGIN_ID_NOT_GIVEN=Ungültige Daten, Typ der Datenquelle fehlt. +INVALID_DATASOURCE_CONFIG_TYPE=Entschuldigung, der Typ der Datenquellenkonfiguration ist ungültig: {0}, bitte erneut überprüfen. +DATASOURCE_CONNECTION_TYPE_ERROR=Ungültiger Datenquellenverbindungstyp: {0}, bitte kontaktieren Sie den Systemadministrator. +DATASOURCE_TYPE_ERROR=Ungültiger Datenquellentyp: {0}, bitte kontaktieren Sie den Systemadministrator. +DUPLICATE_DATABASE_NAME=Oops, dieser Datenquellenname wird bereits verwendet, bitte wählen Sie einen neuen Namen. +DATASOURCE_CLOSE_FAILED=Fehler beim Schließen der Datenquellenverbindung: {0}. +DATASOURCE_AND_APP_ORG_NOT_MATCH=Ungültige Anfrage, die Datenquelle gehört nicht zum Anwendungs-Workspace. +USER_NOT_SIGNED_IN=Unbekannter Benutzer, bitte zuerst anmelden. + +# Authentifizierung +FAIL_TO_GET_OIDC_INFO=Fehler beim Abrufen der OIDC-Informationen, Fehlermeldung: {0}. +LOG_IN_SOURCE_NOT_SUPPORTED=Entschuldigung, dieser Anmeldekanal wird nicht unterstützt. +USER_LOGIN_ID_EXIST=Die aktuelle E-Mail wird bereits von einem anderen Benutzer verwendet. +INVALID_PASSWORD=Entschuldigung, die Passwörter stimmen nicht überein. +PASSWORD_NOT_SET_YET=Dieser Benutzer hat noch kein Passwort festgelegt und kann es daher nicht zurücksetzen. +INVALID_EMAIL_OR_PASSWORD=Ungültige E-Mail oder ungültiges Passwort. +ALREADY_BIND=Entschuldigung, {0} wurde bereits von Benutzer {1} gebunden. +NEED_BIND_THIRD_PARTY_CONNECTION=Entschuldigung, es muss ein Drittanbieter-Anmeldekanal mit dem aktuellen Workspace verbunden werden. +PAYLOAD_TOO_LARGE=Entschuldigung, die maximale Dateigröße beträgt {0} KB, Ihre Datei überschreitet das Limit. + +# Ereignisse +EVENT_TYPE_USER_LOGIN=Anmeldung +EVENT_TYPE_USER_LOGOUT=Abmeldung +EVENT_TYPE_VIEW=App anzeigen +EVENT_TYPE_APPLICATION_CREATE=Neue App erstellen +EVENT_TYPE_APPLICATION_DELETE=App löschen +EVENT_TYPE_APPLICATION_UPDATE=App aktualisieren +EVENT_TYPE_APPLICATION_MOVE=In Ordner verschieben +EVENT_TYPE_APPLICATION_RECYCLED=In Papierkorb verschieben +EVENT_TYPE_APPLICATION_RESTORE=App wiederherstellen +EVENT_TYPE_FOLDER_CREATE=Neuen Ordner erstellen +EVENT_TYPE_FOLDER_DELETE=Ordner löschen +EVENT_TYPE_FOLDER_UPDATE=Ordner aktualisieren +EVENT_TYPE_QUERY_EXECUTION=Abfrage ausführen +EVENT_TYPE_GROUP_CREATE=Neue Gruppe erstellen +EVENT_TYPE_GROUP_UPDATE=Gruppe aktualisieren +EVENT_TYPE_GROUP_DELETE=Gruppe löschen +EVENT_TYPE_GROUP_MEMBER_ADD=Gruppenmitglied hinzufügen +EVENT_TYPE_GROUP_MEMBER_ROLE_UPDATE=Rolle des Gruppenmitglieds aktualisieren +EVENT_TYPE_GROUP_MEMBER_LEAVE=Gruppe verlassen +EVENT_TYPE_GROUP_MEMBER_REMOVE=Gruppenmitglied entfernen +EVENT_TYPE_SERVER_START_UP=Serverstart + +# Limitierungen +EXCEED_MAX_USER_ORG_COUNT=Entschuldigung, Sie haben die maximale Anzahl an Workspaces erreicht. +EXCEED_MAX_ORG_MEMBER_COUNT=Entschuldigung, dieser Workspace hat die maximale Anzahl an Mitgliedern erreicht. +EXCEED_MAX_GROUP_COUNT=Entschuldigung, dieser Workspace hat die maximale Anzahl an Gruppen erreicht. +EXCEED_MAX_APP_COUNT=Entschuldigung, Sie haben die maximale Anzahl an Anwendungen im aktuellen Workspace erreicht. +EXCEED_MAX_DEVELOPER_COUNT=Entschuldigung, Sie haben die maximale Anzahl an Entwicklern erreicht. + +# Plugin +DUPLICATE_COLUMN=Doppelte Spalten gefunden: {0}, bitte verwenden Sie das Schlüsselwort 'as', um doppelte Spalten umzubenennen. +INVALID_JSON_FROM_RESPONSE=Antwortdaten sind kein gültiges JSON, bitte überprüfen Sie Ihren Content-Type-Header. +REACH_REDIRECT_LIMIT=Maximale Anzahl an HTTP-Weiterleitungen erreicht: {0}. +GOOGLESHEETS_QUERY_PARAM_EMPTY=Google Sheets Abfrageparameter ist leer. +GOOGLESHEETS_QUERY_PARAM_ERROR=Google Sheets Abfrageparameter ist ungültig: {0}. +GOOGLESHEETS_REQUEST_ERROR=Google Sheets Anfrage fehlgeschlagen. +GOOGLESHEETS_DATASOURCE_CONFIG_ERROR=Fehler beim Parsen der Google Sheets Datenquellenkonfiguration. +GOOGLESHEETS_EMPTY_ROW=Keine Daten in dieser Zeile gefunden. Möchten Sie zuerst etwas einfügen? +APPLICATION_EDIT_ERROR_LACK_OF_DATASOURCE_PERMISSIONS=Aktuelle Änderungen an dieser Anwendung werden nicht gespeichert, da Berechtigungen für einige Datenquellen fehlen. +CERTIFICATE_EMPTY=Zertifikat ist leer. +USER_NOT_EXIST=Benutzer existiert nicht. +DUPLICATE_AUTH_CONFIG_ADDITION=Dieser Anbieter wurde bereits zur Organisation hinzugefügt. +EMAIL_PROVIDER_DISABLED=E-Mail-Anbieter ist deaktiviert. +SLUG_DUPLICATE_ENTRY=Slug existiert bereits. +SLUG_INVALID=Slug-Format ist ungültig. +FLOW_ERROR=Flow-Fehlermeldung: {0}. diff --git a/server/api-service/lowcoder-sdk/src/main/resources/locale_en.properties b/server/api-service/lowcoder-sdk/src/main/resources/locale_en.properties index 32b74f755..f72df80a6 100644 --- a/server/api-service/lowcoder-sdk/src/main/resources/locale_en.properties +++ b/server/api-service/lowcoder-sdk/src/main/resources/locale_en.properties @@ -285,4 +285,5 @@ DUPLICATE_AUTH_CONFIG_ADDITION=Provider auth type already added to organization EMAIL_PROVIDER_DISABLED=Email provider is disabled. SLUG_DUPLICATE_ENTRY=Slug already exists SLUG_INVALID=Slug format is invalid -FLOW_ERROR=Flow error message: {0} \ No newline at end of file +FLOW_ERROR=Flow error message: {0} +ORGANIZATION_NOT_FOUND=Organization not found. \ No newline at end of file diff --git a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/application/ApplicationApiServiceImpl.java b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/application/ApplicationApiServiceImpl.java index 5c8e269b9..d249661a4 100644 --- a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/application/ApplicationApiServiceImpl.java +++ b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/application/ApplicationApiServiceImpl.java @@ -9,6 +9,7 @@ import lombok.extern.slf4j.Slf4j; import org.apache.commons.collections4.CollectionUtils; import org.apache.commons.collections4.SetUtils; +import org.apache.commons.lang3.ObjectUtils; import org.apache.commons.lang3.StringUtils; import org.lowcoder.api.application.ApplicationEndpoints.CreateApplicationRequest; import org.lowcoder.api.application.view.ApplicationInfoView; @@ -101,7 +102,7 @@ public class ApplicationApiServiceImpl implements ApplicationApiService { public Mono<ApplicationView> create(CreateApplicationRequest createApplicationRequest) { Application application = new Application(createApplicationRequest.organizationId(), - UuidCreator.getTimeOrderedEpoch().toString(), + ObjectUtils.defaultIfNull(createApplicationRequest.gid(), UuidCreator.getTimeOrderedEpoch().toString()), createApplicationRequest.name(), createApplicationRequest.applicationType(), NORMAL, diff --git a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/application/ApplicationController.java b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/application/ApplicationController.java index 582cb2803..9962783cf 100644 --- a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/application/ApplicationController.java +++ b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/application/ApplicationController.java @@ -4,7 +4,6 @@ import org.lowcoder.api.application.view.*; import org.lowcoder.api.framework.view.PageResponseView; import org.lowcoder.api.framework.view.ResponseView; -import org.lowcoder.api.home.SessionUserService; import org.lowcoder.api.home.UserHomeApiService; import org.lowcoder.api.home.UserHomepageView; import org.lowcoder.api.util.BusinessEventPublisher; @@ -14,7 +13,6 @@ import org.lowcoder.domain.application.model.ApplicationStatus; import org.lowcoder.domain.application.model.ApplicationType; import org.lowcoder.domain.application.service.ApplicationRecordService; -import org.lowcoder.domain.folder.service.FolderElementRelationService; import org.lowcoder.domain.permission.model.ResourceRole; import org.springframework.web.bind.annotation.PathVariable; import org.springframework.web.bind.annotation.RequestBody; @@ -37,7 +35,6 @@ public class ApplicationController implements ApplicationEndpoints { private final UserHomeApiService userHomeApiService; private final ApplicationApiService applicationApiService; private final BusinessEventPublisher businessEventPublisher; - private final SessionUserService sessionUserService; private final GidService gidService; private final ApplicationRecordService applicationRecordService; @@ -152,6 +149,14 @@ public Mono<ResponseView<ApplicationView>> publish(@PathVariable String applicat return newtag; }) .switchIfEmpty(Mono.just("1.0.0")) + .delayUntil(newtag -> { + ApplicationPublishRequest req = Objects.requireNonNullElse(applicationPublishRequest, new ApplicationPublishRequest("", newtag)); + return businessEventPublisher.publishApplicationPublishEvent(appId, req).then(Mono.defer(() -> { + if(newtag.equals(req.tag())) { + return businessEventPublisher.publishApplicationVersionChangeEvent(appId, newtag); + } else return Mono.empty(); + })); + }) .flatMap(newtag -> applicationApiService.publish(appId, Objects.requireNonNullElse(applicationPublishRequest, new ApplicationPublishRequest("", newtag)))) .map(ResponseView::success)); } @@ -221,6 +226,7 @@ public Mono<ResponseView<Boolean>> updatePermission(@PathVariable String applica } return gidService.convertApplicationIdToObjectId(applicationId).flatMap(appId -> applicationApiService.updatePermission(appId, permissionId, role) + .delayUntil(__ -> businessEventPublisher.publishApplicationPermissionEvent(applicationId, null, null, permissionId, role.getValue())) .map(ResponseView::success)); } @@ -230,6 +236,7 @@ public Mono<ResponseView<Boolean>> removePermission( @PathVariable String permissionId) { return gidService.convertApplicationIdToObjectId(applicationId).flatMap(appId -> applicationApiService.removePermission(appId, permissionId) + .delayUntil(__ -> businessEventPublisher.publishApplicationPermissionEvent(applicationId, null, null, permissionId, null)) .map(ResponseView::success)); } @@ -246,6 +253,7 @@ public Mono<ResponseView<Boolean>> grantPermission( emptyIfNull(request.userIds()), emptyIfNull(request.groupIds()), role) + .delayUntil(__ -> businessEventPublisher.publishApplicationPermissionEvent(applicationId, emptyIfNull(request.userIds()), emptyIfNull(request.groupIds()), null, role.getValue())) .map(ResponseView::success)); } @@ -262,6 +270,7 @@ public Mono<ResponseView<Boolean>> setApplicationPublicToAll(@PathVariable Strin @RequestBody ApplicationPublicToAllRequest request) { return gidService.convertApplicationIdToObjectId(applicationId).flatMap(appId -> applicationApiService.setApplicationPublicToAll(appId, request.publicToAll()) + .delayUntil(__ -> businessEventPublisher.publishApplicationSharingEvent(applicationId, "PublicToAll")) .map(ResponseView::success)); } @@ -270,6 +279,7 @@ public Mono<ResponseView<Boolean>> setApplicationPublicToMarketplace(@PathVariab @RequestBody ApplicationPublicToMarketplaceRequest request) { return gidService.convertApplicationIdToObjectId(applicationId).flatMap(appId -> applicationApiService.setApplicationPublicToMarketplace(appId, request) + .delayUntil(__ -> businessEventPublisher.publishApplicationSharingEvent(applicationId, "PublicToMarketplace")) .map(ResponseView::success)); } diff --git a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/application/ApplicationEndpoints.java b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/application/ApplicationEndpoints.java index 93487d953..e24873d69 100644 --- a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/application/ApplicationEndpoints.java +++ b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/application/ApplicationEndpoints.java @@ -298,6 +298,7 @@ public record UpdatePermissionRequest(String role) { } public record CreateApplicationRequest(@JsonProperty("orgId") String organizationId, + @Nullable String gid, String name, Integer applicationType, Map<String, Object> editingApplicationDSL, diff --git a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/authentication/service/AuthenticationApiServiceImpl.java b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/authentication/service/AuthenticationApiServiceImpl.java index df1c9e1d1..3dfb040e3 100644 --- a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/authentication/service/AuthenticationApiServiceImpl.java +++ b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/authentication/service/AuthenticationApiServiceImpl.java @@ -32,8 +32,11 @@ import org.lowcoder.domain.user.service.UserService; import org.lowcoder.sdk.auth.AbstractAuthConfig; import org.lowcoder.sdk.config.AuthProperties; +import org.lowcoder.sdk.config.CommonConfig; +import org.lowcoder.sdk.constants.WorkspaceMode; import org.lowcoder.sdk.exception.BizError; import org.lowcoder.sdk.exception.BizException; +import org.lowcoder.sdk.models.HasIdAndAuditing; import org.lowcoder.sdk.util.CookieHelper; import org.springframework.security.core.context.ReactiveSecurityContextHolder; import org.springframework.stereotype.Service; @@ -69,6 +72,7 @@ public class AuthenticationApiServiceImpl implements AuthenticationApiService { private final OrgMemberService orgMemberService; private final JWTUtils jwtUtils; private final AuthProperties authProperties; + private final CommonConfig commonConfig; @Override public Mono<AuthUser> authenticateByForm(String loginId, String password, String source, boolean register, String authId, String orgId) { @@ -238,10 +242,16 @@ public Mono<Void> onUserRegister(User user, boolean isSuperAdmin) { } protected Mono<Void> onUserLogin(String orgId, User user, String source) { - if (StringUtils.isEmpty(orgId)) { - return Mono.empty(); + Mono<String> orgMono; + if(commonConfig.getWorkspace().getMode() == WorkspaceMode.ENTERPRISE) { + orgMono = organizationService.getOrganizationInEnterpriseMode().map(HasIdAndAuditing::getId); + } else { + if (StringUtils.isEmpty(orgId)) { + return Mono.empty(); + } + orgMono = Mono.just(orgId); } - return orgApiService.tryAddUserToOrgAndSwitchOrg(orgId, user.getId()).then(); + return orgMono.flatMap(orgId2 -> orgApiService.tryAddUserToOrgAndSwitchOrg(orgId2, user.getId())).then(); } @Override diff --git a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/datasource/UpsertDatasourceRequestMapper.java b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/datasource/UpsertDatasourceRequestMapper.java index c6913479b..48a6b3ade 100644 --- a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/datasource/UpsertDatasourceRequestMapper.java +++ b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/datasource/UpsertDatasourceRequestMapper.java @@ -34,6 +34,7 @@ public Datasource resolve(UpsertDatasourceRequest dto) { Datasource datasource = new Datasource(); datasource.setId(dto.getId()); + datasource.setGid(dto.getGid()); datasource.setName(dto.getName()); datasource.setType(dto.getType()); datasource.setOrganizationId(dto.getOrganizationId()); diff --git a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/framework/filter/ApiEventFilter.java b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/framework/filter/ApiEventFilter.java index e8b75f8c3..dc084c129 100644 --- a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/framework/filter/ApiEventFilter.java +++ b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/framework/filter/ApiEventFilter.java @@ -1,3 +1,4 @@ + package org.lowcoder.api.framework.filter; import com.google.common.hash.Hashing; @@ -17,6 +18,7 @@ import org.springframework.web.server.WebFilterChain; import reactor.core.publisher.Mono; import reactor.core.scheduler.Schedulers; +import reactor.util.context.ContextView; import java.nio.charset.StandardCharsets; import java.util.Optional; @@ -40,7 +42,7 @@ public Mono<Void> filter(ServerWebExchange exchange, WebFilterChain chain) { String token = contextView.get(VISITOR_TOKEN); ((Mono<OrgMember>) contextView.get(CURRENT_ORG_MEMBER)) .flatMap(orgMember -> { - emitEvent(exchange.getRequest(), token, orgMember); + emitEvent(exchange.getRequest(), token, orgMember, contextView); return Mono.empty(); }) .subscribeOn(Schedulers.boundedElastic()) @@ -51,7 +53,7 @@ public Mono<Void> filter(ServerWebExchange exchange, WebFilterChain chain) { ); } - private void emitEvent(ServerHttpRequest request, String token, OrgMember orgMember) { + private void emitEvent(ServerHttpRequest request, String token, OrgMember orgMember, ContextView contextView) { MultiValueMap<String, String> headers = writableHttpHeaders(request.getHeaders()); headers.remove("Cookie"); Optional<String> ipAddressOptional = headers.remove("X-Real-IP").stream().findFirst(); @@ -69,7 +71,7 @@ private void emitEvent(ServerHttpRequest request, String token, OrgMember orgMem .queryParams(request.getQueryParams()) .ipAddress(ipAddress) .build(); - event.populateDetails(); + event.populateDetails(contextView); log.debug("API call event emitted for '{}' from org '{}' on URI: {}", orgMember.getUserId(), orgMember.getUserId(), request.getURI().getPath()); applicationEventPublisher.publishEvent(event); diff --git a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/framework/filter/GlobalContextFilter.java b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/framework/filter/GlobalContextFilter.java index f2ab85ca7..fe00a0065 100644 --- a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/framework/filter/GlobalContextFilter.java +++ b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/framework/filter/GlobalContextFilter.java @@ -16,6 +16,7 @@ import org.springframework.http.HttpMethod; import org.springframework.http.server.reactive.ServerHttpRequest; import org.springframework.stereotype.Component; +import org.springframework.util.MultiValueMap; import org.springframework.web.server.ServerWebExchange; import org.springframework.web.server.WebFilter; import org.springframework.web.server.WebFilterChain; @@ -32,6 +33,7 @@ import static org.lowcoder.sdk.constants.Authentication.isAnonymousUser; import static org.lowcoder.sdk.constants.GlobalContext.*; import static org.lowcoder.sdk.util.IDUtils.generate; +import static org.springframework.http.HttpHeaders.writableHttpHeaders; @Component @RequiredArgsConstructor @@ -107,6 +109,11 @@ private Map<String, Object> buildContextMap(ServerWebExchange serverWebExchange, contextMap.put(CURRENT_ORG_MEMBER, orgMemberService.getCurrentOrgMember(visitorId).cache()); contextMap.put(VISITOR_TOKEN, cookieHelper.getCookieToken(serverWebExchange)); contextMap.put(DOMAIN, UriUtils.getRefererDomainFromRequest(serverWebExchange)); + + //Analytics related fields + MultiValueMap<String, String> headers = writableHttpHeaders(request.getHeaders()); + headers.remove("Cookie"); + contextMap.put(HEADERS, headers); return contextMap; } diff --git a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/framework/security/SecurityConfig.java b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/framework/security/SecurityConfig.java index 75c253134..3c3059710 100644 --- a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/framework/security/SecurityConfig.java +++ b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/framework/security/SecurityConfig.java @@ -112,6 +112,7 @@ SecurityWebFilterChain securityWebFilterChain(ServerHttpSecurity http) { ServerWebExchangeMatchers.pathMatchers(HttpMethod.GET, ORGANIZATION_URL + "/*/datasourceTypes"), // datasource types ServerWebExchangeMatchers.pathMatchers(HttpMethod.GET, ORGANIZATION_URL + "/byuser/*"), ServerWebExchangeMatchers.pathMatchers(HttpMethod.GET, DATASOURCE_URL + "/jsDatasourcePlugins"), + ServerWebExchangeMatchers.pathMatchers(HttpMethod.POST, META_URL + "/"), ServerWebExchangeMatchers.pathMatchers(HttpMethod.GET, GITHUB_STAR), @@ -145,6 +146,7 @@ SecurityWebFilterChain securityWebFilterChain(ServerHttpSecurity http) { ServerWebExchangeMatchers.pathMatchers(HttpMethod.GET, NewUrl.ORGANIZATION_URL + "/*/datasourceTypes"), // datasource types ServerWebExchangeMatchers.pathMatchers(HttpMethod.GET, NewUrl.ORGANIZATION_URL + "/byuser/*"), ServerWebExchangeMatchers.pathMatchers(HttpMethod.GET, NewUrl.DATASOURCE_URL + "/jsDatasourcePlugins"), + ServerWebExchangeMatchers.pathMatchers(HttpMethod.POST, NewUrl.META_URL + "/"), ServerWebExchangeMatchers.pathMatchers(HttpMethod.GET, NewUrl.NPM_REGISTRY + "/**"), ServerWebExchangeMatchers.pathMatchers(HttpMethod.GET, "/api/docs/**") ) diff --git a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/meta/MetaController.java b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/meta/MetaController.java new file mode 100644 index 000000000..90e63f0b0 --- /dev/null +++ b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/meta/MetaController.java @@ -0,0 +1,75 @@ +package org.lowcoder.api.meta; + +import lombok.RequiredArgsConstructor; +import org.lowcoder.api.application.ApplicationApiService; +import org.lowcoder.api.framework.view.ResponseView; +import org.lowcoder.api.meta.view.*; +import org.lowcoder.domain.application.model.Application; +import org.lowcoder.domain.application.service.ApplicationRecordService; +import org.lowcoder.domain.application.service.ApplicationServiceImpl; +import org.lowcoder.domain.bundle.model.Bundle; +import org.lowcoder.domain.bundle.service.BundleServiceImpl; +import org.lowcoder.domain.datasource.model.Datasource; +import org.lowcoder.domain.datasource.service.impl.DatasourceServiceImpl; +import org.lowcoder.domain.folder.model.Folder; +import org.lowcoder.domain.folder.service.FolderServiceImpl; +import org.lowcoder.domain.group.model.Group; +import org.lowcoder.domain.group.service.GroupServiceImpl; +import org.lowcoder.domain.organization.model.Organization; +import org.lowcoder.domain.organization.service.OrganizationServiceImpl; +import org.lowcoder.domain.query.model.LibraryQuery; +import org.lowcoder.domain.query.service.LibraryQueryServiceImpl; +import org.lowcoder.domain.user.model.User; +import org.lowcoder.domain.user.service.UserServiceImpl; +import org.lowcoder.sdk.util.LocaleUtils; +import org.springframework.web.bind.annotation.RequestBody; +import org.springframework.web.bind.annotation.RestController; +import reactor.core.publisher.Flux; +import reactor.core.publisher.Mono; + +@RequiredArgsConstructor +@RestController +public class MetaController implements MetaEndpoints { + private final ApplicationApiService applicationApiService; + private final ApplicationServiceImpl applicationServiceImpl; + private final UserServiceImpl userServiceImpl; + private final OrganizationServiceImpl organizationServiceImpl; + private final FolderServiceImpl folderServiceImpl; + private final DatasourceServiceImpl datasourceServiceImpl; + private final BundleServiceImpl bundleServiceImpl; + private final GroupServiceImpl groupServiceImpl; + private final LibraryQueryServiceImpl libraryQueryServiceImpl; + private final ApplicationRecordService applicationRecordService; + + @Override + public Mono<ResponseView<MetaView>> getMetaData(@RequestBody GetMetaDataRequest param) { + Flux<ApplicationMetaView> appsFlux = applicationServiceImpl.findByIdIn(param.appIds()).flatMap(app -> ApplicationMetaView.of(app, applicationRecordService)); + Flux<UserMetaView> usersFlux = userServiceImpl.getByIds(param.userIds()).flatMapMany(map -> Flux.fromIterable(map.values())).map(UserMetaView::of); + Flux<OrgMetaView> orgsFlux = organizationServiceImpl.getByIds(param.orgIds()).map(OrgMetaView::of); + Flux<FolderMetaView> foldersFlux = folderServiceImpl.findByIds(param.folderIds()).map(FolderMetaView::of); + Flux<DatasourceMetaView> datasourcesFlux = datasourceServiceImpl.getByIds(param.datasourceIds()).map(DatasourceMetaView::of); + Flux<BundleMetaView> bundlesFlux = bundleServiceImpl.findByIdIn(param.bundleIds()).map(BundleMetaView::of); + Flux<GroupMetaView> groupsFlux = Flux.deferContextual(contextView -> groupServiceImpl.getByIds(param.groupIds()).map(group -> GroupMetaView.of(group, LocaleUtils.getLocale(contextView)))); + Flux<LibraryQueryMetaView> queriesFlux = libraryQueryServiceImpl.getByIds(param.libraryQueryIds()).map(LibraryQueryMetaView::of); + return Mono.zip( + appsFlux.collectList(), + usersFlux.collectList(), + orgsFlux.collectList(), + foldersFlux.collectList(), + datasourcesFlux.collectList(), + bundlesFlux.collectList(), + groupsFlux.collectList(), + queriesFlux.collectList() + ).map(tuple -> MetaView.builder() + .apps(tuple.getT1()) + .users(tuple.getT2()) + .orgs(tuple.getT3()) + .folders(tuple.getT4()) + .datasources(tuple.getT5()) + .bundles(tuple.getT6()) + .groups(tuple.getT7()) + .queries(tuple.getT8()) + .build()) + .map(ResponseView::success); + } +} diff --git a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/meta/MetaEndpoints.java b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/meta/MetaEndpoints.java new file mode 100644 index 000000000..ba6affa40 --- /dev/null +++ b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/meta/MetaEndpoints.java @@ -0,0 +1,36 @@ +package org.lowcoder.api.meta; + +import io.swagger.v3.oas.annotations.Operation; +import org.lowcoder.api.framework.view.ResponseView; +import org.lowcoder.api.meta.view.MetaView; +import org.lowcoder.infra.constant.NewUrl; +import org.lowcoder.infra.constant.Url; +import org.springframework.web.bind.annotation.*; +import reactor.core.publisher.Mono; + +import java.util.List; + +@RestController +@RequestMapping(value = {Url.META_URL, NewUrl.META_URL}) +public interface MetaEndpoints +{ + public static final String TAG_META_MANAGEMENT = "Meta APIs"; + + @Operation( + tags = TAG_META_MANAGEMENT, + operationId = "getMetaData", + summary = "Get metadata by ids", + description = "Get all metadatas by ids" + ) + @PostMapping("/") + public Mono<ResponseView<MetaView>> getMetaData(@RequestBody GetMetaDataRequest param); + + public record GetMetaDataRequest(List<String> appIds, + List<String> orgIds, + List<String> userIds, + List<String> groupIds, + List<String> bundleIds, + List<String> datasourceIds, + List<String> folderIds, + List<String> libraryQueryIds) {} +} diff --git a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/meta/view/ApplicationMetaView.java b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/meta/view/ApplicationMetaView.java new file mode 100644 index 000000000..55fed483d --- /dev/null +++ b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/meta/view/ApplicationMetaView.java @@ -0,0 +1,33 @@ +package org.lowcoder.api.meta.view; + +import lombok.Getter; +import lombok.experimental.SuperBuilder; +import org.lowcoder.domain.application.model.Application; +import org.lowcoder.domain.application.service.ApplicationRecordService; +import reactor.core.publisher.Mono; + +@SuperBuilder +@Getter +public class ApplicationMetaView { + private String id; + private String name; + private String title; + private String description; + private String category; + private String icon; + + public static Mono<ApplicationMetaView> of(Application app, ApplicationRecordService applicationRecordService) { + return Mono.zip(app.getTitle(applicationRecordService), + app.getDescription(applicationRecordService), + app.getCategory(applicationRecordService), + app.getIcon(applicationRecordService)).map(tuple -> + ApplicationMetaView.builder() + .id(app.getId()) + .name(app.getName()) + .title(tuple.getT1()) + .description(tuple.getT2()) + .category(tuple.getT3()) + .icon(tuple.getT4()) + .build()); + } +} diff --git a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/meta/view/BundleMetaView.java b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/meta/view/BundleMetaView.java new file mode 100644 index 000000000..41bc381db --- /dev/null +++ b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/meta/view/BundleMetaView.java @@ -0,0 +1,19 @@ +package org.lowcoder.api.meta.view; + +import lombok.Getter; +import lombok.experimental.SuperBuilder; +import org.lowcoder.domain.bundle.model.Bundle; + +@SuperBuilder +@Getter +public class BundleMetaView { + private String id; + private String name; + + public static BundleMetaView of(Bundle bundle) { + return BundleMetaView.builder() + .id(bundle.getId()) + .name(bundle.getName()) + .build(); + } +} diff --git a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/meta/view/DatasourceMetaView.java b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/meta/view/DatasourceMetaView.java new file mode 100644 index 000000000..353da271a --- /dev/null +++ b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/meta/view/DatasourceMetaView.java @@ -0,0 +1,19 @@ +package org.lowcoder.api.meta.view; + +import lombok.Getter; +import lombok.experimental.SuperBuilder; +import org.lowcoder.domain.datasource.model.Datasource; + +@SuperBuilder +@Getter +public class DatasourceMetaView { + private String id; + private String name; + + public static DatasourceMetaView of(Datasource datasource) { + return DatasourceMetaView.builder() + .id(datasource.getId()) + .name(datasource.getName()) + .build(); + } +} diff --git a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/meta/view/FolderMetaView.java b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/meta/view/FolderMetaView.java new file mode 100644 index 000000000..863634eaa --- /dev/null +++ b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/meta/view/FolderMetaView.java @@ -0,0 +1,19 @@ +package org.lowcoder.api.meta.view; + +import lombok.Getter; +import lombok.experimental.SuperBuilder; +import org.lowcoder.domain.folder.model.Folder; + +@SuperBuilder +@Getter +public class FolderMetaView { + private String id; + private String name; + + public static FolderMetaView of(Folder folder) { + return FolderMetaView.builder() + .id(folder.getId()) + .name(folder.getName()) + .build(); + } +} diff --git a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/meta/view/GroupMetaView.java b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/meta/view/GroupMetaView.java new file mode 100644 index 000000000..37951e54b --- /dev/null +++ b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/meta/view/GroupMetaView.java @@ -0,0 +1,21 @@ +package org.lowcoder.api.meta.view; + +import lombok.Getter; +import lombok.experimental.SuperBuilder; +import org.lowcoder.domain.group.model.Group; + +import java.util.Locale; + +@SuperBuilder +@Getter +public class GroupMetaView { + private String id; + private String name; + + public static GroupMetaView of(Group group, Locale locale) { + return GroupMetaView.builder() + .id(group.getId()) + .name(group.getName(locale)) + .build(); + } +} diff --git a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/meta/view/LibraryQueryMetaView.java b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/meta/view/LibraryQueryMetaView.java new file mode 100644 index 000000000..2b3a2b36f --- /dev/null +++ b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/meta/view/LibraryQueryMetaView.java @@ -0,0 +1,19 @@ +package org.lowcoder.api.meta.view; + +import lombok.Getter; +import lombok.experimental.SuperBuilder; +import org.lowcoder.domain.query.model.LibraryQuery; + +@SuperBuilder +@Getter +public class LibraryQueryMetaView { + private String id; + private String name; + + public static LibraryQueryMetaView of(LibraryQuery libraryQuery) { + return LibraryQueryMetaView.builder() + .id(libraryQuery.getId()) + .name(libraryQuery.getName()) + .build(); + } +} diff --git a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/meta/view/MetaView.java b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/meta/view/MetaView.java new file mode 100644 index 000000000..cc21b5ed8 --- /dev/null +++ b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/meta/view/MetaView.java @@ -0,0 +1,19 @@ +package org.lowcoder.api.meta.view; + +import lombok.Builder; +import lombok.Getter; + +import java.util.List; + +@Builder +@Getter +public class MetaView { + private final List<ApplicationMetaView> apps; + private final List<UserMetaView> users; + private final List<OrgMetaView> orgs; + private final List<FolderMetaView> folders; + private final List<DatasourceMetaView> datasources; + private final List<BundleMetaView> bundles; + private final List<GroupMetaView> groups; + private final List<LibraryQueryMetaView> queries; +} diff --git a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/meta/view/OrgMetaView.java b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/meta/view/OrgMetaView.java new file mode 100644 index 000000000..8842efea6 --- /dev/null +++ b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/meta/view/OrgMetaView.java @@ -0,0 +1,19 @@ +package org.lowcoder.api.meta.view; + +import lombok.Getter; +import lombok.experimental.SuperBuilder; +import org.lowcoder.domain.organization.model.Organization; + +@SuperBuilder +@Getter +public class OrgMetaView { + private String id; + private String name; + + public static OrgMetaView of(Organization user) { + return OrgMetaView.builder() + .id(user.getId()) + .name(user.getName()) + .build(); + } +} diff --git a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/meta/view/UserMetaView.java b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/meta/view/UserMetaView.java new file mode 100644 index 000000000..d9d462cd0 --- /dev/null +++ b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/meta/view/UserMetaView.java @@ -0,0 +1,21 @@ +package org.lowcoder.api.meta.view; + +import lombok.Getter; +import lombok.experimental.SuperBuilder; +import org.lowcoder.domain.user.model.User; + +@SuperBuilder +@Getter +public class UserMetaView { + private String id; + private String name; + private String email; + + public static UserMetaView of(User user) { + return UserMetaView.builder() + .id(user.getId()) + .name(user.getName()) + .email(user.getEmail()) + .build(); + } +} diff --git a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/query/LibraryQueryApiService.java b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/query/LibraryQueryApiService.java index 19f5a50fb..5cdd4717d 100644 --- a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/query/LibraryQueryApiService.java +++ b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/query/LibraryQueryApiService.java @@ -11,6 +11,8 @@ public interface LibraryQueryApiService { Mono<List<LibraryQueryView>> listLibraryQueries(String name); + Mono<LibraryQueryView> get(String libraryQueryId); + Mono<LibraryQueryView> create(LibraryQuery libraryQuery); Mono<Boolean> update(String libraryQueryId, UpsertLibraryQueryRequest upsertLibraryQueryRequest); diff --git a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/query/LibraryQueryApiServiceImpl.java b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/query/LibraryQueryApiServiceImpl.java index 69c5c3f8f..86846e04d 100644 --- a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/query/LibraryQueryApiServiceImpl.java +++ b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/query/LibraryQueryApiServiceImpl.java @@ -113,6 +113,13 @@ private Flux<LibraryQuery> getByOrgIdWithDatasourcePermissions(String orgId) { set -> set.contains(libraryQuery.getQuery().getDatasourceId()))); } + @Override + public Mono<LibraryQueryView> get(String libraryQueryId) { + return libraryQueryService.getById(libraryQueryId) + .zipWhen(lb -> userService.findById(lb.getCreatedBy())) + .map(tuple -> LibraryQueryView.from(tuple.getT1(), tuple.getT2())); + } + @Override public Mono<LibraryQueryView> create(LibraryQuery libraryQuery) { return checkLibraryQueryManagementPermission(libraryQuery) diff --git a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/query/LibraryQueryController.java b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/query/LibraryQueryController.java index d1e3bc2f5..62e869a18 100644 --- a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/query/LibraryQueryController.java +++ b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/query/LibraryQueryController.java @@ -53,6 +53,12 @@ public Mono<PageResponseView<?>> list(@RequestParam(required = false, defaultVal return fluxToPageResponseView(pageNum, pageSize, flux); } + @Override + public Mono<ResponseView<LibraryQueryView>> get(@PathVariable String libraryQueryId) { + return libraryQueryApiService.get(libraryQueryId) + .map(ResponseView::success); + } + @Override public Mono<ResponseView<LibraryQueryView>> create(@RequestBody LibraryQuery libraryQuery) { return libraryQueryApiService.create(libraryQuery) diff --git a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/query/LibraryQueryEndpoints.java b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/query/LibraryQueryEndpoints.java index bf4b8f161..14c54f014 100644 --- a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/query/LibraryQueryEndpoints.java +++ b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/query/LibraryQueryEndpoints.java @@ -43,6 +43,15 @@ public Mono<PageResponseView<?>> list(@RequestParam(required = false, defaultVal @RequestParam(required = false, defaultValue = "1") int pageNum, @RequestParam(required = false, defaultValue = "100") int pageSize); + @Operation( + tags = TAG_LIBRARY_QUERY_MANAGEMENT, + operationId = "getLibraryQuery", + summary = "Get a Library By Id", + description = "Get a Library Query by Id." + ) + @GetMapping("/{libraryQueryId}") + public Mono<ResponseView<LibraryQueryView>> get(@PathVariable String libraryQueryId); + @Operation( tags = TAG_LIBRARY_QUERY_MANAGEMENT, operationId = "createLibraryQuery", diff --git a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/usermanagement/OrganizationController.java b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/usermanagement/OrganizationController.java index 3863eaa2e..c1d83af59 100644 --- a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/usermanagement/OrganizationController.java +++ b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/usermanagement/OrganizationController.java @@ -19,10 +19,15 @@ import org.lowcoder.domain.plugin.DatasourceMetaInfo; import org.lowcoder.domain.plugin.service.DatasourceMetaInfoService; import org.lowcoder.domain.user.service.UserService; +import org.lowcoder.sdk.config.CommonConfig; +import org.lowcoder.sdk.constants.WorkspaceMode; +import org.lowcoder.sdk.exception.BizError; +import org.lowcoder.sdk.exception.BizException; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.http.codec.multipart.Part; import org.springframework.web.bind.annotation.*; import org.springframework.web.server.ServerWebExchange; +import reactor.core.publisher.Flux; import reactor.core.publisher.Mono; import java.util.List; @@ -47,14 +52,21 @@ public class OrganizationController implements OrganizationEndpoints private OrganizationService organizationService; @Autowired private UserService userService; + @Autowired + private CommonConfig commonConfig; @Override public Mono<PageResponseView<?>> getOrganizationByUser(@PathVariable String email, @RequestParam(required = false, defaultValue = "1") Integer pageNum, @RequestParam(required = false, defaultValue = "0") Integer pageSize) { - var flux = userService.findByEmailDeep(email).flux().flatMap(user -> orgMemberService.getAllActiveOrgs(user.getId())) - .flatMap(orgMember -> organizationService.getById(orgMember.getOrgId())) - .map(OrgView::new).cache(); + Flux<?> flux; + if (commonConfig.getWorkspace().getMode() == WorkspaceMode.SAAS) { + flux = userService.findByEmailDeep(email).flux().flatMap(user -> orgMemberService.getAllActiveOrgs(user.getId())) + .flatMap(orgMember -> organizationService.getById(orgMember.getOrgId())) + .map(OrgView::new).cache(); + } else { + flux = organizationService.getOrganizationInEnterpriseMode().flux().cache(); + } return fluxToPageResponseView(pageNum, pageSize, flux); } @@ -172,4 +184,12 @@ public Mono<ResponseView<Organization>> updateSlug(@PathVariable String orgId, @ .map(ResponseView::success); } -} \ No newline at end of file + @Override + public Mono<ResponseView<Organization>> getOrganization(@PathVariable String orgId) { + return gidService.convertOrganizationIdToObjectId(orgId) + .flatMap(id -> organizationService.getById(id)) + .switchIfEmpty(Mono.error(new BizException(BizError.ORGANIZATION_NOT_FOUND, "ORGANIZATION_NOT_FOUND"))) + .map(ResponseView::success); + } + +} diff --git a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/usermanagement/OrganizationEndpoints.java b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/usermanagement/OrganizationEndpoints.java index b1547da93..68bfc9784 100644 --- a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/usermanagement/OrganizationEndpoints.java +++ b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/usermanagement/OrganizationEndpoints.java @@ -184,6 +184,15 @@ public Mono<ResponseView<Boolean>> removeUserFromOrg(@PathVariable String orgId, @PutMapping("/{orgId}/slug") Mono<ResponseView<Organization>> updateSlug(@PathVariable String orgId, @RequestBody String slug); + @Operation( + tags = TAG_ORGANIZATION_MANAGEMENT, + operationId = "getOrganization", + summary = "Get Organization by ID", + description = "Retrieve details of a specific Organization within Lowcoder using its unique ID." + ) + @GetMapping("/{orgId}") + public Mono<ResponseView<Organization>> getOrganization(@PathVariable String orgId); + public record UpdateOrgCommonSettingsRequest(String key, Object value) { } diff --git a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/util/ApiCallEventPublisher.java b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/util/ApiCallEventPublisher.java index 590c8c7a8..42e8a7e27 100644 --- a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/util/ApiCallEventPublisher.java +++ b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/util/ApiCallEventPublisher.java @@ -48,19 +48,20 @@ public void deleteMapping(){} @Pointcut("@annotation(org.springframework.web.bind.annotation.PatchMapping)") public void patchMapping(){} + @SuppressWarnings("unchecked") @Around("(getMapping() || postMapping() || putMapping() || deleteMapping() || patchMapping())") public Object handleAPICallEvent(ProceedingJoinPoint joinPoint) throws Throwable { return sessionUserService.getVisitorToken() .zipWith(sessionUserService.getVisitorOrgMemberCacheSilent().defaultIfEmpty(OrgMember.NOT_EXIST)) .zipWith(ReactiveRequestContextHolder.getRequest()) - .doOnNext( + .delayUntil( tuple -> { String token = tuple.getT1().getT1(); OrgMember orgMember = tuple.getT1().getT2(); ServerHttpRequest request = tuple.getT2(); if (orgMember == OrgMember.NOT_EXIST) { - return; + return Mono.empty(); } MultiValueMap<String, String> headers = writableHttpHeaders(request.getHeaders()); headers.remove("Cookie"); @@ -77,8 +78,11 @@ public Object handleAPICallEvent(ProceedingJoinPoint joinPoint) throws Throwable .queryParams(request.getQueryParams()) .ipAddress(ipAddress) .build(); - event.populateDetails(); - applicationEventPublisher.publishEvent(event); + return Mono.deferContextual(contextView -> { + event.populateDetails(contextView); + applicationEventPublisher.publishEvent(event); + return Mono.empty(); + }); }) .onErrorResume(throwable -> { log.error("handleAPICallEvent error {} for: {} ", joinPoint.getSignature().getName(), EventType.API_CALL_EVENT, throwable); @@ -87,4 +91,4 @@ public Object handleAPICallEvent(ProceedingJoinPoint joinPoint) throws Throwable .then((Mono) joinPoint.proceed()); } -} +} \ No newline at end of file diff --git a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/util/BusinessEventPublisher.java b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/util/BusinessEventPublisher.java index fe3119d32..69af10325 100644 --- a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/util/BusinessEventPublisher.java +++ b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/util/BusinessEventPublisher.java @@ -7,10 +7,12 @@ import org.apache.commons.lang3.StringUtils; import org.apache.commons.lang3.tuple.Pair; import org.lowcoder.api.application.view.ApplicationInfoView; +import org.lowcoder.api.application.view.ApplicationPublishRequest; import org.lowcoder.api.application.view.ApplicationView; import org.lowcoder.api.home.SessionUserService; import org.lowcoder.api.usermanagement.view.AddMemberRequest; import org.lowcoder.api.usermanagement.view.UpdateRoleRequest; +import org.lowcoder.domain.application.model.Application; import org.lowcoder.domain.application.service.ApplicationRecordServiceImpl; import org.lowcoder.domain.application.service.ApplicationService; import org.lowcoder.domain.datasource.model.Datasource; @@ -74,7 +76,7 @@ public Mono<Void> publishFolderCommonEvent(String folderId, String folderName, E return sessionUserService.getVisitorToken() .zipWith(sessionUserService.getVisitorOrgMemberCache()) - .doOnNext( + .delayUntil( tuple -> { String token = tuple.getT1(); OrgMember orgMember = tuple.getT2(); @@ -87,8 +89,11 @@ public Mono<Void> publishFolderCommonEvent(String folderId, String folderName, E .isAnonymous(Authentication.isAnonymousUser(orgMember.getUserId())) .sessionHash(Hashing.sha512().hashString(token, StandardCharsets.UTF_8).toString()) .build(); - event.populateDetails(); - applicationEventPublisher.publishEvent(event); + return Mono.deferContextual(contextView -> { + event.populateDetails(contextView); + applicationEventPublisher.publishEvent(event); + return Mono.empty(); + }); }) .then() .onErrorResume(throwable -> { @@ -124,7 +129,7 @@ public Mono<Void> publishApplicationCommonEvent(ApplicationView applicationView, .zipWith(Mono.defer(() -> { String folderId = applicationView.getApplicationInfoView().getFolderId(); if (StringUtils.isBlank(folderId)) { - return Mono.just(Optional.<Folder> empty()); + return Mono.just(Optional.<Folder>empty()); } return folderService.findById(folderId) .map(Optional::of) @@ -133,7 +138,7 @@ public Mono<Void> publishApplicationCommonEvent(ApplicationView applicationView, .zipWith(Mono.defer(() -> { String folderId = applicationView.getApplicationInfoView().getFolderIdFrom(); if (StringUtils.isBlank(folderId)) { - return Mono.just(Optional.<Folder> empty()); + return Mono.just(Optional.<Folder>empty()); } return folderService.findById(folderId) .map(Optional::of) @@ -151,7 +156,7 @@ public Mono<Void> publishApplicationCommonEvent(ApplicationView applicationView, return Pair.of(category, description); }); }), TupleUtils::merge) - .doOnNext(tuple -> { + .flatMap(tuple -> Mono.deferContextual(contextView -> { OrgMember orgMember = tuple.getT1().getT1(); Optional<Folder> optional = tuple.getT1().getT2(); Optional<Folder> optionalFrom = tuple.getT1().getT3(); @@ -159,6 +164,7 @@ public Mono<Void> publishApplicationCommonEvent(ApplicationView applicationView, String category = tuple.getT3().getLeft(); String description = tuple.getT3().getRight(); ApplicationInfoView applicationInfoView = applicationView.getApplicationInfoView(); + ApplicationCommonEvent event = ApplicationCommonEvent.builder() .orgId(orgMember.getOrgId()) .userId(orgMember.getUserId()) @@ -175,20 +181,210 @@ public Mono<Void> publishApplicationCommonEvent(ApplicationView applicationView, .isAnonymous(anonymous) .sessionHash(Hashing.sha512().hashString(token, StandardCharsets.UTF_8).toString()) .build(); - event.populateDetails(); + + event.populateDetails(contextView); applicationEventPublisher.publishEvent(event); - }) - .then() + return Mono.empty(); + })).then() // **Ensures Mono<Void> return type** .onErrorResume(throwable -> { log.error("publishApplicationCommonEvent error. {}, {}", applicationView, eventType, throwable); return Mono.empty(); }); }); } + + + public Mono<Void> publishApplicationPermissionEvent(String applicationId, Set<String> userIds, Set<String> groupIds, String permissionId, String role) { + return sessionUserService.isAnonymousUser() + .flatMap(anonymous -> { + if (anonymous) { + return Mono.empty(); + } + return sessionUserService.getVisitorOrgMemberCache() + .zipWith(sessionUserService.getVisitorToken()) + .zipWith(applicationService.findById(applicationId) + .zipWhen(application -> application.getCategory(applicationRecordServiceImpl)) + .zipWhen(application -> application.getT1().getDescription(applicationRecordServiceImpl))) + .flatMap(tuple -> { + OrgMember orgMember = tuple.getT1().getT1(); + String token = tuple.getT1().getT2(); + String category = tuple.getT2().getT1().getT2(); + String description = tuple.getT2().getT2(); + Application application = tuple.getT2().getT1().getT1(); + + ApplicationCommonEvent event = ApplicationCommonEvent.builder() + .orgId(orgMember.getOrgId()) + .userId(orgMember.getUserId()) + .applicationId(application.getId()) + .applicationGid(application.getGid()) + .applicationName(application.getName()) + .applicationCategory(category) + .applicationDescription(description) + .type(EventType.APPLICATION_PERMISSION_CHANGE) + .permissionId(permissionId) + .role(role) + .userIds(userIds) + .groupIds(groupIds) + .isAnonymous(anonymous) + .sessionHash(Hashing.sha512().hashString(token, StandardCharsets.UTF_8).toString()) + .build(); + + return Mono.deferContextual(contextView -> { + event.populateDetails(contextView); + applicationEventPublisher.publishEvent(event); + return Mono.empty(); + }).then(); // **Fix: Ensures Mono<Void> is returned** + }); + }) + .onErrorResume(throwable -> { + log.error("publishApplicationPermissionEvent error. {}, {}, {}", applicationId, permissionId, role, throwable); + return Mono.empty(); + }); + } + + + public Mono<Void> publishApplicationSharingEvent(String applicationId, String shareType) { + return sessionUserService.isAnonymousUser() + .flatMap(anonymous -> { + if (anonymous) { + return Mono.empty(); + } + return sessionUserService.getVisitorOrgMemberCache() + .zipWith(sessionUserService.getVisitorToken()) + .zipWith(applicationService.findById(applicationId) + .zipWhen(application -> application.getCategory(applicationRecordServiceImpl)) + .zipWhen(application -> application.getT1().getDescription(applicationRecordServiceImpl))) + .flatMap(tuple -> { + OrgMember orgMember = tuple.getT1().getT1(); + String token = tuple.getT1().getT2(); + String category = tuple.getT2().getT1().getT2(); + String description = tuple.getT2().getT2(); + Application application = tuple.getT2().getT1().getT1(); + + ApplicationCommonEvent event = ApplicationCommonEvent.builder() + .orgId(orgMember.getOrgId()) + .userId(orgMember.getUserId()) + .applicationId(application.getId()) + .applicationGid(application.getGid()) + .applicationName(application.getName()) + .applicationCategory(category) + .applicationDescription(description) + .type(EventType.APPLICATION_SHARING_CHANGE) + .shareType(shareType) + .isAnonymous(anonymous) + .sessionHash(Hashing.sha512().hashString(token, StandardCharsets.UTF_8).toString()) + .build(); + + return Mono.deferContextual(contextView -> { + event.populateDetails(contextView); + applicationEventPublisher.publishEvent(event); + return Mono.empty(); + }).then(); // **Fix: Ensures Mono<Void> is returned** + }); + }) + .onErrorResume(throwable -> { + log.error("publishApplicationSharingEvent error. {}, {}", applicationId, shareType, throwable); + return Mono.empty(); + }); + } + + + public Mono<Void> publishApplicationPublishEvent(String applicationId, ApplicationPublishRequest request) { + return sessionUserService.isAnonymousUser() + .flatMap(anonymous -> { + if (anonymous) { + return Mono.empty(); + } + return sessionUserService.getVisitorOrgMemberCache() + .zipWith(sessionUserService.getVisitorToken()) + .zipWith(applicationService.findById(applicationId) + .zipWhen(application -> application.getCategory(applicationRecordServiceImpl)) + .zipWhen(application -> application.getT1().getDescription(applicationRecordServiceImpl))) + .flatMap(tuple -> { + OrgMember orgMember = tuple.getT1().getT1(); + String token = tuple.getT1().getT2(); + String category = tuple.getT2().getT1().getT2(); + String description = tuple.getT2().getT2(); + Application application = tuple.getT2().getT1().getT1(); + + ApplicationCommonEvent event = ApplicationCommonEvent.builder() + .orgId(orgMember.getOrgId()) + .userId(orgMember.getUserId()) + .applicationId(application.getId()) + .applicationGid(application.getGid()) + .applicationName(application.getName()) + .applicationCategory(category) + .applicationDescription(description) + .type(EventType.APPLICATION_PUBLISH) + .commitMessage(request.commitMessage()) + .tag(request.tag()) + .isAnonymous(anonymous) + .sessionHash(Hashing.sha512().hashString(token, StandardCharsets.UTF_8).toString()) + .build(); + + return Mono.deferContextual(contextView -> { + event.populateDetails(contextView); + applicationEventPublisher.publishEvent(event); + return Mono.empty(); + }).then(); // **Fix: Ensures Mono<Void> is returned** + }); + }) + .onErrorResume(throwable -> { + log.error("publishApplicationPublishEvent error. {}, {}, {}", applicationId, request.tag(), request.commitMessage(), throwable); + return Mono.empty(); + }); + } + + + public Mono<Void> publishApplicationVersionChangeEvent(String applicationId, String newtag) { + return sessionUserService.isAnonymousUser() + .flatMap(anonymous -> { + if (anonymous) { + return Mono.empty(); + } + return sessionUserService.getVisitorOrgMemberCache() + .zipWith(sessionUserService.getVisitorToken()) + .zipWith(applicationService.findById(applicationId) + .zipWhen(application -> application.getCategory(applicationRecordServiceImpl)) + .zipWhen(application -> application.getT1().getDescription(applicationRecordServiceImpl))) + .flatMap(tuple -> { + OrgMember orgMember = tuple.getT1().getT1(); + String token = tuple.getT1().getT2(); + String category = tuple.getT2().getT1().getT2(); + String description = tuple.getT2().getT2(); + Application application = tuple.getT2().getT1().getT1(); + + ApplicationCommonEvent event = ApplicationCommonEvent.builder() + .orgId(orgMember.getOrgId()) + .userId(orgMember.getUserId()) + .applicationId(application.getId()) + .applicationGid(application.getGid()) + .applicationName(application.getName()) + .applicationCategory(category) + .applicationDescription(description) + .type(EventType.APPLICATION_VERSION_CHANGE) + .tag(newtag) + .isAnonymous(anonymous) + .sessionHash(Hashing.sha512().hashString(token, StandardCharsets.UTF_8).toString()) + .build(); + + return Mono.deferContextual(contextView -> { + event.populateDetails(contextView); + applicationEventPublisher.publishEvent(event); + return Mono.empty(); + }).then(); // **Fix: Ensures Mono<Void> is returned** + }); + }) + .onErrorResume(throwable -> { + log.error("publishApplicationVersionChangeEvent error. {}, {}", applicationId, newtag, throwable); + return Mono.empty(); + }); + } + public Mono<Void> publishUserLoginEvent(String source) { return sessionUserService.getVisitorOrgMember().zipWith(sessionUserService.getVisitorToken()) - .doOnNext(tuple -> { + .delayUntil(tuple -> { OrgMember orgMember = tuple.getT1(); String token = tuple.getT2(); UserLoginEvent event = UserLoginEvent.builder() @@ -198,8 +394,11 @@ public Mono<Void> publishUserLoginEvent(String source) { .isAnonymous(Authentication.isAnonymousUser(orgMember.getUserId())) .sessionHash(Hashing.sha512().hashString(token, StandardCharsets.UTF_8).toString()) .build(); - event.populateDetails(); - applicationEventPublisher.publishEvent(event); + return Mono.deferContextual(contextView -> { + event.populateDetails(contextView); + applicationEventPublisher.publishEvent(event); + return Mono.empty(); + }); }) .then() .onErrorResume(throwable -> { @@ -211,7 +410,7 @@ public Mono<Void> publishUserLoginEvent(String source) { public Mono<Void> publishUserLogoutEvent() { return sessionUserService.getVisitorOrgMemberCache() .zipWith(sessionUserService.getVisitorToken()) - .doOnNext(tuple -> { + .delayUntil(tuple -> { OrgMember orgMember = tuple.getT1(); String token = tuple.getT2(); UserLogoutEvent event = UserLogoutEvent.builder() @@ -220,8 +419,11 @@ public Mono<Void> publishUserLogoutEvent() { .isAnonymous(Authentication.isAnonymousUser(orgMember.getUserId())) .sessionHash(Hashing.sha512().hashString(token, StandardCharsets.UTF_8).toString()) .build(); - event.populateDetails(); - applicationEventPublisher.publishEvent(event); + return Mono.deferContextual(contextView -> { + event.populateDetails(contextView); + applicationEventPublisher.publishEvent(event); + return Mono.empty(); + }); }) .then() .onErrorResume(throwable -> { @@ -244,7 +446,7 @@ public Mono<Void> publishGroupCreateEvent(Group group) { .isAnonymous(Authentication.isAnonymousUser(tuple.getT1().getUserId())) .sessionHash(Hashing.sha512().hashString(tuple.getT2(), StandardCharsets.UTF_8).toString()) .build(); - event.populateDetails(); + event.populateDetails(contextView); applicationEventPublisher.publishEvent(event); return Mono.empty(); })) @@ -272,7 +474,7 @@ public Mono<Void> publishGroupUpdateEvent(boolean publish, Group previousGroup, .isAnonymous(Authentication.isAnonymousUser(tuple.getT1().getUserId())) .sessionHash(Hashing.sha512().hashString(tuple.getT2(), StandardCharsets.UTF_8).toString()) .build(); - event.populateDetails(); + event.populateDetails(contextView); applicationEventPublisher.publishEvent(event); return Mono.empty(); })) @@ -300,7 +502,7 @@ public Mono<Void> publishGroupDeleteEvent(boolean publish, Group previousGroup) .isAnonymous(Authentication.isAnonymousUser(tuple.getT1().getUserId())) .sessionHash(Hashing.sha512().hashString(tuple.getT2(), StandardCharsets.UTF_8).toString()) .build(); - event.populateDetails(); + event.populateDetails(contextView); applicationEventPublisher.publishEvent(event); return Mono.empty(); })) @@ -337,7 +539,7 @@ public Mono<Void> publishGroupMemberAddEvent(boolean publish, String groupId, Ad .isAnonymous(Authentication.isAnonymousUser(orgMember.getUserId())) .sessionHash(Hashing.sha512().hashString(token, StandardCharsets.UTF_8).toString()) .build(); - event.populateDetails(); + event.populateDetails(contextView); applicationEventPublisher.publishEvent(event); return Mono.empty(); })) @@ -374,7 +576,7 @@ public Mono<Void> publishGroupMemberRoleUpdateEvent(boolean publish, String grou .isAnonymous(Authentication.isAnonymousUser(orgMember.getUserId())) .sessionHash(Hashing.sha512().hashString(tuple.getT4(), StandardCharsets.UTF_8).toString()) .build(); - event.populateDetails(); + event.populateDetails(contextView); applicationEventPublisher.publishEvent(event); return Mono.empty(); })) @@ -410,7 +612,7 @@ public Mono<Void> publishGroupMemberLeaveEvent(boolean publish, GroupMember grou .isAnonymous(Authentication.isAnonymousUser(orgMember.getUserId())) .sessionHash(Hashing.sha512().hashString(tuple.getT4(), StandardCharsets.UTF_8).toString()) .build(); - event.populateDetails(); + event.populateDetails(contextView); applicationEventPublisher.publishEvent(event); return Mono.empty(); })) @@ -446,7 +648,7 @@ public Mono<Void> publishGroupMemberRemoveEvent(boolean publish, GroupMember pre .isAnonymous(Authentication.isAnonymousUser(orgMember.getUserId())) .sessionHash(Hashing.sha512().hashString(tuple.getT4(), StandardCharsets.UTF_8).toString()) .build(); - event.populateDetails(); + event.populateDetails(contextView); applicationEventPublisher.publishEvent(event); return Mono.empty(); })) @@ -484,9 +686,11 @@ public Mono<Void> publishDatasourceEvent(Datasource datasource, EventType eventT .isAnonymous(Authentication.isAnonymousUser(tuple.getT1().getUserId())) .sessionHash(Hashing.sha512().hashString(tuple.getT2(), StandardCharsets.UTF_8).toString()) .build(); - event.populateDetails(); - applicationEventPublisher.publishEvent(event); - return Mono.<Void> empty(); + return Mono.deferContextual(contextView -> { + event.populateDetails(contextView); + applicationEventPublisher.publishEvent(event); + return Mono.<Void>empty(); + }); }) .onErrorResume(throwable -> { log.error("publishDatasourceEvent error.", throwable); @@ -535,9 +739,11 @@ public Mono<Void> publishDatasourcePermissionEvent(String datasourceId, .isAnonymous(Authentication.isAnonymousUser(orgMember.getUserId())) .sessionHash(Hashing.sha512().hashString(tuple.getT3(), StandardCharsets.UTF_8).toString()) .build(); - datasourcePermissionEvent.populateDetails(); - applicationEventPublisher.publishEvent(datasourcePermissionEvent); - return Mono.<Void> empty(); + return Mono.deferContextual(contextView -> { + datasourcePermissionEvent.populateDetails(contextView); + applicationEventPublisher.publishEvent(datasourcePermissionEvent); + return Mono.<Void>empty(); + }); }) .onErrorResume(throwable -> { log.error("publishDatasourcePermissionEvent error.", throwable); @@ -552,7 +758,7 @@ public Mono<Void> publishLibraryQuery(LibraryQuery libraryQuery, EventType event public Mono<Void> publishLibraryQueryEvent(String id, String name, EventType eventType) { return sessionUserService.getVisitorOrgMemberCache() .zipWith(sessionUserService.getVisitorToken()) - .map(tuple -> { + .flatMap(tuple -> { LibraryQueryEvent event = LibraryQueryEvent.builder() .userId(tuple.getT1().getUserId()) .orgId(tuple.getT1().getOrgId()) @@ -562,10 +768,12 @@ public Mono<Void> publishLibraryQueryEvent(String id, String name, EventType eve .isAnonymous(Authentication.isAnonymousUser(tuple.getT1().getUserId())) .sessionHash(Hashing.sha512().hashString(tuple.getT2(), StandardCharsets.UTF_8).toString()) .build(); - event.populateDetails(); - return event; + return Mono.deferContextual(contextView -> { + event.populateDetails(contextView); + applicationEventPublisher.publishEvent(event); + return Mono.<Void>empty(); + }); }) - .doOnNext(applicationEventPublisher::publishEvent) .then() .onErrorResume(throwable -> { log.error("publishLibraryQueryEvent error.", throwable); diff --git a/server/api-service/lowcoder-server/src/test/java/org/lowcoder/api/application/ApplicationApiServiceIntegrationTest.java b/server/api-service/lowcoder-server/src/test/java/org/lowcoder/api/application/ApplicationApiServiceIntegrationTest.java index cb4d81808..c62937bff 100644 --- a/server/api-service/lowcoder-server/src/test/java/org/lowcoder/api/application/ApplicationApiServiceIntegrationTest.java +++ b/server/api-service/lowcoder-server/src/test/java/org/lowcoder/api/application/ApplicationApiServiceIntegrationTest.java @@ -70,7 +70,7 @@ public void testCreateApplicationSuccess() { }); // Mono<ApplicationView> applicationViewMono = datasourceMono.map(datasource -> new CreateApplicationRequest( - "org01", + "org01", null, "app05", ApplicationType.APPLICATION.getValue(), Map.of("comp", "list", "queries", Set.of(Map.of("datasourceId", datasource.getId()))), @@ -104,7 +104,7 @@ public void testUpdateApplicationFailedDueToLackOfDatasourcePermissions() { }); // Mono<ApplicationView> applicationViewMono = datasourceMono.map(datasource -> new CreateApplicationRequest( - "org01", + "org01", null, "app03", ApplicationType.APPLICATION.getValue(), Map.of("comp", "list", "queries", Set.of(Map.of("datasourceId", datasource.getId()))), @@ -129,7 +129,7 @@ public void testUpdateApplicationFailedDueToLackOfDatasourcePermissions() { @Test @WithMockUser public void testUpdateEditingStateSuccess() { - Mono<ApplicationView> applicationViewMono = applicationApiService.create(new CreateApplicationRequest("org01", "app1", ApplicationType.APPLICATION.getValue(), Map.of("comp", "list"), null)); + Mono<ApplicationView> applicationViewMono = applicationApiService.create(new CreateApplicationRequest("org01", null, "app1", ApplicationType.APPLICATION.getValue(), Map.of("comp", "list"), null)); Mono<ApplicationView> updateEditStateMono = applicationViewMono.delayUntil(app -> applicationApiService.updateEditState(app.getApplicationInfoView().getApplicationId(), new ApplicationEndpoints.UpdateEditStateRequest(true))); Mono<ApplicationView> app = updateEditStateMono.flatMap(applicationView -> applicationApiService.getEditingApplication(applicationView.getApplicationInfoView().getApplicationId())); StepVerifier.create(app) diff --git a/server/api-service/lowcoder-server/src/test/java/org/lowcoder/api/application/ApplicationApiServiceTest.java b/server/api-service/lowcoder-server/src/test/java/org/lowcoder/api/application/ApplicationApiServiceTest.java index f912c3607..9fc63066c 100644 --- a/server/api-service/lowcoder-server/src/test/java/org/lowcoder/api/application/ApplicationApiServiceTest.java +++ b/server/api-service/lowcoder-server/src/test/java/org/lowcoder/api/application/ApplicationApiServiceTest.java @@ -130,7 +130,7 @@ public void testDeleteNormalApplicationWithError() { private Mono<ApplicationView> createApplication(String name, String folderId) { CreateApplicationRequest createApplicationRequest = - new CreateApplicationRequest("org01", name, ApplicationType.APPLICATION.getValue(), + new CreateApplicationRequest("org01", null, name, ApplicationType.APPLICATION.getValue(), Map.of("comp", "list"), folderId); return applicationApiService.create(createApplicationRequest); } diff --git a/server/api-service/lowcoder-server/src/test/java/org/lowcoder/api/service/OrganizationServiceTest.java b/server/api-service/lowcoder-server/src/test/java/org/lowcoder/api/service/OrganizationServiceTest.java index 8083d2ebd..3a079de21 100644 --- a/server/api-service/lowcoder-server/src/test/java/org/lowcoder/api/service/OrganizationServiceTest.java +++ b/server/api-service/lowcoder-server/src/test/java/org/lowcoder/api/service/OrganizationServiceTest.java @@ -11,9 +11,13 @@ import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.test.context.ActiveProfiles; +import reactor.core.publisher.Flux; import reactor.core.publisher.Mono; import reactor.test.StepVerifier; +import java.util.List; +import java.util.UUID; + @SpringBootTest //@RunWith(SpringRunner.class) @ActiveProfiles("OrganizationApiServiceTest") @@ -28,6 +32,7 @@ public class OrganizationServiceTest { private Mono<Organization> createOrganization(String name) { Organization organization = Organization.builder() .name(name) + .gid("gid-" + UUID.randomUUID()) .build(); return organizationService.create(organization, "user01", false); } @@ -51,4 +56,133 @@ public void testUpdateSlug() { }) .verifyComplete(); } + + @Test + @WithMockUser + public void testGetAllActive() { + // Create a single organization to ensure there is at least one active one in the database + Mono<Organization> orgMono = createOrganization("ActiveOrganization"); + + // Ensure the organization is created and then verify getAllActive + Flux<Organization> allActiveOrganizations = orgMono.thenMany(organizationService.getAllActive()); + + StepVerifier.create(allActiveOrganizations.collectList()) + .assertNext(orgList -> { + Assertions.assertFalse(orgList.isEmpty(), "The organization list should not be empty"); + Organization lastOrg = orgList.get(orgList.size() - 1); + + // Check the last element in the list + Assertions.assertNotNull(lastOrg.getId(), "Last organization ID should not be null"); + Assertions.assertEquals("ActiveOrganization", lastOrg.getName(), "Last organization name should match 'ActiveOrganization'"); + }) + .verifyComplete(); + } + + @Test + @WithMockUser + public void testGetByIds() { + // Create the first organization and update its gid + Mono<Organization> org1Mono = createOrganization("Organization1") + .flatMap(org -> { + org.setGid("gid-1"); + return organizationService.update(org.getId(), org) + .thenReturn(org); + }); + + // Create the second organization and update its gid + Mono<Organization> org2Mono = createOrganization("Organization2") + .flatMap(org -> { + org.setGid("gid-2"); + return organizationService.update(org.getId(), org) + .thenReturn(org); + }); + + // Use these updated organizations in further operations or assertions + Flux<Organization> savedOrgs = org1Mono.then(org2Mono) + .thenMany(organizationService.getByIds(List.of("gid-1", "gid-2"))); + + StepVerifier.create(savedOrgs.collectList()) + .assertNext(orgList -> { + Assertions.assertTrue(orgList.size() >= 2, "Organization list should have at least two elements"); + + // Check the last two elements + Organization org1 = orgList.get(orgList.size() - 2); + Organization org2 = orgList.get(orgList.size() - 1); + + Assertions.assertNotNull(org1.getId(), "Organization ID should not be null"); + Assertions.assertEquals("gid-1", org1.getGid(), "First organization GID should match 'gid-1'"); + Assertions.assertEquals("Organization1", org1.getName(), "First organization name should match 'Organization1'"); + + Assertions.assertNotNull(org2.getId(), "Organization ID should not be null"); + Assertions.assertEquals("gid-2", org2.getGid(), "Second organization GID should match 'gid-2'"); + Assertions.assertEquals("Organization2", org2.getName(), "Second organization name should match 'Organization2'"); + }) + .verifyComplete(); + } + + @Test + @WithMockUser + public void testGetOrgCommonSettings() { + + Organization.OrganizationCommonSettings testSettings = new Organization.OrganizationCommonSettings(); + testSettings.put("settingKey1", "settingValue1"); + testSettings.put("settingKey2", "settingValue2"); + + // Create the first organization and update its common setting + Mono<Organization> orgMono = createOrganization("Organization") + .flatMap(org -> { + org.setCommonSettings(testSettings); + return organizationService.update(org.getId(), org) + .thenReturn(org); + }); + + // Retrieve the common settings from the organization + Mono<Organization.OrganizationCommonSettings> commonSettingsMono = orgMono + .flatMap(org -> organizationService.getOrgCommonSettings(org.getId())); + + // Verify that the settings match the expected test settings + StepVerifier.create(commonSettingsMono) + .assertNext(retrievedSettings -> { + Assertions.assertEquals("settingValue1", retrievedSettings.get("settingKey1"), "The setting value for 'settingKey1' should match"); + Assertions.assertEquals("settingValue2", retrievedSettings.get("settingKey2"), "The setting value for 'settingKey2' should match"); + }) + .verifyComplete(); + } + + @Test + @WithMockUser + public void testUpdateCommonSettings() { + // Initial settings for the organization + Organization.OrganizationCommonSettings initialSettings = new Organization.OrganizationCommonSettings(); + initialSettings.put("settingKey1", "initialValue1"); + + // Create an organization with initial settings + Mono<Organization> orgMono = createOrganization("CommonSettingsTestOrganization") + .flatMap(org -> { + org.setCommonSettings(initialSettings); + return organizationService.update(org.getId(), org) + .thenReturn(org); + }); + + // Define key and new value to update + String keyToUpdate = "settingKey1"; + String newValue = "updatedValue1"; + + // Chain the update and verification operations + orgMono.flatMap(org -> + // Update the common settings + organizationService.updateCommonSettings(org.getId(), keyToUpdate, newValue) + .flatMap(updateSuccess -> { + Assertions.assertTrue(updateSuccess, "Update should be successful"); + // Retrieve updated common settings + return organizationService.getOrgCommonSettings(org.getId()); + }) + ) + .as(StepVerifier::create) + .assertNext(updatedSettings -> { + // Verify updated settings + Assertions.assertEquals(newValue, updatedSettings.get(keyToUpdate), "The setting value should be updated to 'updatedValue1'"); + }) + .verifyComplete(); + } } diff --git a/server/api-service/lowcoder-server/src/test/java/org/lowcoder/api/service/impl/ApplicationHistorySnapshotServiceTest.java b/server/api-service/lowcoder-server/src/test/java/org/lowcoder/api/service/impl/ApplicationHistorySnapshotServiceTest.java index 81c0cb56d..e3a427cad 100644 --- a/server/api-service/lowcoder-server/src/test/java/org/lowcoder/api/service/impl/ApplicationHistorySnapshotServiceTest.java +++ b/server/api-service/lowcoder-server/src/test/java/org/lowcoder/api/service/impl/ApplicationHistorySnapshotServiceTest.java @@ -84,5 +84,9 @@ public void testServiceMethods() { }) .verifyComplete(); + StepVerifier.create(service.countByApplicationIdArchived(applicationId)) + .expectNext(0L) + .verifyComplete(); + } } diff --git a/server/api-service/pom.xml b/server/api-service/pom.xml index 499e061b2..510750c14 100644 --- a/server/api-service/pom.xml +++ b/server/api-service/pom.xml @@ -12,7 +12,7 @@ <properties> - <revision>2.6.3</revision> + <revision>2.6.4</revision> <java.version>17</java.version> <maven.compiler.source>${java.version}</maven.compiler.source> <maven.compiler.target>${java.version}</maven.compiler.target> diff --git a/server/node-service/package.json b/server/node-service/package.json index 65ed2001b..90b0536e3 100644 --- a/server/node-service/package.json +++ b/server/node-service/package.json @@ -1,6 +1,6 @@ { "name": "lowcoder-node-server", - "version": "2.6.3", + "version": "2.6.4", "private": true, "engines": { "node": "^14.18.0 || >=16.0.0" diff --git a/server/node-service/src/plugins/hubspot/index.ts b/server/node-service/src/plugins/hubspot/index.ts new file mode 100644 index 000000000..5f4e6a858 --- /dev/null +++ b/server/node-service/src/plugins/hubspot/index.ts @@ -0,0 +1,81 @@ +import { dirToSpecList, specsToOptions, version2spec } from "../../common/util"; +import _ from "lodash"; +import path from "path"; +import { OpenAPI } from "openapi-types"; +import { ConfigToType, DataSourcePlugin, QueryConfig } from "lowcoder-sdk/dataSource"; +import { runOpenApi } from "../openApi"; +import { parseMultiOpenApi, ParseOpenApiOptions } from "../openApi/parse"; + +const specs = { + "v4": dirToSpecList(path.join(__dirname, "./specsV4")), +}; + +const dataSourceConfig = { + type: "dataSource", + params: [ + { + type: "textInput", + key: "authToken", + label: "Private Access Token", + placeholder: "<Your HubSpot private Apps Access Token>", + tooltip: "Read more here: https://developers.hubspot.com/docs/guides/apps/private-apps/overview" + }, + { + label: "API Version", + key: "specVersion", + type: "select", + tooltip: "Choose the HubSpot API Version.", + placeholder: "v4", + options: specsToOptions(specs) + }, + ], +} as const; + +const parseOptions: ParseOpenApiOptions = { + actionLabel: (method: string, path: string, operation: OpenAPI.Operation) => { + return _.upperFirst(operation.operationId || ""); + }, +}; + +let queryConfig: any = {}; + +type DataSourceConfigType = ConfigToType<typeof dataSourceConfig>; + +const hubspotPlugin: DataSourcePlugin<any, DataSourceConfigType> = { + id: "hubspot", + name: "HubSpot", + icon: "hubspot.svg", + category: "CRM", + dataSourceConfig, + + queryConfig: async (data) => { + if (!queryConfig[data.specVersion as keyof typeof queryConfig]) { + const { actions, categories } = await parseMultiOpenApi(version2spec(specs, data.specVersion), parseOptions); + queryConfig[data.specVersion as keyof typeof queryConfig] = { + type: "query", + label: "Action", + categories: { + label: "Resources", + items: categories, + }, + actions, + }; + } + return queryConfig[data.specVersion as keyof typeof queryConfig]; + }, + + run: function (actionData, dataSourceConfig): Promise<any> { + const runApiDsConfig = { + url: "", + serverURL: "https://api.hubapi.com", // HubSpot API base URL + dynamicParamsConfig: dataSourceConfig, + specVersion: dataSourceConfig.specVersion, + headers: { + Authorization: `Bearer ${dataSourceConfig.authToken}`, + }, + }; + return runOpenApi(actionData, runApiDsConfig, version2spec(specs, dataSourceConfig.specVersion)); + }, +}; + +export default hubspotPlugin; diff --git a/server/node-service/src/plugins/hubspot/specsV4/Automation API Collections.json b/server/node-service/src/plugins/hubspot/specsV4/Automation API Collections.json new file mode 100644 index 000000000..e4cb5c364 --- /dev/null +++ b/server/node-service/src/plugins/hubspot/specsV4/Automation API Collections.json @@ -0,0 +1,7327 @@ +openapi: 3.0.0 +info: + title: Automation API Collections + description: "Use [HubSpot's workflows tool](https://knowledge.hubspot.com/workflows/create-workflows) to automate business processes and allow your team to be more efficient. You can create custom workflow actions to integrate your service with HubSpot's workflows.\n\nAfter setting up your custom action, when users install your application, they can add the custom action to their workflows.\n\nIn workflows, you can also use the _Custom code_ action to write and execute JavaScript or Python (_in beta_). With custom code actions, you can extend workflow functionality within and outside of HubSpot. To learn more about HubSpot's APIs, you can refer to either the [developer documentation](https://developers.hubspot.com/docs/api/developer-guides-resources) for the latest versions or the [legacy developer documentation](https://legacydocs.hubspot.com/) for our older APIs. To see examples of common custom code actions, view [HubSpot's Programmable Automation Use Cases](https://www.hubspot.com/programmable-automation-use-cases).\n\nCustom code actions support JavaScript using the [Node 16.x runtime framework](https://aws.amazon.com/blogs/compute/node-js-16-x-runtime-now-available-in-aws-lambda/). If you're using Python for your custom code action, the custom code action will use [Python 3.9 runtime framework](https://www.python.org/downloads/release/python-390/). When an action executes, the runtime compute is managed through a serverless function by HubSpot and [AWS Lambda](https://aws.amazon.com/lambda/features/#:~:text=AWS%20Lambda%20is%20a%20serverless,scale%2C%20performance%2C%20and%20security.).\n\nIf you encounter any general issues implementing your custom code action, you can reach out to [HubSpot support](https://knowledge.hubspot.com/account/get-help-with-hubspot). However, if you're facing any issues with your written custom code, it's recommended to search and post on the [HubSpot Developer's Forum ](https://community.hubspot.com/t5/HubSpot-Developers/ct-p/developers)\_ to get tips, advice, or help with troubleshooting your code.\n\n**Fork the collections using Run in Postman:**\n\n[<img src=\"https://run.pstmn.io/button.svg\" alt=\"Run In Postman\">](https://app.getpostman.com/run-collection/26126890-c13185bb-dede-45ae-a8d8-ae1a1d63385a?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D26126890-c13185bb-dede-45ae-a8d8-ae1a1d63385a%26entityType%3Dcollection%26workspaceId%3Dd7645f33-539d-49c6-9e0c-efa6faae355d)" + version: 1.0.0 +servers: + - url: http://{{baseurl}} +components: + securitySchemes: + oauth2Auth: + type: http + scheme: oauth2 + apikeyAuth: + type: http + scheme: apikey +tags: + - name: Custom Workflow Actions API + description: "Use\_[HubSpot's workflows tool](https://knowledge.hubspot.com/workflows/create-workflows)\_to automate business processes and allow your team to be more efficient. You can create custom workflow actions to integrate your service with HubSpot's workflows.\n\nAfter setting up your custom action, when users install your application, they can add the custom action to their workflows.\_\n\nWhen those workflows execute, HTTPS requests will send to the configured URL with the payload that you set up. Requests made for your custom action will use the v2 version of the\__X-HubSpot-Signature_. Learn more about\_[validating requests from HubSpot](https://developers.hubspot.com/docs/api/webhooks/validating-requests). \n\nYou can also skip forward to the following sections:\n\n- [Before you get started](https://developers.hubspot.com/docs/api/automation/custom-workflow-actions#before)\n \n- [Define your custom action](https://developers.hubspot.com/docs/api/automation/custom-workflow-actions#define)\n \n- [Functions](https://developers.hubspot.com/docs/api/automation/custom-workflow-actions#functions)\n \n- [Input fields](https://developers.hubspot.com/docs/api/automation/custom-workflow-actions#input)\n \n- [Fetch external data fields](https://developers.hubspot.com/docs/api/automation/custom-workflow-actions#fetch)\n \n- [Output fields](https://developers.hubspot.com/docs/api/automation/custom-workflow-actions#output)\n \n- [Labels](https://developers.hubspot.com/docs/api/automation/custom-workflow-actions#label)\n \n- [Execution](https://developers.hubspot.com/docs/api/automation/custom-workflow-actions#execution)\n \n- [Asynchronous custom action execution](https://developers.hubspot.com/docs/api/automation/custom-workflow-actions#asynchronous-execution)\n \n- [Add custom execution messages with execution rules](https://developers.hubspot.com/docs/api/automation/custom-workflow-actions#executionmessage)\n \n- [Test and publish your custom action](https://developers.hubspot.com/docs/api/automation/custom-workflow-actions#publish)\n \n\nThe final section in this article provides\_[several custom action examples](https://developers.hubspot.com/docs/api/automation/custom-workflow-actions#custom-action-examples).\n\n## Before you get started\n\n- You'll need a\_[HubSpot developer account](https://app.hubspot.com/signup/developers)\_with a\_[HubSpot app](https://developers.hubspot.com/docs/api/creating-an-app). Your app logo will be used as the icon for the custom action.\n \n- When making requests to the custom workflow action endpoints, you must include your\_[HubSpot developer account key](https://legacydocs.hubspot.com/docs/faq/developer-api-keys)\_in the request URL. For example:\n \n\n`https://api.hubspot.com/automation/v4/actions/{appId}?hapikey={developer_API_key}`\n\n## Define your custom action\n\nTo create a custom workflow action, you'll need to define the action using the following fields. This also specifies the request format for requests coming from HubSpot, as well as the handling of responses from your service.\n\n- **`actionUrl`**: the URL where an HTTPS request is sent when the action is executed. The request body will contain information about which user the action is executing on behalf of, and what values were entered for the input fields.\n \n- **`objectTypes`****:**\_which CRM objects this action can be used with.\n \n- **`published`****:**\_by default, custom actions are created in an unpublished state. Unpublished actions are only visible in the developer portal associated with your HubSpot application. To make a custom action visible to users, update the published flag on your action definition to true.\n \n- **`inputFields`**: the inputs that the action receives. These will be filled by the user.\n \n- **`inputFieldDependencies`****:**\_these rules allow fields to be grayed out until other fields meet specific conditions.\n \n- `outputFields`: the values that the action will output that can be used by later actions in the workflow. A custom action can have zero, one, or many outputs.\n \n- `objectRequestOptions`**:**\_ properties of the enrolled object included in the payload to the actionUrl.\n \n- `labels`: copy that describes to the user what the action's fields represent and what the action does. English labels are required, but labels can be specified in any of the following supported languages as well:\_French (`fr`), German (`de`), Japanese (`ja`), Spanish (`es`), Brazilian Portuguese (`pt-br`), and Dutch (`nl`).\n \n- **`executionRules`**: a list of definitions you can specify to surface errors from your service to the user creating the workflow.\n \n- **`functions`****:**\_code snippets that are run in order to transform the payload being sent to a url and/or transform the response from that url." + - name: Custom Workflow Actions API > Callbacks + - name: Custom Workflow Actions API > Definitions + - name: Custom Workflow Actions API > Functions + - name: Custom Workflow Actions API > Revisions + - name: Sequences API + - name: Sequences API > Public_Enrollments + - name: Sequences API > Public_Sequences + - name: Workflows V4 API + - name: Workflows V4 API > Workflows + - name: Workflows V4 API > Email campaigns + - name: Workflows V4 API > Workflow ID mappings +paths: + /automation/v4/actions/callbacks/{callbackId}/complete: + post: + tags: + - Custom Workflow Actions API > Callbacks + summary: Completes a callback + requestBody: + content: {} + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: callbackId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "officia_2": [ + "<string>", + "<string>" + ], + "ullamco_2ae": [ + "<string>", + "<string>" + ] + }, + "links": { + "ad3b": "<string>", + "adipisicing065": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "mollita5": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "consectetur98d": [ + "<string>", + "<string>" + ], + "sit_18_": [ + "<string>", + "<string>" + ] + } + } + ] + } + /automation/v4/actions/callbacks/complete: + post: + tags: + - Custom Workflow Actions API > Callbacks + summary: Complete a batch of callbacks + requestBody: + content: {} + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "officia_2": [ + "<string>", + "<string>" + ], + "ullamco_2ae": [ + "<string>", + "<string>" + ] + }, + "links": { + "ad3b": "<string>", + "adipisicing065": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "mollita5": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "consectetur98d": [ + "<string>", + "<string>" + ], + "sit_18_": [ + "<string>", + "<string>" + ] + } + } + ] + } + /automation/v4/actions/{appId}: + get: + tags: + - Custom Workflow Actions API > Definitions + summary: Get paged extension definitions + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: limit + in: query + schema: + type: string + description: The maximum number of results to display per page. + example: <integer> + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + - name: appId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <integer> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - actionUrl: <string> + functions: + - functionType: PRE_FETCH_OPTIONS + id: <string> + - functionType: PRE_ACTION_EXECUTION + id: <string> + id: <string> + inputFields: + - isRequired: <boolean> + typeDefinition: + externalOptions: <boolean> + name: <string> + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + type: date + helpText: <string> + referencedObjectType: SOCIAL_BROADCAST + description: <string> + externalOptionsReferenceType: <string> + label: <string> + fieldType: calculation_read_time + optionsUrl: <string> + automationFieldType: <string> + supportedValueTypes: + - OBJECT_PROPERTY + - STATIC_VALUE + - isRequired: <boolean> + typeDefinition: + externalOptions: <boolean> + name: <string> + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + type: phone_number + helpText: <string> + referencedObjectType: TASK + description: <string> + externalOptionsReferenceType: <string> + label: <string> + fieldType: calculation_score + optionsUrl: <string> + automationFieldType: <string> + supportedValueTypes: + - FIELD_DATA + - STATIC_VALUE + labels: + sed_b63: + actionName: <string> + inputFieldDescriptions: + aute_: <string> + appDisplayName: <string> + outputFieldLabels: + minim_54: <string> + dolore_9c: <string> + inputFieldOptionLabels: + dolor__: + dolore3f: <string> + enim__7: <string> + do3a: + ipsum_7: <string> + in6: <string> + actionDescription: <string> + executionRules: + fugiat_d: <string> + sintdab: <string> + inputFieldLabels: + sint_e05: <string> + actionCardContent: <string> + objectTypes: + - <string> + - <string> + published: <boolean> + revisionId: <string> + outputFields: + - typeDefinition: + externalOptions: <boolean> + name: <string> + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + type: object_coordinates + helpText: <string> + referencedObjectType: SALESFORCE_SYNC_ERROR + description: <string> + externalOptionsReferenceType: <string> + label: <string> + fieldType: textarea + optionsUrl: <string> + - typeDefinition: + externalOptions: <boolean> + name: <string> + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + type: json + helpText: <string> + referencedObjectType: CONTENT_AUDIT_PAGE + description: <string> + externalOptionsReferenceType: <string> + label: <string> + fieldType: date + optionsUrl: <string> + archivedAt: <long> + inputFieldDependencies: + - controllingFieldName: <string> + dependencyType: SINGLE_FIELD + dependentFieldNames: + - <string> + - <string> + - controllingFieldName: <string> + dependencyType: SINGLE_FIELD + dependentFieldNames: + - <string> + - <string> + executionRules: + - conditions: + mollit_89: {} + labelName: <string> + - conditions: + nulla68: {} + labelName: <string> + objectRequestOptions: + properties: + - <string> + - <string> + - actionUrl: <string> + functions: + - functionType: PRE_ACTION_EXECUTION + id: <string> + - functionType: PRE_ACTION_EXECUTION + id: <string> + id: <string> + inputFields: + - isRequired: <boolean> + typeDefinition: + externalOptions: <boolean> + name: <string> + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + type: json + helpText: <string> + referencedObjectType: PORTAL_OBJECT_SYNC_MESSAGE + description: <string> + externalOptionsReferenceType: <string> + label: <string> + fieldType: date + optionsUrl: <string> + automationFieldType: <string> + supportedValueTypes: + - FIELD_DATA + - OBJECT_PROPERTY + - isRequired: <boolean> + typeDefinition: + externalOptions: <boolean> + name: <string> + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + type: datetime + helpText: <string> + referencedObjectType: PORTAL + description: <string> + externalOptionsReferenceType: <string> + label: <string> + fieldType: checkbox + optionsUrl: <string> + automationFieldType: <string> + supportedValueTypes: + - FIELD_DATA + - FETCHED_OBJECT_PROPERTY + labels: + elit__4: + actionName: <string> + inputFieldDescriptions: + commodo__3: <string> + ipsum_56: <string> + appDisplayName: <string> + outputFieldLabels: + velit8: <string> + occaecatf30: <string> + dolore_c: <string> + inputFieldOptionLabels: + deserunt_6a1: + Duisd14: <string> + reprehenderit_0: <string> + et2cf: + minim_b0d: <string> + deserunt_81: <string> + nostrudb8: <string> + qui2: <string> + consectetur7ca: + laborecf4: <string> + tempora: <string> + in5f: + animb3: <string> + incididunt8b2: <string> + laborum98c: <string> + reprehenderit_7d6: <string> + dolore8e_: <string> + actionDescription: <string> + executionRules: + magna_13e: <string> + inputFieldLabels: + sunt_9: <string> + voluptate_c4b: <string> + Excepteur_6d0: <string> + actionCardContent: <string> + ut_3: + actionName: <string> + inputFieldDescriptions: + sed050: <string> + appDisplayName: <string> + outputFieldLabels: + Lorem69: <string> + officiac: <string> + minim473: <string> + inputFieldOptionLabels: + exercitationd47: + anim88: <string> + actionDescription: <string> + executionRules: + cillum9f: <string> + inputFieldLabels: + non_d: <string> + elit51: <string> + actionCardContent: <string> + objectTypes: + - <string> + - <string> + published: <boolean> + revisionId: <string> + outputFields: + - typeDefinition: + externalOptions: <boolean> + name: <string> + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + type: string + helpText: <string> + referencedObjectType: USER + description: <string> + externalOptionsReferenceType: <string> + label: <string> + fieldType: unknown + optionsUrl: <string> + - typeDefinition: + externalOptions: <boolean> + name: <string> + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + type: number + helpText: <string> + referencedObjectType: PRIVACY_SCANNER_COOKIE + description: <string> + externalOptionsReferenceType: <string> + label: <string> + fieldType: text + optionsUrl: <string> + archivedAt: <long> + inputFieldDependencies: + - controllingFieldName: <string> + dependencyType: SINGLE_FIELD + dependentFieldNames: + - <string> + - <string> + - controllingFieldName: <string> + dependencyType: SINGLE_FIELD + dependentFieldNames: + - <string> + - <string> + executionRules: + - conditions: + incididunt67: {} + labelName: <string> + - conditions: + nisi_: {} + irure_7: {} + labelName: <string> + objectRequestOptions: + properties: + - <string> + - <string> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "officia_2": [ + "<string>", + "<string>" + ], + "ullamco_2ae": [ + "<string>", + "<string>" + ] + }, + "links": { + "ad3b": "<string>", + "adipisicing065": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "mollita5": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "consectetur98d": [ + "<string>", + "<string>" + ], + "sit_18_": [ + "<string>", + "<string>" + ] + } + } + ] + } + post: + tags: + - Custom Workflow Actions API > Definitions + summary: Create a new extension definition + requestBody: + content: + application/json: + schema: + type: object + example: + actionUrl: <string> + functions: + - functionSource: <string> + functionType: POST_ACTION_EXECUTION + id: <string> + - functionSource: <string> + functionType: POST_ACTION_EXECUTION + id: <string> + inputFields: + - isRequired: <boolean> + typeDefinition: + externalOptions: <boolean> + name: <string> + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + type: json + helpText: <string> + referencedObjectType: MARKETING_EVENT + description: <string> + externalOptionsReferenceType: <string> + label: <string> + fieldType: calculation_equation + optionsUrl: <string> + automationFieldType: <string> + supportedValueTypes: + - ENROLLMENT_EVENT_PROPERTY + - STATIC_VALUE + - isRequired: <boolean> + typeDefinition: + externalOptions: <boolean> + name: <string> + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + type: phone_number + helpText: <string> + referencedObjectType: DATA_SYNC_STATE + description: <string> + externalOptionsReferenceType: <string> + label: <string> + fieldType: calculation_rollup + optionsUrl: <string> + automationFieldType: <string> + supportedValueTypes: + - FETCHED_OBJECT_PROPERTY + - FETCHED_OBJECT_PROPERTY + labels: + in_a6d: + actionName: <string> + inputFieldDescriptions: + pariature5a: <string> + ine0: <string> + appDisplayName: <string> + outputFieldLabels: + velit_4: <string> + officia2: <string> + inputFieldOptionLabels: + irure8: + proident0: <string> + proidentc0: <string> + actionDescription: <string> + executionRules: + ipsum7d: <string> + velitae: <string> + sunte: <string> + inputFieldLabels: + reprehenderit_0: <string> + fugiat__6a: <string> + sint_cc: <string> + adipisicing7f4: <string> + actionCardContent: <string> + objectTypes: + - <string> + - <string> + published: <boolean> + outputFields: + - typeDefinition: + externalOptions: <boolean> + name: <string> + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + type: object_coordinates + helpText: <string> + referencedObjectType: SCHEMAS_BACKEND_TEST + description: <string> + externalOptionsReferenceType: <string> + label: <string> + fieldType: select + optionsUrl: <string> + - typeDefinition: + externalOptions: <boolean> + name: <string> + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + type: date + helpText: <string> + referencedObjectType: DEAL_REGISTRATION + description: <string> + externalOptionsReferenceType: <string> + label: <string> + fieldType: calculation_read_time + optionsUrl: <string> + archivedAt: <long> + inputFieldDependencies: + - controllingFieldName: <string> + dependencyType: SINGLE_FIELD + dependentFieldNames: + - <string> + - <string> + - controllingFieldName: <string> + dependencyType: SINGLE_FIELD + dependentFieldNames: + - <string> + - <string> + executionRules: + - conditions: + mollit_6f6: {} + aute15: {} + labelName: <string> + - conditions: + ea_659: {} + cillum_29: {} + labelName: <string> + objectRequestOptions: + properties: + - <string> + - <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: appId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <integer> + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + actionUrl: <string> + functions: + - functionType: POST_ACTION_EXECUTION + id: <string> + - functionType: POST_FETCH_OPTIONS + id: <string> + id: <string> + inputFields: + - isRequired: <boolean> + typeDefinition: + externalOptions: <boolean> + name: <string> + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + type: json + helpText: <string> + referencedObjectType: UNKNOWN + description: <string> + externalOptionsReferenceType: <string> + label: <string> + fieldType: checkbox + optionsUrl: <string> + automationFieldType: <string> + supportedValueTypes: + - OBJECT_PROPERTY + - FETCHED_OBJECT_PROPERTY + - isRequired: <boolean> + typeDefinition: + externalOptions: <boolean> + name: <string> + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + type: date + helpText: <string> + referencedObjectType: MARKETING_CAMPAIGN_UTM + description: <string> + externalOptionsReferenceType: <string> + label: <string> + fieldType: calculation_read_time + optionsUrl: <string> + automationFieldType: <string> + supportedValueTypes: + - OBJECT_PROPERTY + - OBJECT_PROPERTY + labels: + dolor319: + actionName: <string> + inputFieldDescriptions: + est_a39: <string> + aute_87: <string> + irure2: <string> + qui4: <string> + appDisplayName: <string> + outputFieldLabels: + reprehenderit19: <string> + inputFieldOptionLabels: + laborum9: + tempor52: <string> + voluptate__98: <string> + actionDescription: <string> + executionRules: + reprehenderit_88: <string> + inputFieldLabels: + sint_9c: <string> + incididunt2: <string> + actionCardContent: <string> + objectTypes: + - <string> + - <string> + published: <boolean> + revisionId: <string> + outputFields: + - typeDefinition: + externalOptions: <boolean> + name: <string> + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + type: date + helpText: <string> + referencedObjectType: DEAL_SPLIT + description: <string> + externalOptionsReferenceType: <string> + label: <string> + fieldType: calculation_score + optionsUrl: <string> + - typeDefinition: + externalOptions: <boolean> + name: <string> + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + type: date + helpText: <string> + referencedObjectType: AI_FORECAST + description: <string> + externalOptionsReferenceType: <string> + label: <string> + fieldType: calculation_rollup + optionsUrl: <string> + archivedAt: <long> + inputFieldDependencies: + - controllingFieldName: <string> + dependencyType: SINGLE_FIELD + dependentFieldNames: + - <string> + - <string> + - controllingFieldName: <string> + dependencyType: SINGLE_FIELD + dependentFieldNames: + - <string> + - <string> + executionRules: + - conditions: + sunt_5_9: {} + dolorbb_: {} + labelName: <string> + - conditions: + nisi_4b: {} + labelName: <string> + objectRequestOptions: + properties: + - <string> + - <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "officia_2": [ + "<string>", + "<string>" + ], + "ullamco_2ae": [ + "<string>", + "<string>" + ] + }, + "links": { + "ad3b": "<string>", + "adipisicing065": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "mollita5": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "consectetur98d": [ + "<string>", + "<string>" + ], + "sit_18_": [ + "<string>", + "<string>" + ] + } + } + ] + } + /automation/v4/actions/{appId}/{definitionId}: + get: + tags: + - Custom Workflow Actions API > Definitions + summary: Get extension definition by Id + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + - name: appId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <integer> + - name: definitionId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + actionUrl: <string> + functions: + - functionType: POST_ACTION_EXECUTION + id: <string> + - functionType: POST_FETCH_OPTIONS + id: <string> + id: <string> + inputFields: + - isRequired: <boolean> + typeDefinition: + externalOptions: <boolean> + name: <string> + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + type: json + helpText: <string> + referencedObjectType: UNKNOWN + description: <string> + externalOptionsReferenceType: <string> + label: <string> + fieldType: checkbox + optionsUrl: <string> + automationFieldType: <string> + supportedValueTypes: + - OBJECT_PROPERTY + - FETCHED_OBJECT_PROPERTY + - isRequired: <boolean> + typeDefinition: + externalOptions: <boolean> + name: <string> + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + type: date + helpText: <string> + referencedObjectType: MARKETING_CAMPAIGN_UTM + description: <string> + externalOptionsReferenceType: <string> + label: <string> + fieldType: calculation_read_time + optionsUrl: <string> + automationFieldType: <string> + supportedValueTypes: + - OBJECT_PROPERTY + - OBJECT_PROPERTY + labels: + dolor319: + actionName: <string> + inputFieldDescriptions: + est_a39: <string> + aute_87: <string> + irure2: <string> + qui4: <string> + appDisplayName: <string> + outputFieldLabels: + reprehenderit19: <string> + inputFieldOptionLabels: + laborum9: + tempor52: <string> + voluptate__98: <string> + actionDescription: <string> + executionRules: + reprehenderit_88: <string> + inputFieldLabels: + sint_9c: <string> + incididunt2: <string> + actionCardContent: <string> + objectTypes: + - <string> + - <string> + published: <boolean> + revisionId: <string> + outputFields: + - typeDefinition: + externalOptions: <boolean> + name: <string> + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + type: date + helpText: <string> + referencedObjectType: DEAL_SPLIT + description: <string> + externalOptionsReferenceType: <string> + label: <string> + fieldType: calculation_score + optionsUrl: <string> + - typeDefinition: + externalOptions: <boolean> + name: <string> + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + type: date + helpText: <string> + referencedObjectType: AI_FORECAST + description: <string> + externalOptionsReferenceType: <string> + label: <string> + fieldType: calculation_rollup + optionsUrl: <string> + archivedAt: <long> + inputFieldDependencies: + - controllingFieldName: <string> + dependencyType: SINGLE_FIELD + dependentFieldNames: + - <string> + - <string> + - controllingFieldName: <string> + dependencyType: SINGLE_FIELD + dependentFieldNames: + - <string> + - <string> + executionRules: + - conditions: + sunt_5_9: {} + dolorbb_: {} + labelName: <string> + - conditions: + nisi_4b: {} + labelName: <string> + objectRequestOptions: + properties: + - <string> + - <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "officia_2": [ + "<string>", + "<string>" + ], + "ullamco_2ae": [ + "<string>", + "<string>" + ] + }, + "links": { + "ad3b": "<string>", + "adipisicing065": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "mollita5": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "consectetur98d": [ + "<string>", + "<string>" + ], + "sit_18_": [ + "<string>", + "<string>" + ] + } + } + ] + } + delete: + tags: + - Custom Workflow Actions API > Definitions + summary: Archive an extension definition + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: appId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <integer> + - name: definitionId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "officia_2": [ + "<string>", + "<string>" + ], + "ullamco_2ae": [ + "<string>", + "<string>" + ] + }, + "links": { + "ad3b": "<string>", + "adipisicing065": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "mollita5": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "consectetur98d": [ + "<string>", + "<string>" + ], + "sit_18_": [ + "<string>", + "<string>" + ] + } + } + ] + } + patch: + tags: + - Custom Workflow Actions API > Definitions + summary: Patch an existing extension definition + requestBody: + content: + application/json: + schema: + type: object + example: + inputFields: + - isRequired: <boolean> + typeDefinition: + externalOptions: <boolean> + name: <string> + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + type: number + helpText: <string> + referencedObjectType: WEB_INTERACTIVE + description: <string> + externalOptionsReferenceType: <string> + label: <string> + fieldType: checkbox + optionsUrl: <string> + automationFieldType: <string> + supportedValueTypes: + - FETCHED_OBJECT_PROPERTY + - FIELD_DATA + - isRequired: <boolean> + typeDefinition: + externalOptions: <boolean> + name: <string> + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + type: number + helpText: <string> + referencedObjectType: FILE_MANAGER_FILE + description: <string> + externalOptionsReferenceType: <string> + label: <string> + fieldType: date + optionsUrl: <string> + automationFieldType: <string> + supportedValueTypes: + - FETCHED_OBJECT_PROPERTY + - OBJECT_PROPERTY + outputFields: + - typeDefinition: + externalOptions: <boolean> + name: <string> + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + type: bool + helpText: <string> + referencedObjectType: CONVERSATION_SESSION + description: <string> + externalOptionsReferenceType: <string> + label: <string> + fieldType: html + optionsUrl: <string> + - typeDefinition: + externalOptions: <boolean> + name: <string> + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + type: object_coordinates + helpText: <string> + referencedObjectType: PARTNER_CLIENT_REVENUE + description: <string> + externalOptionsReferenceType: <string> + label: <string> + fieldType: textarea + optionsUrl: <string> + actionUrl: <string> + inputFieldDependencies: + - controllingFieldName: <string> + dependencyType: SINGLE_FIELD + dependentFieldNames: + - <string> + - <string> + - controllingFieldName: <string> + dependencyType: SINGLE_FIELD + dependentFieldNames: + - <string> + - <string> + published: <boolean> + executionRules: + - conditions: + mollit__: {} + labelName: <string> + - conditions: + commodo41: {} + laboris4b: {} + ut_e81: {} + labelName: <string> + objectTypes: + - <string> + - <string> + objectRequestOptions: + properties: + - <string> + - <string> + labels: + officia8f: + actionName: <string> + inputFieldDescriptions: + consequat8: <string> + id37: <string> + appDisplayName: <string> + outputFieldLabels: + anim01: <string> + inputFieldOptionLabels: + culpa6c: + sit59: <string> + nonfe4: <string> + sit_5: <string> + ut_2: + ea_91: <string> + in1: <string> + dolor0c2: <string> + Duis_f: <string> + veniam06: + sunt5b: <string> + sintbb7: <string> + eu5: + tempor_d: <string> + Utd28: <string> + actionDescription: <string> + executionRules: + irurec: <string> + inputFieldLabels: + eu_2c4: <string> + actionCardContent: <string> + occaecat_31: + actionName: <string> + inputFieldDescriptions: + sint19: <string> + cillum_3: <string> + appDisplayName: <string> + outputFieldLabels: + cupidatat_5af: <string> + inputFieldOptionLabels: + do2: + Lorem_8e: <string> + labore_9e: + elitc57: <string> + actionDescription: <string> + executionRules: + occaecatb: <string> + temporc3: <string> + ut_b: <string> + sunt_0: <string> + inputFieldLabels: + consequat_eb: <string> + actionCardContent: <string> + incididunt_ac: + actionName: <string> + inputFieldDescriptions: + voluptate_8: <string> + quis_d_: <string> + appDisplayName: <string> + outputFieldLabels: + in_8: <string> + quis_8f2: <string> + eiusmod39: <string> + et0c3: <string> + inputFieldOptionLabels: + laborec2: + Duis_2e: <string> + aliquip38: <string> + actionDescription: <string> + executionRules: + magna2: <string> + irure47: <string> + inputFieldLabels: + fugiat0: <string> + eu4: <string> + actionCardContent: <string> + sunt7: + actionName: <string> + inputFieldDescriptions: + aute_ae: <string> + nostrud_0: <string> + appDisplayName: <string> + outputFieldLabels: + cillumfd: <string> + voluptate_2: <string> + inputFieldOptionLabels: + dolor5: + est_7: <string> + proidentf6: <string> + eu_458: <string> + consectetur6: + eu_f4a: <string> + actionDescription: <string> + executionRules: + ipsum_1: <string> + nostrud_c: <string> + inputFieldLabels: + eiusmod_9b0: <string> + actionCardContent: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: appId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <integer> + - name: definitionId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + actionUrl: <string> + functions: + - functionType: POST_ACTION_EXECUTION + id: <string> + - functionType: POST_FETCH_OPTIONS + id: <string> + id: <string> + inputFields: + - isRequired: <boolean> + typeDefinition: + externalOptions: <boolean> + name: <string> + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + type: json + helpText: <string> + referencedObjectType: UNKNOWN + description: <string> + externalOptionsReferenceType: <string> + label: <string> + fieldType: checkbox + optionsUrl: <string> + automationFieldType: <string> + supportedValueTypes: + - OBJECT_PROPERTY + - FETCHED_OBJECT_PROPERTY + - isRequired: <boolean> + typeDefinition: + externalOptions: <boolean> + name: <string> + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + type: date + helpText: <string> + referencedObjectType: MARKETING_CAMPAIGN_UTM + description: <string> + externalOptionsReferenceType: <string> + label: <string> + fieldType: calculation_read_time + optionsUrl: <string> + automationFieldType: <string> + supportedValueTypes: + - OBJECT_PROPERTY + - OBJECT_PROPERTY + labels: + dolor319: + actionName: <string> + inputFieldDescriptions: + est_a39: <string> + aute_87: <string> + irure2: <string> + qui4: <string> + appDisplayName: <string> + outputFieldLabels: + reprehenderit19: <string> + inputFieldOptionLabels: + laborum9: + tempor52: <string> + voluptate__98: <string> + actionDescription: <string> + executionRules: + reprehenderit_88: <string> + inputFieldLabels: + sint_9c: <string> + incididunt2: <string> + actionCardContent: <string> + objectTypes: + - <string> + - <string> + published: <boolean> + revisionId: <string> + outputFields: + - typeDefinition: + externalOptions: <boolean> + name: <string> + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + type: date + helpText: <string> + referencedObjectType: DEAL_SPLIT + description: <string> + externalOptionsReferenceType: <string> + label: <string> + fieldType: calculation_score + optionsUrl: <string> + - typeDefinition: + externalOptions: <boolean> + name: <string> + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + type: date + helpText: <string> + referencedObjectType: AI_FORECAST + description: <string> + externalOptionsReferenceType: <string> + label: <string> + fieldType: calculation_rollup + optionsUrl: <string> + archivedAt: <long> + inputFieldDependencies: + - controllingFieldName: <string> + dependencyType: SINGLE_FIELD + dependentFieldNames: + - <string> + - <string> + - controllingFieldName: <string> + dependencyType: SINGLE_FIELD + dependentFieldNames: + - <string> + - <string> + executionRules: + - conditions: + sunt_5_9: {} + dolorbb_: {} + labelName: <string> + - conditions: + nisi_4b: {} + labelName: <string> + objectRequestOptions: + properties: + - <string> + - <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "officia_2": [ + "<string>", + "<string>" + ], + "ullamco_2ae": [ + "<string>", + "<string>" + ] + }, + "links": { + "ad3b": "<string>", + "adipisicing065": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "mollita5": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "consectetur98d": [ + "<string>", + "<string>" + ], + "sit_18_": [ + "<string>", + "<string>" + ] + } + } + ] + } + /automation/v4/actions/{appId}/{definitionId}/functions: + get: + tags: + - Custom Workflow Actions API > Functions + summary: Get all functions for a given definition + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: appId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <integer> + - name: definitionId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - functionType: POST_FETCH_OPTIONS + id: <string> + - functionType: PRE_ACTION_EXECUTION + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "officia_2": [ + "<string>", + "<string>" + ], + "ullamco_2ae": [ + "<string>", + "<string>" + ] + }, + "links": { + "ad3b": "<string>", + "adipisicing065": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "mollita5": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "consectetur98d": [ + "<string>", + "<string>" + ], + "sit_18_": [ + "<string>", + "<string>" + ] + } + } + ] + } + /automation/v4/actions/{appId}/{definitionId}/functions/{functionType}: + get: + tags: + - Custom Workflow Actions API > Functions + summary: Get all functions by a type for a given definition + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: appId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <integer> + - name: definitionId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + - name: functionType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: POST_ACTION_EXECUTION + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + functionSource: <string> + functionType: POST_FETCH_OPTIONS + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "officia_2": [ + "<string>", + "<string>" + ], + "ullamco_2ae": [ + "<string>", + "<string>" + ] + }, + "links": { + "ad3b": "<string>", + "adipisicing065": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "mollita5": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "consectetur98d": [ + "<string>", + "<string>" + ], + "sit_18_": [ + "<string>", + "<string>" + ] + } + } + ] + } + put: + tags: + - Custom Workflow Actions API > Functions + summary: Insert a function for a definition + requestBody: + content: + application/json: + schema: + type: object + example: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: text/plain + - name: Accept + in: header + schema: + type: string + example: application/json + - name: appId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <integer> + - name: definitionId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + - name: functionType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: POST_ACTION_EXECUTION + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + functionType: PRE_ACTION_EXECUTION + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "officia_2": [ + "<string>", + "<string>" + ], + "ullamco_2ae": [ + "<string>", + "<string>" + ] + }, + "links": { + "ad3b": "<string>", + "adipisicing065": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "mollita5": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "consectetur98d": [ + "<string>", + "<string>" + ], + "sit_18_": [ + "<string>", + "<string>" + ] + } + } + ] + } + delete: + tags: + - Custom Workflow Actions API > Functions + summary: Delete a function for a definition + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: appId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <integer> + - name: definitionId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + - name: functionType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: POST_ACTION_EXECUTION + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "officia_2": [ + "<string>", + "<string>" + ], + "ullamco_2ae": [ + "<string>", + "<string>" + ] + }, + "links": { + "ad3b": "<string>", + "adipisicing065": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "mollita5": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "consectetur98d": [ + "<string>", + "<string>" + ], + "sit_18_": [ + "<string>", + "<string>" + ] + } + } + ] + } + /automation/v4/actions/{appId}/{definitionId}/functions/{functionType}/{functionId}: + get: + tags: + - Custom Workflow Actions API > Functions + summary: Get a function for a given definition + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: appId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <integer> + - name: definitionId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + - name: functionType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: POST_ACTION_EXECUTION + - name: functionId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + functionSource: <string> + functionType: POST_FETCH_OPTIONS + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "officia_2": [ + "<string>", + "<string>" + ], + "ullamco_2ae": [ + "<string>", + "<string>" + ] + }, + "links": { + "ad3b": "<string>", + "adipisicing065": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "mollita5": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "consectetur98d": [ + "<string>", + "<string>" + ], + "sit_18_": [ + "<string>", + "<string>" + ] + } + } + ] + } + put: + tags: + - Custom Workflow Actions API > Functions + summary: Insert a function for a definition + requestBody: + content: + application/json: + schema: + type: object + example: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: text/plain + - name: Accept + in: header + schema: + type: string + example: application/json + - name: appId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <integer> + - name: definitionId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + - name: functionType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: POST_ACTION_EXECUTION + - name: functionId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + functionType: PRE_ACTION_EXECUTION + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "officia_2": [ + "<string>", + "<string>" + ], + "ullamco_2ae": [ + "<string>", + "<string>" + ] + }, + "links": { + "ad3b": "<string>", + "adipisicing065": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "mollita5": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "consectetur98d": [ + "<string>", + "<string>" + ], + "sit_18_": [ + "<string>", + "<string>" + ] + } + } + ] + } + delete: + tags: + - Custom Workflow Actions API > Functions + summary: Archive a function for a definition + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: appId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <integer> + - name: definitionId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + - name: functionType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: POST_ACTION_EXECUTION + - name: functionId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "officia_2": [ + "<string>", + "<string>" + ], + "ullamco_2ae": [ + "<string>", + "<string>" + ] + }, + "links": { + "ad3b": "<string>", + "adipisicing065": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "mollita5": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "consectetur98d": [ + "<string>", + "<string>" + ], + "sit_18_": [ + "<string>", + "<string>" + ] + } + } + ] + } + /automation/v4/actions/{appId}/{definitionId}/revisions/{revisionId}: + get: + tags: + - Custom Workflow Actions API > Revisions + summary: Gets a revision for a given definition by revision id + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: appId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <integer> + - name: definitionId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + - name: revisionId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + definition: + actionUrl: <string> + functions: + - functionType: POST_ACTION_EXECUTION + id: <string> + - functionType: POST_FETCH_OPTIONS + id: <string> + id: <string> + inputFields: + - isRequired: <boolean> + typeDefinition: + externalOptions: <boolean> + name: <string> + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + type: date + helpText: <string> + referencedObjectType: PLAYLIST + description: <string> + externalOptionsReferenceType: <string> + label: <string> + fieldType: select + optionsUrl: <string> + automationFieldType: <string> + supportedValueTypes: + - ENROLLMENT_EVENT_PROPERTY + - OBJECT_PROPERTY + - isRequired: <boolean> + typeDefinition: + externalOptions: <boolean> + name: <string> + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + type: phone_number + helpText: <string> + referencedObjectType: COMMERCE_PAYMENT + description: <string> + externalOptionsReferenceType: <string> + label: <string> + fieldType: calculation_equation + optionsUrl: <string> + automationFieldType: <string> + supportedValueTypes: + - STATIC_VALUE + - ENROLLMENT_EVENT_PROPERTY + labels: + exercitationae7: + actionName: <string> + inputFieldDescriptions: + laborumf: <string> + appDisplayName: <string> + outputFieldLabels: + occaecatf: <string> + amet_1: <string> + inputFieldOptionLabels: + mollit3: + velit_32: <string> + nisi_8: + elit1d: <string> + laboris_b_: <string> + actionDescription: <string> + executionRules: + ut_796: <string> + suntef5: <string> + inputFieldLabels: + in_e: <string> + nisi_07: <string> + actionCardContent: <string> + dolore_b8: + actionName: <string> + inputFieldDescriptions: + adipisicing_b: <string> + appDisplayName: <string> + outputFieldLabels: + Ut8: <string> + laboris87: <string> + inputFieldOptionLabels: + nisia7: + ex_e14: <string> + dolor_: <string> + dolorea5: + in75: <string> + actionDescription: <string> + executionRules: + ex_d5: <string> + inputFieldLabels: + consectetur_aba: <string> + actionCardContent: <string> + objectTypes: + - <string> + - <string> + published: <boolean> + revisionId: <string> + outputFields: + - typeDefinition: + externalOptions: <boolean> + name: <string> + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + type: phone_number + helpText: <string> + referencedObjectType: TASK_TEMPLATE + description: <string> + externalOptionsReferenceType: <string> + label: <string> + fieldType: text + optionsUrl: <string> + - typeDefinition: + externalOptions: <boolean> + name: <string> + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + type: enumeration + helpText: <string> + referencedObjectType: MEDIA_BRIDGE + description: <string> + externalOptionsReferenceType: <string> + label: <string> + fieldType: number + optionsUrl: <string> + archivedAt: <long> + inputFieldDependencies: + - controllingFieldName: <string> + dependencyType: SINGLE_FIELD + dependentFieldNames: + - <string> + - <string> + - controllingFieldName: <string> + dependencyType: SINGLE_FIELD + dependentFieldNames: + - <string> + - <string> + executionRules: + - conditions: + dolor_c4: {} + labelName: <string> + - conditions: + aliquip_c: {} + labelName: <string> + objectRequestOptions: + properties: + - <string> + - <string> + id: <string> + revisionId: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "officia_2": [ + "<string>", + "<string>" + ], + "ullamco_2ae": [ + "<string>", + "<string>" + ] + }, + "links": { + "ad3b": "<string>", + "adipisicing065": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "mollita5": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "consectetur98d": [ + "<string>", + "<string>" + ], + "sit_18_": [ + "<string>", + "<string>" + ] + } + } + ] + } + /automation/v4/actions/{appId}/{definitionId}/revisions: + get: + tags: + - Custom Workflow Actions API > Revisions + summary: Get all revisions for a given definition + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: limit + in: query + schema: + type: string + description: The maximum number of results to display per page. + example: <integer> + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: appId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <integer> + - name: definitionId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + definition: + actionUrl: <string> + functions: + - functionType: PRE_FETCH_OPTIONS + id: <string> + - functionType: POST_FETCH_OPTIONS + id: <string> + id: <string> + inputFields: + - isRequired: <boolean> + typeDefinition: + externalOptions: <boolean> + name: <string> + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + type: bool + helpText: <string> + referencedObjectType: PAYMENT_LINK + description: <string> + externalOptionsReferenceType: <string> + label: <string> + fieldType: select + optionsUrl: <string> + automationFieldType: <string> + supportedValueTypes: + - FIELD_DATA + - FIELD_DATA + - isRequired: <boolean> + typeDefinition: + externalOptions: <boolean> + name: <string> + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + type: json + helpText: <string> + referencedObjectType: DATA_PRIVACY_CONSENT + description: <string> + externalOptionsReferenceType: <string> + label: <string> + fieldType: number + optionsUrl: <string> + automationFieldType: <string> + supportedValueTypes: + - ENROLLMENT_EVENT_PROPERTY + - ENROLLMENT_EVENT_PROPERTY + labels: + veniam_2b: + actionName: <string> + inputFieldDescriptions: + ipsum99: <string> + appDisplayName: <string> + outputFieldLabels: + sunt48: <string> + Lorem8_3: <string> + inputFieldOptionLabels: + dolore_2c1: + Ut7f0: <string> + consequatac8: + do12: <string> + sunt_d: <string> + actionDescription: <string> + executionRules: + consequatc: <string> + in_2: <string> + et_4d8: <string> + inputFieldLabels: + id376: <string> + anim_e: <string> + actionCardContent: <string> + adipisicing018: + actionName: <string> + inputFieldDescriptions: + Excepteur_d13: <string> + occaecat_d: <string> + pariatur_e: <string> + laboris_0: <string> + in000: <string> + appDisplayName: <string> + outputFieldLabels: + sitb: <string> + esse08: <string> + inputFieldOptionLabels: + tempor49: + ead8: <string> + sint_1: <string> + in_e: + addc: <string> + magnab: <string> + actionDescription: <string> + executionRules: + enim_12: <string> + esse_a3: <string> + cupidatatb0: <string> + inputFieldLabels: + in_: <string> + qui_66: <string> + actionCardContent: <string> + objectTypes: + - <string> + - <string> + published: <boolean> + revisionId: <string> + outputFields: + - typeDefinition: + externalOptions: <boolean> + name: <string> + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + type: bool + helpText: <string> + referencedObjectType: QUOTE_TEMPLATE + description: <string> + externalOptionsReferenceType: <string> + label: <string> + fieldType: textarea + optionsUrl: <string> + - typeDefinition: + externalOptions: <boolean> + name: <string> + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + type: datetime + helpText: <string> + referencedObjectType: CALL + description: <string> + externalOptionsReferenceType: <string> + label: <string> + fieldType: number + optionsUrl: <string> + archivedAt: <long> + inputFieldDependencies: + - controllingFieldName: <string> + dependencyType: SINGLE_FIELD + dependentFieldNames: + - <string> + - <string> + - controllingFieldName: <string> + dependencyType: SINGLE_FIELD + dependentFieldNames: + - <string> + - <string> + executionRules: + - conditions: + ex__8e: {} + officia7: {} + labelName: <string> + - conditions: + Lorem39_: {} + labelName: <string> + objectRequestOptions: + properties: + - <string> + - <string> + id: <string> + revisionId: <string> + - createdAt: <dateTime> + definition: + actionUrl: <string> + functions: + - functionType: POST_ACTION_EXECUTION + id: <string> + - functionType: PRE_FETCH_OPTIONS + id: <string> + id: <string> + inputFields: + - isRequired: <boolean> + typeDefinition: + externalOptions: <boolean> + name: <string> + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + type: enumeration + helpText: <string> + referencedObjectType: SUBSCRIPTION + description: <string> + externalOptionsReferenceType: <string> + label: <string> + fieldType: date + optionsUrl: <string> + automationFieldType: <string> + supportedValueTypes: + - STATIC_VALUE + - FETCHED_OBJECT_PROPERTY + - isRequired: <boolean> + typeDefinition: + externalOptions: <boolean> + name: <string> + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + type: datetime + helpText: <string> + referencedObjectType: SOCIAL_CHANNEL + description: <string> + externalOptionsReferenceType: <string> + label: <string> + fieldType: radio + optionsUrl: <string> + automationFieldType: <string> + supportedValueTypes: + - OBJECT_PROPERTY + - ENROLLMENT_EVENT_PROPERTY + labels: + mollit8: + actionName: <string> + inputFieldDescriptions: + ad02: <string> + ad_39: <string> + appDisplayName: <string> + outputFieldLabels: + irure_3d: <string> + inputFieldOptionLabels: + do2f: + dolor_1a: <string> + in_d: <string> + minim704: <string> + et3c1: <string> + do_66: + mollit_5d: <string> + proident_c9: <string> + ut_9: <string> + incididunte: + labore3: <string> + actionDescription: <string> + executionRules: + labore_9f: <string> + esse7: <string> + inputFieldLabels: + exercitation1: <string> + eueb1: <string> + actionCardContent: <string> + sit15: + actionName: <string> + inputFieldDescriptions: + dolore_6d: <string> + ipsum7: <string> + ullamco__: <string> + appDisplayName: <string> + outputFieldLabels: + dolore_9_2: <string> + inputFieldOptionLabels: + laboree: + utb: <string> + proident_b7: <string> + adipisicing3: + qui9: <string> + ut_f: <string> + actionDescription: <string> + executionRules: + est8: <string> + adipisicing_c6: <string> + sunt__c: <string> + dolorebb: <string> + inputFieldLabels: + adc9: <string> + do__a: <string> + sunt_db7: <string> + actionCardContent: <string> + nostrud_3: + actionName: <string> + inputFieldDescriptions: + magna_ba: <string> + officia_dd: <string> + voluptate94: <string> + appDisplayName: <string> + outputFieldLabels: + quis95b: <string> + inputFieldOptionLabels: + velit_f87: + sint_e08: <string> + tempor987: <string> + eiusmod_8: + veniam_9e: <string> + in_9: + Lorem_88: <string> + in__f: + qui_88: <string> + officia_9d: <string> + actionDescription: <string> + executionRules: + ipsum_e5: <string> + inputFieldLabels: + mollitff: <string> + actionCardContent: <string> + objectTypes: + - <string> + - <string> + published: <boolean> + revisionId: <string> + outputFields: + - typeDefinition: + externalOptions: <boolean> + name: <string> + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + type: number + helpText: <string> + referencedObjectType: BLOG_LISTING_PAGE + description: <string> + externalOptionsReferenceType: <string> + label: <string> + fieldType: number + optionsUrl: <string> + - typeDefinition: + externalOptions: <boolean> + name: <string> + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + type: string + helpText: <string> + referencedObjectType: LANDING_PAGE + description: <string> + externalOptionsReferenceType: <string> + label: <string> + fieldType: calculation_read_time + optionsUrl: <string> + archivedAt: <long> + inputFieldDependencies: + - controllingFieldName: <string> + dependencyType: SINGLE_FIELD + dependentFieldNames: + - <string> + - <string> + - controllingFieldName: <string> + dependencyType: SINGLE_FIELD + dependentFieldNames: + - <string> + - <string> + executionRules: + - conditions: + in_889: {} + eu_21: {} + nostrud_79: {} + labelName: <string> + - conditions: + ea0: {} + minim_1: {} + labelName: <string> + objectRequestOptions: + properties: + - <string> + - <string> + id: <string> + revisionId: <string> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "officia_2": [ + "<string>", + "<string>" + ], + "ullamco_2ae": [ + "<string>", + "<string>" + ] + }, + "links": { + "ad3b": "<string>", + "adipisicing065": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "mollita5": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "consectetur98d": [ + "<string>", + "<string>" + ], + "sit_18_": [ + "<string>", + "<string>" + ] + } + } + ] + } + /automation/v4/sequences/enrollments/contact/{contactId}: + get: + tags: + - Sequences API > Public_Enrollments + summary: get-/automation/v4/sequences/enrollments/contact/{contact Id} + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: contactId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + enrolledAt: <dateTime> + enrolledBy: <string> + enrolledByEmail: <string> + id: <string> + sequenceId: <string> + sequenceName: <string> + toEmail: <string> + updatedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "Lorem32b": [ + "<string>", + "<string>" + ], + "pariatur985": [ + "<string>", + "<string>" + ] + }, + "links": { + "culpa_c17": "<string>", + "Excepteur9a1": "<string>", + "velit_f3c": "<string>", + "aliquip8d2": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "ex1e": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "dolore44": [ + "<string>", + "<string>" + ], + "Lorem_d8": [ + "<string>", + "<string>" + ] + } + } + ] + } + /automation/v4/sequences/enrollments: + post: + tags: + - Sequences API > Public_Enrollments + summary: post-/automation/v4/sequences/enrollments + requestBody: + content: + application/json: + schema: + type: object + example: + contactId: <string> + senderEmail: <string> + sequenceId: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: userId + in: query + schema: + type: string + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + enrolledAt: <dateTime> + id: <string> + toEmail: <string> + updatedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "Lorem32b": [ + "<string>", + "<string>" + ], + "pariatur985": [ + "<string>", + "<string>" + ] + }, + "links": { + "culpa_c17": "<string>", + "Excepteur9a1": "<string>", + "velit_f3c": "<string>", + "aliquip8d2": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "ex1e": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "dolore44": [ + "<string>", + "<string>" + ], + "Lorem_d8": [ + "<string>", + "<string>" + ] + } + } + ] + } + /automation/v4/sequences/: + get: + tags: + - Sequences API > Public_Sequences + summary: get-/automation/v4/sequences/ + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: userId + in: query + schema: + type: string + description: '(Required) ' + example: <string> + - name: after + in: query + schema: + type: string + example: <string> + - name: limit + in: query + schema: + type: string + example: <integer> + - name: name + in: query + schema: + type: string + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + name: <string> + updatedAt: <dateTime> + userId: <string> + folderId: <string> + - createdAt: <dateTime> + id: <string> + name: <string> + updatedAt: <dateTime> + userId: <string> + folderId: <string> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "Lorem32b": [ + "<string>", + "<string>" + ], + "pariatur985": [ + "<string>", + "<string>" + ] + }, + "links": { + "culpa_c17": "<string>", + "Excepteur9a1": "<string>", + "velit_f3c": "<string>", + "aliquip8d2": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "ex1e": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "dolore44": [ + "<string>", + "<string>" + ], + "Lorem_d8": [ + "<string>", + "<string>" + ] + } + } + ] + } + /automation/v4/sequences/{sequenceId}: + get: + tags: + - Sequences API > Public_Sequences + summary: get-/automation/v4/sequences/{sequence Id} + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: userId + in: query + schema: + type: string + description: '(Required) ' + example: <string> + - name: sequenceId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + dependencies: + - createdAt: <dateTime> + dependencyType: <string> + id: <string> + reliesOnSequenceStepId: <string> + reliesOnStepOrder: <integer> + requiredBySequenceStepId: <string> + requiredByStepOrder: <integer> + updatedAt: <dateTime> + - createdAt: <dateTime> + dependencyType: <string> + id: <string> + reliesOnSequenceStepId: <string> + reliesOnStepOrder: <integer> + requiredBySequenceStepId: <string> + requiredByStepOrder: <integer> + updatedAt: <dateTime> + id: <string> + name: <string> + steps: + - actionType: <string> + createdAt: <dateTime> + delayMillis: <integer> + id: <string> + stepOrder: <integer> + updatedAt: <dateTime> + emailPattern: + createdAt: <dateTime> + id: <string> + templateId: <string> + updatedAt: <dateTime> + threadEmailToStepOrder: <integer> + taskPattern: + createdAt: <dateTime> + id: <string> + taskPriority: <string> + taskType: <string> + updatedAt: <dateTime> + queueId: <integer> + notes: <string> + subject: <string> + templateId: <long> + threadEmailToStepOrder: <integer> + - actionType: <string> + createdAt: <dateTime> + delayMillis: <integer> + id: <string> + stepOrder: <integer> + updatedAt: <dateTime> + emailPattern: + createdAt: <dateTime> + id: <string> + templateId: <string> + updatedAt: <dateTime> + threadEmailToStepOrder: <integer> + taskPattern: + createdAt: <dateTime> + id: <string> + taskPriority: <string> + taskType: <string> + updatedAt: <dateTime> + queueId: <integer> + notes: <string> + subject: <string> + templateId: <long> + threadEmailToStepOrder: <integer> + updatedAt: <dateTime> + userId: <string> + settings: + createdAt: <dateTime> + eligibleFollowUpDays: <string> + id: <string> + individualTaskRemindersEnabled: <boolean> + sellingStrategy: <string> + sendWindowEndMinute: <integer> + sendWindowStartMinute: <integer> + taskReminderMinute: <integer> + updatedAt: <dateTime> + folderId: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "Lorem32b": [ + "<string>", + "<string>" + ], + "pariatur985": [ + "<string>", + "<string>" + ] + }, + "links": { + "culpa_c17": "<string>", + "Excepteur9a1": "<string>", + "velit_f3c": "<string>", + "aliquip8d2": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "ex1e": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "dolore44": [ + "<string>", + "<string>" + ], + "Lorem_d8": [ + "<string>", + "<string>" + ] + } + } + ] + } + /automation/v4/flows/batch/read: + post: + tags: + - Workflows V4 API > Workflows + summary: Retrieve a batch of workflows + description: Retrieve a batch of workflows by ID. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - flowId: <string> + type: FLOW_ID + - flowId: <string> + type: FLOW_ID + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - actions: + - actionId: <string> + inputValue: + actionId: <string> + dataKey: <string> + type: FIELD_DATA + staticBranches: + - branchValue: <string> + connection: + edgeType: <string> + nextActionId: <string> + - branchValue: <string> + connection: + edgeType: <string> + nextActionId: <string> + type: STATIC_BRANCH + defaultBranchName: <string> + defaultBranch: + edgeType: <string> + nextActionId: <string> + - actionId: <string> + inputValue: + actionId: <string> + dataKey: <string> + type: FIELD_DATA + staticBranches: + - branchValue: <string> + connection: + edgeType: <string> + nextActionId: <string> + - branchValue: <string> + connection: + edgeType: <string> + nextActionId: <string> + type: STATIC_BRANCH + defaultBranchName: <string> + defaultBranch: + edgeType: <string> + nextActionId: <string> + blockedDates: + - dayOfMonth: <integer> + month: JANUARY + year: <integer> + - dayOfMonth: <integer> + month: JUNE + year: <integer> + canEnrollFromSalesforce: <boolean> + createdAt: <dateTime> + crmObjectCreationStatus: COMPLETE + customProperties: + voluptate73: <string> + dataSources: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + name: <string> + objectTypeId: <string> + type: ASSOCIATION + sortBy: + order: DESC + property: <string> + missing: <string> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + name: <string> + objectTypeId: <string> + type: ASSOCIATION + sortBy: + order: ASC + property: <string> + missing: <string> + flowType: UNKNOWN + id: <string> + isEnabled: <boolean> + nextAvailableActionId: <string> + objectTypeId: <string> + revisionId: <string> + suppressionListIds: + - <integer> + - <integer> + timeWindows: + - day: FRIDAY + endTime: + hour: <integer> + minute: <integer> + startTime: + hour: <integer> + minute: <integer> + - day: FRIDAY + endTime: + hour: <integer> + minute: <integer> + startTime: + hour: <integer> + minute: <integer> + type: CONTACT_FLOW + updatedAt: <dateTime> + name: <string> + description: <string> + uuid: <string> + startActionId: <string> + enrollmentCriteria: + listFilterBranch: + filterBranchOperator: <string> + filterBranchType: OR + filterBranches: + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch + detected> + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch + detected> + filters: + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + reEnrollmentTriggersFilterBranches: + - filterBranchOperator: <string> + filterBranchType: OR + filterBranches: + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch + detected> + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch + detected> + filters: + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterBranchOperator: <string> + filterBranchType: OR + filterBranches: + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch + detected> + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch + detected> + filters: + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + shouldReEnroll: <boolean> + type: LIST_BASED + unEnrollObjectsNotMeetingCriteria: <boolean> + enrollmentSchedule: + timeOfDay: + hour: <integer> + minute: <integer> + type: DAILY + goalFilterBranch: + filterBranchOperator: <string> + filterBranchType: OR + filterBranches: + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + filters: + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + eventAnchor: + contactProperty: <string> + type: CONTACT_PROPERTY_ANCHOR + unEnrollmentSetting: + flowIds: + - <string> + - <string> + type: ALL + - actions: + - actionId: <string> + inputValue: + actionId: <string> + dataKey: <string> + type: FIELD_DATA + staticBranches: + - branchValue: <string> + connection: + edgeType: <string> + nextActionId: <string> + - branchValue: <string> + connection: + edgeType: <string> + nextActionId: <string> + type: STATIC_BRANCH + defaultBranchName: <string> + defaultBranch: + edgeType: <string> + nextActionId: <string> + - actionId: <string> + inputValue: + actionId: <string> + dataKey: <string> + type: FIELD_DATA + staticBranches: + - branchValue: <string> + connection: + edgeType: <string> + nextActionId: <string> + - branchValue: <string> + connection: + edgeType: <string> + nextActionId: <string> + type: STATIC_BRANCH + defaultBranchName: <string> + defaultBranch: + edgeType: <string> + nextActionId: <string> + blockedDates: + - dayOfMonth: <integer> + month: FEBRUARY + year: <integer> + - dayOfMonth: <integer> + month: NOVEMBER + year: <integer> + canEnrollFromSalesforce: <boolean> + createdAt: <dateTime> + crmObjectCreationStatus: COMPLETE + customProperties: + labore_782: <string> + ad_c_8: <string> + dataSources: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + name: <string> + objectTypeId: <string> + type: ASSOCIATION + sortBy: + order: ASC + property: <string> + missing: <string> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + name: <string> + objectTypeId: <string> + type: ASSOCIATION + sortBy: + order: DESC + property: <string> + missing: <string> + flowType: ACTION_SET + id: <string> + isEnabled: <boolean> + nextAvailableActionId: <string> + objectTypeId: <string> + revisionId: <string> + suppressionListIds: + - <integer> + - <integer> + timeWindows: + - day: SUNDAY + endTime: + hour: <integer> + minute: <integer> + startTime: + hour: <integer> + minute: <integer> + - day: SATURDAY + endTime: + hour: <integer> + minute: <integer> + startTime: + hour: <integer> + minute: <integer> + type: CONTACT_FLOW + updatedAt: <dateTime> + name: <string> + description: <string> + uuid: <string> + startActionId: <string> + enrollmentCriteria: + listFilterBranch: + filterBranchOperator: <string> + filterBranchType: OR + filterBranches: + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch + detected> + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch + detected> + filters: + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + reEnrollmentTriggersFilterBranches: + - filterBranchOperator: <string> + filterBranchType: OR + filterBranches: + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch + detected> + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch + detected> + filters: + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterBranchOperator: <string> + filterBranchType: OR + filterBranches: + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch + detected> + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch + detected> + filters: + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + shouldReEnroll: <boolean> + type: LIST_BASED + unEnrollObjectsNotMeetingCriteria: <boolean> + enrollmentSchedule: + timeOfDay: + hour: <integer> + minute: <integer> + type: DAILY + goalFilterBranch: + filterBranchOperator: <string> + filterBranchType: OR + filterBranches: + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + filters: + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + eventAnchor: + contactProperty: <string> + type: CONTACT_PROPERTY_ANCHOR + unEnrollmentSetting: + flowIds: + - <string> + - <string> + type: SELECTIVE + startedAt: <dateTime> + status: CANCELED + requestedAt: <dateTime> + links: + Excepteur9: <string> + aliquip_9d: <string> + ut__59: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - actions: + - actionId: <string> + inputValue: + actionId: <string> + dataKey: <string> + type: FIELD_DATA + staticBranches: + - branchValue: <string> + connection: + edgeType: <string> + nextActionId: <string> + - branchValue: <string> + connection: + edgeType: <string> + nextActionId: <string> + type: STATIC_BRANCH + defaultBranchName: <string> + defaultBranch: + edgeType: <string> + nextActionId: <string> + - actionId: <string> + inputValue: + actionId: <string> + dataKey: <string> + type: FIELD_DATA + staticBranches: + - branchValue: <string> + connection: + edgeType: <string> + nextActionId: <string> + - branchValue: <string> + connection: + edgeType: <string> + nextActionId: <string> + type: STATIC_BRANCH + defaultBranchName: <string> + defaultBranch: + edgeType: <string> + nextActionId: <string> + blockedDates: + - dayOfMonth: <integer> + month: SEPTEMBER + year: <integer> + - dayOfMonth: <integer> + month: OCTOBER + year: <integer> + canEnrollFromSalesforce: <boolean> + createdAt: <dateTime> + crmObjectCreationStatus: PENDING + customProperties: + dolore_a0e: <string> + ut__70: <string> + dataSources: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + name: <string> + objectTypeId: <string> + type: ASSOCIATION + sortBy: + order: ASC + property: <string> + missing: <string> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + name: <string> + objectTypeId: <string> + type: ASSOCIATION + sortBy: + order: DESC + property: <string> + missing: <string> + flowType: WORKFLOW + id: <string> + isEnabled: <boolean> + nextAvailableActionId: <string> + objectTypeId: <string> + revisionId: <string> + suppressionListIds: + - <integer> + - <integer> + timeWindows: + - day: MONDAY + endTime: + hour: <integer> + minute: <integer> + startTime: + hour: <integer> + minute: <integer> + - day: FRIDAY + endTime: + hour: <integer> + minute: <integer> + startTime: + hour: <integer> + minute: <integer> + type: CONTACT_FLOW + updatedAt: <dateTime> + name: <string> + description: <string> + uuid: <string> + startActionId: <string> + enrollmentCriteria: + listFilterBranch: + filterBranchOperator: <string> + filterBranchType: OR + filterBranches: + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch + detected> + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch + detected> + filters: + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + reEnrollmentTriggersFilterBranches: + - filterBranchOperator: <string> + filterBranchType: OR + filterBranches: + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch + detected> + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch + detected> + filters: + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterBranchOperator: <string> + filterBranchType: OR + filterBranches: + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch + detected> + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch + detected> + filters: + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + shouldReEnroll: <boolean> + type: LIST_BASED + unEnrollObjectsNotMeetingCriteria: <boolean> + enrollmentSchedule: + timeOfDay: + hour: <integer> + minute: <integer> + type: DAILY + goalFilterBranch: + filterBranchOperator: <string> + filterBranchType: OR + filterBranches: + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + filters: + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + eventAnchor: + contactProperty: <string> + type: CONTACT_PROPERTY_ANCHOR + unEnrollmentSetting: + flowIds: + - <string> + - <string> + type: ALL + - actions: + - actionId: <string> + inputValue: + actionId: <string> + dataKey: <string> + type: FIELD_DATA + staticBranches: + - branchValue: <string> + connection: + edgeType: <string> + nextActionId: <string> + - branchValue: <string> + connection: + edgeType: <string> + nextActionId: <string> + type: STATIC_BRANCH + defaultBranchName: <string> + defaultBranch: + edgeType: <string> + nextActionId: <string> + - actionId: <string> + inputValue: + actionId: <string> + dataKey: <string> + type: FIELD_DATA + staticBranches: + - branchValue: <string> + connection: + edgeType: <string> + nextActionId: <string> + - branchValue: <string> + connection: + edgeType: <string> + nextActionId: <string> + type: STATIC_BRANCH + defaultBranchName: <string> + defaultBranch: + edgeType: <string> + nextActionId: <string> + blockedDates: + - dayOfMonth: <integer> + month: JULY + year: <integer> + - dayOfMonth: <integer> + month: SEPTEMBER + year: <integer> + canEnrollFromSalesforce: <boolean> + createdAt: <dateTime> + crmObjectCreationStatus: COMPLETE + customProperties: + et1_3: <string> + commodo_d: <string> + dataSources: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + name: <string> + objectTypeId: <string> + type: ASSOCIATION + sortBy: + order: DESC + property: <string> + missing: <string> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + name: <string> + objectTypeId: <string> + type: ASSOCIATION + sortBy: + order: DESC + property: <string> + missing: <string> + flowType: UNKNOWN + id: <string> + isEnabled: <boolean> + nextAvailableActionId: <string> + objectTypeId: <string> + revisionId: <string> + suppressionListIds: + - <integer> + - <integer> + timeWindows: + - day: TUESDAY + endTime: + hour: <integer> + minute: <integer> + startTime: + hour: <integer> + minute: <integer> + - day: TUESDAY + endTime: + hour: <integer> + minute: <integer> + startTime: + hour: <integer> + minute: <integer> + type: CONTACT_FLOW + updatedAt: <dateTime> + name: <string> + description: <string> + uuid: <string> + startActionId: <string> + enrollmentCriteria: + listFilterBranch: + filterBranchOperator: <string> + filterBranchType: OR + filterBranches: + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch + detected> + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch + detected> + filters: + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + reEnrollmentTriggersFilterBranches: + - filterBranchOperator: <string> + filterBranchType: OR + filterBranches: + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch + detected> + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch + detected> + filters: + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterBranchOperator: <string> + filterBranchType: OR + filterBranches: + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch + detected> + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch + detected> + filters: + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + shouldReEnroll: <boolean> + type: LIST_BASED + unEnrollObjectsNotMeetingCriteria: <boolean> + enrollmentSchedule: + timeOfDay: + hour: <integer> + minute: <integer> + type: DAILY + goalFilterBranch: + filterBranchOperator: <string> + filterBranchType: OR + filterBranches: + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + filters: + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + eventAnchor: + contactProperty: <string> + type: CONTACT_PROPERTY_ANCHOR + unEnrollmentSetting: + flowIds: + - <string> + - <string> + type: SELECTIVE + startedAt: <dateTime> + status: COMPLETE + numErrors: <integer> + requestedAt: <dateTime> + links: + in2: <string> + Ut22: <string> + aliqua80b: <string> + quis_48f: <string> + errors: + - category: <string> + context: + tempor_d0: + - <string> + - <string> + cillum01: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + reprehenderit0f0: + - <string> + - <string> + sit1f: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + sunt_5b: + - <string> + - <string> + elitc: + - <string> + - <string> + links: + quid: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + - category: <string> + context: + sed_f5: + - <string> + - <string> + sed_e: + - <string> + - <string> + addfb: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + magna8b: + - <string> + - <string> + quis520: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + Lorem_5: + - <string> + - <string> + deserunt_626: + - <string> + - <string> + nulla27: + - <string> + - <string> + officiaf: + - <string> + - <string> + links: + ipsum_2f2: <string> + sunt_ac_: <string> + quis_f0: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ad_87_": [ + "<string>", + "<string>" + ], + "consequat2f": [ + "<string>", + "<string>" + ] + }, + "links": { + "commodo_68": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "dolore_2c1": [ + "<string>", + "<string>" + ], + "commodo_74": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "voluptate5c": [ + "<string>", + "<string>" + ] + } + } + ] + } + /automation/v4/flows: + get: + tags: + - Workflows V4 API > Workflows + summary: Retrieve workflows + description: Retrieve all workflows from an account. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: limit + in: query + schema: + type: integer + description: The maximum number of results to display per page. + example: '100' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + flowType: <string> + id: <string> + isEnabled: <boolean> + objectTypeId: <string> + revisionId: <string> + updatedAt: <dateTime> + name: <string> + uuid: <string> + - createdAt: <dateTime> + flowType: <string> + id: <string> + isEnabled: <boolean> + objectTypeId: <string> + revisionId: <string> + updatedAt: <dateTime> + name: <string> + uuid: <string> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ad_87_": [ + "<string>", + "<string>" + ], + "consequat2f": [ + "<string>", + "<string>" + ] + }, + "links": { + "commodo_68": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "dolore_2c1": [ + "<string>", + "<string>" + ], + "commodo_74": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "voluptate5c": [ + "<string>", + "<string>" + ] + } + } + ] + } + post: + tags: + - Workflows V4 API > Workflows + summary: Create a new workflow + description: Create a new workflow. + requestBody: + content: + application/json: + schema: + type: object + example: + actions: + - actionId: <string> + inputValue: + actionId: <string> + dataKey: <string> + type: FIELD_DATA + staticBranches: + - branchValue: <string> + connection: + edgeType: <string> + nextActionId: <string> + - branchValue: <string> + connection: + edgeType: <string> + nextActionId: <string> + type: STATIC_BRANCH + defaultBranchName: <string> + defaultBranch: + edgeType: <string> + nextActionId: <string> + - actionId: <string> + inputValue: + actionId: <string> + dataKey: <string> + type: FIELD_DATA + staticBranches: + - branchValue: <string> + connection: + edgeType: <string> + nextActionId: <string> + - branchValue: <string> + connection: + edgeType: <string> + nextActionId: <string> + type: STATIC_BRANCH + defaultBranchName: <string> + defaultBranch: + edgeType: <string> + nextActionId: <string> + blockedDates: + - dayOfMonth: <integer> + month: JANUARY + year: <integer> + - dayOfMonth: <integer> + month: MAY + year: <integer> + canEnrollFromSalesforce: <boolean> + customProperties: + dolore888: <string> + elit_fcb: <string> + in_62b: <string> + consequat_dda: <string> + dataSources: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + name: <string> + objectTypeId: <string> + type: ASSOCIATION + sortBy: + order: ASC + property: <string> + missing: <string> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + name: <string> + objectTypeId: <string> + type: ASSOCIATION + sortBy: + order: DESC + property: <string> + missing: <string> + flowType: ACTION_SET + isEnabled: <boolean> + objectTypeId: <string> + suppressionListIds: + - <integer> + - <integer> + timeWindows: + - day: FRIDAY + endTime: + hour: <integer> + minute: <integer> + startTime: + hour: <integer> + minute: <integer> + - day: SUNDAY + endTime: + hour: <integer> + minute: <integer> + startTime: + hour: <integer> + minute: <integer> + type: CONTACT_FLOW + name: <string> + description: <string> + uuid: <string> + startActionId: <string> + enrollmentCriteria: + listFilterBranch: + filterBranchOperator: <string> + filterBranchType: OR + filterBranches: + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + filters: + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + reEnrollmentTriggersFilterBranches: + - filterBranchOperator: <string> + filterBranchType: OR + filterBranches: + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + filters: + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterBranchOperator: <string> + filterBranchType: OR + filterBranches: + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + filters: + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + shouldReEnroll: <boolean> + type: LIST_BASED + unEnrollObjectsNotMeetingCriteria: <boolean> + enrollmentSchedule: + timeOfDay: + hour: <integer> + minute: <integer> + type: DAILY + goalFilterBranch: + filterBranchOperator: <string> + filterBranchType: OR + filterBranches: + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + filters: + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + eventAnchor: + contactProperty: <string> + type: CONTACT_PROPERTY_ANCHOR + unEnrollmentSetting: + flowIds: + - <string> + - <string> + type: ALL + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + actions: + - actionId: <string> + inputValue: + actionId: <string> + dataKey: <string> + type: FIELD_DATA + staticBranches: + - branchValue: <string> + connection: + edgeType: <string> + nextActionId: <string> + - branchValue: <string> + connection: + edgeType: <string> + nextActionId: <string> + type: STATIC_BRANCH + defaultBranchName: <string> + defaultBranch: + edgeType: <string> + nextActionId: <string> + - actionId: <string> + inputValue: + actionId: <string> + dataKey: <string> + type: FIELD_DATA + staticBranches: + - branchValue: <string> + connection: + edgeType: <string> + nextActionId: <string> + - branchValue: <string> + connection: + edgeType: <string> + nextActionId: <string> + type: STATIC_BRANCH + defaultBranchName: <string> + defaultBranch: + edgeType: <string> + nextActionId: <string> + blockedDates: + - dayOfMonth: <integer> + month: OCTOBER + year: <integer> + - dayOfMonth: <integer> + month: APRIL + year: <integer> + canEnrollFromSalesforce: <boolean> + createdAt: <dateTime> + crmObjectCreationStatus: COMPLETE + customProperties: + nullaa9: <string> + elit1: <string> + pariatur_12: <string> + dataSources: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + name: <string> + objectTypeId: <string> + type: ASSOCIATION + sortBy: + order: DESC + property: <string> + missing: <string> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + name: <string> + objectTypeId: <string> + type: ASSOCIATION + sortBy: + order: DESC + property: <string> + missing: <string> + flowType: WORKFLOW + id: <string> + isEnabled: <boolean> + nextAvailableActionId: <string> + objectTypeId: <string> + revisionId: <string> + suppressionListIds: + - <integer> + - <integer> + timeWindows: + - day: FRIDAY + endTime: + hour: <integer> + minute: <integer> + startTime: + hour: <integer> + minute: <integer> + - day: MONDAY + endTime: + hour: <integer> + minute: <integer> + startTime: + hour: <integer> + minute: <integer> + type: CONTACT_FLOW + updatedAt: <dateTime> + name: <string> + description: <string> + uuid: <string> + startActionId: <string> + enrollmentCriteria: + listFilterBranch: + filterBranchOperator: <string> + filterBranchType: OR + filterBranches: + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + filters: + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + reEnrollmentTriggersFilterBranches: + - filterBranchOperator: <string> + filterBranchType: OR + filterBranches: + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + filters: + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterBranchOperator: <string> + filterBranchType: OR + filterBranches: + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + filters: + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + shouldReEnroll: <boolean> + type: LIST_BASED + unEnrollObjectsNotMeetingCriteria: <boolean> + enrollmentSchedule: + timeOfDay: + hour: <integer> + minute: <integer> + type: DAILY + goalFilterBranch: + filterBranchOperator: <string> + filterBranchType: OR + filterBranches: + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + filters: + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + eventAnchor: + contactProperty: <string> + type: CONTACT_PROPERTY_ANCHOR + unEnrollmentSetting: + flowIds: + - <string> + - <string> + type: SELECTIVE + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ad_87_": [ + "<string>", + "<string>" + ], + "consequat2f": [ + "<string>", + "<string>" + ] + }, + "links": { + "commodo_68": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "dolore_2c1": [ + "<string>", + "<string>" + ], + "commodo_74": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "voluptate5c": [ + "<string>", + "<string>" + ] + } + } + ] + } + /automation/v4/flows/{flowId}: + get: + tags: + - Workflows V4 API > Workflows + summary: Retrieve workflow details + description: Retrieve all details for a specific workflow by ID. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: flowId + in: path + schema: + type: string + required: true + description: (Required) The ID of the workflow to retrieve. + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + actions: + - actionId: <string> + inputValue: + actionId: <string> + dataKey: <string> + type: FIELD_DATA + staticBranches: + - branchValue: <string> + connection: + edgeType: <string> + nextActionId: <string> + - branchValue: <string> + connection: + edgeType: <string> + nextActionId: <string> + type: STATIC_BRANCH + defaultBranchName: <string> + defaultBranch: + edgeType: <string> + nextActionId: <string> + - actionId: <string> + inputValue: + actionId: <string> + dataKey: <string> + type: FIELD_DATA + staticBranches: + - branchValue: <string> + connection: + edgeType: <string> + nextActionId: <string> + - branchValue: <string> + connection: + edgeType: <string> + nextActionId: <string> + type: STATIC_BRANCH + defaultBranchName: <string> + defaultBranch: + edgeType: <string> + nextActionId: <string> + blockedDates: + - dayOfMonth: <integer> + month: OCTOBER + year: <integer> + - dayOfMonth: <integer> + month: APRIL + year: <integer> + canEnrollFromSalesforce: <boolean> + createdAt: <dateTime> + crmObjectCreationStatus: COMPLETE + customProperties: + nullaa9: <string> + elit1: <string> + pariatur_12: <string> + dataSources: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + name: <string> + objectTypeId: <string> + type: ASSOCIATION + sortBy: + order: DESC + property: <string> + missing: <string> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + name: <string> + objectTypeId: <string> + type: ASSOCIATION + sortBy: + order: DESC + property: <string> + missing: <string> + flowType: WORKFLOW + id: <string> + isEnabled: <boolean> + nextAvailableActionId: <string> + objectTypeId: <string> + revisionId: <string> + suppressionListIds: + - <integer> + - <integer> + timeWindows: + - day: FRIDAY + endTime: + hour: <integer> + minute: <integer> + startTime: + hour: <integer> + minute: <integer> + - day: MONDAY + endTime: + hour: <integer> + minute: <integer> + startTime: + hour: <integer> + minute: <integer> + type: CONTACT_FLOW + updatedAt: <dateTime> + name: <string> + description: <string> + uuid: <string> + startActionId: <string> + enrollmentCriteria: + listFilterBranch: + filterBranchOperator: <string> + filterBranchType: OR + filterBranches: + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + filters: + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + reEnrollmentTriggersFilterBranches: + - filterBranchOperator: <string> + filterBranchType: OR + filterBranches: + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + filters: + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterBranchOperator: <string> + filterBranchType: OR + filterBranches: + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + filters: + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + shouldReEnroll: <boolean> + type: LIST_BASED + unEnrollObjectsNotMeetingCriteria: <boolean> + enrollmentSchedule: + timeOfDay: + hour: <integer> + minute: <integer> + type: DAILY + goalFilterBranch: + filterBranchOperator: <string> + filterBranchType: OR + filterBranches: + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + filters: + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + eventAnchor: + contactProperty: <string> + type: CONTACT_PROPERTY_ANCHOR + unEnrollmentSetting: + flowIds: + - <string> + - <string> + type: SELECTIVE + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ad_87_": [ + "<string>", + "<string>" + ], + "consequat2f": [ + "<string>", + "<string>" + ] + }, + "links": { + "commodo_68": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "dolore_2c1": [ + "<string>", + "<string>" + ], + "commodo_74": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "voluptate5c": [ + "<string>", + "<string>" + ] + } + } + ] + } + put: + tags: + - Workflows V4 API > Workflows + summary: Update a workflow + description: Update a workflow by ID. + requestBody: + content: + application/json: + schema: + type: object + example: + actions: + - actionId: <string> + inputValue: + actionId: <string> + dataKey: <string> + type: FIELD_DATA + staticBranches: + - branchValue: <string> + connection: + edgeType: <string> + nextActionId: <string> + - branchValue: <string> + connection: + edgeType: <string> + nextActionId: <string> + type: STATIC_BRANCH + defaultBranchName: <string> + defaultBranch: + edgeType: <string> + nextActionId: <string> + - actionId: <string> + inputValue: + actionId: <string> + dataKey: <string> + type: FIELD_DATA + staticBranches: + - branchValue: <string> + connection: + edgeType: <string> + nextActionId: <string> + - branchValue: <string> + connection: + edgeType: <string> + nextActionId: <string> + type: STATIC_BRANCH + defaultBranchName: <string> + defaultBranch: + edgeType: <string> + nextActionId: <string> + blockedDates: + - dayOfMonth: <integer> + month: SEPTEMBER + year: <integer> + - dayOfMonth: <integer> + month: NOVEMBER + year: <integer> + canEnrollFromSalesforce: <boolean> + customProperties: + mollit_72e: <string> + sunt_04: <string> + id65d: <string> + consequat115: <string> + isEnabled: <boolean> + revisionId: <string> + suppressionListIds: + - <integer> + - <integer> + timeWindows: + - day: WEDNESDAY + endTime: + hour: <integer> + minute: <integer> + startTime: + hour: <integer> + minute: <integer> + - day: WEDNESDAY + endTime: + hour: <integer> + minute: <integer> + startTime: + hour: <integer> + minute: <integer> + type: CONTACT_FLOW + name: <string> + description: <string> + uuid: <string> + startActionId: <string> + enrollmentCriteria: + listFilterBranch: + filterBranchOperator: <string> + filterBranchType: OR + filterBranches: + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + filters: + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + reEnrollmentTriggersFilterBranches: + - filterBranchOperator: <string> + filterBranchType: OR + filterBranches: + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + filters: + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterBranchOperator: <string> + filterBranchType: OR + filterBranches: + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + filters: + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + shouldReEnroll: <boolean> + type: LIST_BASED + unEnrollObjectsNotMeetingCriteria: <boolean> + enrollmentSchedule: + timeOfDay: + hour: <integer> + minute: <integer> + type: DAILY + goalFilterBranch: + filterBranchOperator: <string> + filterBranchType: OR + filterBranches: + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + filters: + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + eventAnchor: + contactProperty: <string> + type: CONTACT_PROPERTY_ANCHOR + unEnrollmentSetting: + flowIds: + - <string> + - <string> + type: SELECTIVE + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: flowId + in: path + schema: + type: string + required: true + description: (Required) The ID of the workflow. + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + actions: + - actionId: <string> + inputValue: + actionId: <string> + dataKey: <string> + type: FIELD_DATA + staticBranches: + - branchValue: <string> + connection: + edgeType: <string> + nextActionId: <string> + - branchValue: <string> + connection: + edgeType: <string> + nextActionId: <string> + type: STATIC_BRANCH + defaultBranchName: <string> + defaultBranch: + edgeType: <string> + nextActionId: <string> + - actionId: <string> + inputValue: + actionId: <string> + dataKey: <string> + type: FIELD_DATA + staticBranches: + - branchValue: <string> + connection: + edgeType: <string> + nextActionId: <string> + - branchValue: <string> + connection: + edgeType: <string> + nextActionId: <string> + type: STATIC_BRANCH + defaultBranchName: <string> + defaultBranch: + edgeType: <string> + nextActionId: <string> + blockedDates: + - dayOfMonth: <integer> + month: OCTOBER + year: <integer> + - dayOfMonth: <integer> + month: APRIL + year: <integer> + canEnrollFromSalesforce: <boolean> + createdAt: <dateTime> + crmObjectCreationStatus: COMPLETE + customProperties: + nullaa9: <string> + elit1: <string> + pariatur_12: <string> + dataSources: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + name: <string> + objectTypeId: <string> + type: ASSOCIATION + sortBy: + order: DESC + property: <string> + missing: <string> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + name: <string> + objectTypeId: <string> + type: ASSOCIATION + sortBy: + order: DESC + property: <string> + missing: <string> + flowType: WORKFLOW + id: <string> + isEnabled: <boolean> + nextAvailableActionId: <string> + objectTypeId: <string> + revisionId: <string> + suppressionListIds: + - <integer> + - <integer> + timeWindows: + - day: FRIDAY + endTime: + hour: <integer> + minute: <integer> + startTime: + hour: <integer> + minute: <integer> + - day: MONDAY + endTime: + hour: <integer> + minute: <integer> + startTime: + hour: <integer> + minute: <integer> + type: CONTACT_FLOW + updatedAt: <dateTime> + name: <string> + description: <string> + uuid: <string> + startActionId: <string> + enrollmentCriteria: + listFilterBranch: + filterBranchOperator: <string> + filterBranchType: OR + filterBranches: + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + filters: + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + reEnrollmentTriggersFilterBranches: + - filterBranchOperator: <string> + filterBranchType: OR + filterBranches: + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + filters: + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterBranchOperator: <string> + filterBranchType: OR + filterBranches: + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + filters: + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + shouldReEnroll: <boolean> + type: LIST_BASED + unEnrollObjectsNotMeetingCriteria: <boolean> + enrollmentSchedule: + timeOfDay: + hour: <integer> + minute: <integer> + type: DAILY + goalFilterBranch: + filterBranchOperator: <string> + filterBranchType: OR + filterBranches: + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + filters: + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + eventAnchor: + contactProperty: <string> + type: CONTACT_PROPERTY_ANCHOR + unEnrollmentSetting: + flowIds: + - <string> + - <string> + type: SELECTIVE + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ad_87_": [ + "<string>", + "<string>" + ], + "consequat2f": [ + "<string>", + "<string>" + ] + }, + "links": { + "commodo_68": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "dolore_2c1": [ + "<string>", + "<string>" + ], + "commodo_74": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "voluptate5c": [ + "<string>", + "<string>" + ] + } + } + ] + } + delete: + tags: + - Workflows V4 API > Workflows + summary: Delete a workflow + description: >- + Fully delete a workflow by ID. Deleted workflows cannot be restored via + the API. If you need to restore an accidentally deleted flow, you'll + need to contact support. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: flowId + in: path + schema: + type: string + required: true + description: (Required) The ID of the workflow to delete. + example: <long> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ad_87_": [ + "<string>", + "<string>" + ], + "consequat2f": [ + "<string>", + "<string>" + ] + }, + "links": { + "commodo_68": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "dolore_2c1": [ + "<string>", + "<string>" + ], + "commodo_74": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "voluptate5c": [ + "<string>", + "<string>" + ] + } + } + ] + } + /automation/v4/flows/email-campaigns: + get: + tags: + - Workflows V4 API > Email campaigns + summary: Retrieve workflow emails + description: Retrieve emails sent by a workflow by ID. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: before + in: query + schema: + type: string + example: <string> + - name: limit + in: query + schema: + type: string + description: The maximum number of results to display per page. + example: <integer> + - name: flowId + in: query + schema: + type: string + description: The ID of the workflow. + example: <string> + - name: flowId + in: query + schema: + type: string + description: The ID of the workflow. + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - emailCampaignId: <string> + emailContentId: <string> + flowId: <string> + - emailCampaignId: <string> + emailContentId: <string> + flowId: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ad_87_": [ + "<string>", + "<string>" + ], + "consequat2f": [ + "<string>", + "<string>" + ] + }, + "links": { + "commodo_68": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "dolore_2c1": [ + "<string>", + "<string>" + ], + "commodo_74": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "voluptate5c": [ + "<string>", + "<string>" + ] + } + } + ] + } + /automation/v4/workflow-id-mappings/batch/read: + post: + tags: + - Workflows V4 API > Workflow ID mappings + summary: Retrieve migrated workflow mappings + description: Retrieve the IDs of v3 workflows that have been migrated to the v4 API. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - flowMigrationStatuses: <string> + type: FLOW_ID + - flowMigrationStatuses: <string> + type: FLOW_ID + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - flowId: <integer> + workflowId: <integer> + - flowId: <integer> + workflowId: <integer> + startedAt: <dateTime> + status: CANCELED + requestedAt: <dateTime> + links: + nullabc: <string> + officia_5: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - flowId: <integer> + workflowId: <integer> + - flowId: <integer> + workflowId: <integer> + startedAt: <dateTime> + status: PENDING + numErrors: <integer> + requestedAt: <dateTime> + links: + id0: <string> + ex_13: <string> + errors: + - category: <string> + context: + enim_6b6: + - <string> + - <string> + non_a3: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + cillum_8: + - <string> + - <string> + voluptate7: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + aliquip_2: + - <string> + - <string> + links: + magna_2: <string> + adipisicing1c: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + - category: <string> + context: + ut_0f1: + - <string> + - <string> + sint_b: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + laboreb7: + - <string> + - <string> + ea_c2d: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + cillum1bb: + - <string> + - <string> + links: + amet_ffa: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ad_87_": [ + "<string>", + "<string>" + ], + "consequat2f": [ + "<string>", + "<string>" + ] + }, + "links": { + "commodo_68": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "dolore_2c1": [ + "<string>", + "<string>" + ], + "commodo_74": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "voluptate5c": [ + "<string>", + "<string>" + ] + } + } + ] + } diff --git a/server/node-service/src/plugins/hubspot/specsV4/CMS API Collections.json b/server/node-service/src/plugins/hubspot/specsV4/CMS API Collections.json new file mode 100644 index 000000000..342929568 --- /dev/null +++ b/server/node-service/src/plugins/hubspot/specsV4/CMS API Collections.json @@ -0,0 +1,63340 @@ +openapi: 3.0.0 +info: + title: CMS API Collections + description: >- + The HubSpot CMS is powerful and can be extended through APIs. This + collection is an aggregation of our APIs that are most relevant to + developers building with the CMS. **This is not our** [<b>full list of + APIs</b>](https://developers.hubspot.com/docs/api/overview)**.** Our APIs + are subject to [rate + limits](https://developers.hubspot.com/docs/api/usage-details#rate-limits) + and support + [OAuth](https://developers.hubspot.com/docs/api/working-with-oauth). We + encourage reviewing our [API Usage + Guidelines](https://developers.hubspot.com/docs/api/usage-details) for best + practices. To test your integrations you will need to [create a developer + account](https://app.hubspot.com/signup/developers), which will enable you + to [create test + accounts](https://developers.hubspot.com/docs/api/creating-test-accounts) or + an [application](https://developers.hubspot.com/docs/api/creating-an-app) to + get started with OAuth. This is different from your CMS developer sandbox + portal. + + + **Fork the collections using Run in Postman:** + + + [<img src="https://run.pstmn.io/button.svg" alt="Run In + Postman">](https://app.getpostman.com/run-collection/26126890-d92a58c8-a135-4e2e-9105-f5d616502470?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D26126890-d92a58c8-a135-4e2e-9105-f5d616502470%26entityType%3Dcollection%26workspaceId%3Dd7645f33-539d-49c6-9e0c-efa6faae355d) + version: 1.0.0 +servers: + - url: http://{{baseurl}} +components: + securitySchemes: + apikeyAuth: + type: http + scheme: apikey + oauth2Auth: + type: http + scheme: oauth2 +tags: + - name: Blog Posts API + description: "## **Access and test APIs in beta.**\_\n\n**Please note**: This API is currently under development and is subject to change based on testing and feedback. By using these endpoints you agree to adhere to our\_[Developer Terms](https://legal.hubspot.com/hubspot-developer-terms)&\_[Developer Beta](https://legal.hubspot.com/developerbetaterms?)Terms. You also acknowledge and understand the risk associated with testing an unstable API.\_\n\nYou can use the blog post API to publish and manage blog posts. Learn more about how to create and maintain your blog on the\_[HubSpot Knowledge Base.](https://knowledge.hubspot.com/website/topics#blog)\n\n## Changes in V3\n\n- The following properties are deprecated and will not be included in the response of any of the V3 endpoints:\n \n - _campaign_name_\n \n - _is_draft_\n \n - _keywords_\n \n- The\__topicIds_\_property has been renamed to\__tagIds_.\n \n\n## Limits\n\nThe blog post API endpoints are subject to the limits defined in\_[HubSpot's API usage guidelines](https://developers.hubspot.com/docs/api/usage-details)." + - name: Blog Settings API + - name: Blog Tags API + description: "## **Access and test APIs in beta.**\_\n\n**Please note**: This API is currently under development and is subject to change based on testing and feedback. By using these endpoints you agree to adhere to our\_[Developer Terms](https://legal.hubspot.com/hubspot-developer-terms)&\_[Developer Beta](https://legal.hubspot.com/developerbetaterms?)Terms. You also acknowledge and understand the risk associated with testing an unstable API.\_\n\nUse the blog tags API to manage tags for your blog posts. Learn more about how to create and maintain your blog on the\_[HubSpot Knowledge Base.](https://knowledge.hubspot.com/website/topics#blog)\n\n## Changes in V3\n\nThe\_`description`\_property has been deprecated and will not be included in the response of any of the V3 endpoints." + - name: Blog Tags API > Blog Tags + - name: HubDb API + description: "HubDB is a relational data store that presents data as rows, columns, and cells in a table, much like a spreadsheet. HubDB tables can be added or modified\_[within your HubSpot account](https://developers.hubspot.com/docs/cms/data/hubdb#creating-your-first-table), but you can also use the API endpoints documented here. For information on using data from HubDB tables on your website or in\_[programmable emails](https://developers.hubspot.com/docs/cms/guides/email/hubdb-crm-objects), check out\_[HubSpot's CMS developer documentation](https://developers.hubspot.com/docs/cms/data/hubdb). \n \nSimilar to HubSpot website pages, HubDB tables support\_`draft`\_and\_`published`\_versions. This allows you to update data in the table, either for testing or to allow for a manual approval process, without affecting any live pages. Learn more about\_[drafted versus live tables](https://developers.hubspot.com/docs/api/cms/hubdb#drafted-vs-live-tables).\n\nIf a table is set to be\_[allowed for public access](https://knowledge.hubspot.com/website-pages/create-and-populate-tables-in-hubdb#manage-table-settings-cms-hub-professional-and-enterprise-only), you can access the published version of the table and rows without any authentication by specifying your HubSpot account ID via the query parameter\_`portalId`.\n\nIf you're migrating from v2 of the HubDB API, learn more about the\_[changes in the current (v3) API](https://developers.hubspot.com/docs/api/cms/hubdb#changes-in-v3).\n\n**Please note:**\_endpoints that support\_`GET`\_also support\_`CORS`, so you can access data in a table client-side using JavaScript and your account ID. Other methods and the\__Get all tables_\_endpoint require authentication and do not support\_`CORS`.\n\n## Rate limits\n\nHubDB API requests have different rate limits, depending on the type of request:\n\n- Any\_`GET`\_requests made that don't require authentication (including client-side JavaScript requests) are limited to 10 requests per second. These requests won't count towards the daily limit.\n \n- All other requests\_[using authentication](https://developers.hubspot.com/docs/methods/auth/oauth-overview)\_follow the\_[standard limits](https://developers.hubspot.com/docs/overview)." + - name: HubDb API > Tables + - name: HubDb API > Rows + - name: HubDb API > Rows Batch + - name: Pages API + description: "Use this API to create, manage, and publish website and landing pages. Learn more about\_[creating and customizing pages within HubSpot](https://knowledge.hubspot.com/website-pages/create-and-customize-pages).\_\n\nFor example, fetch a currently drafted page, then publish it so that it's live on your website.\n\n## Changes in v3\n\nThe following properties are deprecated and no longer included within the response:\n\n- `campaign_name`\n \n- `is_draft`\n \n- `style_override_id`\n \n- `meta_keywords`" + - name: Pages API > Site Pages + - name: Pages API > Landing Pages + - name: Blog Authors API + description: "## **Access and test APIs in beta.**\_\n\n**Please note**: This API is currently under development and is subject to change based on testing and feedback. By using these endpoints you agree to adhere to our\_[Developer Terms](https://legal.hubspot.com/hubspot-developer-terms)&\_[Developer Beta](https://legal.hubspot.com/developerbetaterms?)Terms. You also acknowledge and understand the risk associated with testing an unstable API.\_\n\nUse the blog authors API to manage author information for your blog posts. Learn more about how to create and maintain your blog on the\_[HubSpot Knowledge Base.](https://knowledge.hubspot.com/website/topics#blog)\n\n## Changes in V3\n\nThe following properties are deprecated and will not be included in the response of any of the V3 endpoints:\n\n- `user_id`\n \n- `username`\n \n- `googlePlus`\n \n- `gravatarUrl`\n \n- `twitterUsername`\n \n- `hasSocialProfiles`" + - name: Blog Authors API > Blog Authors + - name: CMS Source Code API + description: "## Basic Features\n\nThe CMS Source Code API allows you to interact with the files stored in your HubSpot\_[Developer File System](https://developers.hubspot.com/docs/cms/key-concepts#developer-file-system). These files include all of the templates, modules, CSS, JS, and other CMS assets seen in the Design Manager. Through this API, you can:\n\n- Upload new files to their HubSpot account, or upload changes to existing files.\n \n- Download or delete CMS assets from their account.\n \n- Fetch metadata for each file or folder in the Design Manager.\n \n- Validate file contents for use in HubSpot CMS, including HubL syntax.\n \n- Upload zip files as file packages and extract them inside the account.\n \n\nWith this API you can edit all your CMS assets locally as well as build tooling to help you move even faster.\_\n\n## Environment and path\n\nThe Source Code API endpoints use the\_`environment`\_and\_`path`\_parameters to identify files in the CMS Developer File System. These parameters are generally specified in the endpoint path itself, as in\_`/cms/v3/source-code/{environment}/content/{path}`.\n\nThe\_`environment`\_parameter refers to whether you are interacting with the unpublished or live version of each file. For unpublished changes, use\_`draft`. For live changes, use\_`published`.\n\nNote that uploading to\_`published`\_is equivalent to pressing the “Publish” button in the Design Manager. As such, whatever is currently in\_`draft`\_will be cleared.\n\nThe\_`path`\_parameter refers to the location of the file in the CMS Developer File System. Top level assets are not preceded by a\_`/`\_character as you would see in a UNIX based operating system. When uploading a new file, this should be the desired location where the file should be created. When retrieving or uploading changes to an existing file, this should match the path of the existing file. \n \nWe use the local file formats for all asset types, which means that certain types of assets are broken up into multiple files. For instance, a module is actually represented as a directory ending in the\_`.module`\_suffix, so to retrieve the HTML for a module, one would need to use the path\_`foo.module/module.html`. See the\_[local development documentation](https://developers.hubspot.com/docs/cms/developer-reference/local-development-cms-cli)\_for further information.\n\n## Downloading a file\n\nTo download a file from your HubSpot account, make a\_`GET`\_request to\_`/cms/v3/source-code/{environment}/content/{path}`\_and set the header to\_`Accept: application/octet-stream`.\n\nFile data will be downloaded in binary format. You cannot download the entire contents of a folder. Instead, you must fetch the folder metadata and retrieve each of its children individually.\n\n## Fetching file and folder metadata\n\nTo fetch file and folder metadata, such as path, filename, and created/updated timestamps, make a\_`GET`\_request to\_`/cms/v3/source-code/{environment}/metadata/{path}`\_and set the header to\_`Accept: application/json`.\_\n\nFile and folder metadata will be returned in a JSON object:\n\n- Folder metadata will be indicated by the\_`folder: true`\_property.\n \n- The\_`children`\_array will show the names of files and subfolders within the folder. These filenames can be used to traverse the folder tree: simply fetch one folder metadata and recursively fetch the children of the folder and all subfolders.\n \n\n## Uploading a file\n\nTo upload a local file to your HubSpot account, make a\_`PUT`\_request to\_`/cms/v3/source-code/{environment}/content/{path}`. You must upload the file using the\_`multipart/form-data`\_content type, and the binary file data must be included as a field named\_`file`.\n\nFor example:\n\n- **Uploading a new file:** \n PUT\_`/cms/v3/source-code/published/content/my-new-file.html` \n `Content-Type: multipart/form-data` \n `Form Data: { file: [``_binary file data_``] }`\n \n- **Updating an existing file draft:** \n PUT\_`/cms/v3/source-code/draft/content/path/to/existing-file.html` \n `Content-Type: multipart/form-data` \n `Form Data: { file: [``_binary file data_``] }`\n \n\nHubSpot currently supports the following file types:\n\n- `css`\n \n- `js`\n \n- `json`\n \n- `html`\n \n- `txt`\n \n- `md`\n \n- `jpg`\n \n- `jpeg`\n \n- `png`\n \n- `gif`\n \n- `map`\n \n- `svg`\n \n- `ttf`\n \n- `woff`\n \n- `woff2`\n \n- `zip`\n \n\n## Validating file contents\n\nTo validate the contents of a local file, make a\_`POST`\_request to\_`/cms/v3/source-code/{environment}/validate/{path}`. You must upload the file using the\_`multipart/form-data`\_content type, and the binary file data must be included as a field named\_`file`.\n\nThis can be used to validate HubL in a template/module or JSON for a theme or module. If there are validation errors, you will receive a\_`400`\_response with the list of relevant errors. These are the same warnings and errors you would see within the design manager.\n\nNote that invalid files will be rejected if you try and publish them directly.\_It is recommended to validate files first before publishing.\n\n**For example:** \nPOST\_`/cms/v3/source-code/published/validate/my-file.html` \n`Content-Type: multipart/form-data` \n`Form Data: { file: [``_binary file data_``] }`\n\n## Deleting a file\n\nTo delete a file, make a\_`DELETE`\_request to\_`/cms/v3/source-code/{environment}/content/{path}`.\_ \n \nDeleting from the\_`published`\_environment will remove the file entirely, while deleting from the\_`draft`\_environment will simply clear out any unpublished changes. Note that deleting published files will immediately impact live content if used anywhere, so make sure to remove all existing references to the file before deleting.\n\n## Extracting a file package\n\nTo extract a zip file, make a\_`POST`\_request to\_`/cms/v3/source-code/extract/{path}`. \n \nThe\_`path`\_must be a zip file already uploaded to the account. The extraction process is asynchronous and can take up to a minute depending on how many and how large the compressed files are. The contents of the zip are extracted in place to the same folder that contains the zip file, and the original zip file is not deleted automatically upon successful extraction." + - name: CMS Source Code API > Content + - name: CMS Source Code API > Metadata + - name: CMS Source Code API > Validation + - name: CMS Source Code API > Extract + - name: CMS Source Code API > Source_Code_Extract + - name: Content Audit API + description: "The CMS Content Audit API allows you to filter and sort content object changes by type, time period, or HubSpot user ID. This endpoint is only available in accounts with a\__**CMS Hub**_\__Enterprise_\_subscription.\n\n**Example use case:**\_find out which user most recently made changes to a list of pages.\n\n## [CMS Event Type Listing](https://developers.hubspot.com/docs/guides/api/cms/content-audit#cms-event-type-listing)\n\n| Event Type | Description |\n| --- | --- |\n| `CREATED` | An object has been created. |\n| `DELETED` | An object has been deleted or disconnected. |\n| `PUBLISHED` | An object has been published. |\n| `UNPUBLISHED` | An object has been unpublished. |\n| `UPDATED` | An object has been updated. |\n\n## [CMS Object Types Listing](https://developers.hubspot.com/docs/guides/api/cms/content-audit#cms-object-types-listing)\n\n| Object Type | Description |\n| --- | --- |\n| `BLOG` | Changes made to your blog settings in your account settings. |\n| `BLOG_POST` | Blog posts associated with your blog(s). |\n| `CONTENT_SETTINGS` | Changes made to your website settings in your account settings. The values changed will appear in the\_`meta`\_JSON array. |\n| `CTA` | Changes made to your\_[Calls-to-action (CTAs).](https://knowledge.hubspot.com/cta/get-started-with-calls-to-action-ctas) |\n| `DOMAIN` | Changes made to the domains connected in your Domains & URLs settings in your account settings. |\n| `EMAIL` | Changes made to emails in the email editor. |\n| `FILE` | Changes made to files in the\_[files tool](https://knowledge.hubspot.com/cos-general/organize-edit-and-delete-files). |\n| `GLOBAL_MODULE` | Changes made to\_[global modules.](https://knowledge.hubspot.com/cos-general/can-i-make-changes-to-a-global-module-in-only-one-template) |\n| `HUBDB_TABLE` | Changes made to HubDB tables. |\n| `KNOWLEDGE_BASE` | Changes made to your knowledge base settings in your account settings. |\n| `KNOWLEDGE_BASE_ARTICLE` | Changes made to knowledge base articles in the content editor. |\n| `LANDING_PAGE` | Changes made to landing pages in the content editor. |\n| `MODULE` | Changes made to\_[modules](https://developers.hubspot.com/docs/guides/cms/content/modules/overview). |\n| `SERVERLESS_FUNCTION` | Changes made to\_[serverless functions](https://developers.hubspot.com/docs/guides/cms/content/data-driven-content/serverless-functions/overview). |\n| `TEMPLATE` | Changes made to\_[templates](https://developers.hubspot.com/docs/guides/cms/content/templates/overview). |\n| `THEME` | Changes made to\_[Theme Settings](https://knowledge.hubspot.com/website-pages/edit-your-global-theme-settings)\_and when\_[Themes](https://knowledge.hubspot.com/website-pages/edit-your-global-theme-settings)\_are created. |\n| `URL_MAPPING` | Changes made to your URL Redirects in URL Redirects settings in your account settings. |\n| `WEBSITE_PAGE` | Changes made to website pages in the content editor. |" + - name: Content Audit API > Audit_Logs + - name: URL Redirects API + - name: URL Redirects API > Redirects + - name: Domains API + - name: Domains API > Domains + - name: Media Bridge API + - name: Media Bridge API > Integrator_Settings + - name: Media Bridge API > Schemas + - name: Media Bridge API > Properties + - name: Media Bridge API > Events + - name: Media Bridge API > Groups + - name: Site Search API + - name: Site Search API > Public +paths: + /cms/v3/blogs/posts/schedule: + post: + tags: + - Blog Authors API + summary: Schedule a Blog Post to be Published + description: Schedule a Blog Post to be Published. + requestBody: + content: + application/json: + schema: + type: object + example: + id: <string> + publishDate: <dateTime> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ipsum_c": [ + "<string>", + "<string>" + ], + "sint_97b": [ + "<string>", + "<string>" + ], + "in_23": [ + "<string>", + "<string>" + ], + "laborum_": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_2f": "<string>" + }, + "errors": [ + { + "message": "sint proident pariatur exer", + "subCategory": "reprehenderit fugiat in eu", + "code": "esse labore nulla quis nisi", + "in": "consequat aliqua", + "context": { + "ina": [ + "laboris commodo", + "ad sed elit" + ], + "labore6_": [ + "culpa est esse aute", + "deserunt " + ], + "Duisb31": [ + "Ut", + "reprehenderit" + ] + } + }, + { + "message": "dolor consequat", + "subCategory": "dolore anim", + "code": "proident laboris", + "in": "ut ad do irure magna", + "context": { + "consectetur_1": [ + "mollit pariatur aliquip", + "adipisicing commodo aute" + ] + } + } + ] + } + /cms/v3/blogs/posts/batch/read: + post: + tags: + - Blog Authors API + summary: Retrieve a batch of Blog Posts + description: Retrieve the Blog Post objects identified in the request body. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - qui enim + - ex ea fugiat adipisicing ut + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: string + description: Specifies whether to return deleted Blog Posts. Defaults to `false`. + example: <boolean> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - abStatus: master + abTestId: <string> + archivedAt: <long> + archivedInDashboard: <boolean> + attachedStylesheets: + - cillum_7: {} + - dolore_60: {} + authorName: <string> + blogAuthorId: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '10' + created: <dateTime> + createdById: <string> + currentState: BLOG_EMAIL_DRAFT + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableGoogleAmpOutputOverride: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: gd-gb + layoutSections: + labore_0: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + esse4f0: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - docc: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + aliquaee: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - nullab26: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + in_9c: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + laborum094: {} + Loremb68: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - ea_0ed: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + ipsum61: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - et_4: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + Duis_c3: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + officia__fe: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + aliqua_8b7: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + reprehenderit56: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + pariature6: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + dolore409: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - aute3: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - incididunt7cb: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + mollit_5: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + password: <string> + postBody: <string> + postSummary: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + rssBody: <string> + rssSummary: <string> + slug: <string> + state: <string> + tagIds: + - <long> + - <long> + themeSettingsValues: + laborum3: {} + translatedFromId: <string> + translations: + ut_93: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + nulla1: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + in9: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + ut_76: {} + widgets: + reprehenderit8: {} + - abStatus: mab_variant + abTestId: <string> + archivedAt: <long> + archivedInDashboard: <boolean> + attachedStylesheets: + - ut_32: {} + - voluptate69: {} + authorName: <string> + blogAuthorId: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '5' + created: <dateTime> + createdById: <string> + currentState: PUBLISHED_AB_VARIANT + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableGoogleAmpOutputOverride: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: nmg + layoutSections: + laborisa0: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + cupidatat_ca: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - dolor_39: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - dolore_c3: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + password: <string> + postBody: <string> + postSummary: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + rssBody: <string> + rssSummary: <string> + slug: <string> + state: <string> + tagIds: + - <long> + - <long> + themeSettingsValues: + sed_ae4: {} + magna_2: {} + translatedFromId: <string> + translations: + cupidatat_ba: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + id_0: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + aliqua_7a: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + deserunt_05b: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + et40: {} + proident29: {} + amet911: {} + widgets: + quis_5: {} + qui_a2c: {} + et_7_: {} + startedAt: <dateTime> + status: COMPLETE + requestedAt: <dateTime> + links: + Excepteur_28: <string> + deserunt593: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - abStatus: loser_variant + abTestId: <string> + archivedAt: <long> + archivedInDashboard: <boolean> + attachedStylesheets: + - in_3: {} + velit978: {} + magnaa: {} + - veniam1: {} + authorName: <string> + blogAuthorId: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '7' + created: <dateTime> + createdById: <string> + currentState: BLOG_EMAIL_DRAFT + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableGoogleAmpOutputOverride: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: yo-ng + layoutSections: + in_ba: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + aliquip07f: {} + tempor7_e: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - culpa_a93: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + id9f4: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - esse_ee8: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + magna13: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + commodo_c59: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - aliquip_7: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + ut1: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - est412: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + veniam_66: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + deserunt75: {} + ea_4: {} + ipsum2: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - velit87: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - qui_13: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + id_4_: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + password: <string> + postBody: <string> + postSummary: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + rssBody: <string> + rssSummary: <string> + slug: <string> + state: <string> + tagIds: + - <long> + - <long> + themeSettingsValues: + dolor_67: {} + in05: {} + quis6e: {} + translatedFromId: <string> + translations: + cillum_96: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + in_c: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + esse0: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + eadd5: {} + reprehenderit_d: {} + adipisicinga8: {} + widgets: + qui_1: {} + laborum_21: {} + veniam_5fb: {} + - abStatus: automated_loser_variant + abTestId: <string> + archivedAt: <long> + archivedInDashboard: <boolean> + attachedStylesheets: + - Lorem8e3: {} + anim28a: {} + - ad5d: {} + tempor2d4: {} + ut_fc5: {} + authorName: <string> + blogAuthorId: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '7' + created: <dateTime> + createdById: <string> + currentState: PUBLISHED_OR_SCHEDULED + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableGoogleAmpOutputOverride: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: en-lu + layoutSections: + aliquaa_: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + temporee8: {} + cillum_b_0: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - ipsum_32b: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + minim_14a: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - cillum_ac: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + aliqua_f: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + enim09: {} + amet_9c5: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - nisi_4: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - nostrud_849: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + aute150: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + Ut46: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - veniam_874: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - sint4: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + password: <string> + postBody: <string> + postSummary: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + rssBody: <string> + rssSummary: <string> + slug: <string> + state: <string> + tagIds: + - <long> + - <long> + themeSettingsValues: + velitb: {} + incididunt_5b2: {} + magna_0: {} + ipsum_b9a: {} + in_3: {} + translatedFromId: <string> + translations: + enim_b: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + sint7: {} + widgets: + sunt_b3f: {} + startedAt: <dateTime> + status: COMPLETE + numErrors: <integer> + requestedAt: <dateTime> + links: + enim6: <string> + ipsum_2: <string> + errors: + - category: cupidatat + context: + nulla_aec: + - dolore irure cillum nostrud ullamco + - in do dolore + errors: + - message: occaec + subCategory: magna dolor aliqua + code: irure magna cillum + in: officia ipsum esse sint + context: + et_5_0: + - fugiat commodo + - mollit ut + Excepteur_9f9: + - adipisicing Exc + - laboris + in_252: + - aliquip + - cillum irure incididunt + - message: id in do + subCategory: fugiat dolor anim ex Excepteur + code: ut exercitation eiusmod occaecat amet + in: veniam dolore nisi + context: + ipsum_914: + - '' + - Duis deserunt + do05: + - enim nulla ea ut + - adipisic + links: + dolorbfd: et + message: nisi Duis dolor voluptate + status: do culpa + subCategory: {} + id: magna sed et nisi + - category: sed ut fugiat cupidatat + context: + do__4: + - nulla ex aliqua anim + - pariatur voluptate + errors: + - message: sed exercitation + subCategory: eiusmod + code: amet in + in: dolor laborum pariatur commodo + context: + autec6: + - quis ullamco + - cillum aute reprehenderit aliqua labore + commodo8: + - anim dolore nisi non + - elit + - message: commodo dolor aliquip ut do + subCategory: cillum culpa laboris + code: elit + in: in in ad + context: + ut338: + - sit + - consectetur + inb1: + - qui + - consectetur + reprehenderit_: + - sunt sed fugiat irure + - irure non in minim + links: + reprehenderitad: labore quis et Ut + officia_5b8: ut sed ipsum est + reprehenderit_c6: consectetur irure + message: ut labore commodo aliqua + status: fugiat + subCategory: {} + id: Excepteur sit Ut ipsum ut + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ipsum_c": [ + "<string>", + "<string>" + ], + "sint_97b": [ + "<string>", + "<string>" + ], + "in_23": [ + "<string>", + "<string>" + ], + "laborum_": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_2f": "<string>" + }, + "errors": [ + { + "message": "sint proident pariatur exer", + "subCategory": "reprehenderit fugiat in eu", + "code": "esse labore nulla quis nisi", + "in": "consequat aliqua", + "context": { + "ina": [ + "laboris commodo", + "ad sed elit" + ], + "labore6_": [ + "culpa est esse aute", + "deserunt " + ], + "Duisb31": [ + "Ut", + "reprehenderit" + ] + } + }, + { + "message": "dolor consequat", + "subCategory": "dolore anim", + "code": "proident laboris", + "in": "ut ad do irure magna", + "context": { + "consectetur_1": [ + "mollit pariatur aliquip", + "adipisicing commodo aute" + ] + } + } + ] + } + /cms/v3/blogs/posts/multi-language/update-languages: + post: + tags: + - Blog Authors API + summary: Update languages of multi-language group + description: >- + Explicitly set new languages for each Blog Post in a multi-language + group. + requestBody: + content: + application/json: + schema: + type: object + example: + languages: + voluptate_3: ea ut occaecat + ut_63: velit magna ut non + primaryId: sint eu nostrud + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '200': + description: OK + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ipsum_c": [ + "<string>", + "<string>" + ], + "sint_97b": [ + "<string>", + "<string>" + ], + "in_23": [ + "<string>", + "<string>" + ], + "laborum_": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_2f": "<string>" + }, + "errors": [ + { + "message": "sint proident pariatur exer", + "subCategory": "reprehenderit fugiat in eu", + "code": "esse labore nulla quis nisi", + "in": "consequat aliqua", + "context": { + "ina": [ + "laboris commodo", + "ad sed elit" + ], + "labore6_": [ + "culpa est esse aute", + "deserunt " + ], + "Duisb31": [ + "Ut", + "reprehenderit" + ] + } + }, + { + "message": "dolor consequat", + "subCategory": "dolore anim", + "code": "proident laboris", + "in": "ut ad do irure magna", + "context": { + "consectetur_1": [ + "mollit pariatur aliquip", + "adipisicing commodo aute" + ] + } + } + ] + } + /cms/v3/blogs/posts/{objectId}/revisions/{revisionId}: + get: + tags: + - Blog Authors API + summary: Retrieves a previous version of a blog post + description: Retrieves a previous version of a blog post. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: objectId + in: path + schema: + type: string + required: true + description: (Required) The Blog Post id. + example: <string> + - name: revisionId + in: path + schema: + type: string + required: true + description: (Required) The Blog Post version id. + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + id: <string> + object: + abStatus: variant + abTestId: <string> + archivedAt: <long> + archivedInDashboard: <boolean> + attachedStylesheets: + - Ut117: {} + ipsum_0: {} + et4f9: {} + - velit__6: {} + authorName: <string> + blogAuthorId: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '8' + created: <dateTime> + createdById: <string> + currentState: AUTOMATED_FOR_FORM_DRAFT + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableGoogleAmpOutputOverride: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: cgg-ug + layoutSections: + estd2: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + Duisaf9: {} + tempore42: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - in_ee: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + quis_3d: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - nulla_f: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + ipsum1: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + irurefc: {} + occaecat_87: {} + sed_e01: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - Excepteurd46: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + deserunt6b1: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - ipsum_9: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + culpa56c: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + password: <string> + postBody: <string> + postSummary: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + rssBody: <string> + rssSummary: <string> + slug: <string> + state: <string> + tagIds: + - <long> + - <long> + themeSettingsValues: + sunt866: {} + eu3: {} + translatedFromId: <string> + translations: + cillum33: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + fugiat5a: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + Loremb: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + cupidatat_35: {} + suntc: {} + widgets: + Lorem_35: {} + updatedAt: <dateTime> + user: + email: <string> + fullName: <string> + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ipsum_c": [ + "<string>", + "<string>" + ], + "sint_97b": [ + "<string>", + "<string>" + ], + "in_23": [ + "<string>", + "<string>" + ], + "laborum_": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_2f": "<string>" + }, + "errors": [ + { + "message": "sint proident pariatur exer", + "subCategory": "reprehenderit fugiat in eu", + "code": "esse labore nulla quis nisi", + "in": "consequat aliqua", + "context": { + "ina": [ + "laboris commodo", + "ad sed elit" + ], + "labore6_": [ + "culpa est esse aute", + "deserunt " + ], + "Duisb31": [ + "Ut", + "reprehenderit" + ] + } + }, + { + "message": "dolor consequat", + "subCategory": "dolore anim", + "code": "proident laboris", + "in": "ut ad do irure magna", + "context": { + "consectetur_1": [ + "mollit pariatur aliquip", + "adipisicing commodo aute" + ] + } + } + ] + } + /cms/v3/blogs/posts/batch/update: + post: + tags: + - Blog Authors API + summary: Update a batch of Blog Posts + description: Update the Blog Post objects identified in the request body. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: [] + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: string + description: Specifies whether to update deleted Blog Posts. Defaults to `false`. + example: <boolean> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - abStatus: master + abTestId: <string> + archivedAt: <long> + archivedInDashboard: <boolean> + attachedStylesheets: + - cillum_7: {} + - dolore_60: {} + authorName: <string> + blogAuthorId: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '10' + created: <dateTime> + createdById: <string> + currentState: BLOG_EMAIL_DRAFT + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableGoogleAmpOutputOverride: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: gd-gb + layoutSections: + labore_0: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + esse4f0: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - docc: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + aliquaee: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - nullab26: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + in_9c: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + laborum094: {} + Loremb68: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - ea_0ed: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + ipsum61: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - et_4: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + Duis_c3: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + officia__fe: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + aliqua_8b7: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + reprehenderit56: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + pariature6: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + dolore409: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - aute3: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - incididunt7cb: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + mollit_5: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + password: <string> + postBody: <string> + postSummary: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + rssBody: <string> + rssSummary: <string> + slug: <string> + state: <string> + tagIds: + - <long> + - <long> + themeSettingsValues: + laborum3: {} + translatedFromId: <string> + translations: + ut_93: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + nulla1: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + in9: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + ut_76: {} + widgets: + reprehenderit8: {} + - abStatus: mab_variant + abTestId: <string> + archivedAt: <long> + archivedInDashboard: <boolean> + attachedStylesheets: + - ut_32: {} + - voluptate69: {} + authorName: <string> + blogAuthorId: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '5' + created: <dateTime> + createdById: <string> + currentState: PUBLISHED_AB_VARIANT + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableGoogleAmpOutputOverride: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: nmg + layoutSections: + laborisa0: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + cupidatat_ca: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - dolor_39: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - dolore_c3: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + password: <string> + postBody: <string> + postSummary: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + rssBody: <string> + rssSummary: <string> + slug: <string> + state: <string> + tagIds: + - <long> + - <long> + themeSettingsValues: + sed_ae4: {} + magna_2: {} + translatedFromId: <string> + translations: + cupidatat_ba: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + id_0: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + aliqua_7a: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + deserunt_05b: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + et40: {} + proident29: {} + amet911: {} + widgets: + quis_5: {} + qui_a2c: {} + et_7_: {} + startedAt: <dateTime> + status: COMPLETE + requestedAt: <dateTime> + links: + Excepteur_28: <string> + deserunt593: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - abStatus: loser_variant + abTestId: <string> + archivedAt: <long> + archivedInDashboard: <boolean> + attachedStylesheets: + - in_3: {} + velit978: {} + magnaa: {} + - veniam1: {} + authorName: <string> + blogAuthorId: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '7' + created: <dateTime> + createdById: <string> + currentState: BLOG_EMAIL_DRAFT + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableGoogleAmpOutputOverride: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: yo-ng + layoutSections: + in_ba: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + aliquip07f: {} + tempor7_e: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - culpa_a93: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + id9f4: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - esse_ee8: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + magna13: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + commodo_c59: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - aliquip_7: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + ut1: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - est412: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + veniam_66: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + deserunt75: {} + ea_4: {} + ipsum2: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - velit87: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - qui_13: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + id_4_: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + password: <string> + postBody: <string> + postSummary: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + rssBody: <string> + rssSummary: <string> + slug: <string> + state: <string> + tagIds: + - <long> + - <long> + themeSettingsValues: + dolor_67: {} + in05: {} + quis6e: {} + translatedFromId: <string> + translations: + cillum_96: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + in_c: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + esse0: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + eadd5: {} + reprehenderit_d: {} + adipisicinga8: {} + widgets: + qui_1: {} + laborum_21: {} + veniam_5fb: {} + - abStatus: automated_loser_variant + abTestId: <string> + archivedAt: <long> + archivedInDashboard: <boolean> + attachedStylesheets: + - Lorem8e3: {} + anim28a: {} + - ad5d: {} + tempor2d4: {} + ut_fc5: {} + authorName: <string> + blogAuthorId: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '7' + created: <dateTime> + createdById: <string> + currentState: PUBLISHED_OR_SCHEDULED + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableGoogleAmpOutputOverride: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: en-lu + layoutSections: + aliquaa_: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + temporee8: {} + cillum_b_0: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - ipsum_32b: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + minim_14a: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - cillum_ac: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + aliqua_f: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + enim09: {} + amet_9c5: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - nisi_4: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - nostrud_849: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + aute150: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + Ut46: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - veniam_874: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - sint4: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + password: <string> + postBody: <string> + postSummary: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + rssBody: <string> + rssSummary: <string> + slug: <string> + state: <string> + tagIds: + - <long> + - <long> + themeSettingsValues: + velitb: {} + incididunt_5b2: {} + magna_0: {} + ipsum_b9a: {} + in_3: {} + translatedFromId: <string> + translations: + enim_b: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + sint7: {} + widgets: + sunt_b3f: {} + startedAt: <dateTime> + status: COMPLETE + numErrors: <integer> + requestedAt: <dateTime> + links: + enim6: <string> + ipsum_2: <string> + errors: + - category: cupidatat + context: + nulla_aec: + - dolore irure cillum nostrud ullamco + - in do dolore + errors: + - message: occaec + subCategory: magna dolor aliqua + code: irure magna cillum + in: officia ipsum esse sint + context: + et_5_0: + - fugiat commodo + - mollit ut + Excepteur_9f9: + - adipisicing Exc + - laboris + in_252: + - aliquip + - cillum irure incididunt + - message: id in do + subCategory: fugiat dolor anim ex Excepteur + code: ut exercitation eiusmod occaecat amet + in: veniam dolore nisi + context: + ipsum_914: + - '' + - Duis deserunt + do05: + - enim nulla ea ut + - adipisic + links: + dolorbfd: et + message: nisi Duis dolor voluptate + status: do culpa + subCategory: {} + id: magna sed et nisi + - category: sed ut fugiat cupidatat + context: + do__4: + - nulla ex aliqua anim + - pariatur voluptate + errors: + - message: sed exercitation + subCategory: eiusmod + code: amet in + in: dolor laborum pariatur commodo + context: + autec6: + - quis ullamco + - cillum aute reprehenderit aliqua labore + commodo8: + - anim dolore nisi non + - elit + - message: commodo dolor aliquip ut do + subCategory: cillum culpa laboris + code: elit + in: in in ad + context: + ut338: + - sit + - consectetur + inb1: + - qui + - consectetur + reprehenderit_: + - sunt sed fugiat irure + - irure non in minim + links: + reprehenderitad: labore quis et Ut + officia_5b8: ut sed ipsum est + reprehenderit_c6: consectetur irure + message: ut labore commodo aliqua + status: fugiat + subCategory: {} + id: Excepteur sit Ut ipsum ut + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ipsum_c": [ + "<string>", + "<string>" + ], + "sint_97b": [ + "<string>", + "<string>" + ], + "in_23": [ + "<string>", + "<string>" + ], + "laborum_": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_2f": "<string>" + }, + "errors": [ + { + "message": "sint proident pariatur exer", + "subCategory": "reprehenderit fugiat in eu", + "code": "esse labore nulla quis nisi", + "in": "consequat aliqua", + "context": { + "ina": [ + "laboris commodo", + "ad sed elit" + ], + "labore6_": [ + "culpa est esse aute", + "deserunt " + ], + "Duisb31": [ + "Ut", + "reprehenderit" + ] + } + }, + { + "message": "dolor consequat", + "subCategory": "dolore anim", + "code": "proident laboris", + "in": "ut ad do irure magna", + "context": { + "consectetur_1": [ + "mollit pariatur aliquip", + "adipisicing commodo aute" + ] + } + } + ] + } + /cms/v3/blogs/posts/{objectId}/draft: + get: + tags: + - Blog Authors API + summary: Retrieve the full draft version of the Blog Post + description: Retrieve the full draft version of the Blog Post. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: objectId + in: path + schema: + type: string + required: true + description: (Required) The Blog Post id. + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + abStatus: mab_master + abTestId: <string> + archivedAt: <long> + archivedInDashboard: <boolean> + attachedStylesheets: + - est_b03: {} + nostrudc5: {} + aliquip_ee: {} + - aliquip_d9: {} + Excepteurd_0: {} + non4e8: {} + authorName: <string> + blogAuthorId: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '9' + created: <dateTime> + createdById: <string> + currentState: PROCESSING + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableGoogleAmpOutputOverride: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: ff-sl + layoutSections: + quis__ef: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + aliqua_1: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - labore_: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - exf_d: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + exercitation834: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + anim_3a2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + password: <string> + postBody: <string> + postSummary: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + rssBody: <string> + rssSummary: <string> + slug: <string> + state: <string> + tagIds: + - <long> + - <long> + themeSettingsValues: + Excepteurf: {} + aliqua_6: {} + qui_4: {} + translatedFromId: <string> + translations: + in_1: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + laborum05: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + ametf1: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + Excepteur_6b3: {} + widgets: + eu_e: {} + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ipsum_c": [ + "<string>", + "<string>" + ], + "sint_97b": [ + "<string>", + "<string>" + ], + "in_23": [ + "<string>", + "<string>" + ], + "laborum_": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_2f": "<string>" + }, + "errors": [ + { + "message": "sint proident pariatur exer", + "subCategory": "reprehenderit fugiat in eu", + "code": "esse labore nulla quis nisi", + "in": "consequat aliqua", + "context": { + "ina": [ + "laboris commodo", + "ad sed elit" + ], + "labore6_": [ + "culpa est esse aute", + "deserunt " + ], + "Duisb31": [ + "Ut", + "reprehenderit" + ] + } + }, + { + "message": "dolor consequat", + "subCategory": "dolore anim", + "code": "proident laboris", + "in": "ut ad do irure magna", + "context": { + "consectetur_1": [ + "mollit pariatur aliquip", + "adipisicing commodo aute" + ] + } + } + ] + } + patch: + tags: + - Blog Authors API + summary: Update a Blog Post draft + description: > + Sparse updates the draft version of a single Blog Post object identified + by the id in the path. + + All the column values need not be specified. Only the that need to be + modified can be specified. + requestBody: + content: + application/json: + schema: + type: object + example: + abStatus: mab_master + abTestId: <string> + archivedAt: <long> + archivedInDashboard: <boolean> + attachedStylesheets: + - est_b03: {} + nostrudc5: {} + aliquip_ee: {} + - aliquip_d9: {} + Excepteurd_0: {} + non4e8: {} + authorName: <string> + blogAuthorId: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '9' + created: <dateTime> + createdById: <string> + currentState: PROCESSING + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableGoogleAmpOutputOverride: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: ff-sl + layoutSections: + quis__ef: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + aliqua_1: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - labore_: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - exf_d: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + exercitation834: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + anim_3a2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + password: <string> + postBody: <string> + postSummary: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + rssBody: <string> + rssSummary: <string> + slug: <string> + state: <string> + tagIds: + - <long> + - <long> + themeSettingsValues: + Excepteurf: {} + aliqua_6: {} + qui_4: {} + translatedFromId: <string> + translations: + in_1: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + laborum05: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + ametf1: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + Excepteur_6b3: {} + widgets: + eu_e: {} + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: objectId + in: path + schema: + type: string + required: true + description: (Required) The Blog Post id. + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + abStatus: mab_master + abTestId: <string> + archivedAt: <long> + archivedInDashboard: <boolean> + attachedStylesheets: + - est_b03: {} + nostrudc5: {} + aliquip_ee: {} + - aliquip_d9: {} + Excepteurd_0: {} + non4e8: {} + authorName: <string> + blogAuthorId: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '9' + created: <dateTime> + createdById: <string> + currentState: PROCESSING + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableGoogleAmpOutputOverride: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: ff-sl + layoutSections: + quis__ef: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + aliqua_1: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - labore_: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - exf_d: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + exercitation834: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + anim_3a2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + password: <string> + postBody: <string> + postSummary: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + rssBody: <string> + rssSummary: <string> + slug: <string> + state: <string> + tagIds: + - <long> + - <long> + themeSettingsValues: + Excepteurf: {} + aliqua_6: {} + qui_4: {} + translatedFromId: <string> + translations: + in_1: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + laborum05: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + ametf1: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + Excepteur_6b3: {} + widgets: + eu_e: {} + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ipsum_c": [ + "<string>", + "<string>" + ], + "sint_97b": [ + "<string>", + "<string>" + ], + "in_23": [ + "<string>", + "<string>" + ], + "laborum_": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_2f": "<string>" + }, + "errors": [ + { + "message": "sint proident pariatur exer", + "subCategory": "reprehenderit fugiat in eu", + "code": "esse labore nulla quis nisi", + "in": "consequat aliqua", + "context": { + "ina": [ + "laboris commodo", + "ad sed elit" + ], + "labore6_": [ + "culpa est esse aute", + "deserunt " + ], + "Duisb31": [ + "Ut", + "reprehenderit" + ] + } + }, + { + "message": "dolor consequat", + "subCategory": "dolore anim", + "code": "proident laboris", + "in": "ut ad do irure magna", + "context": { + "consectetur_1": [ + "mollit pariatur aliquip", + "adipisicing commodo aute" + ] + } + } + ] + } + /cms/v3/blogs/posts/batch/create: + post: + tags: + - Blog Authors API + summary: Create a batch of Blog Posts + description: Create the Blog Post objects detailed in the request body. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - abStatus: mab_master + abTestId: <string> + archivedAt: <long> + archivedInDashboard: <boolean> + attachedStylesheets: + - magnab6e: {} + veniame2: {} + - in4: {} + authorName: <string> + blogAuthorId: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '4' + created: <dateTime> + createdById: <string> + currentState: PUBLISHED_OR_SCHEDULED + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableGoogleAmpOutputOverride: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: ar-ae + layoutSections: + magnaec: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + ut5: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - non_24: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - qui_6: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + password: <string> + postBody: <string> + postSummary: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + rssBody: <string> + rssSummary: <string> + slug: <string> + state: <string> + tagIds: + - <long> + - <long> + themeSettingsValues: + irure55: {} + dolore_ed: {} + translatedFromId: <string> + translations: + esse_5: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + incididunt_8d: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + mollit_d9: {} + dolord: {} + widgets: + veniam485: {} + ex5: {} + - abStatus: mab_master + abTestId: <string> + archivedAt: <long> + archivedInDashboard: <boolean> + attachedStylesheets: + - eu_604: {} + dolore_7dc: {} + - eiusmodb4: {} + authorName: <string> + blogAuthorId: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '3' + created: <dateTime> + createdById: <string> + currentState: AUTOMATED_FOR_FORM_LEGACY + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableGoogleAmpOutputOverride: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: it-ch + layoutSections: + ipsum_84: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + in_8a3: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - minim0: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - dolor0: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + sint_16: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + id_d25: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + adipisicing95: {} + mollit_cb3: {} + ut_f: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - ea_d: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + Duis8d: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + irure46b: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - incididunt13f: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + nulla8: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + occaecat8: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + password: <string> + postBody: <string> + postSummary: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + rssBody: <string> + rssSummary: <string> + slug: <string> + state: <string> + tagIds: + - <long> + - <long> + themeSettingsValues: + utc3: {} + incididunt2: {} + translatedFromId: <string> + translations: + elit2: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + in_6d: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + veniam_c: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + nostrud_731: {} + widgets: + minime7: {} + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - abStatus: master + abTestId: <string> + archivedAt: <long> + archivedInDashboard: <boolean> + attachedStylesheets: + - cillum_7: {} + - dolore_60: {} + authorName: <string> + blogAuthorId: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '10' + created: <dateTime> + createdById: <string> + currentState: BLOG_EMAIL_DRAFT + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableGoogleAmpOutputOverride: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: gd-gb + layoutSections: + labore_0: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + esse4f0: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - docc: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + aliquaee: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - nullab26: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + in_9c: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + laborum094: {} + Loremb68: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - ea_0ed: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + ipsum61: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - et_4: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + Duis_c3: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + officia__fe: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + aliqua_8b7: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + reprehenderit56: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + pariature6: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + dolore409: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - aute3: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - incididunt7cb: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + mollit_5: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + password: <string> + postBody: <string> + postSummary: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + rssBody: <string> + rssSummary: <string> + slug: <string> + state: <string> + tagIds: + - <long> + - <long> + themeSettingsValues: + laborum3: {} + translatedFromId: <string> + translations: + ut_93: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + nulla1: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + in9: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + ut_76: {} + widgets: + reprehenderit8: {} + - abStatus: mab_variant + abTestId: <string> + archivedAt: <long> + archivedInDashboard: <boolean> + attachedStylesheets: + - ut_32: {} + - voluptate69: {} + authorName: <string> + blogAuthorId: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '5' + created: <dateTime> + createdById: <string> + currentState: PUBLISHED_AB_VARIANT + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableGoogleAmpOutputOverride: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: nmg + layoutSections: + laborisa0: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + cupidatat_ca: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - dolor_39: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - dolore_c3: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + password: <string> + postBody: <string> + postSummary: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + rssBody: <string> + rssSummary: <string> + slug: <string> + state: <string> + tagIds: + - <long> + - <long> + themeSettingsValues: + sed_ae4: {} + magna_2: {} + translatedFromId: <string> + translations: + cupidatat_ba: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + id_0: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + aliqua_7a: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + deserunt_05b: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + et40: {} + proident29: {} + amet911: {} + widgets: + quis_5: {} + qui_a2c: {} + et_7_: {} + startedAt: <dateTime> + status: COMPLETE + requestedAt: <dateTime> + links: + Excepteur_28: <string> + deserunt593: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - abStatus: loser_variant + abTestId: <string> + archivedAt: <long> + archivedInDashboard: <boolean> + attachedStylesheets: + - in_3: {} + velit978: {} + magnaa: {} + - veniam1: {} + authorName: <string> + blogAuthorId: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '7' + created: <dateTime> + createdById: <string> + currentState: BLOG_EMAIL_DRAFT + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableGoogleAmpOutputOverride: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: yo-ng + layoutSections: + in_ba: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + aliquip07f: {} + tempor7_e: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - culpa_a93: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + id9f4: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - esse_ee8: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + magna13: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + commodo_c59: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - aliquip_7: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + ut1: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - est412: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + veniam_66: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + deserunt75: {} + ea_4: {} + ipsum2: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - velit87: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - qui_13: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + id_4_: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + password: <string> + postBody: <string> + postSummary: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + rssBody: <string> + rssSummary: <string> + slug: <string> + state: <string> + tagIds: + - <long> + - <long> + themeSettingsValues: + dolor_67: {} + in05: {} + quis6e: {} + translatedFromId: <string> + translations: + cillum_96: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + in_c: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + esse0: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + eadd5: {} + reprehenderit_d: {} + adipisicinga8: {} + widgets: + qui_1: {} + laborum_21: {} + veniam_5fb: {} + - abStatus: automated_loser_variant + abTestId: <string> + archivedAt: <long> + archivedInDashboard: <boolean> + attachedStylesheets: + - Lorem8e3: {} + anim28a: {} + - ad5d: {} + tempor2d4: {} + ut_fc5: {} + authorName: <string> + blogAuthorId: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '7' + created: <dateTime> + createdById: <string> + currentState: PUBLISHED_OR_SCHEDULED + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableGoogleAmpOutputOverride: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: en-lu + layoutSections: + aliquaa_: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + temporee8: {} + cillum_b_0: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - ipsum_32b: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + minim_14a: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - cillum_ac: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + aliqua_f: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + enim09: {} + amet_9c5: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - nisi_4: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - nostrud_849: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + aute150: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + Ut46: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - veniam_874: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - sint4: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + password: <string> + postBody: <string> + postSummary: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + rssBody: <string> + rssSummary: <string> + slug: <string> + state: <string> + tagIds: + - <long> + - <long> + themeSettingsValues: + velitb: {} + incididunt_5b2: {} + magna_0: {} + ipsum_b9a: {} + in_3: {} + translatedFromId: <string> + translations: + enim_b: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + sint7: {} + widgets: + sunt_b3f: {} + startedAt: <dateTime> + status: COMPLETE + numErrors: <integer> + requestedAt: <dateTime> + links: + enim6: <string> + ipsum_2: <string> + errors: + - category: cupidatat + context: + nulla_aec: + - dolore irure cillum nostrud ullamco + - in do dolore + errors: + - message: occaec + subCategory: magna dolor aliqua + code: irure magna cillum + in: officia ipsum esse sint + context: + et_5_0: + - fugiat commodo + - mollit ut + Excepteur_9f9: + - adipisicing Exc + - laboris + in_252: + - aliquip + - cillum irure incididunt + - message: id in do + subCategory: fugiat dolor anim ex Excepteur + code: ut exercitation eiusmod occaecat amet + in: veniam dolore nisi + context: + ipsum_914: + - '' + - Duis deserunt + do05: + - enim nulla ea ut + - adipisic + links: + dolorbfd: et + message: nisi Duis dolor voluptate + status: do culpa + subCategory: {} + id: magna sed et nisi + - category: sed ut fugiat cupidatat + context: + do__4: + - nulla ex aliqua anim + - pariatur voluptate + errors: + - message: sed exercitation + subCategory: eiusmod + code: amet in + in: dolor laborum pariatur commodo + context: + autec6: + - quis ullamco + - cillum aute reprehenderit aliqua labore + commodo8: + - anim dolore nisi non + - elit + - message: commodo dolor aliquip ut do + subCategory: cillum culpa laboris + code: elit + in: in in ad + context: + ut338: + - sit + - consectetur + inb1: + - qui + - consectetur + reprehenderit_: + - sunt sed fugiat irure + - irure non in minim + links: + reprehenderitad: labore quis et Ut + officia_5b8: ut sed ipsum est + reprehenderit_c6: consectetur irure + message: ut labore commodo aliqua + status: fugiat + subCategory: {} + id: Excepteur sit Ut ipsum ut + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ipsum_c": [ + "<string>", + "<string>" + ], + "sint_97b": [ + "<string>", + "<string>" + ], + "in_23": [ + "<string>", + "<string>" + ], + "laborum_": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_2f": "<string>" + }, + "errors": [ + { + "message": "sint proident pariatur exer", + "subCategory": "reprehenderit fugiat in eu", + "code": "esse labore nulla quis nisi", + "in": "consequat aliqua", + "context": { + "ina": [ + "laboris commodo", + "ad sed elit" + ], + "labore6_": [ + "culpa est esse aute", + "deserunt " + ], + "Duisb31": [ + "Ut", + "reprehenderit" + ] + } + }, + { + "message": "dolor consequat", + "subCategory": "dolore anim", + "code": "proident laboris", + "in": "ut ad do irure magna", + "context": { + "consectetur_1": [ + "mollit pariatur aliquip", + "adipisicing commodo aute" + ] + } + } + ] + } + /cms/v3/blogs/posts/{objectId}/revisions/{revisionId}/restore-to-draft: + post: + tags: + - Blog Authors API + summary: >- + Restore a previous version of a blog post, to the draft version of the + blog post + description: >- + Takes a specified version of a blog post, sets it as the new draft + version of the blog post. + requestBody: + content: {} + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: objectId + in: path + schema: + type: string + required: true + description: (Required) The Blog Post id. + example: <string> + - name: revisionId + in: path + schema: + type: string + required: true + description: (Required) The Blog Post version id to restore. + example: <long> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + abStatus: mab_master + abTestId: <string> + archivedAt: <long> + archivedInDashboard: <boolean> + attachedStylesheets: + - est_b03: {} + nostrudc5: {} + aliquip_ee: {} + - aliquip_d9: {} + Excepteurd_0: {} + non4e8: {} + authorName: <string> + blogAuthorId: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '9' + created: <dateTime> + createdById: <string> + currentState: PROCESSING + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableGoogleAmpOutputOverride: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: ff-sl + layoutSections: + quis__ef: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + aliqua_1: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - labore_: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - exf_d: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + exercitation834: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + anim_3a2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + password: <string> + postBody: <string> + postSummary: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + rssBody: <string> + rssSummary: <string> + slug: <string> + state: <string> + tagIds: + - <long> + - <long> + themeSettingsValues: + Excepteurf: {} + aliqua_6: {} + qui_4: {} + translatedFromId: <string> + translations: + in_1: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + laborum05: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + ametf1: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + Excepteur_6b3: {} + widgets: + eu_e: {} + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ipsum_c": [ + "<string>", + "<string>" + ], + "sint_97b": [ + "<string>", + "<string>" + ], + "in_23": [ + "<string>", + "<string>" + ], + "laborum_": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_2f": "<string>" + }, + "errors": [ + { + "message": "sint proident pariatur exer", + "subCategory": "reprehenderit fugiat in eu", + "code": "esse labore nulla quis nisi", + "in": "consequat aliqua", + "context": { + "ina": [ + "laboris commodo", + "ad sed elit" + ], + "labore6_": [ + "culpa est esse aute", + "deserunt " + ], + "Duisb31": [ + "Ut", + "reprehenderit" + ] + } + }, + { + "message": "dolor consequat", + "subCategory": "dolore anim", + "code": "proident laboris", + "in": "ut ad do irure magna", + "context": { + "consectetur_1": [ + "mollit pariatur aliquip", + "adipisicing commodo aute" + ] + } + } + ] + } + /cms/v3/blogs/posts/multi-language/create-language-variation: + post: + tags: + - Blog Authors API + summary: Create a new language variation + description: Create a new language variation from an existing Blog Post + requestBody: + content: + application/json: + schema: + type: object + example: + id: <string> + language: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + abStatus: mab_master + abTestId: <string> + archivedAt: <long> + archivedInDashboard: <boolean> + attachedStylesheets: + - est_b03: {} + nostrudc5: {} + aliquip_ee: {} + - aliquip_d9: {} + Excepteurd_0: {} + non4e8: {} + authorName: <string> + blogAuthorId: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '9' + created: <dateTime> + createdById: <string> + currentState: PROCESSING + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableGoogleAmpOutputOverride: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: ff-sl + layoutSections: + quis__ef: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + aliqua_1: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - labore_: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - exf_d: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + exercitation834: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + anim_3a2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + password: <string> + postBody: <string> + postSummary: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + rssBody: <string> + rssSummary: <string> + slug: <string> + state: <string> + tagIds: + - <long> + - <long> + themeSettingsValues: + Excepteurf: {} + aliqua_6: {} + qui_4: {} + translatedFromId: <string> + translations: + in_1: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + laborum05: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + ametf1: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + Excepteur_6b3: {} + widgets: + eu_e: {} + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ipsum_c": [ + "<string>", + "<string>" + ], + "sint_97b": [ + "<string>", + "<string>" + ], + "in_23": [ + "<string>", + "<string>" + ], + "laborum_": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_2f": "<string>" + }, + "errors": [ + { + "message": "sint proident pariatur exer", + "subCategory": "reprehenderit fugiat in eu", + "code": "esse labore nulla quis nisi", + "in": "consequat aliqua", + "context": { + "ina": [ + "laboris commodo", + "ad sed elit" + ], + "labore6_": [ + "culpa est esse aute", + "deserunt " + ], + "Duisb31": [ + "Ut", + "reprehenderit" + ] + } + }, + { + "message": "dolor consequat", + "subCategory": "dolore anim", + "code": "proident laboris", + "in": "ut ad do irure magna", + "context": { + "consectetur_1": [ + "mollit pariatur aliquip", + "adipisicing commodo aute" + ] + } + } + ] + } + /cms/v3/blogs/posts/clone: + post: + tags: + - Blog Authors API + summary: Clone a Blog Post + description: Clone a Blog Post. + requestBody: + content: + application/json: + schema: + type: object + example: + id: <string> + cloneName: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + abStatus: mab_master + abTestId: <string> + archivedAt: <long> + archivedInDashboard: <boolean> + attachedStylesheets: + - est_b03: {} + nostrudc5: {} + aliquip_ee: {} + - aliquip_d9: {} + Excepteurd_0: {} + non4e8: {} + authorName: <string> + blogAuthorId: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '9' + created: <dateTime> + createdById: <string> + currentState: PROCESSING + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableGoogleAmpOutputOverride: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: ff-sl + layoutSections: + quis__ef: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + aliqua_1: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - labore_: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - exf_d: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + exercitation834: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + anim_3a2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + password: <string> + postBody: <string> + postSummary: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + rssBody: <string> + rssSummary: <string> + slug: <string> + state: <string> + tagIds: + - <long> + - <long> + themeSettingsValues: + Excepteurf: {} + aliqua_6: {} + qui_4: {} + translatedFromId: <string> + translations: + in_1: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + laborum05: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + ametf1: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + Excepteur_6b3: {} + widgets: + eu_e: {} + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ipsum_c": [ + "<string>", + "<string>" + ], + "sint_97b": [ + "<string>", + "<string>" + ], + "in_23": [ + "<string>", + "<string>" + ], + "laborum_": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_2f": "<string>" + }, + "errors": [ + { + "message": "sint proident pariatur exer", + "subCategory": "reprehenderit fugiat in eu", + "code": "esse labore nulla quis nisi", + "in": "consequat aliqua", + "context": { + "ina": [ + "laboris commodo", + "ad sed elit" + ], + "labore6_": [ + "culpa est esse aute", + "deserunt " + ], + "Duisb31": [ + "Ut", + "reprehenderit" + ] + } + }, + { + "message": "dolor consequat", + "subCategory": "dolore anim", + "code": "proident laboris", + "in": "ut ad do irure magna", + "context": { + "consectetur_1": [ + "mollit pariatur aliquip", + "adipisicing commodo aute" + ] + } + } + ] + } + /cms/v3/blogs/posts: + get: + tags: + - Blog Authors API + summary: Get all Blog Posts + description: > + Get the list of blog posts. Supports paging and filtering. This method + would be useful for an integration that examined these models and used + an external service to suggest edits. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: createdAt + in: query + schema: + type: string + description: Only return Blog Posts created at exactly the specified time. + example: <dateTime> + - name: createdAfter + in: query + schema: + type: string + description: Only return Blog Posts created after the specified time. + example: <dateTime> + - name: createdBefore + in: query + schema: + type: string + description: Only return Blog Posts created before the specified time. + example: <dateTime> + - name: updatedAt + in: query + schema: + type: string + description: Only return Blog Posts last updated at exactly the specified time. + example: <dateTime> + - name: updatedAfter + in: query + schema: + type: string + description: Only return Blog Posts last updated after the specified time. + example: <dateTime> + - name: updatedBefore + in: query + schema: + type: string + description: Only return Blog Posts last updated before the specified time. + example: <dateTime> + - name: sort + in: query + schema: + type: string + description: >- + Specifies which fields to use for sorting results. Valid fields are + `name`, `createdAt`, `updatedAt`, `createdBy`, `updatedBy`. + `createdAt` will be used by default. + example: <string> + - name: sort + in: query + schema: + type: string + description: >- + Specifies which fields to use for sorting results. Valid fields are + `name`, `createdAt`, `updatedAt`, `createdBy`, `updatedBy`. + `createdAt` will be used by default. + example: <string> + - name: after + in: query + schema: + type: string + description: >- + The cursor token value to get the next set of results. You can get + this from the `paging.next.after` JSON property of a paged response + containing more results. + example: <string> + - name: limit + in: query + schema: + type: string + description: The maximum number of results to return. Default is 20. + example: <integer> + - name: archived + in: query + schema: + type: string + description: Specifies whether to return deleted Blog Posts. Defaults to `false`. + example: <boolean> + - name: property + in: query + schema: + type: string + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - abStatus: loser_variant + abTestId: <string> + archivedAt: <long> + archivedInDashboard: <boolean> + attachedStylesheets: + - Duis_3: {} + proident2: {} + - labore_1: {} + authorName: <string> + blogAuthorId: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '5' + created: <dateTime> + createdById: <string> + currentState: PUBLISHED_OR_SCHEDULED + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableGoogleAmpOutputOverride: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: fy-nl + layoutSections: + in_4: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + deserunt_a_c: {} + in06: {} + consequat__07: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - veniambc: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - dolore65: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + inf5: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + password: <string> + postBody: <string> + postSummary: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + rssBody: <string> + rssSummary: <string> + slug: <string> + state: <string> + tagIds: + - <long> + - <long> + themeSettingsValues: + minim__0: {} + translatedFromId: <string> + translations: + incididunt_395: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + aliqua5: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + reprehenderit_1f: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + magna4: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + commodo_d3: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + enim_b2a: {} + widgets: + ullamco_6a7: {} + - abStatus: master + abTestId: <string> + archivedAt: <long> + archivedInDashboard: <boolean> + attachedStylesheets: + - do430: {} + - dolore_d2: {} + et_14: {} + quis650: {} + authorName: <string> + blogAuthorId: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '4' + created: <dateTime> + createdById: <string> + currentState: RSS_TO_EMAIL_DRAFT + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableGoogleAmpOutputOverride: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: rm-ch + layoutSections: + laborum_0b: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + dolor_1c: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - uta: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + elitc5: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - non_: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + quis__: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + velitd8_: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + password: <string> + postBody: <string> + postSummary: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + rssBody: <string> + rssSummary: <string> + slug: <string> + state: <string> + tagIds: + - <long> + - <long> + themeSettingsValues: + elit8: {} + translatedFromId: <string> + translations: + eu8: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + aliqua0b8: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + ametd: {} + reprehenderit__: {} + magna_da: {} + widgets: + non18c: {} + total: <integer> + paging: + next: + after: se + link: in Ut fugiat ipsum + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ipsum_c": [ + "<string>", + "<string>" + ], + "sint_97b": [ + "<string>", + "<string>" + ], + "in_23": [ + "<string>", + "<string>" + ], + "laborum_": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_2f": "<string>" + }, + "errors": [ + { + "message": "sint proident pariatur exer", + "subCategory": "reprehenderit fugiat in eu", + "code": "esse labore nulla quis nisi", + "in": "consequat aliqua", + "context": { + "ina": [ + "laboris commodo", + "ad sed elit" + ], + "labore6_": [ + "culpa est esse aute", + "deserunt " + ], + "Duisb31": [ + "Ut", + "reprehenderit" + ] + } + }, + { + "message": "dolor consequat", + "subCategory": "dolore anim", + "code": "proident laboris", + "in": "ut ad do irure magna", + "context": { + "consectetur_1": [ + "mollit pariatur aliquip", + "adipisicing commodo aute" + ] + } + } + ] + } + post: + tags: + - Blog Authors API + summary: Create a new Blog Post + description: Create a new Blog Post. + requestBody: + content: + application/json: + schema: + type: object + example: + abStatus: mab_master + abTestId: <string> + archivedAt: <long> + archivedInDashboard: <boolean> + attachedStylesheets: + - est_b03: {} + nostrudc5: {} + aliquip_ee: {} + - aliquip_d9: {} + Excepteurd_0: {} + non4e8: {} + authorName: <string> + blogAuthorId: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '9' + created: <dateTime> + createdById: <string> + currentState: PROCESSING + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableGoogleAmpOutputOverride: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: ff-sl + layoutSections: + quis__ef: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + aliqua_1: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - labore_: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - exf_d: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + exercitation834: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + anim_3a2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + password: <string> + postBody: <string> + postSummary: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + rssBody: <string> + rssSummary: <string> + slug: <string> + state: <string> + tagIds: + - <long> + - <long> + themeSettingsValues: + Excepteurf: {} + aliqua_6: {} + qui_4: {} + translatedFromId: <string> + translations: + in_1: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + laborum05: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + ametf1: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + Excepteur_6b3: {} + widgets: + eu_e: {} + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + abStatus: mab_master + abTestId: <string> + archivedAt: <long> + archivedInDashboard: <boolean> + attachedStylesheets: + - est_b03: {} + nostrudc5: {} + aliquip_ee: {} + - aliquip_d9: {} + Excepteurd_0: {} + non4e8: {} + authorName: <string> + blogAuthorId: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '9' + created: <dateTime> + createdById: <string> + currentState: PROCESSING + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableGoogleAmpOutputOverride: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: ff-sl + layoutSections: + quis__ef: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + aliqua_1: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - labore_: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - exf_d: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + exercitation834: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + anim_3a2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + password: <string> + postBody: <string> + postSummary: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + rssBody: <string> + rssSummary: <string> + slug: <string> + state: <string> + tagIds: + - <long> + - <long> + themeSettingsValues: + Excepteurf: {} + aliqua_6: {} + qui_4: {} + translatedFromId: <string> + translations: + in_1: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + laborum05: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + ametf1: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + Excepteur_6b3: {} + widgets: + eu_e: {} + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ipsum_c": [ + "<string>", + "<string>" + ], + "sint_97b": [ + "<string>", + "<string>" + ], + "in_23": [ + "<string>", + "<string>" + ], + "laborum_": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_2f": "<string>" + }, + "errors": [ + { + "message": "sint proident pariatur exer", + "subCategory": "reprehenderit fugiat in eu", + "code": "esse labore nulla quis nisi", + "in": "consequat aliqua", + "context": { + "ina": [ + "laboris commodo", + "ad sed elit" + ], + "labore6_": [ + "culpa est esse aute", + "deserunt " + ], + "Duisb31": [ + "Ut", + "reprehenderit" + ] + } + }, + { + "message": "dolor consequat", + "subCategory": "dolore anim", + "code": "proident laboris", + "in": "ut ad do irure magna", + "context": { + "consectetur_1": [ + "mollit pariatur aliquip", + "adipisicing commodo aute" + ] + } + } + ] + } + /cms/v3/blogs/posts/{objectId}/revisions/{revisionId}/restore: + post: + tags: + - Blog Authors API + summary: Restore a previous version of a blog post + description: Takes a specified version of a blog post and restores it. + requestBody: + content: {} + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: objectId + in: path + schema: + type: string + required: true + description: (Required) The Blog Post id. + example: <string> + - name: revisionId + in: path + schema: + type: string + required: true + description: (Required) The Blog Post version id to restore. + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + abStatus: mab_master + abTestId: <string> + archivedAt: <long> + archivedInDashboard: <boolean> + attachedStylesheets: + - est_b03: {} + nostrudc5: {} + aliquip_ee: {} + - aliquip_d9: {} + Excepteurd_0: {} + non4e8: {} + authorName: <string> + blogAuthorId: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '9' + created: <dateTime> + createdById: <string> + currentState: PROCESSING + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableGoogleAmpOutputOverride: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: ff-sl + layoutSections: + quis__ef: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + aliqua_1: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - labore_: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - exf_d: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + exercitation834: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + anim_3a2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + password: <string> + postBody: <string> + postSummary: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + rssBody: <string> + rssSummary: <string> + slug: <string> + state: <string> + tagIds: + - <long> + - <long> + themeSettingsValues: + Excepteurf: {} + aliqua_6: {} + qui_4: {} + translatedFromId: <string> + translations: + in_1: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + laborum05: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + ametf1: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + Excepteur_6b3: {} + widgets: + eu_e: {} + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ipsum_c": [ + "<string>", + "<string>" + ], + "sint_97b": [ + "<string>", + "<string>" + ], + "in_23": [ + "<string>", + "<string>" + ], + "laborum_": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_2f": "<string>" + }, + "errors": [ + { + "message": "sint proident pariatur exer", + "subCategory": "reprehenderit fugiat in eu", + "code": "esse labore nulla quis nisi", + "in": "consequat aliqua", + "context": { + "ina": [ + "laboris commodo", + "ad sed elit" + ], + "labore6_": [ + "culpa est esse aute", + "deserunt " + ], + "Duisb31": [ + "Ut", + "reprehenderit" + ] + } + }, + { + "message": "dolor consequat", + "subCategory": "dolore anim", + "code": "proident laboris", + "in": "ut ad do irure magna", + "context": { + "consectetur_1": [ + "mollit pariatur aliquip", + "adipisicing commodo aute" + ] + } + } + ] + } + /cms/v3/blogs/posts/multi-language/detach-from-lang-group: + post: + tags: + - Blog Authors API + summary: Detach a Blog Post from a multi-language group + description: Detach a Blog Post from a multi-language group. + requestBody: + content: + application/json: + schema: + type: object + example: + id: in eu dolore + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '200': + description: OK + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ipsum_c": [ + "<string>", + "<string>" + ], + "sint_97b": [ + "<string>", + "<string>" + ], + "in_23": [ + "<string>", + "<string>" + ], + "laborum_": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_2f": "<string>" + }, + "errors": [ + { + "message": "sint proident pariatur exer", + "subCategory": "reprehenderit fugiat in eu", + "code": "esse labore nulla quis nisi", + "in": "consequat aliqua", + "context": { + "ina": [ + "laboris commodo", + "ad sed elit" + ], + "labore6_": [ + "culpa est esse aute", + "deserunt " + ], + "Duisb31": [ + "Ut", + "reprehenderit" + ] + } + }, + { + "message": "dolor consequat", + "subCategory": "dolore anim", + "code": "proident laboris", + "in": "ut ad do irure magna", + "context": { + "consectetur_1": [ + "mollit pariatur aliquip", + "adipisicing commodo aute" + ] + } + } + ] + } + /cms/v3/blogs/posts/{objectId}/draft/push-live: + post: + tags: + - Blog Authors API + summary: Push Blog Post draft edits live + description: >- + Take any changes from the draft version of the Blog Post and apply them + to the live version. + requestBody: + content: {} + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: objectId + in: path + schema: + type: string + required: true + description: >- + (Required) The id of the Blog Post for which it's draft will be + pushed live. + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ipsum_c": [ + "<string>", + "<string>" + ], + "sint_97b": [ + "<string>", + "<string>" + ], + "in_23": [ + "<string>", + "<string>" + ], + "laborum_": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_2f": "<string>" + }, + "errors": [ + { + "message": "sint proident pariatur exer", + "subCategory": "reprehenderit fugiat in eu", + "code": "esse labore nulla quis nisi", + "in": "consequat aliqua", + "context": { + "ina": [ + "laboris commodo", + "ad sed elit" + ], + "labore6_": [ + "culpa est esse aute", + "deserunt " + ], + "Duisb31": [ + "Ut", + "reprehenderit" + ] + } + }, + { + "message": "dolor consequat", + "subCategory": "dolore anim", + "code": "proident laboris", + "in": "ut ad do irure magna", + "context": { + "consectetur_1": [ + "mollit pariatur aliquip", + "adipisicing commodo aute" + ] + } + } + ] + } + /cms/v3/blogs/posts/batch/archive: + post: + tags: + - Blog Authors API + summary: Delete a batch of Blog Posts + description: >- + Delete the Blog Post objects identified in the request body. + + Note: This is not the same as the in-app `archive` function. To perform + a dashboard `archive` send an normal update with the + `archivedInDashboard` field set to true. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - qui enim + - ex ea fugiat adipisicing ut + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ipsum_c": [ + "<string>", + "<string>" + ], + "sint_97b": [ + "<string>", + "<string>" + ], + "in_23": [ + "<string>", + "<string>" + ], + "laborum_": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_2f": "<string>" + }, + "errors": [ + { + "message": "sint proident pariatur exer", + "subCategory": "reprehenderit fugiat in eu", + "code": "esse labore nulla quis nisi", + "in": "consequat aliqua", + "context": { + "ina": [ + "laboris commodo", + "ad sed elit" + ], + "labore6_": [ + "culpa est esse aute", + "deserunt " + ], + "Duisb31": [ + "Ut", + "reprehenderit" + ] + } + }, + { + "message": "dolor consequat", + "subCategory": "dolore anim", + "code": "proident laboris", + "in": "ut ad do irure magna", + "context": { + "consectetur_1": [ + "mollit pariatur aliquip", + "adipisicing commodo aute" + ] + } + } + ] + } + /cms/v3/blogs/posts/{objectId}/draft/reset: + post: + tags: + - Blog Authors API + summary: Reset the Blog Post draft to the live version + description: Discards any edits and resets the draft to the live version. + requestBody: + content: {} + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: objectId + in: path + schema: + type: string + required: true + description: >- + (Required) The id of the Blog Post for which it's draft will be + reset. + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ipsum_c": [ + "<string>", + "<string>" + ], + "sint_97b": [ + "<string>", + "<string>" + ], + "in_23": [ + "<string>", + "<string>" + ], + "laborum_": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_2f": "<string>" + }, + "errors": [ + { + "message": "sint proident pariatur exer", + "subCategory": "reprehenderit fugiat in eu", + "code": "esse labore nulla quis nisi", + "in": "consequat aliqua", + "context": { + "ina": [ + "laboris commodo", + "ad sed elit" + ], + "labore6_": [ + "culpa est esse aute", + "deserunt " + ], + "Duisb31": [ + "Ut", + "reprehenderit" + ] + } + }, + { + "message": "dolor consequat", + "subCategory": "dolore anim", + "code": "proident laboris", + "in": "ut ad do irure magna", + "context": { + "consectetur_1": [ + "mollit pariatur aliquip", + "adipisicing commodo aute" + ] + } + } + ] + } + /cms/v3/blogs/posts/multi-language/attach-to-lang-group: + post: + tags: + - Blog Authors API + summary: Attach a Blog Post to a multi-language group + description: Attach a Blog Post to a multi-language group. + requestBody: + content: + application/json: + schema: + type: object + example: + id: par + language: consequat in + primaryId: ex sint et + primaryLanguage: sit ut + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '200': + description: OK + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ipsum_c": [ + "<string>", + "<string>" + ], + "sint_97b": [ + "<string>", + "<string>" + ], + "in_23": [ + "<string>", + "<string>" + ], + "laborum_": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_2f": "<string>" + }, + "errors": [ + { + "message": "sint proident pariatur exer", + "subCategory": "reprehenderit fugiat in eu", + "code": "esse labore nulla quis nisi", + "in": "consequat aliqua", + "context": { + "ina": [ + "laboris commodo", + "ad sed elit" + ], + "labore6_": [ + "culpa est esse aute", + "deserunt " + ], + "Duisb31": [ + "Ut", + "reprehenderit" + ] + } + }, + { + "message": "dolor consequat", + "subCategory": "dolore anim", + "code": "proident laboris", + "in": "ut ad do irure magna", + "context": { + "consectetur_1": [ + "mollit pariatur aliquip", + "adipisicing commodo aute" + ] + } + } + ] + } + /cms/v3/blogs/posts/{objectId}/revisions: + get: + tags: + - Blog Authors API + summary: Retrieves all the previous versions of a blog post + description: Retrieves all the previous versions of a blog post. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: after + in: query + schema: + type: string + description: >- + The cursor token value to get the next set of results. You can get + this from the `paging.next.after` JSON property of a paged response + containing more results. + example: <string> + - name: before + in: query + schema: + type: string + example: <string> + - name: limit + in: query + schema: + type: string + description: The maximum number of results to return. Default is 100. + example: <integer> + - name: objectId + in: path + schema: + type: string + required: true + description: (Required) The Blog Post id. + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - id: <string> + object: + abStatus: mab_master + abTestId: <string> + archivedAt: <long> + archivedInDashboard: <boolean> + attachedStylesheets: + - ad2d3: {} + est_9: {} + Excepteur_: {} + in_a: {} + - minim_61: {} + authorName: <string> + blogAuthorId: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '11' + created: <dateTime> + createdById: <string> + currentState: AUTOMATED + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableGoogleAmpOutputOverride: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: de-ch + layoutSections: + fugiat_76e: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + eae_: {} + sunt_b8: {} + ullamco_e: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - deserunt8: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + eiusmod_f: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - commodo_d3: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + veniam_e5: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + dolorb5b: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + utd: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + velit_4_: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + amet3c: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - commodo_bd: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - pariaturd07: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + consectetur_83: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + password: <string> + postBody: <string> + postSummary: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + rssBody: <string> + rssSummary: <string> + slug: <string> + state: <string> + tagIds: + - <long> + - <long> + themeSettingsValues: + inb04: {} + pariatur19c: {} + nostrud6_8: {} + translatedFromId: <string> + translations: + Lorem0: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + magna_4a_: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + Ut6bb: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + ullamco75: {} + widgets: + irure09e: {} + consequat_d8: {} + inab: {} + updatedAt: <dateTime> + user: + email: <string> + fullName: <string> + id: <string> + - id: <string> + object: + abStatus: variant + abTestId: <string> + archivedAt: <long> + archivedInDashboard: <boolean> + attachedStylesheets: + - qui0: {} + - cillum_0ae: {} + in_7: {} + authorName: <string> + blogAuthorId: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '11' + created: <dateTime> + createdById: <string> + currentState: AUTOMATED_FOR_FORM_LEGACY + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableGoogleAmpOutputOverride: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: kea + layoutSections: + qui1c5: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + elit_3: {} + nisi4_e: {} + do_e: {} + anim_783: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - amet_d: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + ipsum_9: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + magna44: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - mollit_f: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + esse9: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + consectetur5a: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + exercitation_b: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - nisi_66_: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + enim8: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - cupidatat_2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + password: <string> + postBody: <string> + postSummary: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + rssBody: <string> + rssSummary: <string> + slug: <string> + state: <string> + tagIds: + - <long> + - <long> + themeSettingsValues: + sed_6e: {} + translatedFromId: <string> + translations: + dolor024: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + velit_4: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + elite_b: {} + ullamco9b: {} + anim_4: {} + widgets: + dolore_db: {} + uta3e: {} + in_3: {} + updatedAt: <dateTime> + user: + email: <string> + fullName: <string> + id: <string> + total: <integer> + paging: + next: + after: sit minim pariatur + link: sunt sint + prev: + before: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ipsum_c": [ + "<string>", + "<string>" + ], + "sint_97b": [ + "<string>", + "<string>" + ], + "in_23": [ + "<string>", + "<string>" + ], + "laborum_": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_2f": "<string>" + }, + "errors": [ + { + "message": "sint proident pariatur exer", + "subCategory": "reprehenderit fugiat in eu", + "code": "esse labore nulla quis nisi", + "in": "consequat aliqua", + "context": { + "ina": [ + "laboris commodo", + "ad sed elit" + ], + "labore6_": [ + "culpa est esse aute", + "deserunt " + ], + "Duisb31": [ + "Ut", + "reprehenderit" + ] + } + }, + { + "message": "dolor consequat", + "subCategory": "dolore anim", + "code": "proident laboris", + "in": "ut ad do irure magna", + "context": { + "consectetur_1": [ + "mollit pariatur aliquip", + "adipisicing commodo aute" + ] + } + } + ] + } + /cms/v3/blogs/posts/multi-language/set-new-lang-primary: + put: + tags: + - Blog Authors API + summary: Set a new primary language + description: Set a Blog Post as the primary language of a multi-language group. + requestBody: + content: + application/json: + schema: + type: object + example: + id: Ut fugiat + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ipsum_c": [ + "<string>", + "<string>" + ], + "sint_97b": [ + "<string>", + "<string>" + ], + "in_23": [ + "<string>", + "<string>" + ], + "laborum_": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_2f": "<string>" + }, + "errors": [ + { + "message": "sint proident pariatur exer", + "subCategory": "reprehenderit fugiat in eu", + "code": "esse labore nulla quis nisi", + "in": "consequat aliqua", + "context": { + "ina": [ + "laboris commodo", + "ad sed elit" + ], + "labore6_": [ + "culpa est esse aute", + "deserunt " + ], + "Duisb31": [ + "Ut", + "reprehenderit" + ] + } + }, + { + "message": "dolor consequat", + "subCategory": "dolore anim", + "code": "proident laboris", + "in": "ut ad do irure magna", + "context": { + "consectetur_1": [ + "mollit pariatur aliquip", + "adipisicing commodo aute" + ] + } + } + ] + } + /cms/v3/blogs/posts/{objectId}: + get: + tags: + - Blog Authors API + summary: Retrieve a Blog Post + description: Retrieve the Blog Post object identified by the id in the path. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: string + description: Specifies whether to return deleted Blog Posts. Defaults to `false`. + example: <boolean> + - name: property + in: query + schema: + type: string + example: <string> + - name: objectId + in: path + schema: + type: string + required: true + description: (Required) The Blog Post id. + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + abStatus: mab_master + abTestId: <string> + archivedAt: <long> + archivedInDashboard: <boolean> + attachedStylesheets: + - est_b03: {} + nostrudc5: {} + aliquip_ee: {} + - aliquip_d9: {} + Excepteurd_0: {} + non4e8: {} + authorName: <string> + blogAuthorId: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '9' + created: <dateTime> + createdById: <string> + currentState: PROCESSING + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableGoogleAmpOutputOverride: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: ff-sl + layoutSections: + quis__ef: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + aliqua_1: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - labore_: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - exf_d: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + exercitation834: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + anim_3a2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + password: <string> + postBody: <string> + postSummary: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + rssBody: <string> + rssSummary: <string> + slug: <string> + state: <string> + tagIds: + - <long> + - <long> + themeSettingsValues: + Excepteurf: {} + aliqua_6: {} + qui_4: {} + translatedFromId: <string> + translations: + in_1: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + laborum05: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + ametf1: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + Excepteur_6b3: {} + widgets: + eu_e: {} + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ipsum_c": [ + "<string>", + "<string>" + ], + "sint_97b": [ + "<string>", + "<string>" + ], + "in_23": [ + "<string>", + "<string>" + ], + "laborum_": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_2f": "<string>" + }, + "errors": [ + { + "message": "sint proident pariatur exer", + "subCategory": "reprehenderit fugiat in eu", + "code": "esse labore nulla quis nisi", + "in": "consequat aliqua", + "context": { + "ina": [ + "laboris commodo", + "ad sed elit" + ], + "labore6_": [ + "culpa est esse aute", + "deserunt " + ], + "Duisb31": [ + "Ut", + "reprehenderit" + ] + } + }, + { + "message": "dolor consequat", + "subCategory": "dolore anim", + "code": "proident laboris", + "in": "ut ad do irure magna", + "context": { + "consectetur_1": [ + "mollit pariatur aliquip", + "adipisicing commodo aute" + ] + } + } + ] + } + delete: + tags: + - Blog Authors API + summary: Delete a Blog Post + description: Delete the Blog Post object identified by the id in the path. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: archived + in: query + schema: + type: string + description: Whether to return only results that have been archived. + example: <boolean> + - name: objectId + in: path + schema: + type: string + required: true + description: (Required) The Blog Post id. + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ipsum_c": [ + "<string>", + "<string>" + ], + "sint_97b": [ + "<string>", + "<string>" + ], + "in_23": [ + "<string>", + "<string>" + ], + "laborum_": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_2f": "<string>" + }, + "errors": [ + { + "message": "sint proident pariatur exer", + "subCategory": "reprehenderit fugiat in eu", + "code": "esse labore nulla quis nisi", + "in": "consequat aliqua", + "context": { + "ina": [ + "laboris commodo", + "ad sed elit" + ], + "labore6_": [ + "culpa est esse aute", + "deserunt " + ], + "Duisb31": [ + "Ut", + "reprehenderit" + ] + } + }, + { + "message": "dolor consequat", + "subCategory": "dolore anim", + "code": "proident laboris", + "in": "ut ad do irure magna", + "context": { + "consectetur_1": [ + "mollit pariatur aliquip", + "adipisicing commodo aute" + ] + } + } + ] + } + patch: + tags: + - Blog Authors API + summary: Update a Blog Post + description: > + Sparse updates a single Blog Post object identified by the id in the + path. + + All the column values need not be specified. Only the that need to be + modified can be specified. + requestBody: + content: + application/json: + schema: + type: object + example: + abStatus: mab_master + abTestId: <string> + archivedAt: <long> + archivedInDashboard: <boolean> + attachedStylesheets: + - est_b03: {} + nostrudc5: {} + aliquip_ee: {} + - aliquip_d9: {} + Excepteurd_0: {} + non4e8: {} + authorName: <string> + blogAuthorId: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '9' + created: <dateTime> + createdById: <string> + currentState: PROCESSING + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableGoogleAmpOutputOverride: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: ff-sl + layoutSections: + quis__ef: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + aliqua_1: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - labore_: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - exf_d: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + exercitation834: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + anim_3a2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + password: <string> + postBody: <string> + postSummary: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + rssBody: <string> + rssSummary: <string> + slug: <string> + state: <string> + tagIds: + - <long> + - <long> + themeSettingsValues: + Excepteurf: {} + aliqua_6: {} + qui_4: {} + translatedFromId: <string> + translations: + in_1: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + laborum05: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + ametf1: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + Excepteur_6b3: {} + widgets: + eu_e: {} + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: string + description: Specifies whether to update deleted Blog Posts. Defaults to `false`. + example: <boolean> + - name: objectId + in: path + schema: + type: string + required: true + description: (Required) The Blog Post id. + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + abStatus: mab_master + abTestId: <string> + archivedAt: <long> + archivedInDashboard: <boolean> + attachedStylesheets: + - est_b03: {} + nostrudc5: {} + aliquip_ee: {} + - aliquip_d9: {} + Excepteurd_0: {} + non4e8: {} + authorName: <string> + blogAuthorId: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '9' + created: <dateTime> + createdById: <string> + currentState: PROCESSING + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableGoogleAmpOutputOverride: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: ff-sl + layoutSections: + quis__ef: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + aliqua_1: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - labore_: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - exf_d: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + exercitation834: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + anim_3a2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + password: <string> + postBody: <string> + postSummary: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + rssBody: <string> + rssSummary: <string> + slug: <string> + state: <string> + tagIds: + - <long> + - <long> + themeSettingsValues: + Excepteurf: {} + aliqua_6: {} + qui_4: {} + translatedFromId: <string> + translations: + in_1: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + laborum05: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + ametf1: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + Excepteur_6b3: {} + widgets: + eu_e: {} + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ipsum_c": [ + "<string>", + "<string>" + ], + "sint_97b": [ + "<string>", + "<string>" + ], + "in_23": [ + "<string>", + "<string>" + ], + "laborum_": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_2f": "<string>" + }, + "errors": [ + { + "message": "sint proident pariatur exer", + "subCategory": "reprehenderit fugiat in eu", + "code": "esse labore nulla quis nisi", + "in": "consequat aliqua", + "context": { + "ina": [ + "laboris commodo", + "ad sed elit" + ], + "labore6_": [ + "culpa est esse aute", + "deserunt " + ], + "Duisb31": [ + "Ut", + "reprehenderit" + ] + } + }, + { + "message": "dolor consequat", + "subCategory": "dolore anim", + "code": "proident laboris", + "in": "ut ad do irure magna", + "context": { + "consectetur_1": [ + "mollit pariatur aliquip", + "adipisicing commodo aute" + ] + } + } + ] + } + /cms/v3/blog-settings/settings/multi-language/update-languages: + post: + tags: + - Blog Settings API + summary: Update languages of multi-language group + description: Explicitly set new languages for each blog in a multi-language group. + requestBody: + content: + application/json: + schema: + type: object + example: + languages: + et637: <string> + primaryId: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '200': + description: OK + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "reprehenderit_2_c": [ + "<string>", + "<string>" + ], + "Lorem_488": [ + "<string>", + "<string>" + ], + "qui_d_": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ut3": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ea_e": [ + "<string>", + "<string>" + ], + "consecteture": [ + "<string>", + "<string>" + ] + }, + "links": { + "in35a": "<string>", + "idb2": "<string>", + "utfa5": "<string>" + } + } + /cms/v3/blog-settings/settings/{blogId}/revisions: + get: + tags: + - Blog Settings API + summary: Retrieves all the previous versions of a Blog + description: Retrieves all the previous versions of a Blog + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: after + in: query + schema: + type: string + description: >- + The cursor token value to get the next set of results. You can get + this from the `paging.next.after` JSON property of a paged response + containing more results. + example: <string> + - name: before + in: query + schema: + type: string + example: <string> + - name: limit + in: query + schema: + type: string + description: The maximum number of results to return. Default is 100. + example: <integer> + - name: blogId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - id: <string> + object: + absoluteUrl: <string> + allowComments: <boolean> + created: <dateTime> + deletedAt: <dateTime> + description: <string> + htmlTitle: <string> + id: <string> + language: os-ge + name: <string> + publicAccessRulesEnabled: <boolean> + publicTitle: <string> + slug: <string> + translatedFromId: <string> + updated: <dateTime> + updatedAt: <dateTime> + user: + email: <string> + fullName: <string> + id: <string> + - id: <string> + object: + absoluteUrl: <string> + allowComments: <boolean> + created: <dateTime> + deletedAt: <dateTime> + description: <string> + htmlTitle: <string> + id: <string> + language: pl-pl + name: <string> + publicAccessRulesEnabled: <boolean> + publicTitle: <string> + slug: <string> + translatedFromId: <string> + updated: <dateTime> + updatedAt: <dateTime> + user: + email: <string> + fullName: <string> + id: <string> + total: <integer> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "reprehenderit_2_c": [ + "<string>", + "<string>" + ], + "Lorem_488": [ + "<string>", + "<string>" + ], + "qui_d_": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ut3": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ea_e": [ + "<string>", + "<string>" + ], + "consecteture": [ + "<string>", + "<string>" + ] + }, + "links": { + "in35a": "<string>", + "idb2": "<string>", + "utfa5": "<string>" + } + } + /cms/v3/blog-settings/settings/{blogId}/revisions/{revisionId}: + get: + tags: + - Blog Settings API + summary: Retrieves a previous version of a Blog + description: Retrieves a previous version of a Blog + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: blogId + in: path + schema: + type: string + required: true + example: <string> + - name: revisionId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + id: <string> + object: + absoluteUrl: <string> + allowComments: <boolean> + created: <dateTime> + deletedAt: <dateTime> + description: <string> + htmlTitle: <string> + id: <string> + language: en-jm + name: <string> + publicAccessRulesEnabled: <boolean> + publicTitle: <string> + slug: <string> + translatedFromId: <string> + updated: <dateTime> + updatedAt: <dateTime> + user: + email: <string> + fullName: <string> + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "reprehenderit_2_c": [ + "<string>", + "<string>" + ], + "Lorem_488": [ + "<string>", + "<string>" + ], + "qui_d_": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ut3": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ea_e": [ + "<string>", + "<string>" + ], + "consecteture": [ + "<string>", + "<string>" + ] + }, + "links": { + "in35a": "<string>", + "idb2": "<string>", + "utfa5": "<string>" + } + } + /cms/v3/blog-settings/settings/{blogId}: + get: + tags: + - Blog Settings API + summary: Retrieve a Blog + description: Retrieve the Blog object identified by the id in the path. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: blogId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + absoluteUrl: <string> + allowComments: <boolean> + created: <dateTime> + deletedAt: <dateTime> + description: <string> + htmlTitle: <string> + id: <string> + language: bn-in + name: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publicTitle: <string> + slug: <string> + translatedFromId: <string> + updated: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "reprehenderit_2_c": [ + "<string>", + "<string>" + ], + "Lorem_488": [ + "<string>", + "<string>" + ], + "qui_d_": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ut3": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ea_e": [ + "<string>", + "<string>" + ], + "consecteture": [ + "<string>", + "<string>" + ] + }, + "links": { + "in35a": "<string>", + "idb2": "<string>", + "utfa5": "<string>" + } + } + /cms/v3/blog-settings/settings/multi-language/create-language-variation: + post: + tags: + - Blog Settings API + summary: Create a new language variation + description: Create a new language variation from an existing blog + requestBody: + content: + application/json: + schema: + type: object + example: + id: <string> + language: <string> + primaryLanguage: <string> + slug: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + absoluteUrl: <string> + allowComments: <boolean> + created: <dateTime> + deletedAt: <dateTime> + description: <string> + htmlTitle: <string> + id: <string> + language: bn-in + name: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publicTitle: <string> + slug: <string> + translatedFromId: <string> + updated: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "reprehenderit_2_c": [ + "<string>", + "<string>" + ], + "Lorem_488": [ + "<string>", + "<string>" + ], + "qui_d_": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ut3": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ea_e": [ + "<string>", + "<string>" + ], + "consecteture": [ + "<string>", + "<string>" + ] + }, + "links": { + "in35a": "<string>", + "idb2": "<string>", + "utfa5": "<string>" + } + } + /cms/v3/blog-settings/settings: + get: + tags: + - Blog Settings API + summary: Get all Blogs + description: > + Get the list of Blogs. Supports paging and filtering. This method would + be useful for an integration that examined these models and used an + external service to suggest edits. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: createdAt + in: query + schema: + type: string + description: Only return Blogs created at exactly the specified time. + example: <dateTime> + - name: createdAfter + in: query + schema: + type: string + description: Only return Blogs created after the specified time. + example: <dateTime> + - name: createdBefore + in: query + schema: + type: string + description: Only return Blogs created before the specified time. + example: <dateTime> + - name: updatedAt + in: query + schema: + type: string + description: Only return Blogs last updated at exactly the specified time. + example: <dateTime> + - name: updatedAfter + in: query + schema: + type: string + description: Only return Blogs last updated after the specified time. + example: <dateTime> + - name: updatedBefore + in: query + schema: + type: string + description: Only return Blogs last updated before the specified time. + example: <dateTime> + - name: sort + in: query + schema: + type: string + description: >- + Specifies which fields to use for sorting results. Valid fields are + `name` and `id` + example: <string> + - name: sort + in: query + schema: + type: string + description: >- + Specifies which fields to use for sorting results. Valid fields are + `name` and `id` + example: <string> + - name: after + in: query + schema: + type: string + description: >- + The cursor token value to get the next set of results. You can get + this from the `paging.next.after` JSON property of a paged response + containing more results. + example: <string> + - name: limit + in: query + schema: + type: string + description: The maximum number of results to return. Default is 100. + example: <integer> + - name: archived + in: query + schema: + type: string + description: Specifies whether to return archived Blogs. Defaults to `false`. + example: <boolean> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - absoluteUrl: <string> + allowComments: <boolean> + created: <dateTime> + deletedAt: <dateTime> + description: <string> + htmlTitle: <string> + id: <string> + language: vai-lr + name: <string> + publicAccessRulesEnabled: <boolean> + publicTitle: <string> + slug: <string> + translatedFromId: <string> + updated: <dateTime> + - absoluteUrl: <string> + allowComments: <boolean> + created: <dateTime> + deletedAt: <dateTime> + description: <string> + htmlTitle: <string> + id: <string> + language: en-gh + name: <string> + publicAccessRulesEnabled: <boolean> + publicTitle: <string> + slug: <string> + translatedFromId: <string> + updated: <dateTime> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "reprehenderit_2_c": [ + "<string>", + "<string>" + ], + "Lorem_488": [ + "<string>", + "<string>" + ], + "qui_d_": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ut3": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ea_e": [ + "<string>", + "<string>" + ], + "consecteture": [ + "<string>", + "<string>" + ] + }, + "links": { + "in35a": "<string>", + "idb2": "<string>", + "utfa5": "<string>" + } + } + /cms/v3/blog-settings/settings/multi-language/set-new-lang-primary: + put: + tags: + - Blog Settings API + summary: Set a new primary language + description: Set a blog as the primary language of a multi-language group. + requestBody: + content: + application/json: + schema: + type: object + example: + id: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "reprehenderit_2_c": [ + "<string>", + "<string>" + ], + "Lorem_488": [ + "<string>", + "<string>" + ], + "qui_d_": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ut3": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ea_e": [ + "<string>", + "<string>" + ], + "consecteture": [ + "<string>", + "<string>" + ] + }, + "links": { + "in35a": "<string>", + "idb2": "<string>", + "utfa5": "<string>" + } + } + /cms/v3/blog-settings/settings/multi-language/detach-from-lang-group: + post: + tags: + - Blog Settings API + summary: Detach a blog from a multi-language group + description: Detach a blog from a multi-language group. + requestBody: + content: + application/json: + schema: + type: object + example: + id: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '200': + description: OK + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "reprehenderit_2_c": [ + "<string>", + "<string>" + ], + "Lorem_488": [ + "<string>", + "<string>" + ], + "qui_d_": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ut3": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ea_e": [ + "<string>", + "<string>" + ], + "consecteture": [ + "<string>", + "<string>" + ] + }, + "links": { + "in35a": "<string>", + "idb2": "<string>", + "utfa5": "<string>" + } + } + /cms/v3/blog-settings/settings/multi-language/attach-to-lang-group: + post: + tags: + - Blog Settings API + summary: Attach a blog to a multi-language group + description: Attach a blog to a multi-language group. + requestBody: + content: + application/json: + schema: + type: object + example: + id: <string> + language: <string> + primaryId: <string> + primaryLanguage: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '200': + description: OK + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "reprehenderit_2_c": [ + "<string>", + "<string>" + ], + "Lorem_488": [ + "<string>", + "<string>" + ], + "qui_d_": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ut3": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ea_e": [ + "<string>", + "<string>" + ], + "consecteture": [ + "<string>", + "<string>" + ] + }, + "links": { + "in35a": "<string>", + "idb2": "<string>", + "utfa5": "<string>" + } + } + /cms/v3/blogs/tags/batch/update: + post: + tags: + - Blog Authors API + summary: Update a batch of Blog Tags + description: Update the Blog Tag objects identified in the request body. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: [] + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: string + description: Specifies whether to update deleted Blog Tags. Defaults to `false`. + example: <boolean> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - created: <dateTime> + deletedAt: <dateTime> + id: <string> + language: cu + name: <string> + translatedFromId: <long> + updated: <dateTime> + - created: <dateTime> + deletedAt: <dateTime> + id: <string> + language: ig + name: <string> + translatedFromId: <long> + updated: <dateTime> + startedAt: <dateTime> + status: COMPLETE + requestedAt: <dateTime> + links: + ullamco3: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - created: <dateTime> + deletedAt: <dateTime> + id: <string> + language: mgh + name: <string> + translatedFromId: <long> + updated: <dateTime> + - created: <dateTime> + deletedAt: <dateTime> + id: <string> + language: el-gr + name: <string> + translatedFromId: <long> + updated: <dateTime> + startedAt: <dateTime> + status: COMPLETE + numErrors: <integer> + requestedAt: <dateTime> + links: + aliqua_f: <string> + voluptate96: <string> + errors: + - category: cillum est nulla + context: + officia75: + - sint fugiat + - dolor in + errors: + - message: adipisicing commodo eiusmod ipsum + subCategory: anim occaecat proident + code: magna exercitation amet veniam + in: sunt nisi + context: + laboris77: + - commodo irure ipsum + - adipisicing do + nostrud__d1: + - non do voluptate + - consectetur + id_0d: + - in aute Duis + - culpa veniam + - message: pariatur occa + subCategory: 'culpa ipsum ' + code: officia id + in: minim fugiat ut occaecat dolore + context: + dolore8b: + - aliqua dolore + - ad ipsum + anim_ae: + - anim elit non officia + - reprehenderit cupidatat + links: + sunt_f8: sit consequat culpa + id__50: labore ut + message: exercitation + status: laboris + subCategory: {} + id: in + - category: ut eiusmod mollit aliqua in + context: + qui7e: + - dolor sunt + - ex en + errors: + - message: amet irure ullamco elit + subCategory: eu est veniam sed + code: cupidatat + in: nostrud laboris + context: + elit_f12: + - pariatur voluptate laboris + - dolore qui + proident_40: + - culpa pariatur non proident + - sed dolor + - message: consequat + subCategory: tempor incididunt anim + code: sed + in: adipisicing proident sed in + context: + pariaturd7c: + - id eu + - consequat in Duis esse reprehenderit + id__4: + - occaecat in sit Excepteur velit + - reprehenderit exercitation magna ipsum + ex_15a: + - aliquip dolor Lorem dolore occaecat + - aliquip nostrud ut nulla + dolore_e_: + - labore + - sunt incid + links: + voluptatef: incididunt minim + message: in + status: labore amet reprehenderit + subCategory: {} + id: ipsum + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ipsum_c": [ + "<string>", + "<string>" + ], + "sint_97b": [ + "<string>", + "<string>" + ], + "in_23": [ + "<string>", + "<string>" + ], + "laborum_": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_2f": "<string>" + }, + "errors": [ + { + "message": "sint proident pariatur exer", + "subCategory": "reprehenderit fugiat in eu", + "code": "esse labore nulla quis nisi", + "in": "consequat aliqua", + "context": { + "ina": [ + "laboris commodo", + "ad sed elit" + ], + "labore6_": [ + "culpa est esse aute", + "deserunt " + ], + "Duisb31": [ + "Ut", + "reprehenderit" + ] + } + }, + { + "message": "dolor consequat", + "subCategory": "dolore anim", + "code": "proident laboris", + "in": "ut ad do irure magna", + "context": { + "consectetur_1": [ + "mollit pariatur aliquip", + "adipisicing commodo aute" + ] + } + } + ] + } + /cms/v3/blogs/tags/multi-language/update-languages: + post: + tags: + - Blog Authors API + summary: Update languages of multi-language group + description: >- + Explicitly set new languages for each Blog Tag in a multi-language + group. + requestBody: + content: + application/json: + schema: + type: object + example: + languages: + voluptate_3: ea ut occaecat + ut_63: velit magna ut non + primaryId: sint eu nostrud + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '200': + description: OK + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ipsum_c": [ + "<string>", + "<string>" + ], + "sint_97b": [ + "<string>", + "<string>" + ], + "in_23": [ + "<string>", + "<string>" + ], + "laborum_": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_2f": "<string>" + }, + "errors": [ + { + "message": "sint proident pariatur exer", + "subCategory": "reprehenderit fugiat in eu", + "code": "esse labore nulla quis nisi", + "in": "consequat aliqua", + "context": { + "ina": [ + "laboris commodo", + "ad sed elit" + ], + "labore6_": [ + "culpa est esse aute", + "deserunt " + ], + "Duisb31": [ + "Ut", + "reprehenderit" + ] + } + }, + { + "message": "dolor consequat", + "subCategory": "dolore anim", + "code": "proident laboris", + "in": "ut ad do irure magna", + "context": { + "consectetur_1": [ + "mollit pariatur aliquip", + "adipisicing commodo aute" + ] + } + } + ] + } + /cms/v3/blogs/tags/multi-language/detach-from-lang-group: + post: + tags: + - Blog Authors API + summary: Detach a Blog Tag from a multi-language group + description: Detach a Blog Tag from a multi-language group. + requestBody: + content: + application/json: + schema: + type: object + example: + id: in eu dolore + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '200': + description: OK + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ipsum_c": [ + "<string>", + "<string>" + ], + "sint_97b": [ + "<string>", + "<string>" + ], + "in_23": [ + "<string>", + "<string>" + ], + "laborum_": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_2f": "<string>" + }, + "errors": [ + { + "message": "sint proident pariatur exer", + "subCategory": "reprehenderit fugiat in eu", + "code": "esse labore nulla quis nisi", + "in": "consequat aliqua", + "context": { + "ina": [ + "laboris commodo", + "ad sed elit" + ], + "labore6_": [ + "culpa est esse aute", + "deserunt " + ], + "Duisb31": [ + "Ut", + "reprehenderit" + ] + } + }, + { + "message": "dolor consequat", + "subCategory": "dolore anim", + "code": "proident laboris", + "in": "ut ad do irure magna", + "context": { + "consectetur_1": [ + "mollit pariatur aliquip", + "adipisicing commodo aute" + ] + } + } + ] + } + /cms/v3/blogs/tags/batch/create: + post: + tags: + - Blog Authors API + summary: Create a batch of Blog Tags + description: Create the Blog Tag objects detailed in the request body. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - created: <dateTime> + deletedAt: <dateTime> + id: <string> + language: sq-al + name: <string> + translatedFromId: <long> + updated: <dateTime> + - created: <dateTime> + deletedAt: <dateTime> + id: <string> + language: ar-ma + name: <string> + translatedFromId: <long> + updated: <dateTime> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - created: <dateTime> + deletedAt: <dateTime> + id: <string> + language: cu + name: <string> + translatedFromId: <long> + updated: <dateTime> + - created: <dateTime> + deletedAt: <dateTime> + id: <string> + language: ig + name: <string> + translatedFromId: <long> + updated: <dateTime> + startedAt: <dateTime> + status: COMPLETE + requestedAt: <dateTime> + links: + ullamco3: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - created: <dateTime> + deletedAt: <dateTime> + id: <string> + language: mgh + name: <string> + translatedFromId: <long> + updated: <dateTime> + - created: <dateTime> + deletedAt: <dateTime> + id: <string> + language: el-gr + name: <string> + translatedFromId: <long> + updated: <dateTime> + startedAt: <dateTime> + status: COMPLETE + numErrors: <integer> + requestedAt: <dateTime> + links: + aliqua_f: <string> + voluptate96: <string> + errors: + - category: cillum est nulla + context: + officia75: + - sint fugiat + - dolor in + errors: + - message: adipisicing commodo eiusmod ipsum + subCategory: anim occaecat proident + code: magna exercitation amet veniam + in: sunt nisi + context: + laboris77: + - commodo irure ipsum + - adipisicing do + nostrud__d1: + - non do voluptate + - consectetur + id_0d: + - in aute Duis + - culpa veniam + - message: pariatur occa + subCategory: 'culpa ipsum ' + code: officia id + in: minim fugiat ut occaecat dolore + context: + dolore8b: + - aliqua dolore + - ad ipsum + anim_ae: + - anim elit non officia + - reprehenderit cupidatat + links: + sunt_f8: sit consequat culpa + id__50: labore ut + message: exercitation + status: laboris + subCategory: {} + id: in + - category: ut eiusmod mollit aliqua in + context: + qui7e: + - dolor sunt + - ex en + errors: + - message: amet irure ullamco elit + subCategory: eu est veniam sed + code: cupidatat + in: nostrud laboris + context: + elit_f12: + - pariatur voluptate laboris + - dolore qui + proident_40: + - culpa pariatur non proident + - sed dolor + - message: consequat + subCategory: tempor incididunt anim + code: sed + in: adipisicing proident sed in + context: + pariaturd7c: + - id eu + - consequat in Duis esse reprehenderit + id__4: + - occaecat in sit Excepteur velit + - reprehenderit exercitation magna ipsum + ex_15a: + - aliquip dolor Lorem dolore occaecat + - aliquip nostrud ut nulla + dolore_e_: + - labore + - sunt incid + links: + voluptatef: incididunt minim + message: in + status: labore amet reprehenderit + subCategory: {} + id: ipsum + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ipsum_c": [ + "<string>", + "<string>" + ], + "sint_97b": [ + "<string>", + "<string>" + ], + "in_23": [ + "<string>", + "<string>" + ], + "laborum_": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_2f": "<string>" + }, + "errors": [ + { + "message": "sint proident pariatur exer", + "subCategory": "reprehenderit fugiat in eu", + "code": "esse labore nulla quis nisi", + "in": "consequat aliqua", + "context": { + "ina": [ + "laboris commodo", + "ad sed elit" + ], + "labore6_": [ + "culpa est esse aute", + "deserunt " + ], + "Duisb31": [ + "Ut", + "reprehenderit" + ] + } + }, + { + "message": "dolor consequat", + "subCategory": "dolore anim", + "code": "proident laboris", + "in": "ut ad do irure magna", + "context": { + "consectetur_1": [ + "mollit pariatur aliquip", + "adipisicing commodo aute" + ] + } + } + ] + } + /cms/v3/blogs/tags/batch/archive: + post: + tags: + - Blog Authors API + summary: Delete a batch of Blog Tags + description: Delete the Blog Tag objects identified in the request body. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - qui enim + - ex ea fugiat adipisicing ut + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ipsum_c": [ + "<string>", + "<string>" + ], + "sint_97b": [ + "<string>", + "<string>" + ], + "in_23": [ + "<string>", + "<string>" + ], + "laborum_": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_2f": "<string>" + }, + "errors": [ + { + "message": "sint proident pariatur exer", + "subCategory": "reprehenderit fugiat in eu", + "code": "esse labore nulla quis nisi", + "in": "consequat aliqua", + "context": { + "ina": [ + "laboris commodo", + "ad sed elit" + ], + "labore6_": [ + "culpa est esse aute", + "deserunt " + ], + "Duisb31": [ + "Ut", + "reprehenderit" + ] + } + }, + { + "message": "dolor consequat", + "subCategory": "dolore anim", + "code": "proident laboris", + "in": "ut ad do irure magna", + "context": { + "consectetur_1": [ + "mollit pariatur aliquip", + "adipisicing commodo aute" + ] + } + } + ] + } + /cms/v3/blogs/tags/multi-language/set-new-lang-primary: + put: + tags: + - Blog Authors API + summary: Set a new primary language + description: Set a Blog Tag as the primary language of a multi-language group. + requestBody: + content: + application/json: + schema: + type: object + example: + id: Ut fugiat + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ipsum_c": [ + "<string>", + "<string>" + ], + "sint_97b": [ + "<string>", + "<string>" + ], + "in_23": [ + "<string>", + "<string>" + ], + "laborum_": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_2f": "<string>" + }, + "errors": [ + { + "message": "sint proident pariatur exer", + "subCategory": "reprehenderit fugiat in eu", + "code": "esse labore nulla quis nisi", + "in": "consequat aliqua", + "context": { + "ina": [ + "laboris commodo", + "ad sed elit" + ], + "labore6_": [ + "culpa est esse aute", + "deserunt " + ], + "Duisb31": [ + "Ut", + "reprehenderit" + ] + } + }, + { + "message": "dolor consequat", + "subCategory": "dolore anim", + "code": "proident laboris", + "in": "ut ad do irure magna", + "context": { + "consectetur_1": [ + "mollit pariatur aliquip", + "adipisicing commodo aute" + ] + } + } + ] + } + /cms/v3/blogs/tags/batch/read: + post: + tags: + - Blog Authors API + summary: Retrieve a batch of Blog Tags + description: Retrieve the Blog Tag objects identified in the request body. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - qui enim + - ex ea fugiat adipisicing ut + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: string + description: Specifies whether to return deleted Blog Tags. Defaults to `false`. + example: <boolean> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - created: <dateTime> + deletedAt: <dateTime> + id: <string> + language: cu + name: <string> + translatedFromId: <long> + updated: <dateTime> + - created: <dateTime> + deletedAt: <dateTime> + id: <string> + language: ig + name: <string> + translatedFromId: <long> + updated: <dateTime> + startedAt: <dateTime> + status: COMPLETE + requestedAt: <dateTime> + links: + ullamco3: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - created: <dateTime> + deletedAt: <dateTime> + id: <string> + language: mgh + name: <string> + translatedFromId: <long> + updated: <dateTime> + - created: <dateTime> + deletedAt: <dateTime> + id: <string> + language: el-gr + name: <string> + translatedFromId: <long> + updated: <dateTime> + startedAt: <dateTime> + status: COMPLETE + numErrors: <integer> + requestedAt: <dateTime> + links: + aliqua_f: <string> + voluptate96: <string> + errors: + - category: cillum est nulla + context: + officia75: + - sint fugiat + - dolor in + errors: + - message: adipisicing commodo eiusmod ipsum + subCategory: anim occaecat proident + code: magna exercitation amet veniam + in: sunt nisi + context: + laboris77: + - commodo irure ipsum + - adipisicing do + nostrud__d1: + - non do voluptate + - consectetur + id_0d: + - in aute Duis + - culpa veniam + - message: pariatur occa + subCategory: 'culpa ipsum ' + code: officia id + in: minim fugiat ut occaecat dolore + context: + dolore8b: + - aliqua dolore + - ad ipsum + anim_ae: + - anim elit non officia + - reprehenderit cupidatat + links: + sunt_f8: sit consequat culpa + id__50: labore ut + message: exercitation + status: laboris + subCategory: {} + id: in + - category: ut eiusmod mollit aliqua in + context: + qui7e: + - dolor sunt + - ex en + errors: + - message: amet irure ullamco elit + subCategory: eu est veniam sed + code: cupidatat + in: nostrud laboris + context: + elit_f12: + - pariatur voluptate laboris + - dolore qui + proident_40: + - culpa pariatur non proident + - sed dolor + - message: consequat + subCategory: tempor incididunt anim + code: sed + in: adipisicing proident sed in + context: + pariaturd7c: + - id eu + - consequat in Duis esse reprehenderit + id__4: + - occaecat in sit Excepteur velit + - reprehenderit exercitation magna ipsum + ex_15a: + - aliquip dolor Lorem dolore occaecat + - aliquip nostrud ut nulla + dolore_e_: + - labore + - sunt incid + links: + voluptatef: incididunt minim + message: in + status: labore amet reprehenderit + subCategory: {} + id: ipsum + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ipsum_c": [ + "<string>", + "<string>" + ], + "sint_97b": [ + "<string>", + "<string>" + ], + "in_23": [ + "<string>", + "<string>" + ], + "laborum_": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_2f": "<string>" + }, + "errors": [ + { + "message": "sint proident pariatur exer", + "subCategory": "reprehenderit fugiat in eu", + "code": "esse labore nulla quis nisi", + "in": "consequat aliqua", + "context": { + "ina": [ + "laboris commodo", + "ad sed elit" + ], + "labore6_": [ + "culpa est esse aute", + "deserunt " + ], + "Duisb31": [ + "Ut", + "reprehenderit" + ] + } + }, + { + "message": "dolor consequat", + "subCategory": "dolore anim", + "code": "proident laboris", + "in": "ut ad do irure magna", + "context": { + "consectetur_1": [ + "mollit pariatur aliquip", + "adipisicing commodo aute" + ] + } + } + ] + } + /cms/v3/blogs/tags: + get: + tags: + - Blog Authors API + summary: Get all Blog Tags + description: > + Get the list of blog tags. Supports paging and filtering. This method + would be useful for an integration that examined these models and used + an external service to suggest edits. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: createdAt + in: query + schema: + type: string + description: Only return Blog Tags created at exactly the specified time. + example: <dateTime> + - name: createdAfter + in: query + schema: + type: string + description: Only return Blog Tags created after the specified time. + example: <dateTime> + - name: createdBefore + in: query + schema: + type: string + description: Only return Blog Tags created before the specified time. + example: <dateTime> + - name: updatedAt + in: query + schema: + type: string + description: Only return Blog Tags last updated at exactly the specified time. + example: <dateTime> + - name: updatedAfter + in: query + schema: + type: string + description: Only return Blog Tags last updated after the specified time. + example: <dateTime> + - name: updatedBefore + in: query + schema: + type: string + description: Only return Blog Tags last updated before the specified time. + example: <dateTime> + - name: sort + in: query + schema: + type: string + description: >- + Specifies which fields to use for sorting results. Valid fields are + `name`, `createdAt`, `updatedAt`, `createdBy`, `updatedBy`. + `createdAt` will be used by default. + example: <string> + - name: sort + in: query + schema: + type: string + description: >- + Specifies which fields to use for sorting results. Valid fields are + `name`, `createdAt`, `updatedAt`, `createdBy`, `updatedBy`. + `createdAt` will be used by default. + example: <string> + - name: after + in: query + schema: + type: string + description: >- + The cursor token value to get the next set of results. You can get + this from the `paging.next.after` JSON property of a paged response + containing more results. + example: <string> + - name: limit + in: query + schema: + type: string + description: The maximum number of results to return. Default is 100. + example: <integer> + - name: archived + in: query + schema: + type: string + description: Specifies whether to return deleted Blog Tags. Defaults to `false`. + example: <boolean> + - name: property + in: query + schema: + type: string + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - created: <dateTime> + deletedAt: <dateTime> + id: <string> + language: rw-rw + name: <string> + translatedFromId: <long> + updated: <dateTime> + - created: <dateTime> + deletedAt: <dateTime> + id: <string> + language: et + name: <string> + translatedFromId: <long> + updated: <dateTime> + total: <integer> + paging: + next: + after: elit in aliquip amet sit + link: eu aute + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ipsum_c": [ + "<string>", + "<string>" + ], + "sint_97b": [ + "<string>", + "<string>" + ], + "in_23": [ + "<string>", + "<string>" + ], + "laborum_": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_2f": "<string>" + }, + "errors": [ + { + "message": "sint proident pariatur exer", + "subCategory": "reprehenderit fugiat in eu", + "code": "esse labore nulla quis nisi", + "in": "consequat aliqua", + "context": { + "ina": [ + "laboris commodo", + "ad sed elit" + ], + "labore6_": [ + "culpa est esse aute", + "deserunt " + ], + "Duisb31": [ + "Ut", + "reprehenderit" + ] + } + }, + { + "message": "dolor consequat", + "subCategory": "dolore anim", + "code": "proident laboris", + "in": "ut ad do irure magna", + "context": { + "consectetur_1": [ + "mollit pariatur aliquip", + "adipisicing commodo aute" + ] + } + } + ] + } + post: + tags: + - Blog Authors API + summary: Create a new Blog Tag + description: Create a new Blog Tag. + requestBody: + content: + application/json: + schema: + type: object + example: + created: <dateTime> + deletedAt: <dateTime> + id: <string> + language: ti-er + name: <string> + translatedFromId: <long> + updated: <dateTime> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + created: <dateTime> + deletedAt: <dateTime> + id: <string> + language: ti-er + name: <string> + translatedFromId: <long> + updated: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ipsum_c": [ + "<string>", + "<string>" + ], + "sint_97b": [ + "<string>", + "<string>" + ], + "in_23": [ + "<string>", + "<string>" + ], + "laborum_": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_2f": "<string>" + }, + "errors": [ + { + "message": "sint proident pariatur exer", + "subCategory": "reprehenderit fugiat in eu", + "code": "esse labore nulla quis nisi", + "in": "consequat aliqua", + "context": { + "ina": [ + "laboris commodo", + "ad sed elit" + ], + "labore6_": [ + "culpa est esse aute", + "deserunt " + ], + "Duisb31": [ + "Ut", + "reprehenderit" + ] + } + }, + { + "message": "dolor consequat", + "subCategory": "dolore anim", + "code": "proident laboris", + "in": "ut ad do irure magna", + "context": { + "consectetur_1": [ + "mollit pariatur aliquip", + "adipisicing commodo aute" + ] + } + } + ] + } + /cms/v3/blogs/tags/multi-language/attach-to-lang-group: + post: + tags: + - Blog Authors API + summary: Attach a Blog Tag to a multi-language group + description: Attach a Blog Tag to a multi-language group. + requestBody: + content: + application/json: + schema: + type: object + example: + id: par + language: consequat in + primaryId: ex sint et + primaryLanguage: sit ut + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '200': + description: OK + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ipsum_c": [ + "<string>", + "<string>" + ], + "sint_97b": [ + "<string>", + "<string>" + ], + "in_23": [ + "<string>", + "<string>" + ], + "laborum_": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_2f": "<string>" + }, + "errors": [ + { + "message": "sint proident pariatur exer", + "subCategory": "reprehenderit fugiat in eu", + "code": "esse labore nulla quis nisi", + "in": "consequat aliqua", + "context": { + "ina": [ + "laboris commodo", + "ad sed elit" + ], + "labore6_": [ + "culpa est esse aute", + "deserunt " + ], + "Duisb31": [ + "Ut", + "reprehenderit" + ] + } + }, + { + "message": "dolor consequat", + "subCategory": "dolore anim", + "code": "proident laboris", + "in": "ut ad do irure magna", + "context": { + "consectetur_1": [ + "mollit pariatur aliquip", + "adipisicing commodo aute" + ] + } + } + ] + } + /cms/v3/blogs/tags/{objectId}: + get: + tags: + - Blog Authors API + summary: Retrieve a Blog Tag + description: Retrieve the Blog Tag object identified by the id in the path. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: string + description: Specifies whether to return deleted Blog Tags. Defaults to `false`. + example: <boolean> + - name: property + in: query + schema: + type: string + example: <string> + - name: objectId + in: path + schema: + type: string + required: true + description: (Required) The Blog Tag id. + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + created: <dateTime> + deletedAt: <dateTime> + id: <string> + language: ti-er + name: <string> + translatedFromId: <long> + updated: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ipsum_c": [ + "<string>", + "<string>" + ], + "sint_97b": [ + "<string>", + "<string>" + ], + "in_23": [ + "<string>", + "<string>" + ], + "laborum_": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_2f": "<string>" + }, + "errors": [ + { + "message": "sint proident pariatur exer", + "subCategory": "reprehenderit fugiat in eu", + "code": "esse labore nulla quis nisi", + "in": "consequat aliqua", + "context": { + "ina": [ + "laboris commodo", + "ad sed elit" + ], + "labore6_": [ + "culpa est esse aute", + "deserunt " + ], + "Duisb31": [ + "Ut", + "reprehenderit" + ] + } + }, + { + "message": "dolor consequat", + "subCategory": "dolore anim", + "code": "proident laboris", + "in": "ut ad do irure magna", + "context": { + "consectetur_1": [ + "mollit pariatur aliquip", + "adipisicing commodo aute" + ] + } + } + ] + } + delete: + tags: + - Blog Authors API + summary: Delete a Blog Tag + description: Delete the Blog Tag object identified by the id in the path. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: archived + in: query + schema: + type: string + description: Whether to return only results that have been archived. + example: <boolean> + - name: objectId + in: path + schema: + type: string + required: true + description: (Required) The Blog Tag id. + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ipsum_c": [ + "<string>", + "<string>" + ], + "sint_97b": [ + "<string>", + "<string>" + ], + "in_23": [ + "<string>", + "<string>" + ], + "laborum_": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_2f": "<string>" + }, + "errors": [ + { + "message": "sint proident pariatur exer", + "subCategory": "reprehenderit fugiat in eu", + "code": "esse labore nulla quis nisi", + "in": "consequat aliqua", + "context": { + "ina": [ + "laboris commodo", + "ad sed elit" + ], + "labore6_": [ + "culpa est esse aute", + "deserunt " + ], + "Duisb31": [ + "Ut", + "reprehenderit" + ] + } + }, + { + "message": "dolor consequat", + "subCategory": "dolore anim", + "code": "proident laboris", + "in": "ut ad do irure magna", + "context": { + "consectetur_1": [ + "mollit pariatur aliquip", + "adipisicing commodo aute" + ] + } + } + ] + } + patch: + tags: + - Blog Authors API + summary: Update a Blog Tag + description: > + Sparse updates a single Blog Tag object identified by the id in the + path. + + All the column values need not be specified. Only the that need to be + modified can be specified. + requestBody: + content: + application/json: + schema: + type: object + example: + created: <dateTime> + deletedAt: <dateTime> + id: <string> + language: ti-er + name: <string> + translatedFromId: <long> + updated: <dateTime> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: string + description: Specifies whether to update deleted Blog Tags. Defaults to `false`. + example: <boolean> + - name: objectId + in: path + schema: + type: string + required: true + description: (Required) The Blog Tag id. + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + created: <dateTime> + deletedAt: <dateTime> + id: <string> + language: ti-er + name: <string> + translatedFromId: <long> + updated: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ipsum_c": [ + "<string>", + "<string>" + ], + "sint_97b": [ + "<string>", + "<string>" + ], + "in_23": [ + "<string>", + "<string>" + ], + "laborum_": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_2f": "<string>" + }, + "errors": [ + { + "message": "sint proident pariatur exer", + "subCategory": "reprehenderit fugiat in eu", + "code": "esse labore nulla quis nisi", + "in": "consequat aliqua", + "context": { + "ina": [ + "laboris commodo", + "ad sed elit" + ], + "labore6_": [ + "culpa est esse aute", + "deserunt " + ], + "Duisb31": [ + "Ut", + "reprehenderit" + ] + } + }, + { + "message": "dolor consequat", + "subCategory": "dolore anim", + "code": "proident laboris", + "in": "ut ad do irure magna", + "context": { + "consectetur_1": [ + "mollit pariatur aliquip", + "adipisicing commodo aute" + ] + } + } + ] + } + /cms/v3/blogs/tags/multi-language/create-language-variation: + post: + tags: + - Blog Authors API + summary: Create a new language variation + description: Create a new language variation from an existing Blog Tag + requestBody: + content: + application/json: + schema: + type: object + example: + id: <string> + name: <string> + language: <string> + primaryLanguage: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + created: <dateTime> + deletedAt: <dateTime> + id: <string> + language: ti-er + name: <string> + translatedFromId: <long> + updated: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ipsum_c": [ + "<string>", + "<string>" + ], + "sint_97b": [ + "<string>", + "<string>" + ], + "in_23": [ + "<string>", + "<string>" + ], + "laborum_": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_2f": "<string>" + }, + "errors": [ + { + "message": "sint proident pariatur exer", + "subCategory": "reprehenderit fugiat in eu", + "code": "esse labore nulla quis nisi", + "in": "consequat aliqua", + "context": { + "ina": [ + "laboris commodo", + "ad sed elit" + ], + "labore6_": [ + "culpa est esse aute", + "deserunt " + ], + "Duisb31": [ + "Ut", + "reprehenderit" + ] + } + }, + { + "message": "dolor consequat", + "subCategory": "dolore anim", + "code": "proident laboris", + "in": "ut ad do irure magna", + "context": { + "consectetur_1": [ + "mollit pariatur aliquip", + "adipisicing commodo aute" + ] + } + } + ] + } + /cms/v3/blogs/authors/batch/update: + post: + tags: + - Blog Authors API > Blog Authors + summary: Update a batch of Blog Authors + description: Update the Blog Author objects identified in the request body. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: [] + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: string + description: >- + Specifies whether to update deleted Blog Authors. Defaults to + `false`. + example: <boolean> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - avatar: <string> + bio: <string> + created: <dateTime> + deletedAt: <dateTime> + displayName: <string> + email: <string> + facebook: <string> + fullName: <string> + id: <string> + language: it-it + linkedin: <string> + name: <string> + slug: <string> + translatedFromId: <long> + twitter: <string> + updated: <dateTime> + website: <string> + - avatar: <string> + bio: <string> + created: <dateTime> + deletedAt: <dateTime> + displayName: <string> + email: <string> + facebook: <string> + fullName: <string> + id: <string> + language: nl-ch + linkedin: <string> + name: <string> + slug: <string> + translatedFromId: <long> + twitter: <string> + updated: <dateTime> + website: <string> + startedAt: <dateTime> + status: COMPLETE + requestedAt: <dateTime> + links: + quie95: <string> + non_fe_: <string> + reprehenderita6: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - avatar: <string> + bio: <string> + created: <dateTime> + deletedAt: <dateTime> + displayName: <string> + email: <string> + facebook: <string> + fullName: <string> + id: <string> + language: zu + linkedin: <string> + name: <string> + slug: <string> + translatedFromId: <long> + twitter: <string> + updated: <dateTime> + website: <string> + - avatar: <string> + bio: <string> + created: <dateTime> + deletedAt: <dateTime> + displayName: <string> + email: <string> + facebook: <string> + fullName: <string> + id: <string> + language: ckb-iq + linkedin: <string> + name: <string> + slug: <string> + translatedFromId: <long> + twitter: <string> + updated: <dateTime> + website: <string> + startedAt: <dateTime> + status: PROCESSING + numErrors: <integer> + errors: + - category: <string> + context: + Lorem_2: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + cupidatat9: + - <string> + - <string> + commodo469: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + labore_b04: + - <string> + - <string> + eiusmod_e: + - <string> + - <string> + veniam_6f2: + - <string> + - <string> + links: + fugiat98: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + dolor_0: + - <string> + - <string> + incididunt7: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + fugiat_1: + - <string> + - <string> + occaecat7: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + labore_4: + - <string> + - <string> + commodo_9: + - <string> + - <string> + links: + Excepteur_e: <string> + aute_3: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + doloree8: <string> + exercitation729: <string> + sint__5: <string> + pariatur3: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "aliquipbcd": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ut_0d5": [ + "<string>", + "<string>" + ], + "ut_2_e": [ + "<string>", + "<string>" + ], + "nostrud7": [ + "<string>", + "<string>" + ], + "doe": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ut_927": [ + "<string>", + "<string>" + ], + "deserunt9": [ + "<string>", + "<string>" + ], + "laborum_5d": [ + "<string>", + "<string>" + ], + "eiusmod2fa": [ + "<string>", + "<string>" + ] + }, + "links": { + "Lorem1": "<string>", + "mollita": "<string>", + "est_6_": "<string>", + "etb": "<string>", + "non_4_": "<string>" + } + } + /cms/v3/blogs/authors/multi-language/attach-to-lang-group: + post: + tags: + - Blog Authors API > Blog Authors + summary: Attach a Blog Author to a multi-language group + description: Attach a Blog Author to a multi-language group. + requestBody: + content: + application/json: + schema: + type: object + example: + id: <string> + language: <string> + primaryId: <string> + primaryLanguage: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '200': + description: OK + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "aliquipbcd": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ut_0d5": [ + "<string>", + "<string>" + ], + "ut_2_e": [ + "<string>", + "<string>" + ], + "nostrud7": [ + "<string>", + "<string>" + ], + "doe": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ut_927": [ + "<string>", + "<string>" + ], + "deserunt9": [ + "<string>", + "<string>" + ], + "laborum_5d": [ + "<string>", + "<string>" + ], + "eiusmod2fa": [ + "<string>", + "<string>" + ] + }, + "links": { + "Lorem1": "<string>", + "mollita": "<string>", + "est_6_": "<string>", + "etb": "<string>", + "non_4_": "<string>" + } + } + /cms/v3/blogs/authors/batch/create: + post: + tags: + - Blog Authors API > Blog Authors + summary: Create a batch of Blog Authors + description: Create the Blog Author objects detailed in the request body. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - avatar: <string> + bio: <string> + created: <dateTime> + deletedAt: <dateTime> + displayName: <string> + email: <string> + facebook: <string> + fullName: <string> + id: <string> + language: mfe-mu + linkedin: <string> + name: <string> + slug: <string> + translatedFromId: <long> + twitter: <string> + updated: <dateTime> + website: <string> + - avatar: <string> + bio: <string> + created: <dateTime> + deletedAt: <dateTime> + displayName: <string> + email: <string> + facebook: <string> + fullName: <string> + id: <string> + language: is-is + linkedin: <string> + name: <string> + slug: <string> + translatedFromId: <long> + twitter: <string> + updated: <dateTime> + website: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - avatar: <string> + bio: <string> + created: <dateTime> + deletedAt: <dateTime> + displayName: <string> + email: <string> + facebook: <string> + fullName: <string> + id: <string> + language: it-it + linkedin: <string> + name: <string> + slug: <string> + translatedFromId: <long> + twitter: <string> + updated: <dateTime> + website: <string> + - avatar: <string> + bio: <string> + created: <dateTime> + deletedAt: <dateTime> + displayName: <string> + email: <string> + facebook: <string> + fullName: <string> + id: <string> + language: nl-ch + linkedin: <string> + name: <string> + slug: <string> + translatedFromId: <long> + twitter: <string> + updated: <dateTime> + website: <string> + startedAt: <dateTime> + status: COMPLETE + requestedAt: <dateTime> + links: + quie95: <string> + non_fe_: <string> + reprehenderita6: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - avatar: <string> + bio: <string> + created: <dateTime> + deletedAt: <dateTime> + displayName: <string> + email: <string> + facebook: <string> + fullName: <string> + id: <string> + language: zu + linkedin: <string> + name: <string> + slug: <string> + translatedFromId: <long> + twitter: <string> + updated: <dateTime> + website: <string> + - avatar: <string> + bio: <string> + created: <dateTime> + deletedAt: <dateTime> + displayName: <string> + email: <string> + facebook: <string> + fullName: <string> + id: <string> + language: ckb-iq + linkedin: <string> + name: <string> + slug: <string> + translatedFromId: <long> + twitter: <string> + updated: <dateTime> + website: <string> + startedAt: <dateTime> + status: PROCESSING + numErrors: <integer> + errors: + - category: <string> + context: + Lorem_2: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + cupidatat9: + - <string> + - <string> + commodo469: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + labore_b04: + - <string> + - <string> + eiusmod_e: + - <string> + - <string> + veniam_6f2: + - <string> + - <string> + links: + fugiat98: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + dolor_0: + - <string> + - <string> + incididunt7: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + fugiat_1: + - <string> + - <string> + occaecat7: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + labore_4: + - <string> + - <string> + commodo_9: + - <string> + - <string> + links: + Excepteur_e: <string> + aute_3: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + doloree8: <string> + exercitation729: <string> + sint__5: <string> + pariatur3: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "aliquipbcd": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ut_0d5": [ + "<string>", + "<string>" + ], + "ut_2_e": [ + "<string>", + "<string>" + ], + "nostrud7": [ + "<string>", + "<string>" + ], + "doe": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ut_927": [ + "<string>", + "<string>" + ], + "deserunt9": [ + "<string>", + "<string>" + ], + "laborum_5d": [ + "<string>", + "<string>" + ], + "eiusmod2fa": [ + "<string>", + "<string>" + ] + }, + "links": { + "Lorem1": "<string>", + "mollita": "<string>", + "est_6_": "<string>", + "etb": "<string>", + "non_4_": "<string>" + } + } + /cms/v3/blogs/authors: + get: + tags: + - Blog Authors API > Blog Authors + summary: Get all Blog Authors + description: > + Get the list of blog authors. Supports paging and filtering. This method + would be useful for an integration that examined these models and used + an external service to suggest edits. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: createdAt + in: query + schema: + type: string + description: Only return Blog Authors created at exactly the specified time. + example: <dateTime> + - name: createdAfter + in: query + schema: + type: string + description: Only return Blog Authors created after the specified time. + example: <dateTime> + - name: createdBefore + in: query + schema: + type: string + description: Only return Blog Authors created before the specified time. + example: <dateTime> + - name: updatedAt + in: query + schema: + type: string + description: Only return Blog Authors last updated at exactly the specified time. + example: <dateTime> + - name: updatedAfter + in: query + schema: + type: string + description: Only return Blog Authors last updated after the specified time. + example: <dateTime> + - name: updatedBefore + in: query + schema: + type: string + description: Only return Blog Authors last updated before the specified time. + example: <dateTime> + - name: sort + in: query + schema: + type: string + description: >- + Specifies which fields to use for sorting results. Valid fields are + `name`, `createdAt`, `updatedAt`, `createdBy`, `updatedBy`. + `createdAt` will be used by default. + example: <string> + - name: sort + in: query + schema: + type: string + description: >- + Specifies which fields to use for sorting results. Valid fields are + `name`, `createdAt`, `updatedAt`, `createdBy`, `updatedBy`. + `createdAt` will be used by default. + example: <string> + - name: after + in: query + schema: + type: string + description: >- + The cursor token value to get the next set of results. You can get + this from the `paging.next.after` JSON property of a paged response + containing more results. + example: <string> + - name: limit + in: query + schema: + type: string + description: The maximum number of results to return. Default is 100. + example: <integer> + - name: archived + in: query + schema: + type: string + description: >- + Specifies whether to return deleted Blog Authors. Defaults to + `false`. + example: <boolean> + - name: property + in: query + schema: + type: string + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - avatar: <string> + bio: <string> + created: <dateTime> + deletedAt: <dateTime> + displayName: <string> + email: <string> + facebook: <string> + fullName: <string> + id: <string> + language: sr-cs + linkedin: <string> + name: <string> + slug: <string> + translatedFromId: <long> + twitter: <string> + updated: <dateTime> + website: <string> + - avatar: <string> + bio: <string> + created: <dateTime> + deletedAt: <dateTime> + displayName: <string> + email: <string> + facebook: <string> + fullName: <string> + id: <string> + language: sr-xk + linkedin: <string> + name: <string> + slug: <string> + translatedFromId: <long> + twitter: <string> + updated: <dateTime> + website: <string> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "aliquipbcd": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ut_0d5": [ + "<string>", + "<string>" + ], + "ut_2_e": [ + "<string>", + "<string>" + ], + "nostrud7": [ + "<string>", + "<string>" + ], + "doe": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ut_927": [ + "<string>", + "<string>" + ], + "deserunt9": [ + "<string>", + "<string>" + ], + "laborum_5d": [ + "<string>", + "<string>" + ], + "eiusmod2fa": [ + "<string>", + "<string>" + ] + }, + "links": { + "Lorem1": "<string>", + "mollita": "<string>", + "est_6_": "<string>", + "etb": "<string>", + "non_4_": "<string>" + } + } + post: + tags: + - Blog Authors API > Blog Authors + summary: Create a new Blog Author + description: Create a new Blog Author. + requestBody: + content: + application/json: + schema: + type: object + example: + avatar: <string> + bio: <string> + created: <dateTime> + deletedAt: <dateTime> + displayName: <string> + email: <string> + facebook: <string> + fullName: <string> + id: <string> + language: ksf + linkedin: <string> + name: <string> + slug: <string> + translatedFromId: <long> + twitter: <string> + updated: <dateTime> + website: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + avatar: <string> + bio: <string> + created: <dateTime> + deletedAt: <dateTime> + displayName: <string> + email: <string> + facebook: <string> + fullName: <string> + id: <string> + language: ksf + linkedin: <string> + name: <string> + slug: <string> + translatedFromId: <long> + twitter: <string> + updated: <dateTime> + website: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "aliquipbcd": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ut_0d5": [ + "<string>", + "<string>" + ], + "ut_2_e": [ + "<string>", + "<string>" + ], + "nostrud7": [ + "<string>", + "<string>" + ], + "doe": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ut_927": [ + "<string>", + "<string>" + ], + "deserunt9": [ + "<string>", + "<string>" + ], + "laborum_5d": [ + "<string>", + "<string>" + ], + "eiusmod2fa": [ + "<string>", + "<string>" + ] + }, + "links": { + "Lorem1": "<string>", + "mollita": "<string>", + "est_6_": "<string>", + "etb": "<string>", + "non_4_": "<string>" + } + } + /cms/v3/blogs/authors/{objectId}: + get: + tags: + - Blog Authors API > Blog Authors + summary: Retrieve a Blog Author + description: Retrieve the Blog Author object identified by the id in the path. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: string + description: >- + Specifies whether to return deleted Blog Authors. Defaults to + `false`. + example: <boolean> + - name: property + in: query + schema: + type: string + example: <string> + - name: objectId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + avatar: <string> + bio: <string> + created: <dateTime> + deletedAt: <dateTime> + displayName: <string> + email: <string> + facebook: <string> + fullName: <string> + id: <string> + language: ksf + linkedin: <string> + name: <string> + slug: <string> + translatedFromId: <long> + twitter: <string> + updated: <dateTime> + website: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "aliquipbcd": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ut_0d5": [ + "<string>", + "<string>" + ], + "ut_2_e": [ + "<string>", + "<string>" + ], + "nostrud7": [ + "<string>", + "<string>" + ], + "doe": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ut_927": [ + "<string>", + "<string>" + ], + "deserunt9": [ + "<string>", + "<string>" + ], + "laborum_5d": [ + "<string>", + "<string>" + ], + "eiusmod2fa": [ + "<string>", + "<string>" + ] + }, + "links": { + "Lorem1": "<string>", + "mollita": "<string>", + "est_6_": "<string>", + "etb": "<string>", + "non_4_": "<string>" + } + } + delete: + tags: + - Blog Authors API > Blog Authors + summary: Delete a Blog Author + description: Delete the Blog Author object identified by the id in the path. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: archived + in: query + schema: + type: string + description: Whether to return only results that have been archived. + example: <boolean> + - name: objectId + in: path + schema: + type: string + required: true + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "aliquipbcd": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ut_0d5": [ + "<string>", + "<string>" + ], + "ut_2_e": [ + "<string>", + "<string>" + ], + "nostrud7": [ + "<string>", + "<string>" + ], + "doe": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ut_927": [ + "<string>", + "<string>" + ], + "deserunt9": [ + "<string>", + "<string>" + ], + "laborum_5d": [ + "<string>", + "<string>" + ], + "eiusmod2fa": [ + "<string>", + "<string>" + ] + }, + "links": { + "Lorem1": "<string>", + "mollita": "<string>", + "est_6_": "<string>", + "etb": "<string>", + "non_4_": "<string>" + } + } + patch: + tags: + - Blog Authors API > Blog Authors + summary: Update a Blog Author + description: > + Sparse updates a single Blog Author object identified by the id in the + path. + + All the column values need not be specified. Only the that need to be + modified can be specified. + requestBody: + content: + application/json: + schema: + type: object + example: + avatar: <string> + bio: <string> + created: <dateTime> + deletedAt: <dateTime> + displayName: <string> + email: <string> + facebook: <string> + fullName: <string> + id: <string> + language: ksf + linkedin: <string> + name: <string> + slug: <string> + translatedFromId: <long> + twitter: <string> + updated: <dateTime> + website: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: string + description: >- + Specifies whether to update deleted Blog Authors. Defaults to + `false`. + example: <boolean> + - name: objectId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + avatar: <string> + bio: <string> + created: <dateTime> + deletedAt: <dateTime> + displayName: <string> + email: <string> + facebook: <string> + fullName: <string> + id: <string> + language: ksf + linkedin: <string> + name: <string> + slug: <string> + translatedFromId: <long> + twitter: <string> + updated: <dateTime> + website: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "aliquipbcd": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ut_0d5": [ + "<string>", + "<string>" + ], + "ut_2_e": [ + "<string>", + "<string>" + ], + "nostrud7": [ + "<string>", + "<string>" + ], + "doe": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ut_927": [ + "<string>", + "<string>" + ], + "deserunt9": [ + "<string>", + "<string>" + ], + "laborum_5d": [ + "<string>", + "<string>" + ], + "eiusmod2fa": [ + "<string>", + "<string>" + ] + }, + "links": { + "Lorem1": "<string>", + "mollita": "<string>", + "est_6_": "<string>", + "etb": "<string>", + "non_4_": "<string>" + } + } + /cms/v3/blogs/authors/multi-language/detach-from-lang-group: + post: + tags: + - Blog Authors API > Blog Authors + summary: Detach a Blog Author from a multi-language group + description: Detach a Blog Author from a multi-language group. + requestBody: + content: + application/json: + schema: + type: object + example: + id: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '200': + description: OK + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "aliquipbcd": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ut_0d5": [ + "<string>", + "<string>" + ], + "ut_2_e": [ + "<string>", + "<string>" + ], + "nostrud7": [ + "<string>", + "<string>" + ], + "doe": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ut_927": [ + "<string>", + "<string>" + ], + "deserunt9": [ + "<string>", + "<string>" + ], + "laborum_5d": [ + "<string>", + "<string>" + ], + "eiusmod2fa": [ + "<string>", + "<string>" + ] + }, + "links": { + "Lorem1": "<string>", + "mollita": "<string>", + "est_6_": "<string>", + "etb": "<string>", + "non_4_": "<string>" + } + } + /cms/v3/blogs/authors/batch/archive: + post: + tags: + - Blog Authors API > Blog Authors + summary: Delete a batch of Blog Authors + description: Delete the Blog Author objects identified in the request body. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - <string> + - <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "aliquipbcd": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ut_0d5": [ + "<string>", + "<string>" + ], + "ut_2_e": [ + "<string>", + "<string>" + ], + "nostrud7": [ + "<string>", + "<string>" + ], + "doe": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ut_927": [ + "<string>", + "<string>" + ], + "deserunt9": [ + "<string>", + "<string>" + ], + "laborum_5d": [ + "<string>", + "<string>" + ], + "eiusmod2fa": [ + "<string>", + "<string>" + ] + }, + "links": { + "Lorem1": "<string>", + "mollita": "<string>", + "est_6_": "<string>", + "etb": "<string>", + "non_4_": "<string>" + } + } + /cms/v3/blogs/authors/batch/read: + post: + tags: + - Blog Authors API > Blog Authors + summary: Retrieve a batch of Blog Authors + description: Retrieve the Blog Author objects identified in the request body. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - <string> + - <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: string + description: >- + Specifies whether to return deleted Blog Authors. Defaults to + `false`. + example: <boolean> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - avatar: <string> + bio: <string> + created: <dateTime> + deletedAt: <dateTime> + displayName: <string> + email: <string> + facebook: <string> + fullName: <string> + id: <string> + language: it-it + linkedin: <string> + name: <string> + slug: <string> + translatedFromId: <long> + twitter: <string> + updated: <dateTime> + website: <string> + - avatar: <string> + bio: <string> + created: <dateTime> + deletedAt: <dateTime> + displayName: <string> + email: <string> + facebook: <string> + fullName: <string> + id: <string> + language: nl-ch + linkedin: <string> + name: <string> + slug: <string> + translatedFromId: <long> + twitter: <string> + updated: <dateTime> + website: <string> + startedAt: <dateTime> + status: COMPLETE + requestedAt: <dateTime> + links: + quie95: <string> + non_fe_: <string> + reprehenderita6: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - avatar: <string> + bio: <string> + created: <dateTime> + deletedAt: <dateTime> + displayName: <string> + email: <string> + facebook: <string> + fullName: <string> + id: <string> + language: zu + linkedin: <string> + name: <string> + slug: <string> + translatedFromId: <long> + twitter: <string> + updated: <dateTime> + website: <string> + - avatar: <string> + bio: <string> + created: <dateTime> + deletedAt: <dateTime> + displayName: <string> + email: <string> + facebook: <string> + fullName: <string> + id: <string> + language: ckb-iq + linkedin: <string> + name: <string> + slug: <string> + translatedFromId: <long> + twitter: <string> + updated: <dateTime> + website: <string> + startedAt: <dateTime> + status: PROCESSING + numErrors: <integer> + errors: + - category: <string> + context: + Lorem_2: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + cupidatat9: + - <string> + - <string> + commodo469: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + labore_b04: + - <string> + - <string> + eiusmod_e: + - <string> + - <string> + veniam_6f2: + - <string> + - <string> + links: + fugiat98: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + dolor_0: + - <string> + - <string> + incididunt7: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + fugiat_1: + - <string> + - <string> + occaecat7: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + labore_4: + - <string> + - <string> + commodo_9: + - <string> + - <string> + links: + Excepteur_e: <string> + aute_3: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + doloree8: <string> + exercitation729: <string> + sint__5: <string> + pariatur3: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "aliquipbcd": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ut_0d5": [ + "<string>", + "<string>" + ], + "ut_2_e": [ + "<string>", + "<string>" + ], + "nostrud7": [ + "<string>", + "<string>" + ], + "doe": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ut_927": [ + "<string>", + "<string>" + ], + "deserunt9": [ + "<string>", + "<string>" + ], + "laborum_5d": [ + "<string>", + "<string>" + ], + "eiusmod2fa": [ + "<string>", + "<string>" + ] + }, + "links": { + "Lorem1": "<string>", + "mollita": "<string>", + "est_6_": "<string>", + "etb": "<string>", + "non_4_": "<string>" + } + } + /cms/v3/blogs/authors/multi-language/update-languages: + post: + tags: + - Blog Authors API > Blog Authors + summary: Update languages of multi-language group + description: >- + Explicitly set new languages for each Blog Author in a multi-language + group. + requestBody: + content: + application/json: + schema: + type: object + example: + languages: + esse0_: <string> + primaryId: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '200': + description: OK + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "aliquipbcd": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ut_0d5": [ + "<string>", + "<string>" + ], + "ut_2_e": [ + "<string>", + "<string>" + ], + "nostrud7": [ + "<string>", + "<string>" + ], + "doe": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ut_927": [ + "<string>", + "<string>" + ], + "deserunt9": [ + "<string>", + "<string>" + ], + "laborum_5d": [ + "<string>", + "<string>" + ], + "eiusmod2fa": [ + "<string>", + "<string>" + ] + }, + "links": { + "Lorem1": "<string>", + "mollita": "<string>", + "est_6_": "<string>", + "etb": "<string>", + "non_4_": "<string>" + } + } + /cms/v3/blogs/authors/multi-language/set-new-lang-primary: + put: + tags: + - Blog Authors API > Blog Authors + summary: Set a new primary language + description: Set a Blog Author as the primary language of a multi-language group. + requestBody: + content: + application/json: + schema: + type: object + example: + id: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "aliquipbcd": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ut_0d5": [ + "<string>", + "<string>" + ], + "ut_2_e": [ + "<string>", + "<string>" + ], + "nostrud7": [ + "<string>", + "<string>" + ], + "doe": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ut_927": [ + "<string>", + "<string>" + ], + "deserunt9": [ + "<string>", + "<string>" + ], + "laborum_5d": [ + "<string>", + "<string>" + ], + "eiusmod2fa": [ + "<string>", + "<string>" + ] + }, + "links": { + "Lorem1": "<string>", + "mollita": "<string>", + "est_6_": "<string>", + "etb": "<string>", + "non_4_": "<string>" + } + } + /cms/v3/blogs/authors/multi-language/create-language-variation: + post: + tags: + - Blog Authors API > Blog Authors + summary: Create a new language variation + description: Create a new language variation from an existing Blog Author. + requestBody: + content: + application/json: + schema: + type: object + example: + blogAuthor: + avatar: <string> + bio: <string> + created: <dateTime> + deletedAt: <dateTime> + displayName: <string> + email: <string> + facebook: <string> + fullName: <string> + id: <string> + language: ar-ly + linkedin: <string> + name: <string> + slug: <string> + translatedFromId: <long> + twitter: <string> + updated: <dateTime> + website: <string> + id: <string> + language: <string> + primaryLanguage: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + avatar: <string> + bio: <string> + created: <dateTime> + deletedAt: <dateTime> + displayName: <string> + email: <string> + facebook: <string> + fullName: <string> + id: <string> + language: ksf + linkedin: <string> + name: <string> + slug: <string> + translatedFromId: <long> + twitter: <string> + updated: <dateTime> + website: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "aliquipbcd": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ut_0d5": [ + "<string>", + "<string>" + ], + "ut_2_e": [ + "<string>", + "<string>" + ], + "nostrud7": [ + "<string>", + "<string>" + ], + "doe": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ut_927": [ + "<string>", + "<string>" + ], + "deserunt9": [ + "<string>", + "<string>" + ], + "laborum_5d": [ + "<string>", + "<string>" + ], + "eiusmod2fa": [ + "<string>", + "<string>" + ] + }, + "links": { + "Lorem1": "<string>", + "mollita": "<string>", + "est_6_": "<string>", + "etb": "<string>", + "non_4_": "<string>" + } + } + /cms/v3/hubdb/tables/{tableIdOrName}/draft/export: + get: + tags: + - HubDb API > Tables + summary: Export a draft table + description: Exports the `draft` version of a table to CSV / EXCEL format. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/vnd.ms-excel + - name: format + in: query + schema: + type: string + description: >- + The file format to export. Possible values include `CSV`, `XLSX`, + and `XLS`. + example: <string> + - name: tableIdOrName + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/vnd.ms-excel + content: + text/plain: + schema: + type: string + example: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "incididunt7": [ + "<string>", + "<string>" + ], + "doloref": [ + "<string>", + "<string>" + ], + "culpa_a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ea9d": [ + "<string>", + "<string>" + ], + "ut_ead": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ad12f": [ + "<string>", + "<string>" + ] + }, + "links": { + "adipisicinge8": "<string>" + } + } + /cms/v3/hubdb/tables/draft: + get: + tags: + - HubDb API > Tables + summary: Return all draft tables + description: >- + Returns the details for each draft table defined in the specified + account, including column definitions. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: sort + in: query + schema: + type: string + description: >- + Specifies which fields to use for sorting results. Valid fields are + `name`, `createdAt`, `updatedAt`, `createdBy`, `updatedBy`. + `createdAt` will be used by default. + example: <string> + - name: sort + in: query + schema: + type: string + description: >- + Specifies which fields to use for sorting results. Valid fields are + `name`, `createdAt`, `updatedAt`, `createdBy`, `updatedBy`. + `createdAt` will be used by default. + example: <string> + - name: after + in: query + schema: + type: string + description: >- + The cursor token value to get the next set of results. You can get + this from the `paging.next.after` JSON property of a paged response + containing more results. + example: <string> + - name: limit + in: query + schema: + type: string + description: The maximum number of results to return. Default is 1000. + example: <integer> + - name: createdAt + in: query + schema: + type: string + description: Only return tables created at exactly the specified time. + example: <dateTime> + - name: createdAfter + in: query + schema: + type: string + description: Only return tables created after the specified time. + example: <dateTime> + - name: createdBefore + in: query + schema: + type: string + description: Only return tables created before the specified time. + example: <dateTime> + - name: updatedAt + in: query + schema: + type: string + description: Only return tables last updated at exactly the specified time. + example: <dateTime> + - name: updatedAfter + in: query + schema: + type: string + description: Only return tables last updated after the specified time. + example: <dateTime> + - name: updatedBefore + in: query + schema: + type: string + description: Only return tables last updated before the specified time. + example: <dateTime> + - name: archived + in: query + schema: + type: string + description: Specifies whether to return archived tables. Defaults to `false`. + example: <boolean> + - name: contentType + in: query + schema: + type: string + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - label: <string> + name: <string> + id: <string> + columns: + - label: <string> + name: <string> + type: FILE + id: <string> + deleted: <boolean> + options: + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + width: <integer> + foreignTableId: <long> + foreignColumnId: <integer> + description: <string> + foreignIds: + - id: <string> + name: <string> + type: <string> + - id: <string> + name: <string> + type: <string> + foreignIdsByName: + labore_1: + id: <string> + name: <string> + type: <string> + ut2c6: + id: <string> + name: <string> + type: <string> + foreignIdsById: + aute8: + id: <string> + name: <string> + type: <string> + aute_7: + id: <string> + name: <string> + type: <string> + optionCount: <integer> + - label: <string> + name: <string> + type: MULTISELECT + id: <string> + deleted: <boolean> + options: + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + width: <integer> + foreignTableId: <long> + foreignColumnId: <integer> + description: <string> + foreignIds: + - id: <string> + name: <string> + type: <string> + - id: <string> + name: <string> + type: <string> + foreignIdsByName: + aute3_6: + id: <string> + name: <string> + type: <string> + foreignIdsById: + Duisa0: + id: <string> + name: <string> + type: <string> + optionCount: <integer> + published: <boolean> + deleted: <boolean> + columnCount: <integer> + rowCount: <integer> + createdBy: + email: <string> + firstName: <string> + id: <string> + lastName: <string> + updatedBy: + email: <string> + firstName: <string> + id: <string> + lastName: <string> + useForPages: <boolean> + allowChildTables: <boolean> + enableChildTablePages: <boolean> + isOrderedManually: <boolean> + dynamicMetaTags: + pariatur_2: <integer> + Duis664: <integer> + allowPublicApiAccess: <boolean> + createdAt: <dateTime> + publishedAt: <dateTime> + updatedAt: <dateTime> + - label: <string> + name: <string> + id: <string> + columns: + - label: <string> + name: <string> + type: CTA + id: <string> + deleted: <boolean> + options: + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + width: <integer> + foreignTableId: <long> + foreignColumnId: <integer> + description: <string> + foreignIds: + - id: <string> + name: <string> + type: <string> + - id: <string> + name: <string> + type: <string> + foreignIdsByName: + aliquip_31: + id: <string> + name: <string> + type: <string> + velit_ec: + id: <string> + name: <string> + type: <string> + commodo_2: + id: <string> + name: <string> + type: <string> + nulla_0ec: + id: <string> + name: <string> + type: <string> + foreignIdsById: + proident8: + id: <string> + name: <string> + type: <string> + elit464: + id: <string> + name: <string> + type: <string> + optionCount: <integer> + - label: <string> + name: <string> + type: CTA + id: <string> + deleted: <boolean> + options: + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + width: <integer> + foreignTableId: <long> + foreignColumnId: <integer> + description: <string> + foreignIds: + - id: <string> + name: <string> + type: <string> + - id: <string> + name: <string> + type: <string> + foreignIdsByName: + pariatur_004: + id: <string> + name: <string> + type: <string> + sit8: + id: <string> + name: <string> + type: <string> + foreignIdsById: + laboris2ab: + id: <string> + name: <string> + type: <string> + optionCount: <integer> + published: <boolean> + deleted: <boolean> + columnCount: <integer> + rowCount: <integer> + createdBy: + email: <string> + firstName: <string> + id: <string> + lastName: <string> + updatedBy: + email: <string> + firstName: <string> + id: <string> + lastName: <string> + useForPages: <boolean> + allowChildTables: <boolean> + enableChildTablePages: <boolean> + isOrderedManually: <boolean> + dynamicMetaTags: + occaecat_2f: <integer> + nullace: <integer> + allowPublicApiAccess: <boolean> + createdAt: <dateTime> + publishedAt: <dateTime> + updatedAt: <dateTime> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "incididunt7": [ + "<string>", + "<string>" + ], + "doloref": [ + "<string>", + "<string>" + ], + "culpa_a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ea9d": [ + "<string>", + "<string>" + ], + "ut_ead": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ad12f": [ + "<string>", + "<string>" + ] + }, + "links": { + "adipisicinge8": "<string>" + } + } + /cms/v3/hubdb/tables/{tableIdOrName}/draft/reset: + post: + tags: + - HubDb API > Tables + summary: Reset a draft table + description: >- + Replaces the data in the `draft` version of the table with values from + the `published` version. Any unpublished changes in the `draft` will be + lost after this call is made. + requestBody: + content: {} + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: includeForeignIds + in: query + schema: + type: string + description: Set this to `true` to populate foreign ID values in the response. + example: <boolean> + - name: tableIdOrName + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + label: <string> + name: <string> + id: <string> + columns: + - label: <string> + name: <string> + type: DATE + id: <string> + deleted: <boolean> + options: + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + width: <integer> + foreignTableId: <long> + foreignColumnId: <integer> + description: <string> + foreignIds: + - id: <string> + name: <string> + type: <string> + - id: <string> + name: <string> + type: <string> + foreignIdsByName: + irure1: + id: <string> + name: <string> + type: <string> + laboris0: + id: <string> + name: <string> + type: <string> + foreignIdsById: + sint5: + id: <string> + name: <string> + type: <string> + sed0: + id: <string> + name: <string> + type: <string> + et_1: + id: <string> + name: <string> + type: <string> + optionCount: <integer> + - label: <string> + name: <string> + type: URL + id: <string> + deleted: <boolean> + options: + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + width: <integer> + foreignTableId: <long> + foreignColumnId: <integer> + description: <string> + foreignIds: + - id: <string> + name: <string> + type: <string> + - id: <string> + name: <string> + type: <string> + foreignIdsByName: + non_d: + id: <string> + name: <string> + type: <string> + magna___6: + id: <string> + name: <string> + type: <string> + foreignIdsById: + fugiat0: + id: <string> + name: <string> + type: <string> + optionCount: <integer> + published: <boolean> + deleted: <boolean> + columnCount: <integer> + rowCount: <integer> + createdBy: + email: <string> + firstName: <string> + id: <string> + lastName: <string> + updatedBy: + email: <string> + firstName: <string> + id: <string> + lastName: <string> + useForPages: <boolean> + allowChildTables: <boolean> + enableChildTablePages: <boolean> + isOrderedManually: <boolean> + dynamicMetaTags: + est6c3: <integer> + allowPublicApiAccess: <boolean> + createdAt: <dateTime> + publishedAt: <dateTime> + updatedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "incididunt7": [ + "<string>", + "<string>" + ], + "doloref": [ + "<string>", + "<string>" + ], + "culpa_a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ea9d": [ + "<string>", + "<string>" + ], + "ut_ead": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ad12f": [ + "<string>", + "<string>" + ] + }, + "links": { + "adipisicinge8": "<string>" + } + } + /cms/v3/hubdb/tables/{tableIdOrName}/export: + get: + tags: + - HubDb API > Tables + summary: Export a published version of a table + description: Exports the `published` version of a table to CSV / EXCEL format. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/vnd.ms-excel + - name: format + in: query + schema: + type: string + description: >- + The file format to export. Possible values include `CSV`, `XLSX`, + and `XLS`. + example: <string> + - name: tableIdOrName + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/vnd.ms-excel + content: + text/plain: + schema: + type: string + example: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "incididunt7": [ + "<string>", + "<string>" + ], + "doloref": [ + "<string>", + "<string>" + ], + "culpa_a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ea9d": [ + "<string>", + "<string>" + ], + "ut_ead": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ad12f": [ + "<string>", + "<string>" + ] + }, + "links": { + "adipisicinge8": "<string>" + } + } + /cms/v3/hubdb/tables/{tableIdOrName}/draft/clone: + post: + tags: + - HubDb API > Tables + summary: Clone a table + description: >- + Clone an existing HubDB table. The `newName` and `newLabel` of the new + table can be sent as JSON in the `body` parameter. This will create the + cloned table as a `draft`. + requestBody: + content: + application/json: + schema: + type: object + example: + copyRows: <boolean> + newName: <string> + newLabel: <string> + isHubspotDefined: <boolean> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: tableIdOrName + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + label: <string> + name: <string> + id: <string> + columns: + - label: <string> + name: <string> + type: DATE + id: <string> + deleted: <boolean> + options: + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + width: <integer> + foreignTableId: <long> + foreignColumnId: <integer> + description: <string> + foreignIds: + - id: <string> + name: <string> + type: <string> + - id: <string> + name: <string> + type: <string> + foreignIdsByName: + irure1: + id: <string> + name: <string> + type: <string> + laboris0: + id: <string> + name: <string> + type: <string> + foreignIdsById: + sint5: + id: <string> + name: <string> + type: <string> + sed0: + id: <string> + name: <string> + type: <string> + et_1: + id: <string> + name: <string> + type: <string> + optionCount: <integer> + - label: <string> + name: <string> + type: URL + id: <string> + deleted: <boolean> + options: + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + width: <integer> + foreignTableId: <long> + foreignColumnId: <integer> + description: <string> + foreignIds: + - id: <string> + name: <string> + type: <string> + - id: <string> + name: <string> + type: <string> + foreignIdsByName: + non_d: + id: <string> + name: <string> + type: <string> + magna___6: + id: <string> + name: <string> + type: <string> + foreignIdsById: + fugiat0: + id: <string> + name: <string> + type: <string> + optionCount: <integer> + published: <boolean> + deleted: <boolean> + columnCount: <integer> + rowCount: <integer> + createdBy: + email: <string> + firstName: <string> + id: <string> + lastName: <string> + updatedBy: + email: <string> + firstName: <string> + id: <string> + lastName: <string> + useForPages: <boolean> + allowChildTables: <boolean> + enableChildTablePages: <boolean> + isOrderedManually: <boolean> + dynamicMetaTags: + est6c3: <integer> + allowPublicApiAccess: <boolean> + createdAt: <dateTime> + publishedAt: <dateTime> + updatedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "incididunt7": [ + "<string>", + "<string>" + ], + "doloref": [ + "<string>", + "<string>" + ], + "culpa_a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ea9d": [ + "<string>", + "<string>" + ], + "ut_ead": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ad12f": [ + "<string>", + "<string>" + ] + }, + "links": { + "adipisicinge8": "<string>" + } + } + /cms/v3/hubdb/tables/{tableIdOrName}/draft/import: + post: + tags: + - HubDb API > Tables + summary: Import data into draft table + description: >- + Import the contents of a CSV file into an existing HubDB table. The data + will always be imported into the `draft` version of the table. Use + `/publish` endpoint to push these changes to `published` version. + + This endpoint takes a multi-part POST request. The first part will be a + set of JSON-formatted options for the import and you can specify this + with the name as `config`. The second part will be the CSV file you + want to import and you can specify this with the name as `file`. Refer + the [overview + section](https://developers.hubspot.com/docs/api/cms/hubdb#importing-tables) + to check the details and format of the JSON-formatted options for the + import. + requestBody: + content: + multipart/form-data: + schema: + type: object + properties: + config: + type: string + description: >- + Configuration for the import in JSON format as described + above. + example: <string> + file: + type: string + description: The source CSV file to be imported. + example: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: multipart/form-data + - name: Accept + in: header + schema: + type: string + example: application/json + - name: tableIdOrName + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + duplicateRows: <integer> + errors: + - category: <string> + correlationId: <uuid> + message: <string> + subCategory: <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + cupidatatc: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + laborum_42: + - <string> + - <string> + ullamco_478: + - <string> + - <string> + aliqua__d: + - <string> + - <string> + minimf: + - <string> + - <string> + context: + in_736: + - <string> + - <string> + adipisicingf5: + - <string> + - <string> + links: + enim1f: <string> + anim6d: <string> + - category: <string> + correlationId: <uuid> + message: <string> + subCategory: <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + Lorem_9: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + Duis94: + - <string> + - <string> + magna_bc: + - <string> + - <string> + labore08a: + - <string> + - <string> + context: + est4d4: + - <string> + - <string> + ipsum_1: + - <string> + - <string> + cillume: + - <string> + - <string> + links: + Excepteur_ff: <string> + rowLimitExceeded: <boolean> + rowsImported: <integer> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "incididunt7": [ + "<string>", + "<string>" + ], + "doloref": [ + "<string>", + "<string>" + ], + "culpa_a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ea9d": [ + "<string>", + "<string>" + ], + "ut_ead": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ad12f": [ + "<string>", + "<string>" + ] + }, + "links": { + "adipisicinge8": "<string>" + } + } + /cms/v3/hubdb/tables/{tableIdOrName}: + get: + tags: + - HubDb API > Tables + summary: Get details of a published table + description: >- + Returns the details for the `published` version of the specified table. + This will include the definitions for the columns in the table and the + number of rows in the table. + + + **Note:** This endpoint can be accessed without any authentication if + the table is set to be allowed for public access. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: includeForeignIds + in: query + schema: + type: string + description: Set this to `true` to populate foreign ID values in the result. + example: <boolean> + - name: archived + in: query + schema: + type: string + description: >- + Set this to `true` to return details for an archived table. Defaults + to `false`. + example: <boolean> + - name: isGetLocalizedSchema + in: query + schema: + type: string + example: <boolean> + - name: tableIdOrName + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + label: <string> + name: <string> + id: <string> + columns: + - label: <string> + name: <string> + type: DATE + id: <string> + deleted: <boolean> + options: + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + width: <integer> + foreignTableId: <long> + foreignColumnId: <integer> + description: <string> + foreignIds: + - id: <string> + name: <string> + type: <string> + - id: <string> + name: <string> + type: <string> + foreignIdsByName: + irure1: + id: <string> + name: <string> + type: <string> + laboris0: + id: <string> + name: <string> + type: <string> + foreignIdsById: + sint5: + id: <string> + name: <string> + type: <string> + sed0: + id: <string> + name: <string> + type: <string> + et_1: + id: <string> + name: <string> + type: <string> + optionCount: <integer> + - label: <string> + name: <string> + type: URL + id: <string> + deleted: <boolean> + options: + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + width: <integer> + foreignTableId: <long> + foreignColumnId: <integer> + description: <string> + foreignIds: + - id: <string> + name: <string> + type: <string> + - id: <string> + name: <string> + type: <string> + foreignIdsByName: + non_d: + id: <string> + name: <string> + type: <string> + magna___6: + id: <string> + name: <string> + type: <string> + foreignIdsById: + fugiat0: + id: <string> + name: <string> + type: <string> + optionCount: <integer> + published: <boolean> + deleted: <boolean> + columnCount: <integer> + rowCount: <integer> + createdBy: + email: <string> + firstName: <string> + id: <string> + lastName: <string> + updatedBy: + email: <string> + firstName: <string> + id: <string> + lastName: <string> + useForPages: <boolean> + allowChildTables: <boolean> + enableChildTablePages: <boolean> + isOrderedManually: <boolean> + dynamicMetaTags: + est6c3: <integer> + allowPublicApiAccess: <boolean> + createdAt: <dateTime> + publishedAt: <dateTime> + updatedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "incididunt7": [ + "<string>", + "<string>" + ], + "doloref": [ + "<string>", + "<string>" + ], + "culpa_a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ea9d": [ + "<string>", + "<string>" + ], + "ut_ead": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ad12f": [ + "<string>", + "<string>" + ] + }, + "links": { + "adipisicinge8": "<string>" + } + } + delete: + tags: + - HubDb API > Tables + summary: Archive a table + description: >- + Archive (soft delete) an existing HubDB table. This archives both the + published and draft versions. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: tableIdOrName + in: path + schema: + type: string + required: true + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "incididunt7": [ + "<string>", + "<string>" + ], + "doloref": [ + "<string>", + "<string>" + ], + "culpa_a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ea9d": [ + "<string>", + "<string>" + ], + "ut_ead": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ad12f": [ + "<string>", + "<string>" + ] + }, + "links": { + "adipisicinge8": "<string>" + } + } + /cms/v3/hubdb/tables: + get: + tags: + - HubDb API > Tables + summary: Get all published tables + description: >- + Returns the details for the `published` version of each table defined in + an account, including column definitions. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: sort + in: query + schema: + type: string + description: >- + Specifies which fields to use for sorting results. Valid fields are + `name`, `createdAt`, `updatedAt`, `createdBy`, `updatedBy`. + `createdAt` will be used by default. + example: <string> + - name: sort + in: query + schema: + type: string + description: >- + Specifies which fields to use for sorting results. Valid fields are + `name`, `createdAt`, `updatedAt`, `createdBy`, `updatedBy`. + `createdAt` will be used by default. + example: <string> + - name: after + in: query + schema: + type: string + description: >- + The cursor token value to get the next set of results. You can get + this from the `paging.next.after` JSON property of a paged response + containing more results. + example: <string> + - name: limit + in: query + schema: + type: string + description: The maximum number of results to return. Default is 1000. + example: <integer> + - name: createdAt + in: query + schema: + type: string + description: Only return tables created at exactly the specified time. + example: <dateTime> + - name: createdAfter + in: query + schema: + type: string + description: Only return tables created after the specified time. + example: <dateTime> + - name: createdBefore + in: query + schema: + type: string + description: Only return tables created before the specified time. + example: <dateTime> + - name: updatedAt + in: query + schema: + type: string + description: Only return tables last updated at exactly the specified time. + example: <dateTime> + - name: updatedAfter + in: query + schema: + type: string + description: Only return tables last updated after the specified time. + example: <dateTime> + - name: updatedBefore + in: query + schema: + type: string + description: Only return tables last updated before the specified time. + example: <dateTime> + - name: archived + in: query + schema: + type: string + description: Specifies whether to return archived tables. Defaults to `false`. + example: <boolean> + - name: contentType + in: query + schema: + type: string + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - label: <string> + name: <string> + id: <string> + columns: + - label: <string> + name: <string> + type: FILE + id: <string> + deleted: <boolean> + options: + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + width: <integer> + foreignTableId: <long> + foreignColumnId: <integer> + description: <string> + foreignIds: + - id: <string> + name: <string> + type: <string> + - id: <string> + name: <string> + type: <string> + foreignIdsByName: + labore_1: + id: <string> + name: <string> + type: <string> + ut2c6: + id: <string> + name: <string> + type: <string> + foreignIdsById: + aute8: + id: <string> + name: <string> + type: <string> + aute_7: + id: <string> + name: <string> + type: <string> + optionCount: <integer> + - label: <string> + name: <string> + type: MULTISELECT + id: <string> + deleted: <boolean> + options: + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + width: <integer> + foreignTableId: <long> + foreignColumnId: <integer> + description: <string> + foreignIds: + - id: <string> + name: <string> + type: <string> + - id: <string> + name: <string> + type: <string> + foreignIdsByName: + aute3_6: + id: <string> + name: <string> + type: <string> + foreignIdsById: + Duisa0: + id: <string> + name: <string> + type: <string> + optionCount: <integer> + published: <boolean> + deleted: <boolean> + columnCount: <integer> + rowCount: <integer> + createdBy: + email: <string> + firstName: <string> + id: <string> + lastName: <string> + updatedBy: + email: <string> + firstName: <string> + id: <string> + lastName: <string> + useForPages: <boolean> + allowChildTables: <boolean> + enableChildTablePages: <boolean> + isOrderedManually: <boolean> + dynamicMetaTags: + pariatur_2: <integer> + Duis664: <integer> + allowPublicApiAccess: <boolean> + createdAt: <dateTime> + publishedAt: <dateTime> + updatedAt: <dateTime> + - label: <string> + name: <string> + id: <string> + columns: + - label: <string> + name: <string> + type: CTA + id: <string> + deleted: <boolean> + options: + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + width: <integer> + foreignTableId: <long> + foreignColumnId: <integer> + description: <string> + foreignIds: + - id: <string> + name: <string> + type: <string> + - id: <string> + name: <string> + type: <string> + foreignIdsByName: + aliquip_31: + id: <string> + name: <string> + type: <string> + velit_ec: + id: <string> + name: <string> + type: <string> + commodo_2: + id: <string> + name: <string> + type: <string> + nulla_0ec: + id: <string> + name: <string> + type: <string> + foreignIdsById: + proident8: + id: <string> + name: <string> + type: <string> + elit464: + id: <string> + name: <string> + type: <string> + optionCount: <integer> + - label: <string> + name: <string> + type: CTA + id: <string> + deleted: <boolean> + options: + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + width: <integer> + foreignTableId: <long> + foreignColumnId: <integer> + description: <string> + foreignIds: + - id: <string> + name: <string> + type: <string> + - id: <string> + name: <string> + type: <string> + foreignIdsByName: + pariatur_004: + id: <string> + name: <string> + type: <string> + sit8: + id: <string> + name: <string> + type: <string> + foreignIdsById: + laboris2ab: + id: <string> + name: <string> + type: <string> + optionCount: <integer> + published: <boolean> + deleted: <boolean> + columnCount: <integer> + rowCount: <integer> + createdBy: + email: <string> + firstName: <string> + id: <string> + lastName: <string> + updatedBy: + email: <string> + firstName: <string> + id: <string> + lastName: <string> + useForPages: <boolean> + allowChildTables: <boolean> + enableChildTablePages: <boolean> + isOrderedManually: <boolean> + dynamicMetaTags: + occaecat_2f: <integer> + nullace: <integer> + allowPublicApiAccess: <boolean> + createdAt: <dateTime> + publishedAt: <dateTime> + updatedAt: <dateTime> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "incididunt7": [ + "<string>", + "<string>" + ], + "doloref": [ + "<string>", + "<string>" + ], + "culpa_a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ea9d": [ + "<string>", + "<string>" + ], + "ut_ead": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ad12f": [ + "<string>", + "<string>" + ] + }, + "links": { + "adipisicinge8": "<string>" + } + } + post: + tags: + - HubDb API > Tables + summary: Create a new table + description: >- + Creates a new draft HubDB table given a JSON schema. The table name and + label should be unique for each account. + requestBody: + content: + application/json: + schema: + type: object + example: + label: <string> + name: <string> + useForPages: <boolean> + allowPublicApiAccess: <boolean> + allowChildTables: <boolean> + enableChildTablePages: <boolean> + columns: + - id: <integer> + label: <string> + name: <string> + options: + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + type: NUMBER + foreignTableId: <long> + foreignColumnId: <integer> + - id: <integer> + label: <string> + name: <string> + options: + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + type: 'NULL' + foreignTableId: <long> + foreignColumnId: <integer> + dynamicMetaTags: + dolore487: <integer> + voluptate_0: <integer> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + label: <string> + name: <string> + id: <string> + columns: + - label: <string> + name: <string> + type: DATE + id: <string> + deleted: <boolean> + options: + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + width: <integer> + foreignTableId: <long> + foreignColumnId: <integer> + description: <string> + foreignIds: + - id: <string> + name: <string> + type: <string> + - id: <string> + name: <string> + type: <string> + foreignIdsByName: + irure1: + id: <string> + name: <string> + type: <string> + laboris0: + id: <string> + name: <string> + type: <string> + foreignIdsById: + sint5: + id: <string> + name: <string> + type: <string> + sed0: + id: <string> + name: <string> + type: <string> + et_1: + id: <string> + name: <string> + type: <string> + optionCount: <integer> + - label: <string> + name: <string> + type: URL + id: <string> + deleted: <boolean> + options: + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + width: <integer> + foreignTableId: <long> + foreignColumnId: <integer> + description: <string> + foreignIds: + - id: <string> + name: <string> + type: <string> + - id: <string> + name: <string> + type: <string> + foreignIdsByName: + non_d: + id: <string> + name: <string> + type: <string> + magna___6: + id: <string> + name: <string> + type: <string> + foreignIdsById: + fugiat0: + id: <string> + name: <string> + type: <string> + optionCount: <integer> + published: <boolean> + deleted: <boolean> + columnCount: <integer> + rowCount: <integer> + createdBy: + email: <string> + firstName: <string> + id: <string> + lastName: <string> + updatedBy: + email: <string> + firstName: <string> + id: <string> + lastName: <string> + useForPages: <boolean> + allowChildTables: <boolean> + enableChildTablePages: <boolean> + isOrderedManually: <boolean> + dynamicMetaTags: + est6c3: <integer> + allowPublicApiAccess: <boolean> + createdAt: <dateTime> + publishedAt: <dateTime> + updatedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "incididunt7": [ + "<string>", + "<string>" + ], + "doloref": [ + "<string>", + "<string>" + ], + "culpa_a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ea9d": [ + "<string>", + "<string>" + ], + "ut_ead": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ad12f": [ + "<string>", + "<string>" + ] + }, + "links": { + "adipisicinge8": "<string>" + } + } + /cms/v3/hubdb/tables/{tableIdOrName}/unpublish: + post: + tags: + - HubDb API > Tables + summary: Unpublish a table + description: >- + Unpublishes the table, meaning any website pages using data from the + table will not render any data. + requestBody: + content: {} + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: includeForeignIds + in: query + schema: + type: string + description: Set this to `true` to populate foreign ID values in the response. + example: <boolean> + - name: tableIdOrName + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + label: <string> + name: <string> + id: <string> + columns: + - label: <string> + name: <string> + type: DATE + id: <string> + deleted: <boolean> + options: + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + width: <integer> + foreignTableId: <long> + foreignColumnId: <integer> + description: <string> + foreignIds: + - id: <string> + name: <string> + type: <string> + - id: <string> + name: <string> + type: <string> + foreignIdsByName: + irure1: + id: <string> + name: <string> + type: <string> + laboris0: + id: <string> + name: <string> + type: <string> + foreignIdsById: + sint5: + id: <string> + name: <string> + type: <string> + sed0: + id: <string> + name: <string> + type: <string> + et_1: + id: <string> + name: <string> + type: <string> + optionCount: <integer> + - label: <string> + name: <string> + type: URL + id: <string> + deleted: <boolean> + options: + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + width: <integer> + foreignTableId: <long> + foreignColumnId: <integer> + description: <string> + foreignIds: + - id: <string> + name: <string> + type: <string> + - id: <string> + name: <string> + type: <string> + foreignIdsByName: + non_d: + id: <string> + name: <string> + type: <string> + magna___6: + id: <string> + name: <string> + type: <string> + foreignIdsById: + fugiat0: + id: <string> + name: <string> + type: <string> + optionCount: <integer> + published: <boolean> + deleted: <boolean> + columnCount: <integer> + rowCount: <integer> + createdBy: + email: <string> + firstName: <string> + id: <string> + lastName: <string> + updatedBy: + email: <string> + firstName: <string> + id: <string> + lastName: <string> + useForPages: <boolean> + allowChildTables: <boolean> + enableChildTablePages: <boolean> + isOrderedManually: <boolean> + dynamicMetaTags: + est6c3: <integer> + allowPublicApiAccess: <boolean> + createdAt: <dateTime> + publishedAt: <dateTime> + updatedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "incididunt7": [ + "<string>", + "<string>" + ], + "doloref": [ + "<string>", + "<string>" + ], + "culpa_a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ea9d": [ + "<string>", + "<string>" + ], + "ut_ead": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ad12f": [ + "<string>", + "<string>" + ] + }, + "links": { + "adipisicinge8": "<string>" + } + } + /cms/v3/hubdb/tables/{tableIdOrName}/draft: + get: + tags: + - HubDb API > Tables + summary: Get details for a draft table + description: >- + Get the details for the `draft` version of a specific HubDB table. This + will include the definitions for the columns in the table and the number + of rows in the table. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: includeForeignIds + in: query + schema: + type: string + description: Set this to `true` to populate foreign ID values in the result. + example: <boolean> + - name: archived + in: query + schema: + type: string + description: Set this to `true` to return an archived table. Defaults to `false`. + example: <boolean> + - name: isGetLocalizedSchema + in: query + schema: + type: string + example: <boolean> + - name: tableIdOrName + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + label: <string> + name: <string> + id: <string> + columns: + - label: <string> + name: <string> + type: DATE + id: <string> + deleted: <boolean> + options: + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + width: <integer> + foreignTableId: <long> + foreignColumnId: <integer> + description: <string> + foreignIds: + - id: <string> + name: <string> + type: <string> + - id: <string> + name: <string> + type: <string> + foreignIdsByName: + irure1: + id: <string> + name: <string> + type: <string> + laboris0: + id: <string> + name: <string> + type: <string> + foreignIdsById: + sint5: + id: <string> + name: <string> + type: <string> + sed0: + id: <string> + name: <string> + type: <string> + et_1: + id: <string> + name: <string> + type: <string> + optionCount: <integer> + - label: <string> + name: <string> + type: URL + id: <string> + deleted: <boolean> + options: + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + width: <integer> + foreignTableId: <long> + foreignColumnId: <integer> + description: <string> + foreignIds: + - id: <string> + name: <string> + type: <string> + - id: <string> + name: <string> + type: <string> + foreignIdsByName: + non_d: + id: <string> + name: <string> + type: <string> + magna___6: + id: <string> + name: <string> + type: <string> + foreignIdsById: + fugiat0: + id: <string> + name: <string> + type: <string> + optionCount: <integer> + published: <boolean> + deleted: <boolean> + columnCount: <integer> + rowCount: <integer> + createdBy: + email: <string> + firstName: <string> + id: <string> + lastName: <string> + updatedBy: + email: <string> + firstName: <string> + id: <string> + lastName: <string> + useForPages: <boolean> + allowChildTables: <boolean> + enableChildTablePages: <boolean> + isOrderedManually: <boolean> + dynamicMetaTags: + est6c3: <integer> + allowPublicApiAccess: <boolean> + createdAt: <dateTime> + publishedAt: <dateTime> + updatedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "incididunt7": [ + "<string>", + "<string>" + ], + "doloref": [ + "<string>", + "<string>" + ], + "culpa_a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ea9d": [ + "<string>", + "<string>" + ], + "ut_ead": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ad12f": [ + "<string>", + "<string>" + ] + }, + "links": { + "adipisicinge8": "<string>" + } + } + patch: + tags: + - HubDb API > Tables + summary: Update an existing table + description: >- + Update an existing HubDB table. You can use this endpoint to add or + remove columns to the table as well as restore an archived table. Tables + updated using the endpoint will only modify the `draft` verion of the + table. Use `publish` endpoint to push all the changes to the `published` + version. To restore a table, include the query parameter `archived=true` + and `"archived": false` in the json body. + + **Note:** You need to include all the columns in the input when you are + adding/removing/updating a column. If you do not include an already + existing column in the request, it will be deleted. + requestBody: + content: + application/json: + schema: + type: object + example: + label: <string> + name: <string> + useForPages: <boolean> + allowPublicApiAccess: <boolean> + allowChildTables: <boolean> + enableChildTablePages: <boolean> + columns: + - id: <integer> + label: <string> + name: <string> + options: + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + type: NUMBER + foreignTableId: <long> + foreignColumnId: <integer> + - id: <integer> + label: <string> + name: <string> + options: + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + type: 'NULL' + foreignTableId: <long> + foreignColumnId: <integer> + dynamicMetaTags: + dolore487: <integer> + voluptate_0: <integer> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: includeForeignIds + in: query + schema: + type: string + description: Set this to `true` to populate foreign ID values in the result. + example: <boolean> + - name: archived + in: query + schema: + type: string + description: Specifies whether to return archived tables. Defaults to `false`. + example: <boolean> + - name: isGetLocalizedSchema + in: query + schema: + type: string + example: <boolean> + - name: tableIdOrName + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + label: <string> + name: <string> + id: <string> + columns: + - label: <string> + name: <string> + type: DATE + id: <string> + deleted: <boolean> + options: + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + width: <integer> + foreignTableId: <long> + foreignColumnId: <integer> + description: <string> + foreignIds: + - id: <string> + name: <string> + type: <string> + - id: <string> + name: <string> + type: <string> + foreignIdsByName: + irure1: + id: <string> + name: <string> + type: <string> + laboris0: + id: <string> + name: <string> + type: <string> + foreignIdsById: + sint5: + id: <string> + name: <string> + type: <string> + sed0: + id: <string> + name: <string> + type: <string> + et_1: + id: <string> + name: <string> + type: <string> + optionCount: <integer> + - label: <string> + name: <string> + type: URL + id: <string> + deleted: <boolean> + options: + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + width: <integer> + foreignTableId: <long> + foreignColumnId: <integer> + description: <string> + foreignIds: + - id: <string> + name: <string> + type: <string> + - id: <string> + name: <string> + type: <string> + foreignIdsByName: + non_d: + id: <string> + name: <string> + type: <string> + magna___6: + id: <string> + name: <string> + type: <string> + foreignIdsById: + fugiat0: + id: <string> + name: <string> + type: <string> + optionCount: <integer> + published: <boolean> + deleted: <boolean> + columnCount: <integer> + rowCount: <integer> + createdBy: + email: <string> + firstName: <string> + id: <string> + lastName: <string> + updatedBy: + email: <string> + firstName: <string> + id: <string> + lastName: <string> + useForPages: <boolean> + allowChildTables: <boolean> + enableChildTablePages: <boolean> + isOrderedManually: <boolean> + dynamicMetaTags: + est6c3: <integer> + allowPublicApiAccess: <boolean> + createdAt: <dateTime> + publishedAt: <dateTime> + updatedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "incididunt7": [ + "<string>", + "<string>" + ], + "doloref": [ + "<string>", + "<string>" + ], + "culpa_a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ea9d": [ + "<string>", + "<string>" + ], + "ut_ead": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ad12f": [ + "<string>", + "<string>" + ] + }, + "links": { + "adipisicinge8": "<string>" + } + } + /cms/v3/hubdb/tables/{tableIdOrName}/draft/publish: + post: + tags: + - HubDb API > Tables + summary: Publish a table from draft + description: >- + Publishes the table by copying the data and table schema changes from + draft version to the published version, meaning any website pages using + data from the table will be updated. + requestBody: + content: {} + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: includeForeignIds + in: query + schema: + type: string + description: Set this to `true` to populate foreign ID values in the response. + example: <boolean> + - name: tableIdOrName + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + label: <string> + name: <string> + id: <string> + columns: + - label: <string> + name: <string> + type: DATE + id: <string> + deleted: <boolean> + options: + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + width: <integer> + foreignTableId: <long> + foreignColumnId: <integer> + description: <string> + foreignIds: + - id: <string> + name: <string> + type: <string> + - id: <string> + name: <string> + type: <string> + foreignIdsByName: + irure1: + id: <string> + name: <string> + type: <string> + laboris0: + id: <string> + name: <string> + type: <string> + foreignIdsById: + sint5: + id: <string> + name: <string> + type: <string> + sed0: + id: <string> + name: <string> + type: <string> + et_1: + id: <string> + name: <string> + type: <string> + optionCount: <integer> + - label: <string> + name: <string> + type: URL + id: <string> + deleted: <boolean> + options: + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + - id: <string> + name: <string> + order: <integer> + type: <string> + label: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + width: <integer> + foreignTableId: <long> + foreignColumnId: <integer> + description: <string> + foreignIds: + - id: <string> + name: <string> + type: <string> + - id: <string> + name: <string> + type: <string> + foreignIdsByName: + non_d: + id: <string> + name: <string> + type: <string> + magna___6: + id: <string> + name: <string> + type: <string> + foreignIdsById: + fugiat0: + id: <string> + name: <string> + type: <string> + optionCount: <integer> + published: <boolean> + deleted: <boolean> + columnCount: <integer> + rowCount: <integer> + createdBy: + email: <string> + firstName: <string> + id: <string> + lastName: <string> + updatedBy: + email: <string> + firstName: <string> + id: <string> + lastName: <string> + useForPages: <boolean> + allowChildTables: <boolean> + enableChildTablePages: <boolean> + isOrderedManually: <boolean> + dynamicMetaTags: + est6c3: <integer> + allowPublicApiAccess: <boolean> + createdAt: <dateTime> + publishedAt: <dateTime> + updatedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "incididunt7": [ + "<string>", + "<string>" + ], + "doloref": [ + "<string>", + "<string>" + ], + "culpa_a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ea9d": [ + "<string>", + "<string>" + ], + "ut_ead": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ad12f": [ + "<string>", + "<string>" + ] + }, + "links": { + "adipisicinge8": "<string>" + } + } + /cms/v3/hubdb/tables/{tableIdOrName}/rows/draft: + get: + tags: + - HubDb API > Rows + summary: Get rows from draft table + description: >- + Returns rows in the `draft` version of the specified table. Row results + can be filtered and sorted. Filtering and sorting options will be sent + as query parameters to the API request. For example, by adding the query + parameters `column1__gt=5&sort=-column1`, API returns the rows with + values for column `column1` greater than 5 and in the descending order + of `column1` values. Refer to the [overview + section](https://developers.hubspot.com/docs/api/cms/hubdb#filtering-and-sorting-table-rows) + for detailed filtering and sorting options. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: sort + in: query + schema: + type: string + description: Specifies the column names to sort the results by. + example: <string> + - name: sort + in: query + schema: + type: string + description: Specifies the column names to sort the results by. + example: <string> + - name: after + in: query + schema: + type: string + description: >- + The cursor token value to get the next set of results. You can get + this from the `paging.next.after` JSON property of a paged response + containing more results. + example: <string> + - name: limit + in: query + schema: + type: string + description: The maximum number of results to return. Default is `1000`. + example: <integer> + - name: properties + in: query + schema: + type: string + description: >- + Specify the column names to get results containing only the required + columns instead of all column details. If you want to include + multiple columns in the result, use this query param as many times. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + Specify the column names to get results containing only the required + columns instead of all column details. If you want to include + multiple columns in the result, use this query param as many times. + example: <string> + - name: offset + in: query + schema: + type: string + example: <integer> + - name: archived + in: query + schema: + type: string + example: <boolean> + - name: tableIdOrName + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - values: + velit683: {} + qui_ff7: {} + id: <string> + path: <string> + name: <string> + childTableId: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + publishedAt: <dateTime> + - values: + culpab: {} + sed79d: {} + id: <string> + path: <string> + name: <string> + childTableId: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + publishedAt: <dateTime> + total: <integer> + paging: + next: + after: <string> + link: <string> + offset: <integer> + type: RANDOM_ACCESS + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "incididunt7": [ + "<string>", + "<string>" + ], + "doloref": [ + "<string>", + "<string>" + ], + "culpa_a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ea9d": [ + "<string>", + "<string>" + ], + "ut_ead": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ad12f": [ + "<string>", + "<string>" + ] + }, + "links": { + "adipisicinge8": "<string>" + } + } + /cms/v3/hubdb/tables/{tableIdOrName}/rows/{rowId}: + get: + tags: + - HubDb API > Rows + summary: Get a table row + description: >- + Get a single row by ID from a table's `published` version. + + **Note:** This endpoint can be accessed without any authentication, if + the table is set to be allowed for public access. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: string + example: <boolean> + - name: tableIdOrName + in: path + schema: + type: string + required: true + example: <string> + - name: rowId + in: path + schema: + type: integer + required: true + example: '259' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + values: + eu_c_5: {} + cupidatat1c2: {} + id: <string> + path: <string> + name: <string> + childTableId: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + publishedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "incididunt7": [ + "<string>", + "<string>" + ], + "doloref": [ + "<string>", + "<string>" + ], + "culpa_a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ea9d": [ + "<string>", + "<string>" + ], + "ut_ead": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ad12f": [ + "<string>", + "<string>" + ] + }, + "links": { + "adipisicinge8": "<string>" + } + } + /cms/v3/hubdb/tables/{tableIdOrName}/rows/{rowId}/draft/clone: + post: + tags: + - HubDb API > Rows + summary: Clone a row + description: Clones a single row in the `draft` version of the table. + requestBody: + content: {} + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: name + in: query + schema: + type: string + example: <string> + - name: tableIdOrName + in: path + schema: + type: string + required: true + example: <string> + - name: rowId + in: path + schema: + type: integer + required: true + example: '259' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + values: + eu_c_5: {} + cupidatat1c2: {} + id: <string> + path: <string> + name: <string> + childTableId: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + publishedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "incididunt7": [ + "<string>", + "<string>" + ], + "doloref": [ + "<string>", + "<string>" + ], + "culpa_a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ea9d": [ + "<string>", + "<string>" + ], + "ut_ead": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ad12f": [ + "<string>", + "<string>" + ] + }, + "links": { + "adipisicinge8": "<string>" + } + } + /cms/v3/hubdb/tables/{tableIdOrName}/rows/{rowId}/draft: + get: + tags: + - HubDb API > Rows + summary: Get a row from the draft table + description: Get a single row by ID from a table's `draft` version. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: string + example: <boolean> + - name: tableIdOrName + in: path + schema: + type: string + required: true + example: <string> + - name: rowId + in: path + schema: + type: integer + required: true + example: '259' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + values: + eu_c_5: {} + cupidatat1c2: {} + id: <string> + path: <string> + name: <string> + childTableId: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + publishedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "incididunt7": [ + "<string>", + "<string>" + ], + "doloref": [ + "<string>", + "<string>" + ], + "culpa_a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ea9d": [ + "<string>", + "<string>" + ], + "ut_ead": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ad12f": [ + "<string>", + "<string>" + ] + }, + "links": { + "adipisicinge8": "<string>" + } + } + put: + tags: + - HubDb API > Rows + summary: Replaces an existing row + description: >- + Replace a single row in the table's `draft` version. + + All the column values must be specified. If a column has a value in the + target table and this request doesn't define that value, it will be + deleted. + + See the `Create a row` endpoint for instructions on how to format the + JSON row definitions. + requestBody: + content: + application/json: + schema: + type: object + example: + values: + velite: {} + path: <string> + name: <string> + childTableId: <long> + displayIndex: <integer> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: tableIdOrName + in: path + schema: + type: string + required: true + example: <string> + - name: rowId + in: path + schema: + type: integer + required: true + example: '259' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + values: + eu_c_5: {} + cupidatat1c2: {} + id: <string> + path: <string> + name: <string> + childTableId: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + publishedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "incididunt7": [ + "<string>", + "<string>" + ], + "doloref": [ + "<string>", + "<string>" + ], + "culpa_a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ea9d": [ + "<string>", + "<string>" + ], + "ut_ead": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ad12f": [ + "<string>", + "<string>" + ] + }, + "links": { + "adipisicinge8": "<string>" + } + } + delete: + tags: + - HubDb API > Rows + summary: Permanently deletes a row + description: Permanently deletes a row from a table's `draft` version. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: tableIdOrName + in: path + schema: + type: string + required: true + example: <string> + - name: rowId + in: path + schema: + type: integer + required: true + example: '259' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "incididunt7": [ + "<string>", + "<string>" + ], + "doloref": [ + "<string>", + "<string>" + ], + "culpa_a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ea9d": [ + "<string>", + "<string>" + ], + "ut_ead": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ad12f": [ + "<string>", + "<string>" + ] + }, + "links": { + "adipisicinge8": "<string>" + } + } + patch: + tags: + - HubDb API > Rows + summary: Updates an existing row + description: >- + Sparse updates a single row in the table's `draft` version. + + All the column values need not be specified. Only the columns or fields + that needs to be modified can be specified. + + See the `Create a row` endpoint for instructions on how to format the + JSON row definitions. + requestBody: + content: + application/json: + schema: + type: object + example: + values: + velite: {} + path: <string> + name: <string> + childTableId: <long> + displayIndex: <integer> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: tableIdOrName + in: path + schema: + type: string + required: true + example: <string> + - name: rowId + in: path + schema: + type: integer + required: true + example: '259' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + values: + eu_c_5: {} + cupidatat1c2: {} + id: <string> + path: <string> + name: <string> + childTableId: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + publishedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "incididunt7": [ + "<string>", + "<string>" + ], + "doloref": [ + "<string>", + "<string>" + ], + "culpa_a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ea9d": [ + "<string>", + "<string>" + ], + "ut_ead": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ad12f": [ + "<string>", + "<string>" + ] + }, + "links": { + "adipisicinge8": "<string>" + } + } + /cms/v3/hubdb/tables/{tableIdOrName}/rows: + get: + tags: + - HubDb API > Rows + summary: Get rows for a table + description: >- + Returns a set of rows in the `published` version of the specified table. + Row results can be filtered and sorted. Filtering and sorting options + will be sent as query parameters to the API request. For example, by + adding the query parameters `column1__gt=5&sort=-column1`, API returns + the rows with values for column `column1` greater than 5 and in the + descending order of `column1` values. Refer to the [overview + section](https://developers.hubspot.com/docs/api/cms/hubdb#filtering-and-sorting-table-rows) + for detailed filtering and sorting options. + + **Note:** This endpoint can be accessed without any authentication, if + the table is set to be allowed for public access. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: sort + in: query + schema: + type: string + description: >- + Specifies the column names to sort the results by. See the above + description for more details. + example: <string> + - name: sort + in: query + schema: + type: string + description: >- + Specifies the column names to sort the results by. See the above + description for more details. + example: <string> + - name: after + in: query + schema: + type: string + description: >- + The cursor token value to get the next set of results. You can get + this from the `paging.next.after` JSON property of a paged response + containing more results. + example: <string> + - name: limit + in: query + schema: + type: string + description: The maximum number of results to return. Default is `1000`. + example: <integer> + - name: properties + in: query + schema: + type: string + description: >- + Specify the column names to get results containing only the required + columns instead of all column details. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + Specify the column names to get results containing only the required + columns instead of all column details. + example: <string> + - name: offset + in: query + schema: + type: string + example: <integer> + - name: archived + in: query + schema: + type: string + example: <boolean> + - name: tableIdOrName + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - values: + velit683: {} + qui_ff7: {} + id: <string> + path: <string> + name: <string> + childTableId: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + publishedAt: <dateTime> + - values: + culpab: {} + sed79d: {} + id: <string> + path: <string> + name: <string> + childTableId: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + publishedAt: <dateTime> + total: <integer> + paging: + next: + after: <string> + link: <string> + offset: <integer> + type: RANDOM_ACCESS + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "incididunt7": [ + "<string>", + "<string>" + ], + "doloref": [ + "<string>", + "<string>" + ], + "culpa_a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ea9d": [ + "<string>", + "<string>" + ], + "ut_ead": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ad12f": [ + "<string>", + "<string>" + ] + }, + "links": { + "adipisicinge8": "<string>" + } + } + post: + tags: + - HubDb API > Rows + summary: Add a new row to a table + description: >- + Add a new row to a HubDB table. New rows will be added to the `draft` + version of the table. Use `publish` endpoint to push these changes to + published version. + requestBody: + content: + application/json: + schema: + type: object + example: + values: + velite: {} + path: <string> + name: <string> + childTableId: <long> + displayIndex: <integer> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: tableIdOrName + in: path + schema: + type: string + required: true + example: <string> + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + values: + eu_c_5: {} + cupidatat1c2: {} + id: <string> + path: <string> + name: <string> + childTableId: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + publishedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "incididunt7": [ + "<string>", + "<string>" + ], + "doloref": [ + "<string>", + "<string>" + ], + "culpa_a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ea9d": [ + "<string>", + "<string>" + ], + "ut_ead": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ad12f": [ + "<string>", + "<string>" + ] + }, + "links": { + "adipisicinge8": "<string>" + } + } + /cms/v3/hubdb/tables/{tableIdOrName}/rows/draft/batch/replace: + post: + tags: + - HubDb API > Rows Batch + summary: Replace rows in batch in draft table + description: >- + Replaces multiple rows as a batch in the `draft` version of the table, + with a maximum of 100 rows per call. See the endpoint `PUT + /tables/{tableIdOrName}/rows/{rowId}/draft` for details on updating a + single row. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + values: + dobe: {} + path: <string> + name: <string> + childTableId: <integer> + displayIndex: <integer> + - id: <string> + values: + utf: {} + Lorem7de: {} + exercitationf44: {} + est__be: {} + path: <string> + name: <string> + childTableId: <integer> + displayIndex: <integer> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: tableIdOrName + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + status: PENDING + results: + - values: + ade4: {} + id: <string> + path: <string> + name: <string> + childTableId: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + publishedAt: <dateTime> + - values: + Lorem_495: {} + id: <string> + path: <string> + name: <string> + childTableId: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + publishedAt: <dateTime> + requestedAt: <dateTime> + startedAt: <dateTime> + completedAt: <dateTime> + links: + dolore_f85: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - values: + consequat82b: {} + id: <string> + path: <string> + name: <string> + childTableId: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + publishedAt: <dateTime> + - values: + ametad: {} + id: <string> + path: <string> + name: <string> + childTableId: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + publishedAt: <dateTime> + startedAt: <dateTime> + status: COMPLETE + numErrors: <integer> + errors: + - category: <string> + context: + labore_7: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + consequata20: + - <string> + - <string> + veniam91b: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + quisc2e: + - <string> + - <string> + links: + sint_4: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + doc: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + exercitation_5f: + - <string> + - <string> + cupidatat_02: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + non0: + - <string> + - <string> + ete0b: + - <string> + - <string> + links: + cillum62: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + sed_f33: <string> + laborumd62: <string> + irurea_: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "incididunt7": [ + "<string>", + "<string>" + ], + "doloref": [ + "<string>", + "<string>" + ], + "culpa_a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ea9d": [ + "<string>", + "<string>" + ], + "ut_ead": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ad12f": [ + "<string>", + "<string>" + ] + }, + "links": { + "adipisicinge8": "<string>" + } + } + /cms/v3/hubdb/tables/{tableIdOrName}/rows/draft/batch/purge: + post: + tags: + - HubDb API > Rows Batch + summary: Permanently deletes rows + description: >- + Permanently deletes rows from the `draft` version of the table, given a + set of row ids. Maximum of 100 row ids per call. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - <string> + - <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: tableIdOrName + in: path + schema: + type: string + required: true + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "incididunt7": [ + "<string>", + "<string>" + ], + "doloref": [ + "<string>", + "<string>" + ], + "culpa_a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ea9d": [ + "<string>", + "<string>" + ], + "ut_ead": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ad12f": [ + "<string>", + "<string>" + ] + }, + "links": { + "adipisicinge8": "<string>" + } + } + /cms/v3/hubdb/tables/{tableIdOrName}/rows/batch/read: + post: + tags: + - HubDb API > Rows Batch + summary: Get a set of rows + description: >- + Returns rows in the `published` version of the specified table, given a + set of row ids. + + **Note:** This endpoint can be accessed without any authentication if + the table is set to be allowed for public access. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - <string> + - <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: tableIdOrName + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + status: PENDING + results: + - values: + ade4: {} + id: <string> + path: <string> + name: <string> + childTableId: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + publishedAt: <dateTime> + - values: + Lorem_495: {} + id: <string> + path: <string> + name: <string> + childTableId: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + publishedAt: <dateTime> + requestedAt: <dateTime> + startedAt: <dateTime> + completedAt: <dateTime> + links: + dolore_f85: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - values: + consequat82b: {} + id: <string> + path: <string> + name: <string> + childTableId: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + publishedAt: <dateTime> + - values: + ametad: {} + id: <string> + path: <string> + name: <string> + childTableId: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + publishedAt: <dateTime> + startedAt: <dateTime> + status: COMPLETE + numErrors: <integer> + errors: + - category: <string> + context: + labore_7: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + consequata20: + - <string> + - <string> + veniam91b: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + quisc2e: + - <string> + - <string> + links: + sint_4: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + doc: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + exercitation_5f: + - <string> + - <string> + cupidatat_02: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + non0: + - <string> + - <string> + ete0b: + - <string> + - <string> + links: + cillum62: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + sed_f33: <string> + laborumd62: <string> + irurea_: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "incididunt7": [ + "<string>", + "<string>" + ], + "doloref": [ + "<string>", + "<string>" + ], + "culpa_a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ea9d": [ + "<string>", + "<string>" + ], + "ut_ead": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ad12f": [ + "<string>", + "<string>" + ] + }, + "links": { + "adipisicinge8": "<string>" + } + } + /cms/v3/hubdb/tables/{tableIdOrName}/rows/draft/batch/create: + post: + tags: + - HubDb API > Rows Batch + summary: Create rows in batch + description: >- + Creates rows in the `draft` version of the specified table, given an + array of row objects. Maximum of 100 row object per call. See the + overview section for more details with an example. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - values: + veniamefb: {} + utd5: {} + path: <string> + name: <string> + childTableId: <long> + displayIndex: <integer> + - values: + sunt5: {} + path: <string> + name: <string> + childTableId: <long> + displayIndex: <integer> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: tableIdOrName + in: path + schema: + type: string + required: true + example: <string> + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + status: PENDING + results: + - values: + ade4: {} + id: <string> + path: <string> + name: <string> + childTableId: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + publishedAt: <dateTime> + - values: + Lorem_495: {} + id: <string> + path: <string> + name: <string> + childTableId: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + publishedAt: <dateTime> + requestedAt: <dateTime> + startedAt: <dateTime> + completedAt: <dateTime> + links: + dolore_f85: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - values: + consequat82b: {} + id: <string> + path: <string> + name: <string> + childTableId: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + publishedAt: <dateTime> + - values: + ametad: {} + id: <string> + path: <string> + name: <string> + childTableId: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + publishedAt: <dateTime> + startedAt: <dateTime> + status: COMPLETE + numErrors: <integer> + errors: + - category: <string> + context: + labore_7: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + consequata20: + - <string> + - <string> + veniam91b: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + quisc2e: + - <string> + - <string> + links: + sint_4: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + doc: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + exercitation_5f: + - <string> + - <string> + cupidatat_02: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + non0: + - <string> + - <string> + ete0b: + - <string> + - <string> + links: + cillum62: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + sed_f33: <string> + laborumd62: <string> + irurea_: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "incididunt7": [ + "<string>", + "<string>" + ], + "doloref": [ + "<string>", + "<string>" + ], + "culpa_a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ea9d": [ + "<string>", + "<string>" + ], + "ut_ead": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ad12f": [ + "<string>", + "<string>" + ] + }, + "links": { + "adipisicinge8": "<string>" + } + } + /cms/v3/hubdb/tables/{tableIdOrName}/rows/draft/batch/read: + post: + tags: + - HubDb API > Rows Batch + summary: Get a set of rows from draft table + description: >- + Returns rows in the `draft` version of the specified table, given a set + of row ids. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - <string> + - <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: tableIdOrName + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + status: PENDING + results: + - values: + ade4: {} + id: <string> + path: <string> + name: <string> + childTableId: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + publishedAt: <dateTime> + - values: + Lorem_495: {} + id: <string> + path: <string> + name: <string> + childTableId: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + publishedAt: <dateTime> + requestedAt: <dateTime> + startedAt: <dateTime> + completedAt: <dateTime> + links: + dolore_f85: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - values: + consequat82b: {} + id: <string> + path: <string> + name: <string> + childTableId: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + publishedAt: <dateTime> + - values: + ametad: {} + id: <string> + path: <string> + name: <string> + childTableId: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + publishedAt: <dateTime> + startedAt: <dateTime> + status: COMPLETE + numErrors: <integer> + errors: + - category: <string> + context: + labore_7: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + consequata20: + - <string> + - <string> + veniam91b: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + quisc2e: + - <string> + - <string> + links: + sint_4: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + doc: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + exercitation_5f: + - <string> + - <string> + cupidatat_02: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + non0: + - <string> + - <string> + ete0b: + - <string> + - <string> + links: + cillum62: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + sed_f33: <string> + laborumd62: <string> + irurea_: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "incididunt7": [ + "<string>", + "<string>" + ], + "doloref": [ + "<string>", + "<string>" + ], + "culpa_a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ea9d": [ + "<string>", + "<string>" + ], + "ut_ead": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ad12f": [ + "<string>", + "<string>" + ] + }, + "links": { + "adipisicinge8": "<string>" + } + } + /cms/v3/hubdb/tables/{tableIdOrName}/rows/draft/batch/clone: + post: + tags: + - HubDb API > Rows Batch + summary: Clone rows in batch + description: >- + Clones rows in the `draft` version of the specified table, given a set + of row ids. Maximum of 100 row ids per call. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + name: <string> + - id: <string> + name: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: tableIdOrName + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + status: PENDING + results: + - values: + ade4: {} + id: <string> + path: <string> + name: <string> + childTableId: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + publishedAt: <dateTime> + - values: + Lorem_495: {} + id: <string> + path: <string> + name: <string> + childTableId: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + publishedAt: <dateTime> + requestedAt: <dateTime> + startedAt: <dateTime> + completedAt: <dateTime> + links: + dolore_f85: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "incididunt7": [ + "<string>", + "<string>" + ], + "doloref": [ + "<string>", + "<string>" + ], + "culpa_a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ea9d": [ + "<string>", + "<string>" + ], + "ut_ead": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ad12f": [ + "<string>", + "<string>" + ] + }, + "links": { + "adipisicinge8": "<string>" + } + } + /cms/v3/hubdb/tables/{tableIdOrName}/rows/draft/batch/update: + post: + tags: + - HubDb API > Rows Batch + summary: Update rows in batch in draft table + description: >- + Updates multiple rows as a batch in the `draft` version of the table, + with a maximum of 100 rows per call. See the endpoint `PATCH + /tables/{tableIdOrName}/rows/{rowId}/draft` for details on updating a + single row. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + values: + dobe: {} + path: <string> + name: <string> + childTableId: <integer> + displayIndex: <integer> + - id: <string> + values: + utf: {} + Lorem7de: {} + exercitationf44: {} + est__be: {} + path: <string> + name: <string> + childTableId: <integer> + displayIndex: <integer> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: tableIdOrName + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + status: PENDING + results: + - values: + ade4: {} + id: <string> + path: <string> + name: <string> + childTableId: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + publishedAt: <dateTime> + - values: + Lorem_495: {} + id: <string> + path: <string> + name: <string> + childTableId: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + publishedAt: <dateTime> + requestedAt: <dateTime> + startedAt: <dateTime> + completedAt: <dateTime> + links: + dolore_f85: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - values: + consequat82b: {} + id: <string> + path: <string> + name: <string> + childTableId: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + publishedAt: <dateTime> + - values: + ametad: {} + id: <string> + path: <string> + name: <string> + childTableId: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + publishedAt: <dateTime> + startedAt: <dateTime> + status: COMPLETE + numErrors: <integer> + errors: + - category: <string> + context: + labore_7: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + consequata20: + - <string> + - <string> + veniam91b: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + quisc2e: + - <string> + - <string> + links: + sint_4: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + doc: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + exercitation_5f: + - <string> + - <string> + cupidatat_02: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + non0: + - <string> + - <string> + ete0b: + - <string> + - <string> + links: + cillum62: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + sed_f33: <string> + laborumd62: <string> + irurea_: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "incididunt7": [ + "<string>", + "<string>" + ], + "doloref": [ + "<string>", + "<string>" + ], + "culpa_a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ea9d": [ + "<string>", + "<string>" + ], + "ut_ead": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ad12f": [ + "<string>", + "<string>" + ] + }, + "links": { + "adipisicinge8": "<string>" + } + } + /cms/v3/pages/site-pages/{objectId}/revisions/{revisionId}: + get: + tags: + - Pages API > Site Pages + summary: Retrieves a previous version of a Site Page + description: Retrieves a previous version of a Site Page + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: objectId + in: path + schema: + type: string + required: true + example: <string> + - name: revisionId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + id: <string> + object: + abStatus: variant + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - do3: {} + aliqua_5: {} + - aliqua9: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '3' + created: <dateTime> + createdById: <string> + currentState: AUTOMATED_AB + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: sw + layoutSections: + esse8_: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + consequat_ce5: {} + adipisicing_0: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - occaecat831: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + elitf8: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + enim0e: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - consectetur6e2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + sitd: {} + quis_b15: {} + inf: {} + Ut_4ec: {} + translatedFromId: <string> + translations: + id_fe: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + fugiat_e6: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + nisi_9: {} + widgets: + Lorem_7: {} + in_90: {} + updatedAt: <dateTime> + user: + email: <string> + fullName: <string> + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/site-pages/batch/update: + post: + tags: + - Pages API > Site Pages + summary: Update a batch of Site Pages + description: Update the Site Page objects identified in the request body. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: [] + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: string + description: Specifies whether to update deleted Site Pages. Defaults to `false`. + example: <boolean> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - abStatus: master + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - nostrud_41: {} + minim89: {} + - adipisicing_e05: {} + tempor_eb7: {} + amet_6: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '10' + created: <dateTime> + createdById: <string> + currentState: PROCESSING + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: es + layoutSections: + ullamco21: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + in_3: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - Lorem_e: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - dolore7: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + laborisf3d: {} + cillum4: {} + reprehenderit7: {} + translatedFromId: <string> + translations: + dolor_b2a: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + laborum9: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + ut_4e4: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + sit_dbc: {} + voluptate18: {} + widgets: + cupidatat_3: {} + - abStatus: automated_loser_variant + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - cillumc: {} + - labore_22: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '3' + created: <dateTime> + createdById: <string> + currentState: AUTOMATED_AB + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: gu-in + layoutSections: + cillum_9: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + sit8: {} + enim_2: {} + amet19: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - ex_7ec: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + enim_866: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - aliquip_7: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + enim_ba: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + idf5: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + id_8b: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - veniam_cc2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + quis_67: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + laborum_272: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - occaecat1: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + aute7f: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + sed406: {} + translatedFromId: <string> + translations: + amet_b32: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + dolor_65: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + nostrude: {} + sit_2bf: {} + widgets: + ut_0e: {} + eu2: {} + startedAt: <dateTime> + status: PROCESSING + requestedAt: <dateTime> + links: + Lorem05: <string> + Ut_6: <string> + in_1: <string> + nostrud7d8: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - abStatus: automated_loser_variant + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - occaecat9: {} + - labore_f0: {} + nonec: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '3' + created: <dateTime> + createdById: <string> + currentState: PUBLISHED_OR_SCHEDULED + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: kln-ke + layoutSections: + eiusmodb: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + consectetur6c: {} + mollit_0c: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - cillum_d: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + irurefd: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - reprehenderit_1: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + commodo_6: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + velit__: {} + aliqua_b6: {} + pariatureb3: {} + translatedFromId: <string> + translations: + tempor_b: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + sunte45: {} + cillumf: {} + widgets: + animf9: {} + - abStatus: mab_variant + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - in_b7: {} + - Excepteur6_: {} + mollita89: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '5' + created: <dateTime> + createdById: <string> + currentState: SCHEDULED + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: fr-ga + layoutSections: + officiadb5: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + ex_48: {} + id1: {} + dolore_5: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - ipsum0: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - in5d: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cillum_55: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + exercitationb77: {} + dolorea3: {} + labore_8: {} + sunt0b: {} + translatedFromId: <string> + translations: + esse_3: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + est_05: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + ipsum_2: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + tempor_2b1: {} + eu_f8: {} + widgets: + ex_f: {} + nonb8_: {} + do9d: {} + fugiat_31: {} + startedAt: <dateTime> + status: PENDING + numErrors: <integer> + errors: + - category: <string> + context: + veniam921: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + culpa_cd: + - <string> + - <string> + exd3a: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + ut_31: + - <string> + - <string> + cillum_ef: + - <string> + - <string> + links: + quis_e: <string> + dolore_b6: <string> + Duis_3: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + do_a3b: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + et_7c: + - <string> + - <string> + nullaaa: + - <string> + - <string> + ex75_: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + voluptate_049: + - <string> + - <string> + links: + utc: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + amet_ae: <string> + Excepteur_5e: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/site-pages/{objectId}/revisions/{revisionId}/restore: + post: + tags: + - Pages API > Site Pages + summary: Restore a previous version of a Site Page + description: Takes a specified version of a Site Page and restores it. + requestBody: + content: {} + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: objectId + in: path + schema: + type: string + required: true + example: <string> + - name: revisionId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + abStatus: mab_master + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - ullamcob2: {} + mollitf5: {} + officia_96: {} + nonf4: {} + - pariatur7d: {} + quis45: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '5' + created: <dateTime> + createdById: <string> + currentState: DRAFT_AB_VARIANT + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: fr + layoutSections: + irure_d_: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + elit_b: {} + in5d: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - consequat4: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - veniam64e: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + minim1: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + proident8a: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + sint_df4: {} + consectetur_ec: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - in_6a: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cupidatat8a2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + nullaf: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - sint_b5: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + exercitation_7d0: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + ea2c: {} + ea_d5: {} + translatedFromId: <string> + translations: + ex_2f: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + Duis_2: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + in1: {} + Excepteur4: {} + voluptate72: {} + adipisicing__4: {} + deserunt_6f3: {} + widgets: + mollitd8: {} + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/site-pages/schedule: + post: + tags: + - Pages API > Site Pages + summary: Schedule a Site Page to be Published + description: Schedule a Site Page to be Published + requestBody: + content: + application/json: + schema: + type: object + example: + id: <string> + publishDate: <dateTime> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/site-pages/multi-language/attach-to-lang-group: + post: + tags: + - Pages API > Site Pages + summary: Attach a site page to a multi-language group + description: Attach a site page to a multi-language group. + requestBody: + content: + application/json: + schema: + type: object + example: + id: <string> + language: <string> + primaryId: <string> + primaryLanguage: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '200': + description: OK + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/site-pages/multi-language/detach-from-lang-group: + post: + tags: + - Pages API > Site Pages + summary: Detach a site page from a multi-language group + description: Detach a site page from a multi-language group. + requestBody: + content: + application/json: + schema: + type: object + example: + id: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '200': + description: OK + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/site-pages/{objectId}/revisions: + get: + tags: + - Pages API > Site Pages + summary: Retrieves all the previous versions of a Site Page + description: Retrieves all the previous versions of a Site Page. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: after + in: query + schema: + type: string + description: >- + The cursor token value to get the next set of results. You can get + this from the `paging.next.after` JSON property of a paged response + containing more results. + example: <string> + - name: before + in: query + schema: + type: string + example: <string> + - name: limit + in: query + schema: + type: string + description: The maximum number of results to return. Default is 100. + example: <integer> + - name: objectId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - id: <string> + object: + abStatus: master + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - pariatur210: {} + aliqua_5ee: {} + - consequat4: {} + consequatb: {} + eu3b: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '4' + created: <dateTime> + createdById: <string> + currentState: AUTOMATED + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: fr-fr + layoutSections: + in7: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + Lorem_0: {} + proident_cb: {} + sunt_6: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - ut494: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + laborum_c4: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - nulla9: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + Lorem_0d: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + occaecat__57: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - Duis_d: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + aliquip_5: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - Ut4c: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + ipsum_9ce: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + sit_1: {} + dolore1: {} + translatedFromId: <string> + translations: + magna18: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + consectetur_c_4: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + eiusmod_c: {} + anim_b: {} + widgets: + magna_5: {} + ullamcod64: {} + updatedAt: <dateTime> + user: + email: <string> + fullName: <string> + id: <string> + - id: <string> + object: + abStatus: mab_master + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - officia21: {} + - mollitc: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '2' + created: <dateTime> + createdById: <string> + currentState: SCHEDULED + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: is + layoutSections: + ut_3: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + dolorebd: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - dolor92: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + ullamco_46: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + in1: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - do_c: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + Ut4c5: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + ipsum_fd9: {} + eiusmod_d: {} + consequat_86: {} + reprehenderit_dc8: {} + fugiat_62_: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - Excepteur_28d: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + ut30: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - occaecat_c7: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + eu_3: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + ute: {} + nisi_a: {} + translatedFromId: <string> + translations: + sunt_0f: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + quis_98: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + consequat_8a: {} + eiusmod2: {} + amet__: {} + widgets: + adf91: {} + in2b3: {} + updatedAt: <dateTime> + user: + email: <string> + fullName: <string> + id: <string> + total: <integer> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/site-pages/{objectId}/revisions/{revisionId}/restore-to-draft: + post: + tags: + - Pages API > Site Pages + summary: >- + Restore a previous version of a Site Page, to the draft version of the + Site Page + description: >- + Takes a specified version of a Site Page, sets it as the new draft + version of the Site Page. + requestBody: + content: {} + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: objectId + in: path + schema: + type: string + required: true + example: <string> + - name: revisionId + in: path + schema: + type: string + required: true + example: <long> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + abStatus: mab_master + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - ullamcob2: {} + mollitf5: {} + officia_96: {} + nonf4: {} + - pariatur7d: {} + quis45: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '5' + created: <dateTime> + createdById: <string> + currentState: DRAFT_AB_VARIANT + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: fr + layoutSections: + irure_d_: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + elit_b: {} + in5d: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - consequat4: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - veniam64e: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + minim1: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + proident8a: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + sint_df4: {} + consectetur_ec: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - in_6a: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cupidatat8a2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + nullaf: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - sint_b5: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + exercitation_7d0: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + ea2c: {} + ea_d5: {} + translatedFromId: <string> + translations: + ex_2f: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + Duis_2: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + in1: {} + Excepteur4: {} + voluptate72: {} + adipisicing__4: {} + deserunt_6f3: {} + widgets: + mollitd8: {} + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/site-pages/ab-test/end: + post: + tags: + - Pages API > Site Pages + summary: End an active A/B test + description: End an active A/B test and designate a winner. + requestBody: + content: + application/json: + schema: + type: object + example: + abTestId: <string> + winnerId: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/site-pages/{objectId}/draft: + get: + tags: + - Pages API > Site Pages + summary: Retrieve the full draft version of the Site Page + description: Retrieve the full draft version of the Site Page. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: objectId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + abStatus: mab_master + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - ullamcob2: {} + mollitf5: {} + officia_96: {} + nonf4: {} + - pariatur7d: {} + quis45: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '5' + created: <dateTime> + createdById: <string> + currentState: DRAFT_AB_VARIANT + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: fr + layoutSections: + irure_d_: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + elit_b: {} + in5d: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - consequat4: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - veniam64e: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + minim1: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + proident8a: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + sint_df4: {} + consectetur_ec: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - in_6a: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cupidatat8a2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + nullaf: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - sint_b5: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + exercitation_7d0: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + ea2c: {} + ea_d5: {} + translatedFromId: <string> + translations: + ex_2f: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + Duis_2: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + in1: {} + Excepteur4: {} + voluptate72: {} + adipisicing__4: {} + deserunt_6f3: {} + widgets: + mollitd8: {} + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + patch: + tags: + - Pages API > Site Pages + summary: Update a Site Page draft + description: > + Sparse updates the draft version of a single Site Page object identified + by the id in the path. + + You only need to specify the column values that you are modifying. + requestBody: + content: + application/json: + schema: + type: object + example: + abStatus: mab_master + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - ullamcob2: {} + mollitf5: {} + officia_96: {} + nonf4: {} + - pariatur7d: {} + quis45: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '5' + created: <dateTime> + createdById: <string> + currentState: DRAFT_AB_VARIANT + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: fr + layoutSections: + irure_d_: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + elit_b: {} + in5d: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - consequat4: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - veniam64e: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + minim1: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + proident8a: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + sint_df4: {} + consectetur_ec: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - in_6a: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cupidatat8a2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + nullaf: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - sint_b5: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + exercitation_7d0: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + ea2c: {} + ea_d5: {} + translatedFromId: <string> + translations: + ex_2f: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + Duis_2: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + in1: {} + Excepteur4: {} + voluptate72: {} + adipisicing__4: {} + deserunt_6f3: {} + widgets: + mollitd8: {} + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: objectId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + abStatus: mab_master + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - ullamcob2: {} + mollitf5: {} + officia_96: {} + nonf4: {} + - pariatur7d: {} + quis45: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '5' + created: <dateTime> + createdById: <string> + currentState: DRAFT_AB_VARIANT + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: fr + layoutSections: + irure_d_: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + elit_b: {} + in5d: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - consequat4: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - veniam64e: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + minim1: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + proident8a: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + sint_df4: {} + consectetur_ec: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - in_6a: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cupidatat8a2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + nullaf: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - sint_b5: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + exercitation_7d0: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + ea2c: {} + ea_d5: {} + translatedFromId: <string> + translations: + ex_2f: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + Duis_2: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + in1: {} + Excepteur4: {} + voluptate72: {} + adipisicing__4: {} + deserunt_6f3: {} + widgets: + mollitd8: {} + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/site-pages/batch/read: + post: + tags: + - Pages API > Site Pages + summary: Retrieve a batch of Site Pages + description: Retrieve the Site Page objects identified in the request body. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - <string> + - <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: string + description: Specifies whether to return deleted Site Pages. Defaults to `false`. + example: <boolean> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - abStatus: master + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - nostrud_41: {} + minim89: {} + - adipisicing_e05: {} + tempor_eb7: {} + amet_6: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '10' + created: <dateTime> + createdById: <string> + currentState: PROCESSING + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: es + layoutSections: + ullamco21: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + in_3: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - Lorem_e: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - dolore7: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + laborisf3d: {} + cillum4: {} + reprehenderit7: {} + translatedFromId: <string> + translations: + dolor_b2a: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + laborum9: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + ut_4e4: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + sit_dbc: {} + voluptate18: {} + widgets: + cupidatat_3: {} + - abStatus: automated_loser_variant + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - cillumc: {} + - labore_22: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '3' + created: <dateTime> + createdById: <string> + currentState: AUTOMATED_AB + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: gu-in + layoutSections: + cillum_9: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + sit8: {} + enim_2: {} + amet19: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - ex_7ec: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + enim_866: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - aliquip_7: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + enim_ba: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + idf5: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + id_8b: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - veniam_cc2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + quis_67: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + laborum_272: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - occaecat1: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + aute7f: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + sed406: {} + translatedFromId: <string> + translations: + amet_b32: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + dolor_65: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + nostrude: {} + sit_2bf: {} + widgets: + ut_0e: {} + eu2: {} + startedAt: <dateTime> + status: PROCESSING + requestedAt: <dateTime> + links: + Lorem05: <string> + Ut_6: <string> + in_1: <string> + nostrud7d8: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - abStatus: automated_loser_variant + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - occaecat9: {} + - labore_f0: {} + nonec: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '3' + created: <dateTime> + createdById: <string> + currentState: PUBLISHED_OR_SCHEDULED + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: kln-ke + layoutSections: + eiusmodb: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + consectetur6c: {} + mollit_0c: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - cillum_d: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + irurefd: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - reprehenderit_1: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + commodo_6: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + velit__: {} + aliqua_b6: {} + pariatureb3: {} + translatedFromId: <string> + translations: + tempor_b: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + sunte45: {} + cillumf: {} + widgets: + animf9: {} + - abStatus: mab_variant + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - in_b7: {} + - Excepteur6_: {} + mollita89: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '5' + created: <dateTime> + createdById: <string> + currentState: SCHEDULED + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: fr-ga + layoutSections: + officiadb5: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + ex_48: {} + id1: {} + dolore_5: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - ipsum0: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - in5d: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cillum_55: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + exercitationb77: {} + dolorea3: {} + labore_8: {} + sunt0b: {} + translatedFromId: <string> + translations: + esse_3: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + est_05: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + ipsum_2: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + tempor_2b1: {} + eu_f8: {} + widgets: + ex_f: {} + nonb8_: {} + do9d: {} + fugiat_31: {} + startedAt: <dateTime> + status: PENDING + numErrors: <integer> + errors: + - category: <string> + context: + veniam921: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + culpa_cd: + - <string> + - <string> + exd3a: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + ut_31: + - <string> + - <string> + cillum_ef: + - <string> + - <string> + links: + quis_e: <string> + dolore_b6: <string> + Duis_3: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + do_a3b: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + et_7c: + - <string> + - <string> + nullaaa: + - <string> + - <string> + ex75_: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + voluptate_049: + - <string> + - <string> + links: + utc: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + amet_ae: <string> + Excepteur_5e: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/site-pages: + get: + tags: + - Pages API > Site Pages + summary: Get all Site Pages + description: > + Get the list of site pages. Supports paging and filtering. This method + would be useful for an integration that examined these models and used + an external service to suggest edits. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: createdAt + in: query + schema: + type: string + description: Only return Site Pages created at exactly the specified time. + example: <dateTime> + - name: createdAfter + in: query + schema: + type: string + description: Only return Site Pages created after the specified time. + example: <dateTime> + - name: createdBefore + in: query + schema: + type: string + description: Only return Site Pages created before the specified time. + example: <dateTime> + - name: updatedAt + in: query + schema: + type: string + description: Only return Site Pages last updated at exactly the specified time. + example: <dateTime> + - name: updatedAfter + in: query + schema: + type: string + description: Only return Site Pages last updated after the specified time. + example: <dateTime> + - name: updatedBefore + in: query + schema: + type: string + description: Only return Site Pages last updated before the specified time. + example: <dateTime> + - name: sort + in: query + schema: + type: string + description: >- + Specifies which fields to use for sorting results. Valid fields are + `name`, `createdAt`, `updatedAt`, `createdBy`, `updatedBy`. + `createdAt` will be used by default. + example: <string> + - name: sort + in: query + schema: + type: string + description: >- + Specifies which fields to use for sorting results. Valid fields are + `name`, `createdAt`, `updatedAt`, `createdBy`, `updatedBy`. + `createdAt` will be used by default. + example: <string> + - name: after + in: query + schema: + type: string + description: >- + The cursor token value to get the next set of results. You can get + this from the `paging.next.after` JSON property of a paged response + containing more results. + example: <string> + - name: limit + in: query + schema: + type: string + description: The maximum number of results to return. Default is 100. + example: <integer> + - name: archived + in: query + schema: + type: string + description: Specifies whether to return deleted Site Pages. Defaults to `false`. + example: <boolean> + - name: property + in: query + schema: + type: string + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - abStatus: master + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - est0: {} + - commodo_adf: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '3' + created: <dateTime> + createdById: <string> + currentState: PAGE_STUB + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: ta-sg + layoutSections: + cillum61: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + ex_f8_: {} + amet_f: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - tempor_ae: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + labore02: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + consequat_8: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + nisi__f: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - amet_2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + eiusmod194: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + aliquip_1c1: {} + eu_ce: {} + mollit2_c: {} + translatedFromId: <string> + translations: + in_f5: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + consectetur49: {} + widgets: + ut_d5: {} + enim85d: {} + - abStatus: automated_master + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - sita6: {} + - esse_: {} + qui_b4: {} + Excepteur_2: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '8' + created: <dateTime> + createdById: <string> + currentState: DRAFT_AB + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: en-nu + layoutSections: + incididunt_fac: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + nisi_b: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - fugiat_6_f: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - proident_8a7: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + mollit6e: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + etca: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + reprehenderit853: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + dod92: {} + dolorbd: {} + laborum8e: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - laboris82: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + deserunt398: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + sed_d: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - amet_e92: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + enim02b: {} + incididunt73: {} + translatedFromId: <string> + translations: + eiusmod_e: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + sed4e: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + laborisf: {} + Ut_1b0: {} + nostrud_6_7: {} + widgets: + dolord38: {} + laborise9: {} + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + post: + tags: + - Pages API > Site Pages + summary: Create a new Site Page + description: Create a new Site Page + requestBody: + content: + application/json: + schema: + type: object + example: + abStatus: mab_master + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - ullamcob2: {} + mollitf5: {} + officia_96: {} + nonf4: {} + - pariatur7d: {} + quis45: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '5' + created: <dateTime> + createdById: <string> + currentState: DRAFT_AB_VARIANT + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: fr + layoutSections: + irure_d_: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + elit_b: {} + in5d: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - consequat4: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - veniam64e: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + minim1: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + proident8a: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + sint_df4: {} + consectetur_ec: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - in_6a: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cupidatat8a2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + nullaf: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - sint_b5: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + exercitation_7d0: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + ea2c: {} + ea_d5: {} + translatedFromId: <string> + translations: + ex_2f: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + Duis_2: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + in1: {} + Excepteur4: {} + voluptate72: {} + adipisicing__4: {} + deserunt_6f3: {} + widgets: + mollitd8: {} + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + content: + text/plain: + schema: + type: string + example: null + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + abStatus: mab_master + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - ullamcob2: {} + mollitf5: {} + officia_96: {} + nonf4: {} + - pariatur7d: {} + quis45: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '5' + created: <dateTime> + createdById: <string> + currentState: DRAFT_AB_VARIANT + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: fr + layoutSections: + irure_d_: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + elit_b: {} + in5d: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - consequat4: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - veniam64e: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + minim1: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + proident8a: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + sint_df4: {} + consectetur_ec: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - in_6a: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cupidatat8a2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + nullaf: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - sint_b5: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + exercitation_7d0: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + ea2c: {} + ea_d5: {} + translatedFromId: <string> + translations: + ex_2f: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + Duis_2: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + in1: {} + Excepteur4: {} + voluptate72: {} + adipisicing__4: {} + deserunt_6f3: {} + widgets: + mollitd8: {} + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/site-pages/multi-language/create-language-variation: + post: + tags: + - Pages API > Site Pages + summary: Create a new language variation + description: Create a new language variation from an existing site page + requestBody: + content: + application/json: + schema: + type: object + example: + id: <string> + language: <string> + primaryLanguage: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + abStatus: mab_master + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - ullamcob2: {} + mollitf5: {} + officia_96: {} + nonf4: {} + - pariatur7d: {} + quis45: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '5' + created: <dateTime> + createdById: <string> + currentState: DRAFT_AB_VARIANT + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: fr + layoutSections: + irure_d_: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + elit_b: {} + in5d: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - consequat4: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - veniam64e: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + minim1: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + proident8a: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + sint_df4: {} + consectetur_ec: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - in_6a: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cupidatat8a2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + nullaf: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - sint_b5: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + exercitation_7d0: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + ea2c: {} + ea_d5: {} + translatedFromId: <string> + translations: + ex_2f: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + Duis_2: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + in1: {} + Excepteur4: {} + voluptate72: {} + adipisicing__4: {} + deserunt_6f3: {} + widgets: + mollitd8: {} + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/site-pages/ab-test/create-variation: + post: + tags: + - Pages API > Site Pages + summary: Create a new A/B test variation + description: > + Create a new A/B test variation based on the information provided in the + request body. + requestBody: + content: + application/json: + schema: + type: object + example: + contentId: <string> + variationName: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + abStatus: mab_master + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - ullamcob2: {} + mollitf5: {} + officia_96: {} + nonf4: {} + - pariatur7d: {} + quis45: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '5' + created: <dateTime> + createdById: <string> + currentState: DRAFT_AB_VARIANT + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: fr + layoutSections: + irure_d_: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + elit_b: {} + in5d: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - consequat4: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - veniam64e: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + minim1: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + proident8a: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + sint_df4: {} + consectetur_ec: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - in_6a: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cupidatat8a2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + nullaf: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - sint_b5: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + exercitation_7d0: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + ea2c: {} + ea_d5: {} + translatedFromId: <string> + translations: + ex_2f: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + Duis_2: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + in1: {} + Excepteur4: {} + voluptate72: {} + adipisicing__4: {} + deserunt_6f3: {} + widgets: + mollitd8: {} + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/site-pages/multi-language/update-languages: + post: + tags: + - Pages API > Site Pages + summary: Update languages of multi-language group + description: >- + Explicitly set new languages for each site page in a multi-language + group. + requestBody: + content: + application/json: + schema: + type: object + example: + languages: + sint6ea: <string> + officiab8: <string> + nulla_40d: <string> + aliqua_5b3: <string> + et_e: <string> + primaryId: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '200': + description: OK + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/site-pages/batch/create: + post: + tags: + - Pages API > Site Pages + summary: Create a batch of Site Pages + description: Create the Site Page objects detailed in the request body. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - abStatus: mab_master + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - mollit03b: {} + laboris_d31: {} + cupidatat9a8: {} + - non53e: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '6' + created: <dateTime> + createdById: <string> + currentState: SCHEDULED_OR_PUBLISHED + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: dua-cm + layoutSections: + fugiat31: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + nostrud7c: {} + quis_d: {} + ut13: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - commodo_19: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - eiusmod84: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + consequat2: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + sit_cd: {} + consequat11e: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - enim_3: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + ea6: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + sit25a: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + voluptate3a: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - cilluma: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + exercitationd66: {} + elit572: {} + eu_84f: {} + translatedFromId: <string> + translations: + idc30: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + enim_5: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + deserunta: {} + widgets: + ut_c1: {} + - abStatus: variant + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - utd8c: {} + Lorem_ae8: {} + - anim_7: {} + sit_5: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '5' + created: <dateTime> + createdById: <string> + currentState: ERROR + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: ar-sa + layoutSections: + aute_bd: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + qui_646: {} + inf: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - enim__: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + irure_42b: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - sedc94: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cillum42: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + anim9ff: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + eaae: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + dolore0: {} + aliqua8d7: {} + sit_fc7: {} + translatedFromId: <string> + translations: + ipsum71: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + aute421: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + minim3: {} + sitd: {} + sint_: {} + est_0: {} + widgets: + anim_14: {} + incididuntf: {} + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - abStatus: master + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - nostrud_41: {} + minim89: {} + - adipisicing_e05: {} + tempor_eb7: {} + amet_6: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '10' + created: <dateTime> + createdById: <string> + currentState: PROCESSING + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: es + layoutSections: + ullamco21: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + in_3: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - Lorem_e: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - dolore7: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + laborisf3d: {} + cillum4: {} + reprehenderit7: {} + translatedFromId: <string> + translations: + dolor_b2a: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + laborum9: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + ut_4e4: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + sit_dbc: {} + voluptate18: {} + widgets: + cupidatat_3: {} + - abStatus: automated_loser_variant + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - cillumc: {} + - labore_22: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '3' + created: <dateTime> + createdById: <string> + currentState: AUTOMATED_AB + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: gu-in + layoutSections: + cillum_9: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + sit8: {} + enim_2: {} + amet19: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - ex_7ec: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + enim_866: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - aliquip_7: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + enim_ba: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + idf5: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + id_8b: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - veniam_cc2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + quis_67: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + laborum_272: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - occaecat1: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + aute7f: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + sed406: {} + translatedFromId: <string> + translations: + amet_b32: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + dolor_65: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + nostrude: {} + sit_2bf: {} + widgets: + ut_0e: {} + eu2: {} + startedAt: <dateTime> + status: PROCESSING + requestedAt: <dateTime> + links: + Lorem05: <string> + Ut_6: <string> + in_1: <string> + nostrud7d8: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - abStatus: automated_loser_variant + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - occaecat9: {} + - labore_f0: {} + nonec: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '3' + created: <dateTime> + createdById: <string> + currentState: PUBLISHED_OR_SCHEDULED + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: kln-ke + layoutSections: + eiusmodb: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + consectetur6c: {} + mollit_0c: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - cillum_d: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + irurefd: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - reprehenderit_1: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + commodo_6: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + velit__: {} + aliqua_b6: {} + pariatureb3: {} + translatedFromId: <string> + translations: + tempor_b: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + sunte45: {} + cillumf: {} + widgets: + animf9: {} + - abStatus: mab_variant + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - in_b7: {} + - Excepteur6_: {} + mollita89: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '5' + created: <dateTime> + createdById: <string> + currentState: SCHEDULED + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: fr-ga + layoutSections: + officiadb5: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + ex_48: {} + id1: {} + dolore_5: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - ipsum0: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - in5d: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cillum_55: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + exercitationb77: {} + dolorea3: {} + labore_8: {} + sunt0b: {} + translatedFromId: <string> + translations: + esse_3: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + est_05: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + ipsum_2: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + tempor_2b1: {} + eu_f8: {} + widgets: + ex_f: {} + nonb8_: {} + do9d: {} + fugiat_31: {} + startedAt: <dateTime> + status: PENDING + numErrors: <integer> + errors: + - category: <string> + context: + veniam921: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + culpa_cd: + - <string> + - <string> + exd3a: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + ut_31: + - <string> + - <string> + cillum_ef: + - <string> + - <string> + links: + quis_e: <string> + dolore_b6: <string> + Duis_3: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + do_a3b: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + et_7c: + - <string> + - <string> + nullaaa: + - <string> + - <string> + ex75_: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + voluptate_049: + - <string> + - <string> + links: + utc: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + amet_ae: <string> + Excepteur_5e: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/site-pages/batch/archive: + post: + tags: + - Pages API > Site Pages + summary: Delete a batch of Site Pages + description: >- + Delete the Site Page objects identified in the request body. + + Note: This is not the same as the dashboard `archive` function. To + perform a dashboard `archive` send an normal update with the + `archivedInDashboard` field set to true. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - <string> + - <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/site-pages/clone: + post: + tags: + - Pages API > Site Pages + summary: Clone a Site Page + description: Clone a Site Page + requestBody: + content: + application/json: + schema: + type: object + example: + id: <string> + cloneName: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + abStatus: mab_master + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - ullamcob2: {} + mollitf5: {} + officia_96: {} + nonf4: {} + - pariatur7d: {} + quis45: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '5' + created: <dateTime> + createdById: <string> + currentState: DRAFT_AB_VARIANT + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: fr + layoutSections: + irure_d_: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + elit_b: {} + in5d: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - consequat4: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - veniam64e: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + minim1: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + proident8a: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + sint_df4: {} + consectetur_ec: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - in_6a: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cupidatat8a2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + nullaf: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - sint_b5: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + exercitation_7d0: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + ea2c: {} + ea_d5: {} + translatedFromId: <string> + translations: + ex_2f: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + Duis_2: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + in1: {} + Excepteur4: {} + voluptate72: {} + adipisicing__4: {} + deserunt_6f3: {} + widgets: + mollitd8: {} + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/site-pages/multi-language/set-new-lang-primary: + put: + tags: + - Pages API > Site Pages + summary: Set a new primary language + description: Set a site page as the primary language of a multi-language group. + requestBody: + content: + application/json: + schema: + type: object + example: + id: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/site-pages/{objectId}/draft/push-live: + post: + tags: + - Pages API > Site Pages + summary: Push Site Page draft edits live + description: >- + Take any changes from the draft version of the Site Page and apply them + to the live version. + requestBody: + content: {} + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: objectId + in: path + schema: + type: string + required: true + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/site-pages/ab-test/rerun: + post: + tags: + - Pages API > Site Pages + summary: Rerun a previous A/B test + description: Rerun a previous A/B test. + requestBody: + content: + application/json: + schema: + type: object + example: + abTestId: <string> + variationId: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/site-pages/{objectId}/draft/reset: + post: + tags: + - Pages API > Site Pages + summary: Reset the Site Page draft to the live version + description: Discards any edits and resets the draft to the live version. + requestBody: + content: {} + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: objectId + in: path + schema: + type: string + required: true + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/site-pages/{objectId}: + get: + tags: + - Pages API > Site Pages + summary: Retrieve a Site Page + description: Retrieve the Site Page object identified by the id in the path. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: string + description: Specifies whether to return deleted Site Pages. Defaults to `false`. + example: <boolean> + - name: property + in: query + schema: + type: string + example: <string> + - name: objectId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + abStatus: mab_master + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - ullamcob2: {} + mollitf5: {} + officia_96: {} + nonf4: {} + - pariatur7d: {} + quis45: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '5' + created: <dateTime> + createdById: <string> + currentState: DRAFT_AB_VARIANT + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: fr + layoutSections: + irure_d_: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + elit_b: {} + in5d: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - consequat4: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - veniam64e: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + minim1: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + proident8a: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + sint_df4: {} + consectetur_ec: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - in_6a: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cupidatat8a2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + nullaf: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - sint_b5: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + exercitation_7d0: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + ea2c: {} + ea_d5: {} + translatedFromId: <string> + translations: + ex_2f: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + Duis_2: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + in1: {} + Excepteur4: {} + voluptate72: {} + adipisicing__4: {} + deserunt_6f3: {} + widgets: + mollitd8: {} + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + delete: + tags: + - Pages API > Site Pages + summary: Delete a Site Page + description: Delete the Site Page object identified by the id in the path. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: archived + in: query + schema: + type: string + description: Whether to return only results that have been archived. + example: <boolean> + - name: objectId + in: path + schema: + type: string + required: true + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + patch: + tags: + - Pages API > Site Pages + summary: Update a Site Page + description: > + Sparse updates a single Site Page object identified by the id in the + path. + + You only need to specify the column values that you are modifying. + requestBody: + content: + application/json: + schema: + type: object + example: + abStatus: mab_master + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - ullamcob2: {} + mollitf5: {} + officia_96: {} + nonf4: {} + - pariatur7d: {} + quis45: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '5' + created: <dateTime> + createdById: <string> + currentState: DRAFT_AB_VARIANT + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: fr + layoutSections: + irure_d_: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + elit_b: {} + in5d: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - consequat4: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - veniam64e: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + minim1: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + proident8a: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + sint_df4: {} + consectetur_ec: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - in_6a: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cupidatat8a2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + nullaf: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - sint_b5: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + exercitation_7d0: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + ea2c: {} + ea_d5: {} + translatedFromId: <string> + translations: + ex_2f: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + Duis_2: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + in1: {} + Excepteur4: {} + voluptate72: {} + adipisicing__4: {} + deserunt_6f3: {} + widgets: + mollitd8: {} + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: string + description: Specifies whether to update deleted Site Pages. Defaults to `false`. + example: <boolean> + - name: objectId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + abStatus: mab_master + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - ullamcob2: {} + mollitf5: {} + officia_96: {} + nonf4: {} + - pariatur7d: {} + quis45: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '5' + created: <dateTime> + createdById: <string> + currentState: DRAFT_AB_VARIANT + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: fr + layoutSections: + irure_d_: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + elit_b: {} + in5d: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - consequat4: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - veniam64e: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + minim1: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + proident8a: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + sint_df4: {} + consectetur_ec: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - in_6a: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cupidatat8a2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + nullaf: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - sint_b5: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + exercitation_7d0: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + ea2c: {} + ea_d5: {} + translatedFromId: <string> + translations: + ex_2f: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + Duis_2: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + in1: {} + Excepteur4: {} + voluptate72: {} + adipisicing__4: {} + deserunt_6f3: {} + widgets: + mollitd8: {} + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/landing-pages/{objectId}/revisions: + get: + tags: + - Pages API > Landing Pages + summary: Retrieves all the previous versions of a Landing Page + description: Retrieves all the previous versions of a Landing Page. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: after + in: query + schema: + type: string + description: >- + The cursor token value to get the next set of results. You can get + this from the `paging.next.after` JSON property of a paged response + containing more results. + example: <string> + - name: before + in: query + schema: + type: string + example: <string> + - name: limit + in: query + schema: + type: string + description: The maximum number of results to return. Default is 100. + example: <integer> + - name: objectId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - id: <string> + object: + abStatus: master + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - pariatur210: {} + aliqua_5ee: {} + - consequat4: {} + consequatb: {} + eu3b: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '4' + created: <dateTime> + createdById: <string> + currentState: AUTOMATED + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: fr-fr + layoutSections: + in7: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + Lorem_0: {} + proident_cb: {} + sunt_6: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - ut494: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + laborum_c4: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - nulla9: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + Lorem_0d: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + occaecat__57: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - Duis_d: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + aliquip_5: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - Ut4c: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + ipsum_9ce: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + sit_1: {} + dolore1: {} + translatedFromId: <string> + translations: + magna18: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + consectetur_c_4: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + eiusmod_c: {} + anim_b: {} + widgets: + magna_5: {} + ullamcod64: {} + updatedAt: <dateTime> + user: + email: <string> + fullName: <string> + id: <string> + - id: <string> + object: + abStatus: mab_master + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - officia21: {} + - mollitc: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '2' + created: <dateTime> + createdById: <string> + currentState: SCHEDULED + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: is + layoutSections: + ut_3: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + dolorebd: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - dolor92: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + ullamco_46: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + in1: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - do_c: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + Ut4c5: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + ipsum_fd9: {} + eiusmod_d: {} + consequat_86: {} + reprehenderit_dc8: {} + fugiat_62_: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - Excepteur_28d: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + ut30: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - occaecat_c7: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + eu_3: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + ute: {} + nisi_a: {} + translatedFromId: <string> + translations: + sunt_0f: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + quis_98: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + consequat_8a: {} + eiusmod2: {} + amet__: {} + widgets: + adf91: {} + in2b3: {} + updatedAt: <dateTime> + user: + email: <string> + fullName: <string> + id: <string> + total: <integer> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/landing-pages/folders/{objectId}/revisions: + get: + tags: + - Pages API > Landing Pages + summary: Retrieves all the previous versions of a Folder + description: Retrieves all the previous versions of a Folder. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: after + in: query + schema: + type: string + description: >- + The cursor token value to get the next set of results. You can get + this from the `paging.next.after` JSON property of a paged response + containing more results. + example: <string> + - name: before + in: query + schema: + type: string + example: <string> + - name: limit + in: query + schema: + type: string + description: The maximum number of results to return. Default is 100. + example: <integer> + - name: objectId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - id: <string> + object: + category: <integer> + created: <dateTime> + deletedAt: <dateTime> + id: <string> + name: <string> + parentFolderId: <long> + updated: <dateTime> + updatedAt: <dateTime> + user: + email: <string> + fullName: <string> + id: <string> + - id: <string> + object: + category: <integer> + created: <dateTime> + deletedAt: <dateTime> + id: <string> + name: <string> + parentFolderId: <long> + updated: <dateTime> + updatedAt: <dateTime> + user: + email: <string> + fullName: <string> + id: <string> + total: <integer> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/landing-pages/folders: + get: + tags: + - Pages API > Landing Pages + summary: Get all Landing Page Folders + description: > + Get the list of Landing Page Folders. Supports paging and filtering. + This method would be useful for an integration that examined these + models and used an external service to suggest edits. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: createdAt + in: query + schema: + type: string + description: Only return Folders created at exactly the specified time. + example: <dateTime> + - name: createdAfter + in: query + schema: + type: string + description: Only return Folders created after the specified time. + example: <dateTime> + - name: createdBefore + in: query + schema: + type: string + description: Only return Folders created before the specified time. + example: <dateTime> + - name: updatedAt + in: query + schema: + type: string + description: Only return Folders last updated at exactly the specified time. + example: <dateTime> + - name: updatedAfter + in: query + schema: + type: string + description: Only return Folders last updated after the specified time. + example: <dateTime> + - name: updatedBefore + in: query + schema: + type: string + description: Only return Folders last updated before the specified time. + example: <dateTime> + - name: sort + in: query + schema: + type: string + description: >- + Specifies which fields to use for sorting results. Valid fields are + `name`, `createdAt`, `updatedAt`, `createdBy`, `updatedBy`. + `createdAt` will be used by default. + example: <string> + - name: sort + in: query + schema: + type: string + description: >- + Specifies which fields to use for sorting results. Valid fields are + `name`, `createdAt`, `updatedAt`, `createdBy`, `updatedBy`. + `createdAt` will be used by default. + example: <string> + - name: after + in: query + schema: + type: string + description: >- + The cursor token value to get the next set of results. You can get + this from the `paging.next.after` JSON property of a paged response + containing more results. + example: <string> + - name: limit + in: query + schema: + type: string + description: The maximum number of results to return. Default is 100. + example: <integer> + - name: archived + in: query + schema: + type: string + description: Specifies whether to return deleted Folders. Defaults to `false`. + example: <boolean> + - name: property + in: query + schema: + type: string + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - category: <integer> + created: <dateTime> + deletedAt: <dateTime> + id: <string> + name: <string> + parentFolderId: <long> + updated: <dateTime> + - category: <integer> + created: <dateTime> + deletedAt: <dateTime> + id: <string> + name: <string> + parentFolderId: <long> + updated: <dateTime> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + post: + tags: + - Pages API > Landing Pages + summary: Create a new Folder + description: Create a new Folder + requestBody: + content: + application/json: + schema: + type: object + example: + category: <integer> + created: <dateTime> + deletedAt: <dateTime> + id: <string> + name: <string> + parentFolderId: <long> + updated: <dateTime> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + category: <integer> + created: <dateTime> + deletedAt: <dateTime> + id: <string> + name: <string> + parentFolderId: <long> + updated: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/landing-pages/folders/batch/create: + post: + tags: + - Pages API > Landing Pages + summary: Create a batch of Folders + description: Create the Folder objects detailed in the request body. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - category: <integer> + created: <dateTime> + deletedAt: <dateTime> + id: <string> + name: <string> + parentFolderId: <long> + updated: <dateTime> + - category: <integer> + created: <dateTime> + deletedAt: <dateTime> + id: <string> + name: <string> + parentFolderId: <long> + updated: <dateTime> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - category: <integer> + created: <dateTime> + deletedAt: <dateTime> + id: <string> + name: <string> + parentFolderId: <long> + updated: <dateTime> + - category: <integer> + created: <dateTime> + deletedAt: <dateTime> + id: <string> + name: <string> + parentFolderId: <long> + updated: <dateTime> + startedAt: <dateTime> + status: CANCELED + requestedAt: <dateTime> + links: + in_ef: <string> + pariaturff: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - category: <integer> + created: <dateTime> + deletedAt: <dateTime> + id: <string> + name: <string> + parentFolderId: <long> + updated: <dateTime> + - category: <integer> + created: <dateTime> + deletedAt: <dateTime> + id: <string> + name: <string> + parentFolderId: <long> + updated: <dateTime> + startedAt: <dateTime> + status: CANCELED + numErrors: <integer> + errors: + - category: <string> + context: + aliquip_1e9: + - <string> + - <string> + ut6e: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + deserunt_8f: + - <string> + - <string> + dolore_: + - <string> + - <string> + dolore_f4: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + sed80: + - <string> + - <string> + links: + doloredb: <string> + in_d: <string> + dolor_6: <string> + ipsumd_b: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + in_1: + - <string> + - <string> + et_1e: + - <string> + - <string> + fugiat_4: + - <string> + - <string> + eiusmod59: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + sunt_cd: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + nullae: + - <string> + - <string> + links: + qui_4e7: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + dolore_b: <string> + ea82: <string> + essebe5: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/landing-pages/{objectId}/draft: + get: + tags: + - Pages API > Landing Pages + summary: Retrieve the full draft version of the Landing Page + description: Retrieve the full draft version of the Landing Page. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: objectId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + abStatus: mab_master + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - ullamcob2: {} + mollitf5: {} + officia_96: {} + nonf4: {} + - pariatur7d: {} + quis45: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '5' + created: <dateTime> + createdById: <string> + currentState: DRAFT_AB_VARIANT + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: fr + layoutSections: + irure_d_: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + elit_b: {} + in5d: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - consequat4: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - veniam64e: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + minim1: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + proident8a: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + sint_df4: {} + consectetur_ec: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - in_6a: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cupidatat8a2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + nullaf: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - sint_b5: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + exercitation_7d0: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + ea2c: {} + ea_d5: {} + translatedFromId: <string> + translations: + ex_2f: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + Duis_2: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + in1: {} + Excepteur4: {} + voluptate72: {} + adipisicing__4: {} + deserunt_6f3: {} + widgets: + mollitd8: {} + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + patch: + tags: + - Pages API > Landing Pages + summary: Update a Landing Page draft + description: > + Sparse updates the draft version of a single Landing Page object + identified by the id in the path. + + You only need to specify the column values that you are modifying. + requestBody: + content: + application/json: + schema: + type: object + example: + abStatus: mab_master + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - ullamcob2: {} + mollitf5: {} + officia_96: {} + nonf4: {} + - pariatur7d: {} + quis45: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '5' + created: <dateTime> + createdById: <string> + currentState: DRAFT_AB_VARIANT + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: fr + layoutSections: + irure_d_: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + elit_b: {} + in5d: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - consequat4: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - veniam64e: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + minim1: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + proident8a: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + sint_df4: {} + consectetur_ec: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - in_6a: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cupidatat8a2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + nullaf: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - sint_b5: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + exercitation_7d0: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + ea2c: {} + ea_d5: {} + translatedFromId: <string> + translations: + ex_2f: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + Duis_2: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + in1: {} + Excepteur4: {} + voluptate72: {} + adipisicing__4: {} + deserunt_6f3: {} + widgets: + mollitd8: {} + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: objectId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + abStatus: mab_master + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - ullamcob2: {} + mollitf5: {} + officia_96: {} + nonf4: {} + - pariatur7d: {} + quis45: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '5' + created: <dateTime> + createdById: <string> + currentState: DRAFT_AB_VARIANT + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: fr + layoutSections: + irure_d_: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + elit_b: {} + in5d: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - consequat4: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - veniam64e: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + minim1: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + proident8a: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + sint_df4: {} + consectetur_ec: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - in_6a: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cupidatat8a2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + nullaf: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - sint_b5: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + exercitation_7d0: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + ea2c: {} + ea_d5: {} + translatedFromId: <string> + translations: + ex_2f: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + Duis_2: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + in1: {} + Excepteur4: {} + voluptate72: {} + adipisicing__4: {} + deserunt_6f3: {} + widgets: + mollitd8: {} + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/landing-pages: + get: + tags: + - Pages API > Landing Pages + summary: Get all Landing Pages + description: > + Get the list of landing pages. Supports paging and filtering. This + method would be useful for an integration that examined these models and + used an external service to suggest edits. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: createdAt + in: query + schema: + type: string + description: Only return Landing Pages created at exactly the specified time. + example: <dateTime> + - name: createdAfter + in: query + schema: + type: string + description: Only return Landing Pages created after the specified time. + example: <dateTime> + - name: createdBefore + in: query + schema: + type: string + description: Only return Landing Pages created before the specified time. + example: <dateTime> + - name: updatedAt + in: query + schema: + type: string + description: >- + Only return Landing Pages last updated at exactly the specified + time. + example: <dateTime> + - name: updatedAfter + in: query + schema: + type: string + description: Only return Landing Pages last updated after the specified time. + example: <dateTime> + - name: updatedBefore + in: query + schema: + type: string + description: Only return Landing Pages last updated before the specified time. + example: <dateTime> + - name: sort + in: query + schema: + type: string + description: >- + Specifies which fields to use for sorting results. Valid fields are + `name`, `createdAt`, `updatedAt`, `createdBy`, `updatedBy`. + `createdAt` will be used by default. + example: <string> + - name: sort + in: query + schema: + type: string + description: >- + Specifies which fields to use for sorting results. Valid fields are + `name`, `createdAt`, `updatedAt`, `createdBy`, `updatedBy`. + `createdAt` will be used by default. + example: <string> + - name: after + in: query + schema: + type: string + description: >- + The cursor token value to get the next set of results. You can get + this from the `paging.next.after` JSON property of a paged response + containing more results. + example: <string> + - name: limit + in: query + schema: + type: string + description: The maximum number of results to return. Default is 100. + example: <integer> + - name: archived + in: query + schema: + type: string + description: >- + Specifies whether to return deleted Landing Pages. Defaults to + `false`. + example: <boolean> + - name: property + in: query + schema: + type: string + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - abStatus: master + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - est0: {} + - commodo_adf: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '3' + created: <dateTime> + createdById: <string> + currentState: PAGE_STUB + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: ta-sg + layoutSections: + cillum61: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + ex_f8_: {} + amet_f: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - tempor_ae: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + labore02: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + consequat_8: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + nisi__f: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - amet_2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + eiusmod194: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + aliquip_1c1: {} + eu_ce: {} + mollit2_c: {} + translatedFromId: <string> + translations: + in_f5: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + consectetur49: {} + widgets: + ut_d5: {} + enim85d: {} + - abStatus: automated_master + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - sita6: {} + - esse_: {} + qui_b4: {} + Excepteur_2: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '8' + created: <dateTime> + createdById: <string> + currentState: DRAFT_AB + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: en-nu + layoutSections: + incididunt_fac: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + nisi_b: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - fugiat_6_f: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - proident_8a7: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + mollit6e: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + etca: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + reprehenderit853: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + dod92: {} + dolorbd: {} + laborum8e: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - laboris82: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + deserunt398: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + sed_d: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - amet_e92: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + enim02b: {} + incididunt73: {} + translatedFromId: <string> + translations: + eiusmod_e: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + sed4e: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + laborisf: {} + Ut_1b0: {} + nostrud_6_7: {} + widgets: + dolord38: {} + laborise9: {} + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + post: + tags: + - Pages API > Landing Pages + summary: Create a new Landing Page + description: Create a new Landing Page + requestBody: + content: + application/json: + schema: + type: object + example: + abStatus: mab_master + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - ullamcob2: {} + mollitf5: {} + officia_96: {} + nonf4: {} + - pariatur7d: {} + quis45: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '5' + created: <dateTime> + createdById: <string> + currentState: DRAFT_AB_VARIANT + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: fr + layoutSections: + irure_d_: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + elit_b: {} + in5d: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - consequat4: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - veniam64e: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + minim1: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + proident8a: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + sint_df4: {} + consectetur_ec: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - in_6a: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cupidatat8a2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + nullaf: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - sint_b5: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + exercitation_7d0: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + ea2c: {} + ea_d5: {} + translatedFromId: <string> + translations: + ex_2f: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + Duis_2: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + in1: {} + Excepteur4: {} + voluptate72: {} + adipisicing__4: {} + deserunt_6f3: {} + widgets: + mollitd8: {} + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + content: + text/plain: + schema: + type: string + example: null + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + abStatus: mab_master + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - ullamcob2: {} + mollitf5: {} + officia_96: {} + nonf4: {} + - pariatur7d: {} + quis45: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '5' + created: <dateTime> + createdById: <string> + currentState: DRAFT_AB_VARIANT + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: fr + layoutSections: + irure_d_: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + elit_b: {} + in5d: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - consequat4: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - veniam64e: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + minim1: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + proident8a: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + sint_df4: {} + consectetur_ec: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - in_6a: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cupidatat8a2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + nullaf: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - sint_b5: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + exercitation_7d0: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + ea2c: {} + ea_d5: {} + translatedFromId: <string> + translations: + ex_2f: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + Duis_2: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + in1: {} + Excepteur4: {} + voluptate72: {} + adipisicing__4: {} + deserunt_6f3: {} + widgets: + mollitd8: {} + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/landing-pages/batch/create: + post: + tags: + - Pages API > Landing Pages + summary: Create a batch of Landing Pages + description: Create the Landing Page objects detailed in the request body. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - abStatus: mab_master + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - mollit03b: {} + laboris_d31: {} + cupidatat9a8: {} + - non53e: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '6' + created: <dateTime> + createdById: <string> + currentState: SCHEDULED_OR_PUBLISHED + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: dua-cm + layoutSections: + fugiat31: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + nostrud7c: {} + quis_d: {} + ut13: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - commodo_19: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - eiusmod84: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + consequat2: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + sit_cd: {} + consequat11e: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - enim_3: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + ea6: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + sit25a: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + voluptate3a: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - cilluma: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + exercitationd66: {} + elit572: {} + eu_84f: {} + translatedFromId: <string> + translations: + idc30: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + enim_5: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + deserunta: {} + widgets: + ut_c1: {} + - abStatus: variant + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - utd8c: {} + Lorem_ae8: {} + - anim_7: {} + sit_5: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '5' + created: <dateTime> + createdById: <string> + currentState: ERROR + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: ar-sa + layoutSections: + aute_bd: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + qui_646: {} + inf: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - enim__: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + irure_42b: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - sedc94: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cillum42: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + anim9ff: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + eaae: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + dolore0: {} + aliqua8d7: {} + sit_fc7: {} + translatedFromId: <string> + translations: + ipsum71: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + aute421: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + minim3: {} + sitd: {} + sint_: {} + est_0: {} + widgets: + anim_14: {} + incididuntf: {} + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - abStatus: master + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - nostrud_41: {} + minim89: {} + - adipisicing_e05: {} + tempor_eb7: {} + amet_6: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '10' + created: <dateTime> + createdById: <string> + currentState: PROCESSING + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: es + layoutSections: + ullamco21: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + in_3: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - Lorem_e: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - dolore7: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + laborisf3d: {} + cillum4: {} + reprehenderit7: {} + translatedFromId: <string> + translations: + dolor_b2a: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + laborum9: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + ut_4e4: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + sit_dbc: {} + voluptate18: {} + widgets: + cupidatat_3: {} + - abStatus: automated_loser_variant + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - cillumc: {} + - labore_22: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '3' + created: <dateTime> + createdById: <string> + currentState: AUTOMATED_AB + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: gu-in + layoutSections: + cillum_9: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + sit8: {} + enim_2: {} + amet19: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - ex_7ec: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + enim_866: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - aliquip_7: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + enim_ba: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + idf5: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + id_8b: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - veniam_cc2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + quis_67: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + laborum_272: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - occaecat1: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + aute7f: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + sed406: {} + translatedFromId: <string> + translations: + amet_b32: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + dolor_65: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + nostrude: {} + sit_2bf: {} + widgets: + ut_0e: {} + eu2: {} + startedAt: <dateTime> + status: PROCESSING + requestedAt: <dateTime> + links: + Lorem05: <string> + Ut_6: <string> + in_1: <string> + nostrud7d8: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - abStatus: automated_loser_variant + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - occaecat9: {} + - labore_f0: {} + nonec: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '3' + created: <dateTime> + createdById: <string> + currentState: PUBLISHED_OR_SCHEDULED + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: kln-ke + layoutSections: + eiusmodb: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + consectetur6c: {} + mollit_0c: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - cillum_d: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + irurefd: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - reprehenderit_1: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + commodo_6: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + velit__: {} + aliqua_b6: {} + pariatureb3: {} + translatedFromId: <string> + translations: + tempor_b: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + sunte45: {} + cillumf: {} + widgets: + animf9: {} + - abStatus: mab_variant + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - in_b7: {} + - Excepteur6_: {} + mollita89: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '5' + created: <dateTime> + createdById: <string> + currentState: SCHEDULED + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: fr-ga + layoutSections: + officiadb5: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + ex_48: {} + id1: {} + dolore_5: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - ipsum0: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - in5d: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cillum_55: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + exercitationb77: {} + dolorea3: {} + labore_8: {} + sunt0b: {} + translatedFromId: <string> + translations: + esse_3: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + est_05: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + ipsum_2: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + tempor_2b1: {} + eu_f8: {} + widgets: + ex_f: {} + nonb8_: {} + do9d: {} + fugiat_31: {} + startedAt: <dateTime> + status: PENDING + numErrors: <integer> + errors: + - category: <string> + context: + veniam921: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + culpa_cd: + - <string> + - <string> + exd3a: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + ut_31: + - <string> + - <string> + cillum_ef: + - <string> + - <string> + links: + quis_e: <string> + dolore_b6: <string> + Duis_3: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + do_a3b: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + et_7c: + - <string> + - <string> + nullaaa: + - <string> + - <string> + ex75_: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + voluptate_049: + - <string> + - <string> + links: + utc: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + amet_ae: <string> + Excepteur_5e: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/landing-pages/batch/update: + post: + tags: + - Pages API > Landing Pages + summary: Update a batch of Landing Pages + description: Update the Landing Page objects identified in the request body. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: [] + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: string + description: >- + Specifies whether to update deleted Landing Pages. Defaults to + `false`. + example: <boolean> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - abStatus: master + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - nostrud_41: {} + minim89: {} + - adipisicing_e05: {} + tempor_eb7: {} + amet_6: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '10' + created: <dateTime> + createdById: <string> + currentState: PROCESSING + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: es + layoutSections: + ullamco21: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + in_3: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - Lorem_e: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - dolore7: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + laborisf3d: {} + cillum4: {} + reprehenderit7: {} + translatedFromId: <string> + translations: + dolor_b2a: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + laborum9: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + ut_4e4: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + sit_dbc: {} + voluptate18: {} + widgets: + cupidatat_3: {} + - abStatus: automated_loser_variant + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - cillumc: {} + - labore_22: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '3' + created: <dateTime> + createdById: <string> + currentState: AUTOMATED_AB + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: gu-in + layoutSections: + cillum_9: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + sit8: {} + enim_2: {} + amet19: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - ex_7ec: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + enim_866: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - aliquip_7: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + enim_ba: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + idf5: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + id_8b: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - veniam_cc2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + quis_67: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + laborum_272: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - occaecat1: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + aute7f: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + sed406: {} + translatedFromId: <string> + translations: + amet_b32: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + dolor_65: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + nostrude: {} + sit_2bf: {} + widgets: + ut_0e: {} + eu2: {} + startedAt: <dateTime> + status: PROCESSING + requestedAt: <dateTime> + links: + Lorem05: <string> + Ut_6: <string> + in_1: <string> + nostrud7d8: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - abStatus: automated_loser_variant + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - occaecat9: {} + - labore_f0: {} + nonec: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '3' + created: <dateTime> + createdById: <string> + currentState: PUBLISHED_OR_SCHEDULED + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: kln-ke + layoutSections: + eiusmodb: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + consectetur6c: {} + mollit_0c: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - cillum_d: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + irurefd: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - reprehenderit_1: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + commodo_6: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + velit__: {} + aliqua_b6: {} + pariatureb3: {} + translatedFromId: <string> + translations: + tempor_b: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + sunte45: {} + cillumf: {} + widgets: + animf9: {} + - abStatus: mab_variant + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - in_b7: {} + - Excepteur6_: {} + mollita89: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '5' + created: <dateTime> + createdById: <string> + currentState: SCHEDULED + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: fr-ga + layoutSections: + officiadb5: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + ex_48: {} + id1: {} + dolore_5: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - ipsum0: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - in5d: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cillum_55: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + exercitationb77: {} + dolorea3: {} + labore_8: {} + sunt0b: {} + translatedFromId: <string> + translations: + esse_3: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + est_05: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + ipsum_2: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + tempor_2b1: {} + eu_f8: {} + widgets: + ex_f: {} + nonb8_: {} + do9d: {} + fugiat_31: {} + startedAt: <dateTime> + status: PENDING + numErrors: <integer> + errors: + - category: <string> + context: + veniam921: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + culpa_cd: + - <string> + - <string> + exd3a: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + ut_31: + - <string> + - <string> + cillum_ef: + - <string> + - <string> + links: + quis_e: <string> + dolore_b6: <string> + Duis_3: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + do_a3b: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + et_7c: + - <string> + - <string> + nullaaa: + - <string> + - <string> + ex75_: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + voluptate_049: + - <string> + - <string> + links: + utc: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + amet_ae: <string> + Excepteur_5e: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/landing-pages/batch/read: + post: + tags: + - Pages API > Landing Pages + summary: Retrieve a batch of Landing Pages + description: Retrieve the Landing Page objects identified in the request body. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - <string> + - <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: string + description: >- + Specifies whether to return deleted Landing Pages. Defaults to + `false`. + example: <boolean> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - abStatus: master + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - nostrud_41: {} + minim89: {} + - adipisicing_e05: {} + tempor_eb7: {} + amet_6: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '10' + created: <dateTime> + createdById: <string> + currentState: PROCESSING + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: es + layoutSections: + ullamco21: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + in_3: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - Lorem_e: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - dolore7: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + laborisf3d: {} + cillum4: {} + reprehenderit7: {} + translatedFromId: <string> + translations: + dolor_b2a: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + laborum9: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + ut_4e4: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + sit_dbc: {} + voluptate18: {} + widgets: + cupidatat_3: {} + - abStatus: automated_loser_variant + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - cillumc: {} + - labore_22: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '3' + created: <dateTime> + createdById: <string> + currentState: AUTOMATED_AB + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: gu-in + layoutSections: + cillum_9: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + sit8: {} + enim_2: {} + amet19: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - ex_7ec: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + enim_866: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - aliquip_7: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + enim_ba: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + idf5: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + id_8b: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - veniam_cc2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + quis_67: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + laborum_272: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - occaecat1: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + aute7f: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + sed406: {} + translatedFromId: <string> + translations: + amet_b32: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + dolor_65: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + nostrude: {} + sit_2bf: {} + widgets: + ut_0e: {} + eu2: {} + startedAt: <dateTime> + status: PROCESSING + requestedAt: <dateTime> + links: + Lorem05: <string> + Ut_6: <string> + in_1: <string> + nostrud7d8: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - abStatus: automated_loser_variant + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - occaecat9: {} + - labore_f0: {} + nonec: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '3' + created: <dateTime> + createdById: <string> + currentState: PUBLISHED_OR_SCHEDULED + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: kln-ke + layoutSections: + eiusmodb: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + consectetur6c: {} + mollit_0c: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - cillum_d: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + irurefd: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - reprehenderit_1: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + commodo_6: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + velit__: {} + aliqua_b6: {} + pariatureb3: {} + translatedFromId: <string> + translations: + tempor_b: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + sunte45: {} + cillumf: {} + widgets: + animf9: {} + - abStatus: mab_variant + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - in_b7: {} + - Excepteur6_: {} + mollita89: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '5' + created: <dateTime> + createdById: <string> + currentState: SCHEDULED + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: fr-ga + layoutSections: + officiadb5: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + ex_48: {} + id1: {} + dolore_5: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - ipsum0: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - in5d: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cillum_55: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + exercitationb77: {} + dolorea3: {} + labore_8: {} + sunt0b: {} + translatedFromId: <string> + translations: + esse_3: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + est_05: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + ipsum_2: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + tempor_2b1: {} + eu_f8: {} + widgets: + ex_f: {} + nonb8_: {} + do9d: {} + fugiat_31: {} + startedAt: <dateTime> + status: PENDING + numErrors: <integer> + errors: + - category: <string> + context: + veniam921: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + culpa_cd: + - <string> + - <string> + exd3a: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + ut_31: + - <string> + - <string> + cillum_ef: + - <string> + - <string> + links: + quis_e: <string> + dolore_b6: <string> + Duis_3: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + do_a3b: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + et_7c: + - <string> + - <string> + nullaaa: + - <string> + - <string> + ex75_: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + voluptate_049: + - <string> + - <string> + links: + utc: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + amet_ae: <string> + Excepteur_5e: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/landing-pages/clone: + post: + tags: + - Pages API > Landing Pages + summary: Clone a Landing Page + description: Clone a Landing Page + requestBody: + content: + application/json: + schema: + type: object + example: + id: <string> + cloneName: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + abStatus: mab_master + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - ullamcob2: {} + mollitf5: {} + officia_96: {} + nonf4: {} + - pariatur7d: {} + quis45: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '5' + created: <dateTime> + createdById: <string> + currentState: DRAFT_AB_VARIANT + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: fr + layoutSections: + irure_d_: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + elit_b: {} + in5d: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - consequat4: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - veniam64e: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + minim1: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + proident8a: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + sint_df4: {} + consectetur_ec: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - in_6a: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cupidatat8a2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + nullaf: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - sint_b5: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + exercitation_7d0: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + ea2c: {} + ea_d5: {} + translatedFromId: <string> + translations: + ex_2f: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + Duis_2: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + in1: {} + Excepteur4: {} + voluptate72: {} + adipisicing__4: {} + deserunt_6f3: {} + widgets: + mollitd8: {} + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/landing-pages/folders/{objectId}/revisions/{revisionId}/restore: + post: + tags: + - Pages API > Landing Pages + summary: Restore a previous version of a Folder + description: Takes a specified version of a Folder and restores it. + requestBody: + content: {} + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: objectId + in: path + schema: + type: string + required: true + example: <string> + - name: revisionId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + category: <integer> + created: <dateTime> + deletedAt: <dateTime> + id: <string> + name: <string> + parentFolderId: <long> + updated: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/landing-pages/multi-language/set-new-lang-primary: + put: + tags: + - Pages API > Landing Pages + summary: Set a new primary language + description: Set a landing page as the primary language of a multi-language group. + requestBody: + content: + application/json: + schema: + type: object + example: + id: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/landing-pages/{objectId}/revisions/{revisionId}/restore: + post: + tags: + - Pages API > Landing Pages + summary: Restore a previous version of a Landing Page + description: Takes a specified version of a Landing Page and restores it. + requestBody: + content: {} + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: objectId + in: path + schema: + type: string + required: true + example: <string> + - name: revisionId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + abStatus: mab_master + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - ullamcob2: {} + mollitf5: {} + officia_96: {} + nonf4: {} + - pariatur7d: {} + quis45: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '5' + created: <dateTime> + createdById: <string> + currentState: DRAFT_AB_VARIANT + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: fr + layoutSections: + irure_d_: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + elit_b: {} + in5d: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - consequat4: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - veniam64e: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + minim1: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + proident8a: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + sint_df4: {} + consectetur_ec: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - in_6a: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cupidatat8a2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + nullaf: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - sint_b5: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + exercitation_7d0: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + ea2c: {} + ea_d5: {} + translatedFromId: <string> + translations: + ex_2f: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + Duis_2: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + in1: {} + Excepteur4: {} + voluptate72: {} + adipisicing__4: {} + deserunt_6f3: {} + widgets: + mollitd8: {} + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/landing-pages/folders/{objectId}: + get: + tags: + - Pages API > Landing Pages + summary: Retrieve a Folder + description: Retrieve the Folder object identified by the id in the path. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: string + description: Specifies whether to return deleted Folders. Defaults to `false`. + example: <boolean> + - name: property + in: query + schema: + type: string + example: <string> + - name: objectId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + category: <integer> + created: <dateTime> + deletedAt: <dateTime> + id: <string> + name: <string> + parentFolderId: <long> + updated: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + delete: + tags: + - Pages API > Landing Pages + summary: Delete a Folder + description: Delete the Folder object identified by the id in the path. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: archived + in: query + schema: + type: string + description: Whether to return only results that have been archived. + example: <boolean> + - name: objectId + in: path + schema: + type: string + required: true + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + patch: + tags: + - Pages API > Landing Pages + summary: Update a Folder + description: | + Sparse updates a single Folder object identified by the id in the path. + You only need to specify the column values that you are modifying. + requestBody: + content: + application/json: + schema: + type: object + example: + category: <integer> + created: <dateTime> + deletedAt: <dateTime> + id: <string> + name: <string> + parentFolderId: <long> + updated: <dateTime> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: string + description: Specifies whether to update deleted Folders. Defaults to `false`. + example: <boolean> + - name: objectId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + category: <integer> + created: <dateTime> + deletedAt: <dateTime> + id: <string> + name: <string> + parentFolderId: <long> + updated: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/landing-pages/ab-test/create-variation: + post: + tags: + - Pages API > Landing Pages + summary: Create a new A/B test variation + description: > + Create a new A/B test variation based on the information provided in the + request body. + requestBody: + content: + application/json: + schema: + type: object + example: + contentId: <string> + variationName: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + abStatus: mab_master + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - ullamcob2: {} + mollitf5: {} + officia_96: {} + nonf4: {} + - pariatur7d: {} + quis45: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '5' + created: <dateTime> + createdById: <string> + currentState: DRAFT_AB_VARIANT + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: fr + layoutSections: + irure_d_: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + elit_b: {} + in5d: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - consequat4: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - veniam64e: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + minim1: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + proident8a: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + sint_df4: {} + consectetur_ec: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - in_6a: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cupidatat8a2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + nullaf: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - sint_b5: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + exercitation_7d0: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + ea2c: {} + ea_d5: {} + translatedFromId: <string> + translations: + ex_2f: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + Duis_2: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + in1: {} + Excepteur4: {} + voluptate72: {} + adipisicing__4: {} + deserunt_6f3: {} + widgets: + mollitd8: {} + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/landing-pages/multi-language/attach-to-lang-group: + post: + tags: + - Pages API > Landing Pages + summary: Attach a landing page to a multi-language group + description: Attach a landing page to a multi-language group. + requestBody: + content: + application/json: + schema: + type: object + example: + id: <string> + language: <string> + primaryId: <string> + primaryLanguage: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '200': + description: OK + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/landing-pages/{objectId}/revisions/{revisionId}: + get: + tags: + - Pages API > Landing Pages + summary: Retrieves a previous version of a Landing Page + description: Retrieves a previous version of a Landing Page + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: objectId + in: path + schema: + type: string + required: true + example: <string> + - name: revisionId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + id: <string> + object: + abStatus: variant + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - do3: {} + aliqua_5: {} + - aliqua9: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '3' + created: <dateTime> + createdById: <string> + currentState: AUTOMATED_AB + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: sw + layoutSections: + esse8_: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + consequat_ce5: {} + adipisicing_0: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - occaecat831: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + elitf8: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + enim0e: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - consectetur6e2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + sitd: {} + quis_b15: {} + inf: {} + Ut_4ec: {} + translatedFromId: <string> + translations: + id_fe: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + fugiat_e6: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + nisi_9: {} + widgets: + Lorem_7: {} + in_90: {} + updatedAt: <dateTime> + user: + email: <string> + fullName: <string> + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/landing-pages/ab-test/end: + post: + tags: + - Pages API > Landing Pages + summary: End an active A/B test + description: End an active A/B test and designate a winner. + requestBody: + content: + application/json: + schema: + type: object + example: + abTestId: <string> + winnerId: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/landing-pages/{objectId}/draft/push-live: + post: + tags: + - Pages API > Landing Pages + summary: Push Landing Page draft edits live + description: >- + Take any changes from the draft version of the Landing Page and apply + them to the live version. + requestBody: + content: {} + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: objectId + in: path + schema: + type: string + required: true + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/landing-pages/multi-language/detach-from-lang-group: + post: + tags: + - Pages API > Landing Pages + summary: Detach a landing page from a multi-language group + description: Detach a landing page from a multi-language group. + requestBody: + content: + application/json: + schema: + type: object + example: + id: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '200': + description: OK + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/landing-pages/schedule: + post: + tags: + - Pages API > Landing Pages + summary: Schedule a Landing Page to be Published + description: Schedule a Landing Page to be Published + requestBody: + content: + application/json: + schema: + type: object + example: + id: <string> + publishDate: <dateTime> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/landing-pages/multi-language/update-languages: + post: + tags: + - Pages API > Landing Pages + summary: Update languages of multi-language group + description: >- + Explicitly set new languages for each landing page in a multi-language + group. + requestBody: + content: + application/json: + schema: + type: object + example: + languages: + sint6ea: <string> + officiab8: <string> + nulla_40d: <string> + aliqua_5b3: <string> + et_e: <string> + primaryId: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '200': + description: OK + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/landing-pages/ab-test/rerun: + post: + tags: + - Pages API > Landing Pages + summary: Rerun a previous A/B test + description: Rerun a previous A/B test. + requestBody: + content: + application/json: + schema: + type: object + example: + abTestId: <string> + variationId: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/landing-pages/folders/batch/archive: + post: + tags: + - Pages API > Landing Pages + summary: Delete a batch of Folders + description: Delete the Folder objects identified in the request body. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - <string> + - <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/landing-pages/folders/batch/update: + post: + tags: + - Pages API > Landing Pages + summary: Update a batch of Folders + description: Update the Folder objects identified in the request body. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: [] + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: string + description: Whether to return only results that have been archived. + example: <boolean> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - category: <integer> + created: <dateTime> + deletedAt: <dateTime> + id: <string> + name: <string> + parentFolderId: <long> + updated: <dateTime> + - category: <integer> + created: <dateTime> + deletedAt: <dateTime> + id: <string> + name: <string> + parentFolderId: <long> + updated: <dateTime> + startedAt: <dateTime> + status: CANCELED + requestedAt: <dateTime> + links: + in_ef: <string> + pariaturff: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - category: <integer> + created: <dateTime> + deletedAt: <dateTime> + id: <string> + name: <string> + parentFolderId: <long> + updated: <dateTime> + - category: <integer> + created: <dateTime> + deletedAt: <dateTime> + id: <string> + name: <string> + parentFolderId: <long> + updated: <dateTime> + startedAt: <dateTime> + status: CANCELED + numErrors: <integer> + errors: + - category: <string> + context: + aliquip_1e9: + - <string> + - <string> + ut6e: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + deserunt_8f: + - <string> + - <string> + dolore_: + - <string> + - <string> + dolore_f4: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + sed80: + - <string> + - <string> + links: + doloredb: <string> + in_d: <string> + dolor_6: <string> + ipsumd_b: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + in_1: + - <string> + - <string> + et_1e: + - <string> + - <string> + fugiat_4: + - <string> + - <string> + eiusmod59: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + sunt_cd: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + nullae: + - <string> + - <string> + links: + qui_4e7: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + dolore_b: <string> + ea82: <string> + essebe5: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/landing-pages/folders/{objectId}/revisions/{revisionId}: + get: + tags: + - Pages API > Landing Pages + summary: Retrieves a previous version of a Folder + description: Retrieves a previous version of a Folder + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: objectId + in: path + schema: + type: string + required: true + example: <string> + - name: revisionId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + id: <string> + object: + category: <integer> + created: <dateTime> + deletedAt: <dateTime> + id: <string> + name: <string> + parentFolderId: <long> + updated: <dateTime> + updatedAt: <dateTime> + user: + email: <string> + fullName: <string> + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/landing-pages/{objectId}/draft/reset: + post: + tags: + - Pages API > Landing Pages + summary: Reset the Landing Page draft to the live version + description: Discards any edits and resets the draft to the live version. + requestBody: + content: {} + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: objectId + in: path + schema: + type: string + required: true + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/landing-pages/{objectId}: + get: + tags: + - Pages API > Landing Pages + summary: Retrieve a Landing Page + description: Retrieve the Landing Page object identified by the id in the path. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: string + description: >- + Specifies whether to return deleted Landing Pages. Defaults to + `false`. + example: <boolean> + - name: property + in: query + schema: + type: string + example: <string> + - name: objectId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + abStatus: mab_master + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - ullamcob2: {} + mollitf5: {} + officia_96: {} + nonf4: {} + - pariatur7d: {} + quis45: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '5' + created: <dateTime> + createdById: <string> + currentState: DRAFT_AB_VARIANT + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: fr + layoutSections: + irure_d_: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + elit_b: {} + in5d: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - consequat4: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - veniam64e: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + minim1: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + proident8a: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + sint_df4: {} + consectetur_ec: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - in_6a: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cupidatat8a2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + nullaf: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - sint_b5: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + exercitation_7d0: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + ea2c: {} + ea_d5: {} + translatedFromId: <string> + translations: + ex_2f: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + Duis_2: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + in1: {} + Excepteur4: {} + voluptate72: {} + adipisicing__4: {} + deserunt_6f3: {} + widgets: + mollitd8: {} + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + delete: + tags: + - Pages API > Landing Pages + summary: Delete a Landing Page + description: Delete the Landing Page object identified by the id in the path. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: archived + in: query + schema: + type: string + description: Whether to return only results that have been archived. + example: <boolean> + - name: objectId + in: path + schema: + type: string + required: true + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + patch: + tags: + - Pages API > Landing Pages + summary: Update a Landing Page + description: > + Sparse updates a single Landing Page object identified by the id in the + path. + + You only need to specify the column values that you are modifying. + requestBody: + content: + application/json: + schema: + type: object + example: + abStatus: mab_master + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - ullamcob2: {} + mollitf5: {} + officia_96: {} + nonf4: {} + - pariatur7d: {} + quis45: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '5' + created: <dateTime> + createdById: <string> + currentState: DRAFT_AB_VARIANT + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: fr + layoutSections: + irure_d_: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + elit_b: {} + in5d: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - consequat4: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - veniam64e: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + minim1: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + proident8a: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + sint_df4: {} + consectetur_ec: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - in_6a: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cupidatat8a2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + nullaf: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - sint_b5: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + exercitation_7d0: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + ea2c: {} + ea_d5: {} + translatedFromId: <string> + translations: + ex_2f: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + Duis_2: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + in1: {} + Excepteur4: {} + voluptate72: {} + adipisicing__4: {} + deserunt_6f3: {} + widgets: + mollitd8: {} + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: string + description: >- + Specifies whether to update deleted Landing Pages. Defaults to + `false`. + example: <boolean> + - name: objectId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + abStatus: mab_master + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - ullamcob2: {} + mollitf5: {} + officia_96: {} + nonf4: {} + - pariatur7d: {} + quis45: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '5' + created: <dateTime> + createdById: <string> + currentState: DRAFT_AB_VARIANT + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: fr + layoutSections: + irure_d_: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + elit_b: {} + in5d: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - consequat4: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - veniam64e: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + minim1: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + proident8a: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + sint_df4: {} + consectetur_ec: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - in_6a: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cupidatat8a2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + nullaf: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - sint_b5: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + exercitation_7d0: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + ea2c: {} + ea_d5: {} + translatedFromId: <string> + translations: + ex_2f: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + Duis_2: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + in1: {} + Excepteur4: {} + voluptate72: {} + adipisicing__4: {} + deserunt_6f3: {} + widgets: + mollitd8: {} + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/landing-pages/multi-language/create-language-variation: + post: + tags: + - Pages API > Landing Pages + summary: Create a new language variation + description: Create a new language variation from an existing landing page + requestBody: + content: + application/json: + schema: + type: object + example: + id: <string> + language: <string> + primaryLanguage: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + abStatus: mab_master + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - ullamcob2: {} + mollitf5: {} + officia_96: {} + nonf4: {} + - pariatur7d: {} + quis45: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '5' + created: <dateTime> + createdById: <string> + currentState: DRAFT_AB_VARIANT + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: fr + layoutSections: + irure_d_: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + elit_b: {} + in5d: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - consequat4: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - veniam64e: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + minim1: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + proident8a: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + sint_df4: {} + consectetur_ec: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - in_6a: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cupidatat8a2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + nullaf: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - sint_b5: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + exercitation_7d0: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + ea2c: {} + ea_d5: {} + translatedFromId: <string> + translations: + ex_2f: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + Duis_2: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + in1: {} + Excepteur4: {} + voluptate72: {} + adipisicing__4: {} + deserunt_6f3: {} + widgets: + mollitd8: {} + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/landing-pages/batch/archive: + post: + tags: + - Pages API > Landing Pages + summary: Delete a batch of Landing Pages + description: >- + Delete the Landing Page objects identified in the request body. + + Note: This is not the same as the dashboard `archive` function. To + perform a dashboard `archive` send an normal update with the + `archivedInDashboard` field set to true. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - <string> + - <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/landing-pages/{objectId}/revisions/{revisionId}/restore-to-draft: + post: + tags: + - Pages API > Landing Pages + summary: >- + Restore a previous version of a Landing Page, to the draft version of + the Landing Page + description: >- + Takes a specified version of a Landing Page, sets it as the new draft + version of the Landing Page. + requestBody: + content: {} + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: objectId + in: path + schema: + type: string + required: true + example: <string> + - name: revisionId + in: path + schema: + type: string + required: true + example: <long> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + abStatus: mab_master + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - ullamcob2: {} + mollitf5: {} + officia_96: {} + nonf4: {} + - pariatur7d: {} + quis45: {} + authorName: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '5' + created: <dateTime> + createdById: <string> + currentState: DRAFT_AB_VARIANT + currentlyPublished: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <string> + footerHtml: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + language: fr + layoutSections: + irure_d_: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + elit_b: {} + in5d: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - consequat4: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - veniam64e: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + minim1: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + proident8a: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + sint_df4: {} + consectetur_ec: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - in_6a: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cupidatat8a2: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + nullaf: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - sint_b5: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + exercitation_7d0: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + slug: <string> + state: <string> + subcategory: <string> + templatePath: <string> + themeSettingsValues: + ea2c: {} + ea_d5: {} + translatedFromId: <string> + translations: + ex_2f: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + Duis_2: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + widgetContainers: + in1: {} + Excepteur4: {} + voluptate72: {} + adipisicing__4: {} + deserunt_6f3: {} + widgets: + mollitd8: {} + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/pages/landing-pages/folders/batch/read: + post: + tags: + - Pages API > Landing Pages + summary: Retrieve a batch of Folders + description: Update the Folder objects identified in the request body. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - <string> + - <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: string + description: Specifies whether to return deleted Folders. Defaults to `false`. + example: <boolean> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - category: <integer> + created: <dateTime> + deletedAt: <dateTime> + id: <string> + name: <string> + parentFolderId: <long> + updated: <dateTime> + - category: <integer> + created: <dateTime> + deletedAt: <dateTime> + id: <string> + name: <string> + parentFolderId: <long> + updated: <dateTime> + startedAt: <dateTime> + status: CANCELED + requestedAt: <dateTime> + links: + in_ef: <string> + pariaturff: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - category: <integer> + created: <dateTime> + deletedAt: <dateTime> + id: <string> + name: <string> + parentFolderId: <long> + updated: <dateTime> + - category: <integer> + created: <dateTime> + deletedAt: <dateTime> + id: <string> + name: <string> + parentFolderId: <long> + updated: <dateTime> + startedAt: <dateTime> + status: CANCELED + numErrors: <integer> + errors: + - category: <string> + context: + aliquip_1e9: + - <string> + - <string> + ut6e: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + deserunt_8f: + - <string> + - <string> + dolore_: + - <string> + - <string> + dolore_f4: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + sed80: + - <string> + - <string> + links: + doloredb: <string> + in_d: <string> + dolor_6: <string> + ipsumd_b: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + in_1: + - <string> + - <string> + et_1e: + - <string> + - <string> + fugiat_4: + - <string> + - <string> + eiusmod59: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + sunt_cd: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + nullae: + - <string> + - <string> + links: + qui_4e7: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + dolore_b: <string> + ea82: <string> + essebe5: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_2": [ + "<string>", + "<string>" + ], + "proident_f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex93f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "dolor_6c": [ + "<string>", + "<string>" + ], + "exercitationa3": [ + "<string>", + "<string>" + ] + }, + "links": { + "officia_2de": "<string>", + "exercitation_c": "<string>" + } + } + /cms/v3/source-code/{environment}/content/{path}: + get: + tags: + - CMS Source Code API > Content + summary: Download a file + description: >- + Downloads the byte contents of the file at the specified path in the + specified environment. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: environment + in: path + schema: + type: string + required: true + description: (Required) The environment of the file ("draft" or "published"). + example: <string> + - name: path + in: path + schema: + type: string + required: true + description: (Required) The file system location of the file. + example: '=,''kmy' + responses: + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "laboris_14b": [ + "<string>", + "<string>" + ] + }, + "links": { + "mollit_3_f": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "enim_82": [ + "<string>", + "<string>" + ], + "ex4": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "magna0_0": [ + "<string>", + "<string>" + ], + "culpac32": [ + "<string>", + "<string>" + ], + "ex_a": [ + "<string>", + "<string>" + ] + } + } + ] + } + put: + tags: + - CMS Source Code API > Content + summary: Create or update a file + description: >- + Upserts a file at the specified path in the specified environment. + Accepts multipart/form-data content type. + requestBody: + content: + multipart/form-data: + schema: + type: object + properties: + file: + type: string + description: The file to upload. + example: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: multipart/form-data + - name: Accept + in: header + schema: + type: string + example: application/json + - name: environment + in: path + schema: + type: string + required: true + description: (Required) The environment of the file ("draft" or "published"). + example: <string> + - name: path + in: path + schema: + type: string + required: true + description: (Required) The file system location of the file. + example: '=,''kmy' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <integer> + folder: <boolean> + id: <string> + name: <string> + updatedAt: <integer> + archivedAt: <long> + children: + - <string> + - <string> + hash: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "laboris_14b": [ + "<string>", + "<string>" + ] + }, + "links": { + "mollit_3_f": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "enim_82": [ + "<string>", + "<string>" + ], + "ex4": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "magna0_0": [ + "<string>", + "<string>" + ], + "culpac32": [ + "<string>", + "<string>" + ], + "ex_a": [ + "<string>", + "<string>" + ] + } + } + ] + } + post: + tags: + - CMS Source Code API > Content + summary: Create a file + description: >- + Creates a file at the specified path in the specified environment. + Accepts multipart/form-data content type. Throws an error if a file + already exists at the specified path. + requestBody: + content: + multipart/form-data: + schema: + type: object + properties: + file: + type: string + description: The file to upload. + example: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: multipart/form-data + - name: Accept + in: header + schema: + type: string + example: application/json + - name: environment + in: path + schema: + type: string + required: true + description: (Required) The environment of the file ("draft" or "published"). + example: <string> + - name: path + in: path + schema: + type: string + required: true + description: (Required) The file system location of the file. + example: '=,''kmy' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <integer> + folder: <boolean> + id: <string> + name: <string> + updatedAt: <integer> + archivedAt: <long> + children: + - <string> + - <string> + hash: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "laboris_14b": [ + "<string>", + "<string>" + ] + }, + "links": { + "mollit_3_f": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "enim_82": [ + "<string>", + "<string>" + ], + "ex4": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "magna0_0": [ + "<string>", + "<string>" + ], + "culpac32": [ + "<string>", + "<string>" + ], + "ex_a": [ + "<string>", + "<string>" + ] + } + } + ] + } + delete: + tags: + - CMS Source Code API > Content + summary: Delete a file + description: Deletes the file at the specified path in the specified environment. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: environment + in: path + schema: + type: string + required: true + description: (Required) The environment of the file ("draft" or "published"). + example: <string> + - name: path + in: path + schema: + type: string + required: true + description: (Required) The file system location of the file. + example: '=,''kmy' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "laboris_14b": [ + "<string>", + "<string>" + ] + }, + "links": { + "mollit_3_f": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "enim_82": [ + "<string>", + "<string>" + ], + "ex4": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "magna0_0": [ + "<string>", + "<string>" + ], + "culpac32": [ + "<string>", + "<string>" + ], + "ex_a": [ + "<string>", + "<string>" + ] + } + } + ] + } + /cms/v3/source-code/{environment}/metadata/{path}: + get: + tags: + - CMS Source Code API > Metadata + summary: Get the metadata for a file + description: >- + Gets the metadata object for the file at the specified path in the + specified environment. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: properties + in: query + schema: + type: string + example: <string> + - name: environment + in: path + schema: + type: string + required: true + description: (Required) The environment of the file ("draft" or "published"). + example: <string> + - name: path + in: path + schema: + type: string + required: true + description: (Required) The file system location of the file. + example: '=,''kmy' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <integer> + folder: <boolean> + id: <string> + name: <string> + updatedAt: <integer> + archivedAt: <long> + children: + - <string> + - <string> + hash: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "laboris_14b": [ + "<string>", + "<string>" + ] + }, + "links": { + "mollit_3_f": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "enim_82": [ + "<string>", + "<string>" + ], + "ex4": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "magna0_0": [ + "<string>", + "<string>" + ], + "culpac32": [ + "<string>", + "<string>" + ], + "ex_a": [ + "<string>", + "<string>" + ] + } + } + ] + } + /cms/v3/source-code/{environment}/validate/{path}: + post: + tags: + - CMS Source Code API > Validation + summary: Validate the contents of a file + description: >- + Validates the file contents passed to the endpoint given a specified + path and environment. Accepts multipart/form-data content type. + requestBody: + content: + multipart/form-data: + schema: + type: object + properties: + file: + type: string + description: The file to validate. + example: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: multipart/form-data + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: environment + in: path + schema: + type: string + required: true + description: '(Required) ' + example: '=,''kmy' + - name: path + in: path + schema: + type: string + required: true + description: (Required) The file system location of the file. + example: '=,''kmy' + responses: + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "laboris_14b": [ + "<string>", + "<string>" + ] + }, + "links": { + "mollit_3_f": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "enim_82": [ + "<string>", + "<string>" + ], + "ex4": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "magna0_0": [ + "<string>", + "<string>" + ], + "culpac32": [ + "<string>", + "<string>" + ], + "ex_a": [ + "<string>", + "<string>" + ] + } + } + ] + } + /cms/v3/source-code/extract/{path}: + post: + tags: + - CMS Source Code API > Extract + summary: Extracts a zip file + description: >- + Extracts a zip file in the file system. The zip file will be extracted + in-place and not be deleted automatically. + requestBody: + content: {} + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: path + in: path + schema: + type: string + required: true + description: (Required) The file system location of the zip file. + example: '=,''kmy' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "laboris_14b": [ + "<string>", + "<string>" + ] + }, + "links": { + "mollit_3_f": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "enim_82": [ + "<string>", + "<string>" + ], + "ex4": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "magna0_0": [ + "<string>", + "<string>" + ], + "culpac32": [ + "<string>", + "<string>" + ], + "ex_a": [ + "<string>", + "<string>" + ] + } + } + ] + } + /cms/v3/source-code/extract/async: + post: + tags: + - CMS Source Code API > Source_Code_Extract + summary: post-/cms/v3/source-code/extract/async do Async + requestBody: + content: + application/json: + schema: + type: object + example: + path: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '202': + description: Accepted + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + id: <string> + links: + reprehenderit_641: <string> + ex156: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "laboris_14b": [ + "<string>", + "<string>" + ] + }, + "links": { + "mollit_3_f": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "enim_82": [ + "<string>", + "<string>" + ], + "ex4": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "magna0_0": [ + "<string>", + "<string>" + ], + "culpac32": [ + "<string>", + "<string>" + ], + "ex_a": [ + "<string>", + "<string>" + ] + } + } + ] + } + /cms/v3/source-code/extract/async/tasks/{taskId}/status: + get: + tags: + - CMS Source Code API > Source_Code_Extract + summary: >- + get-/cms/v3/source-code/extract/async/tasks/{task Id}/status get Async + Status + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: taskId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <integer> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + startedAt: <dateTime> + status: CANCELED + requestedAt: <dateTime> + links: + occaecat4_3: <string> + cillum402: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "laboris_14b": [ + "<string>", + "<string>" + ] + }, + "links": { + "mollit_3_f": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "enim_82": [ + "<string>", + "<string>" + ], + "ex4": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "magna0_0": [ + "<string>", + "<string>" + ], + "culpac32": [ + "<string>", + "<string>" + ], + "ex_a": [ + "<string>", + "<string>" + ] + } + } + ] + } + /cms/v3/audit-logs/: + get: + tags: + - Content Audit API > Audit_Logs + summary: Query audit logs + description: Returns audit logs based on filters. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: userId + in: query + schema: + type: string + description: Comma separated list of user ids to filter by. + example: <string> + - name: userId + in: query + schema: + type: string + description: Comma separated list of user ids to filter by. + example: <string> + - name: eventType + in: query + schema: + type: string + description: >- + Comma separated list of event types to filter by (CREATED, UPDATED, + PUBLISHED, DELETED, UNPUBLISHED). + example: <string> + - name: eventType + in: query + schema: + type: string + description: >- + Comma separated list of event types to filter by (CREATED, UPDATED, + PUBLISHED, DELETED, UNPUBLISHED). + example: <string> + - name: objectType + in: query + schema: + type: string + description: >- + Comma separated list of object types to filter by (BLOG, + LANDING_PAGE, DOMAIN, HUBDB_TABLE etc.) + example: <string> + - name: objectType + in: query + schema: + type: string + description: >- + Comma separated list of object types to filter by (BLOG, + LANDING_PAGE, DOMAIN, HUBDB_TABLE etc.) + example: <string> + - name: objectId + in: query + schema: + type: string + description: Comma separated list of object ids to filter by. + example: <string> + - name: objectId + in: query + schema: + type: string + description: Comma separated list of object ids to filter by. + example: <string> + - name: after + in: query + schema: + type: string + description: Timestamp after which audit logs will be returned + example: <string> + - name: before + in: query + schema: + type: string + description: Timestamp before which audit logs will be returned + example: <string> + - name: limit + in: query + schema: + type: string + description: The number of logs to return. + example: <integer> + - name: sort + in: query + schema: + type: string + description: The sort direction for the audit logs. (Can only sort by timestamp). + example: <string> + - name: sort + in: query + schema: + type: string + description: The sort direction for the audit logs. (Can only sort by timestamp). + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - event: UPDATED + fullName: <string> + objectId: <string> + objectName: <string> + objectType: CONTENT_SETTINGS + timestamp: <dateTime> + userId: <string> + meta: {} + - event: CREATED + fullName: <string> + objectId: <string> + objectName: <string> + objectType: THEME + timestamp: <dateTime> + userId: <string> + meta: {} + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "incididunt198": [ + "<string>", + "<string>" + ] + }, + "links": { + "esse1": "<string>", + "occaecat_94": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "est35e": [ + "<string>", + "<string>" + ], + "voluptate_9": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "dolore_5b": [ + "<string>", + "<string>" + ], + "cupidatat28": [ + "<string>", + "<string>" + ] + } + } + ] + } + /cms/v3/url-redirects/: + get: + tags: + - URL Redirects API > Redirects + summary: Get current redirects + description: >- + Returns all existing URL redirects. Results can be limited and filtered + by creation or updated date. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: createdAt + in: query + schema: + type: string + description: Only return redirects created on exactly this date. + example: <dateTime> + - name: createdAfter + in: query + schema: + type: string + description: Only return redirects created after this date. + example: <dateTime> + - name: createdBefore + in: query + schema: + type: string + description: Only return redirects created before this date. + example: <dateTime> + - name: updatedAt + in: query + schema: + type: string + description: Only return redirects last updated on exactly this date. + example: <dateTime> + - name: updatedAfter + in: query + schema: + type: string + description: Only return redirects last updated after this date. + example: <dateTime> + - name: updatedBefore + in: query + schema: + type: string + description: Only return redirects last updated before this date. + example: <dateTime> + - name: sort + in: query + schema: + type: string + example: <string> + - name: sort + in: query + schema: + type: string + example: <string> + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: limit + in: query + schema: + type: string + description: Maximum number of result per page + example: <integer> + - name: archived + in: query + schema: + type: string + description: Whether to return only results that have been archived. + example: <boolean> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - destination: <string> + id: <string> + isMatchFullUrl: <boolean> + isMatchQueryString: <boolean> + isOnlyAfterNotFound: <boolean> + isPattern: <boolean> + isProtocolAgnostic: <boolean> + isTrailingSlashOptional: <boolean> + precedence: <integer> + redirectStyle: <integer> + routePrefix: <string> + created: <dateTime> + updated: <dateTime> + - destination: <string> + id: <string> + isMatchFullUrl: <boolean> + isMatchQueryString: <boolean> + isOnlyAfterNotFound: <boolean> + isPattern: <boolean> + isProtocolAgnostic: <boolean> + isTrailingSlashOptional: <boolean> + precedence: <integer> + redirectStyle: <integer> + routePrefix: <string> + created: <dateTime> + updated: <dateTime> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "laborum_01d": [ + "<string>", + "<string>" + ] + }, + "links": { + "dolor9": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "nostrud67": [ + "<string>", + "<string>" + ], + "eiusmod_8e": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "irure62f": [ + "<string>", + "<string>" + ], + "quis867": [ + "<string>", + "<string>" + ] + } + } + ] + } + post: + tags: + - URL Redirects API > Redirects + summary: Create a redirect + description: Creates and configures a new URL redirect. + requestBody: + content: + application/json: + schema: + type: object + example: + destination: <string> + redirectStyle: <integer> + routePrefix: <string> + isTrailingSlashOptional: <boolean> + isMatchQueryString: <boolean> + isMatchFullUrl: <boolean> + isProtocolAgnostic: <boolean> + isOnlyAfterNotFound: <boolean> + isPattern: <boolean> + precedence: <integer> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + destination: <string> + id: <string> + isMatchFullUrl: <boolean> + isMatchQueryString: <boolean> + isOnlyAfterNotFound: <boolean> + isPattern: <boolean> + isProtocolAgnostic: <boolean> + isTrailingSlashOptional: <boolean> + precedence: <integer> + redirectStyle: <integer> + routePrefix: <string> + created: <dateTime> + updated: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "laborum_01d": [ + "<string>", + "<string>" + ] + }, + "links": { + "dolor9": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "nostrud67": [ + "<string>", + "<string>" + ], + "eiusmod_8e": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "irure62f": [ + "<string>", + "<string>" + ], + "quis867": [ + "<string>", + "<string>" + ] + } + } + ] + } + /cms/v3/url-redirects/{urlRedirectId}: + get: + tags: + - URL Redirects API > Redirects + summary: Get details for a redirect + description: Returns the details for a single existing URL redirect by ID. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: urlRedirectId + in: path + schema: + type: string + required: true + description: (Required) The ID of the target redirect. + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + destination: <string> + id: <string> + isMatchFullUrl: <boolean> + isMatchQueryString: <boolean> + isOnlyAfterNotFound: <boolean> + isPattern: <boolean> + isProtocolAgnostic: <boolean> + isTrailingSlashOptional: <boolean> + precedence: <integer> + redirectStyle: <integer> + routePrefix: <string> + created: <dateTime> + updated: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "laborum_01d": [ + "<string>", + "<string>" + ] + }, + "links": { + "dolor9": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "nostrud67": [ + "<string>", + "<string>" + ], + "eiusmod_8e": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "irure62f": [ + "<string>", + "<string>" + ], + "quis867": [ + "<string>", + "<string>" + ] + } + } + ] + } + delete: + tags: + - URL Redirects API > Redirects + summary: Delete a redirect + description: Delete one existing redirect, so it is no longer mapped. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: urlRedirectId + in: path + schema: + type: string + required: true + description: (Required) The ID of the target redirect. + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "laborum_01d": [ + "<string>", + "<string>" + ] + }, + "links": { + "dolor9": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "nostrud67": [ + "<string>", + "<string>" + ], + "eiusmod_8e": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "irure62f": [ + "<string>", + "<string>" + ], + "quis867": [ + "<string>", + "<string>" + ] + } + } + ] + } + patch: + tags: + - URL Redirects API > Redirects + summary: Update a redirect + description: Updates the settings for an existing URL redirect. + requestBody: + content: + application/json: + schema: + type: object + example: + destination: <string> + id: <string> + isMatchFullUrl: <boolean> + isMatchQueryString: <boolean> + isOnlyAfterNotFound: <boolean> + isPattern: <boolean> + isProtocolAgnostic: <boolean> + isTrailingSlashOptional: <boolean> + precedence: <integer> + redirectStyle: <integer> + routePrefix: <string> + created: <dateTime> + updated: <dateTime> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: urlRedirectId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + destination: <string> + id: <string> + isMatchFullUrl: <boolean> + isMatchQueryString: <boolean> + isOnlyAfterNotFound: <boolean> + isPattern: <boolean> + isProtocolAgnostic: <boolean> + isTrailingSlashOptional: <boolean> + precedence: <integer> + redirectStyle: <integer> + routePrefix: <string> + created: <dateTime> + updated: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "laborum_01d": [ + "<string>", + "<string>" + ] + }, + "links": { + "dolor9": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "nostrud67": [ + "<string>", + "<string>" + ], + "eiusmod_8e": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "irure62f": [ + "<string>", + "<string>" + ], + "quis867": [ + "<string>", + "<string>" + ] + } + } + ] + } + /cms/v3/domains/: + get: + tags: + - Domains API > Domains + summary: Get current domains + description: >- + Returns all existing domains that have been created. Results can be + limited and filtered by creation or updated date. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: createdAt + in: query + schema: + type: string + description: Only return domains created at this date. + example: <dateTime> + - name: createdAfter + in: query + schema: + type: string + description: Only return domains created after this date. + example: <dateTime> + - name: createdBefore + in: query + schema: + type: string + description: Only return domains created before this date. + example: <dateTime> + - name: updatedAt + in: query + schema: + type: string + description: Only return domains updated at this date. + example: <dateTime> + - name: updatedAfter + in: query + schema: + type: string + description: Only return domains updated after this date. + example: <dateTime> + - name: updatedBefore + in: query + schema: + type: string + description: Only return domains updated before this date. + example: <dateTime> + - name: sort + in: query + schema: + type: string + example: <string> + - name: sort + in: query + schema: + type: string + example: <string> + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: limit + in: query + schema: + type: string + description: Maximum number of results per page. + example: <integer> + - name: archived + in: query + schema: + type: string + description: Whether to return only results that have been archived. + example: <boolean> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - domain: <string> + id: <string> + isResolving: <boolean> + isUsedForBlogPost: <boolean> + isUsedForEmail: <boolean> + isUsedForKnowledge: <boolean> + isUsedForLandingPage: <boolean> + isUsedForSitePage: <boolean> + primaryBlogPost: <boolean> + primaryKnowledge: <boolean> + created: <dateTime> + secondaryToDomain: <string> + manuallyMarkedAsResolving: <boolean> + isSslEnabled: <boolean> + primarySitePage: <boolean> + primaryLandingPage: <boolean> + correctCname: <string> + isSslOnly: <boolean> + updated: <dateTime> + primaryEmail: <boolean> + - domain: <string> + id: <string> + isResolving: <boolean> + isUsedForBlogPost: <boolean> + isUsedForEmail: <boolean> + isUsedForKnowledge: <boolean> + isUsedForLandingPage: <boolean> + isUsedForSitePage: <boolean> + primaryBlogPost: <boolean> + primaryKnowledge: <boolean> + created: <dateTime> + secondaryToDomain: <string> + manuallyMarkedAsResolving: <boolean> + isSslEnabled: <boolean> + primarySitePage: <boolean> + primaryLandingPage: <boolean> + correctCname: <string> + isSslOnly: <boolean> + updated: <dateTime> + primaryEmail: <boolean> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "sit9cb": [ + "<string>", + "<string>" + ], + "labore313": [ + "<string>", + "<string>" + ], + "tempord": [ + "<string>", + "<string>" + ] + }, + "links": { + "laborum0": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "velit_4": [ + "<string>", + "<string>" + ], + "reprehenderit__4": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "eu31c": [ + "<string>", + "<string>" + ], + "Excepteur_5c": [ + "<string>", + "<string>" + ], + "fugiat020": [ + "<string>", + "<string>" + ], + "etcc": [ + "<string>", + "<string>" + ], + "enim4": [ + "<string>", + "<string>" + ] + } + } + ] + } + /cms/v3/domains/{domainId}: + get: + tags: + - Domains API > Domains + summary: Get a single domain + description: Returns a single domains with the id specified. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: domainId + in: path + schema: + type: string + required: true + description: (Required) The unique ID of the domain. + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + domain: <string> + id: <string> + isResolving: <boolean> + isUsedForBlogPost: <boolean> + isUsedForEmail: <boolean> + isUsedForKnowledge: <boolean> + isUsedForLandingPage: <boolean> + isUsedForSitePage: <boolean> + primaryBlogPost: <boolean> + primaryKnowledge: <boolean> + created: <dateTime> + secondaryToDomain: <string> + manuallyMarkedAsResolving: <boolean> + isSslEnabled: <boolean> + primarySitePage: <boolean> + primaryLandingPage: <boolean> + correctCname: <string> + isSslOnly: <boolean> + updated: <dateTime> + primaryEmail: <boolean> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "sit9cb": [ + "<string>", + "<string>" + ], + "labore313": [ + "<string>", + "<string>" + ], + "tempord": [ + "<string>", + "<string>" + ] + }, + "links": { + "laborum0": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "velit_4": [ + "<string>", + "<string>" + ], + "reprehenderit__4": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "eu31c": [ + "<string>", + "<string>" + ], + "Excepteur_5c": [ + "<string>", + "<string>" + ], + "fugiat020": [ + "<string>", + "<string>" + ], + "etcc": [ + "<string>", + "<string>" + ], + "enim4": [ + "<string>", + "<string>" + ] + } + } + ] + } + /media-bridge/v1/{appId}/settings/event-visibility: + get: + tags: + - Media Bridge API > Integrator_Settings + summary: get-/media-bridge/v1/{app Id}/settings/event-visibility + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: appId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: j, + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + visibilitySettings: + - eventType: MEDIA_PLAYS_PERCENT + updatedAt: <long> + showInWorkflows: <boolean> + showInReporting: <boolean> + showInTimeline: <boolean> + - eventType: ATTENTION_SPAN + updatedAt: <long> + showInWorkflows: <boolean> + showInReporting: <boolean> + showInTimeline: <boolean> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "non6d": [ + "<string>", + "<string>" + ], + "nulla5b": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_e2": "<string>", + "aliquip_16": "<string>", + "in_815": "<string>", + "in8c": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempord": [ + "<string>", + "<string>" + ], + "eua": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempor__d": [ + "<string>", + "<string>" + ], + "est90": [ + "<string>", + "<string>" + ] + } + } + ] + } + patch: + tags: + - Media Bridge API > Integrator_Settings + summary: patch-/media-bridge/v1/{app Id}/settings/event-visibility + requestBody: + content: + application/json: + schema: + type: object + example: + eventType: ALL + updatedAt: <long> + showInWorkflows: <boolean> + showInReporting: <boolean> + showInTimeline: <boolean> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: appId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: j, + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + eventType: ALL + updatedAt: <long> + showInWorkflows: <boolean> + showInReporting: <boolean> + showInTimeline: <boolean> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "non6d": [ + "<string>", + "<string>" + ], + "nulla5b": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_e2": "<string>", + "aliquip_16": "<string>", + "in_815": "<string>", + "in8c": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempord": [ + "<string>", + "<string>" + ], + "eua": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempor__d": [ + "<string>", + "<string>" + ], + "est90": [ + "<string>", + "<string>" + ] + } + } + ] + } + /media-bridge/v1/{appId}/settings/register: + post: + tags: + - Media Bridge API > Integrator_Settings + summary: post-/media-bridge/v1/{app Id}/settings/register + requestBody: + content: + application/json: + schema: + type: object + example: + updatedAt: <long> + name: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: appId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: j, + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + appId: <integer> + name: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "non6d": [ + "<string>", + "<string>" + ], + "nulla5b": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_e2": "<string>", + "aliquip_16": "<string>", + "in_815": "<string>", + "in8c": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempord": [ + "<string>", + "<string>" + ], + "eua": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempor__d": [ + "<string>", + "<string>" + ], + "est90": [ + "<string>", + "<string>" + ] + } + } + ] + } + /media-bridge/v1/{appId}/settings/object-definitions/{mediaType}: + get: + tags: + - Media Bridge API > Integrator_Settings + summary: get-/media-bridge/v1/{app Id}/settings/object-definitions/{media Type} + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: includeFullDefinition + in: query + schema: + type: string + example: <boolean> + - name: appId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: j, + - name: mediaType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: DOCUMENT + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + objectTypeId: <string> + objectTypeName: <string> + properties: + - objectTypeId: <string> + property: + allowedObjectTypes: + - innerId: <integer> + metaTypeId: <integer> + - innerId: <integer> + metaTypeId: <integer> + calculated: <boolean> + createdAt: <long> + createdUserId: <long> + currencyPropertyName: <string> + deleted: <boolean> + description: <string> + displayMode: current_value + displayOrder: <integer> + externalOptions: <boolean> + externalOptionsReferenceType: <string> + favorited: <boolean> + favoritedOrder: <integer> + fieldType: <string> + formField: <boolean> + fromUserId: <long> + groupName: <string> + hasUniqueValue: <boolean> + hidden: <boolean> + hubspotDefined: <boolean> + isCustomizedDefault: <boolean> + isMultiValued: <boolean> + isPartial: <boolean> + label: <string> + mutableDefinitionNotDeletable: <boolean> + name: <string> + numberDisplayHint: probability + optionSortStrategy: ALPHABETICAL + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + optionsAreMutable: <boolean> + portalId: <long> + readOnlyDefinition: <boolean> + readOnlyValue: <boolean> + referencedObjectType: BLOG_LISTING_PAGE + searchTextAnalysisMode: NOT_ANALYZED_TEXT + searchableInGlobalSearch: <boolean> + showCurrencySymbol: <boolean> + textDisplayHint: phone_number + type: datetime + updatedAt: <long> + fulcrumPortalId: <integer> + janusGroup: <string> + fulcrumTimestamp: <long> + calculationFormula: <string> + propertyRequirements: + gates: + - <string> + - <string> + operator: AND + scopeNames: + - <string> + - <string> + settings: + - <string> + - <string> + definitionSource: + type: GLOBAL + name: <string> + externalOptionsMetaData: + filter: + pipelineIds: + - <string> + - <string> + relatedObjectTypeId: <string> + permission: + accessLevel: <string> + calculationExpression: + operator: CONSTANT_BOOLEAN + propertyName: <string> + inputs: + - value: >- + <Circular reference to + #/components/schemas/ConstantBoolean detected> + - value: >- + <Circular reference to + #/components/schemas/ConstantBoolean detected> + value: <boolean> + rollupExpression: + associationTypes: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + rollupOperator: <string> + sourceObjectTypeId: <string> + sourcePropertyName: <string> + emptyRollupValue: <string> + conditionalFormula: <string> + conditionalExpression: + operator: CONSTANT_BOOLEAN + propertyName: <string> + inputs: + - value: >- + <Circular reference to + #/components/schemas/ConstantBoolean detected> + - value: >- + <Circular reference to + #/components/schemas/ConstantBoolean detected> + value: <boolean> + sourceCompareByPropertyName: <string> + - objectTypeId: <string> + property: + allowedObjectTypes: + - innerId: <integer> + metaTypeId: <integer> + - innerId: <integer> + metaTypeId: <integer> + calculated: <boolean> + createdAt: <long> + createdUserId: <long> + currencyPropertyName: <string> + deleted: <boolean> + description: <string> + displayMode: all_unique_versions + displayOrder: <integer> + externalOptions: <boolean> + externalOptionsReferenceType: <string> + favorited: <boolean> + favoritedOrder: <integer> + fieldType: <string> + formField: <boolean> + fromUserId: <long> + groupName: <string> + hasUniqueValue: <boolean> + hidden: <boolean> + hubspotDefined: <boolean> + isCustomizedDefault: <boolean> + isMultiValued: <boolean> + isPartial: <boolean> + label: <string> + mutableDefinitionNotDeletable: <boolean> + name: <string> + numberDisplayHint: duration + optionSortStrategy: ALPHABETICAL + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + optionsAreMutable: <boolean> + portalId: <long> + readOnlyDefinition: <boolean> + readOnlyValue: <boolean> + referencedObjectType: POSTAL_MAIL + searchTextAnalysisMode: NONE + searchableInGlobalSearch: <boolean> + showCurrencySymbol: <boolean> + textDisplayHint: multi_line + type: phone_number + updatedAt: <long> + fulcrumPortalId: <integer> + janusGroup: <string> + fulcrumTimestamp: <long> + calculationFormula: <string> + propertyRequirements: + gates: + - <string> + - <string> + operator: OR + scopeNames: + - <string> + - <string> + settings: + - <string> + - <string> + definitionSource: + type: GLOBAL + name: <string> + externalOptionsMetaData: + filter: + pipelineIds: + - <string> + - <string> + relatedObjectTypeId: <string> + permission: + accessLevel: <string> + calculationExpression: + operator: CONSTANT_BOOLEAN + propertyName: <string> + inputs: + - value: >- + <Circular reference to + #/components/schemas/ConstantBoolean detected> + - value: >- + <Circular reference to + #/components/schemas/ConstantBoolean detected> + value: <boolean> + rollupExpression: + associationTypes: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + rollupOperator: <string> + sourceObjectTypeId: <string> + sourcePropertyName: <string> + emptyRollupValue: <string> + conditionalFormula: <string> + conditionalExpression: + operator: CONSTANT_BOOLEAN + propertyName: <string> + inputs: + - value: >- + <Circular reference to + #/components/schemas/ConstantBoolean detected> + - value: >- + <Circular reference to + #/components/schemas/ConstantBoolean detected> + value: <boolean> + sourceCompareByPropertyName: <string> + propertyGroups: + - displayName: <string> + displayOrder: <integer> + fulcrumPortalId: <integer> + fulcrumTimestamp: <long> + hubspotDefined: <boolean> + name: <string> + - displayName: <string> + displayOrder: <integer> + fulcrumPortalId: <integer> + fulcrumTimestamp: <long> + hubspotDefined: <boolean> + name: <string> + schema: + createDatePropertyName: <string> + defaultSearchPropertyNames: + - <string> + - <string> + deleted: <boolean> + fullyQualifiedName: <string> + hasCustomProperties: <boolean> + hasDefaultProperties: <boolean> + hasExternalObjectIds: <boolean> + hasOwners: <boolean> + hasPipelines: <boolean> + id: <integer> + indexedForFiltersAndReports: <boolean> + lastModifiedPropertyName: <string> + metaType: HUBSPOT + metaTypeId: <integer> + name: <string> + objectTypeId: <string> + permissioningType: <string> + pipelinePropertyName: <string> + pipelineStagePropertyName: <string> + requiredProperties: + - <string> + - <string> + restorable: <boolean> + scopeMappings: + - accessLevel: <string> + requestAction: <string> + scopeName: <string> + - accessLevel: <string> + requestAction: <string> + scopeName: <string> + secondaryDisplayLabelPropertyNames: + - <string> + - <string> + primaryDisplayLabelPropertyName: <string> + integrationAppId: <integer> + description: <string> + pipelineTimeToClosePropertyName: <string> + singularForm: <string> + ownerPortalId: <integer> + pluralForm: <string> + janusGroup: <string> + pipelineCloseDatePropertyName: <string> + writeScopeName: <string> + accessScopeName: <string> + readScopeName: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "non6d": [ + "<string>", + "<string>" + ], + "nulla5b": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_e2": "<string>", + "aliquip_16": "<string>", + "in_815": "<string>", + "in8c": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempord": [ + "<string>", + "<string>" + ], + "eua": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempor__d": [ + "<string>", + "<string>" + ], + "est90": [ + "<string>", + "<string>" + ] + } + } + ] + } + /media-bridge/v1/{appId}/settings/object-definitions: + post: + tags: + - Media Bridge API > Integrator_Settings + summary: post-/media-bridge/v1/{app Id}/settings/object-definitions + requestBody: + content: + application/json: + schema: + type: object + example: + mediaTypes: + - IMAGE + - OTHER + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: appId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: j, + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + deserunt1f8: + objectType: + createDatePropertyName: <string> + defaultSearchPropertyNames: + - <string> + - <string> + deleted: <boolean> + fullyQualifiedName: <string> + hasCustomProperties: <boolean> + hasDefaultProperties: <boolean> + hasExternalObjectIds: <boolean> + hasOwners: <boolean> + hasPipelines: <boolean> + id: <integer> + indexedForFiltersAndReports: <boolean> + lastModifiedPropertyName: <string> + metaType: HUBSPOT_EVENT + metaTypeId: <integer> + name: <string> + objectTypeId: <string> + permissioningType: <string> + pipelinePropertyName: <string> + pipelineStagePropertyName: <string> + requiredProperties: + - <string> + - <string> + restorable: <boolean> + scopeMappings: + - accessLevel: <string> + requestAction: <string> + scopeName: <string> + - accessLevel: <string> + requestAction: <string> + scopeName: <string> + secondaryDisplayLabelPropertyNames: + - <string> + - <string> + primaryDisplayLabelPropertyName: <string> + integrationAppId: <integer> + description: <string> + pipelineTimeToClosePropertyName: <string> + singularForm: <string> + ownerPortalId: <integer> + pluralForm: <string> + janusGroup: <string> + pipelineCloseDatePropertyName: <string> + writeScopeName: <string> + accessScopeName: <string> + readScopeName: <string> + properties: + - objectTypeId: <string> + property: + allowedObjectTypes: + - innerId: <integer> + metaTypeId: <integer> + - innerId: <integer> + metaTypeId: <integer> + calculated: <boolean> + createdAt: <long> + createdUserId: <long> + currencyPropertyName: <string> + deleted: <boolean> + description: <string> + displayMode: current_value + displayOrder: <integer> + externalOptions: <boolean> + externalOptionsReferenceType: <string> + favorited: <boolean> + favoritedOrder: <integer> + fieldType: <string> + formField: <boolean> + fromUserId: <long> + groupName: <string> + hasUniqueValue: <boolean> + hidden: <boolean> + hubspotDefined: <boolean> + isCustomizedDefault: <boolean> + isMultiValued: <boolean> + isPartial: <boolean> + label: <string> + mutableDefinitionNotDeletable: <boolean> + name: <string> + numberDisplayHint: currency + optionSortStrategy: DISPLAY_ORDER + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + optionsAreMutable: <boolean> + portalId: <long> + readOnlyDefinition: <boolean> + readOnlyValue: <boolean> + referencedObjectType: GSC_PROPERTY + searchTextAnalysisMode: NOT_ANALYZED_TEXT + searchableInGlobalSearch: <boolean> + showCurrencySymbol: <boolean> + textDisplayHint: email + type: bool + updatedAt: <long> + fulcrumPortalId: <integer> + janusGroup: <string> + fulcrumTimestamp: <long> + calculationFormula: <string> + propertyRequirements: + gates: + - <string> + - <string> + operator: AND + scopeNames: + - <string> + - <string> + settings: + - <string> + - <string> + definitionSource: + type: GLOBAL + name: <string> + externalOptionsMetaData: + filter: + pipelineIds: + - <string> + - <string> + relatedObjectTypeId: <string> + permission: + accessLevel: <string> + calculationExpression: + operator: CONSTANT_BOOLEAN + propertyName: <string> + inputs: + - value: >- + <Circular reference to + #/components/schemas/ConstantBoolean detected> + - value: >- + <Circular reference to + #/components/schemas/ConstantBoolean detected> + value: <boolean> + rollupExpression: + associationTypes: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + rollupOperator: <string> + sourceObjectTypeId: <string> + sourcePropertyName: <string> + emptyRollupValue: <string> + conditionalFormula: <string> + conditionalExpression: + operator: CONSTANT_BOOLEAN + propertyName: <string> + inputs: + - value: >- + <Circular reference to + #/components/schemas/ConstantBoolean detected> + - value: >- + <Circular reference to + #/components/schemas/ConstantBoolean detected> + value: <boolean> + sourceCompareByPropertyName: <string> + - objectTypeId: <string> + property: + allowedObjectTypes: + - innerId: <integer> + metaTypeId: <integer> + - innerId: <integer> + metaTypeId: <integer> + calculated: <boolean> + createdAt: <long> + createdUserId: <long> + currencyPropertyName: <string> + deleted: <boolean> + description: <string> + displayMode: current_value + displayOrder: <integer> + externalOptions: <boolean> + externalOptionsReferenceType: <string> + favorited: <boolean> + favoritedOrder: <integer> + fieldType: <string> + formField: <boolean> + fromUserId: <long> + groupName: <string> + hasUniqueValue: <boolean> + hidden: <boolean> + hubspotDefined: <boolean> + isCustomizedDefault: <boolean> + isMultiValued: <boolean> + isPartial: <boolean> + label: <string> + mutableDefinitionNotDeletable: <boolean> + name: <string> + numberDisplayHint: duration + optionSortStrategy: ALPHABETICAL + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + optionsAreMutable: <boolean> + portalId: <long> + readOnlyDefinition: <boolean> + readOnlyValue: <boolean> + referencedObjectType: MARKETING_CAMPAIGN_UTM + searchTextAnalysisMode: NONE + searchableInGlobalSearch: <boolean> + showCurrencySymbol: <boolean> + textDisplayHint: physical_address + type: object_coordinates + updatedAt: <long> + fulcrumPortalId: <integer> + janusGroup: <string> + fulcrumTimestamp: <long> + calculationFormula: <string> + propertyRequirements: + gates: + - <string> + - <string> + operator: AND + scopeNames: + - <string> + - <string> + settings: + - <string> + - <string> + definitionSource: + type: GLOBAL + name: <string> + externalOptionsMetaData: + filter: + pipelineIds: + - <string> + - <string> + relatedObjectTypeId: <string> + permission: + accessLevel: <string> + calculationExpression: + operator: CONSTANT_BOOLEAN + propertyName: <string> + inputs: + - value: >- + <Circular reference to + #/components/schemas/ConstantBoolean detected> + - value: >- + <Circular reference to + #/components/schemas/ConstantBoolean detected> + value: <boolean> + rollupExpression: + associationTypes: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + rollupOperator: <string> + sourceObjectTypeId: <string> + sourcePropertyName: <string> + emptyRollupValue: <string> + conditionalFormula: <string> + conditionalExpression: + operator: CONSTANT_BOOLEAN + propertyName: <string> + inputs: + - value: >- + <Circular reference to + #/components/schemas/ConstantBoolean detected> + - value: >- + <Circular reference to + #/components/schemas/ConstantBoolean detected> + value: <boolean> + sourceCompareByPropertyName: <string> + propertyGroups: + - deleted: <boolean> + displayName: <string> + displayOrder: <integer> + fulcrumPortalId: <integer> + fulcrumTimestamp: <long> + hubspotDefined: <boolean> + name: <string> + portalId: <long> + - deleted: <boolean> + displayName: <string> + displayOrder: <integer> + fulcrumPortalId: <integer> + fulcrumTimestamp: <long> + hubspotDefined: <boolean> + name: <string> + portalId: <long> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "non6d": [ + "<string>", + "<string>" + ], + "nulla5b": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_e2": "<string>", + "aliquip_16": "<string>", + "in_815": "<string>", + "in8c": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempord": [ + "<string>", + "<string>" + ], + "eua": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempor__d": [ + "<string>", + "<string>" + ], + "est90": [ + "<string>", + "<string>" + ] + } + } + ] + } + /media-bridge/v1/{appId}/settings/oembed-domains: + get: + tags: + - Media Bridge API > Integrator_Settings + summary: get-/media-bridge/v1/{app Id}/settings/oembed-domains + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: domainPortalId + in: query + schema: + type: string + example: '-1' + - name: appId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: j, + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - appId: <integer> + createdAt: <long> + deletedAt: <long> + endpoints: + discovery: <boolean> + schemes: + - <string> + - <string> + url: <string> + id: <long> + portalId: <integer> + updatedAt: <long> + - appId: <integer> + createdAt: <long> + deletedAt: <long> + endpoints: + discovery: <boolean> + schemes: + - <string> + - <string> + url: <string> + id: <long> + portalId: <integer> + updatedAt: <long> + totalCount: <integer> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "non6d": [ + "<string>", + "<string>" + ], + "nulla5b": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_e2": "<string>", + "aliquip_16": "<string>", + "in_815": "<string>", + "in8c": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempord": [ + "<string>", + "<string>" + ], + "eua": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempor__d": [ + "<string>", + "<string>" + ], + "est90": [ + "<string>", + "<string>" + ] + } + } + ] + } + post: + tags: + - Media Bridge API > Integrator_Settings + summary: post-/media-bridge/v1/{app Id}/settings/oembed-domains + requestBody: + content: + application/json: + schema: + type: object + example: + endpoints: + discovery: <boolean> + schemes: + - <string> + - <string> + url: <string> + portalId: <integer> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: appId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: j, + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + appId: <integer> + createdAt: <long> + deletedAt: <long> + endpoints: + discovery: <boolean> + schemes: + - <string> + - <string> + url: <string> + id: <long> + portalId: <integer> + updatedAt: <long> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "non6d": [ + "<string>", + "<string>" + ], + "nulla5b": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_e2": "<string>", + "aliquip_16": "<string>", + "in_815": "<string>", + "in8c": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempord": [ + "<string>", + "<string>" + ], + "eua": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempor__d": [ + "<string>", + "<string>" + ], + "est90": [ + "<string>", + "<string>" + ] + } + } + ] + } + delete: + tags: + - Media Bridge API > Integrator_Settings + summary: delete-/media-bridge/v1/{app Id}/settings/oembed-domains + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: id + in: query + schema: + type: string + example: <long> + - name: domainPortalId + in: query + schema: + type: string + example: '-1' + - name: appId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: j, + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "non6d": [ + "<string>", + "<string>" + ], + "nulla5b": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_e2": "<string>", + "aliquip_16": "<string>", + "in_815": "<string>", + "in8c": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempord": [ + "<string>", + "<string>" + ], + "eua": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempor__d": [ + "<string>", + "<string>" + ], + "est90": [ + "<string>", + "<string>" + ] + } + } + ] + } + /media-bridge/v1/{appId}/settings: + put: + tags: + - Media Bridge API > Integrator_Settings + summary: put-/media-bridge/v1/{app Id}/settings + requestBody: + content: + application/json: + schema: + type: object + example: + updatedAt: <long> + name: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: appId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: j, + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + appId: <integer> + name: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "non6d": [ + "<string>", + "<string>" + ], + "nulla5b": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_e2": "<string>", + "aliquip_16": "<string>", + "in_815": "<string>", + "in8c": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempord": [ + "<string>", + "<string>" + ], + "eua": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempor__d": [ + "<string>", + "<string>" + ], + "est90": [ + "<string>", + "<string>" + ] + } + } + ] + } + /media-bridge/v1/{appId}/settings/oembed-domains/{oEmbedDomainId}: + get: + tags: + - Media Bridge API > Integrator_Settings + summary: >- + get-/media-bridge/v1/{app Id}/settings/oembed-domains/{o Embed Domain + Id} + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: appId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: j, + - name: oEmbedDomainId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + appId: <integer> + createdAt: <long> + deletedAt: <long> + endpoints: + discovery: <boolean> + schemes: + - <string> + - <string> + url: <string> + id: <long> + portalId: <integer> + updatedAt: <long> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "non6d": [ + "<string>", + "<string>" + ], + "nulla5b": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_e2": "<string>", + "aliquip_16": "<string>", + "in_815": "<string>", + "in8c": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempord": [ + "<string>", + "<string>" + ], + "eua": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempor__d": [ + "<string>", + "<string>" + ], + "est90": [ + "<string>", + "<string>" + ] + } + } + ] + } + patch: + tags: + - Media Bridge API > Integrator_Settings + summary: >- + patch-/media-bridge/v1/{app Id}/settings/oembed-domains/{o Embed Domain + Id} + requestBody: + content: + application/json: + schema: + type: object + example: + endpoints: + discovery: <boolean> + schemes: + - <string> + - <string> + url: <string> + portalId: <integer> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: appId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: j, + - name: oEmbedDomainId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + appId: <integer> + createdAt: <long> + deletedAt: <long> + endpoints: + discovery: <boolean> + schemes: + - <string> + - <string> + url: <string> + id: <long> + portalId: <integer> + updatedAt: <long> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "non6d": [ + "<string>", + "<string>" + ], + "nulla5b": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_e2": "<string>", + "aliquip_16": "<string>", + "in_815": "<string>", + "in8c": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempord": [ + "<string>", + "<string>" + ], + "eua": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempor__d": [ + "<string>", + "<string>" + ], + "est90": [ + "<string>", + "<string>" + ] + } + } + ] + } + /media-bridge/v1/{appId}/schemas: + get: + tags: + - Media Bridge API > Schemas + summary: get-/media-bridge/v1/{app Id}/schemas + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + - name: appId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: j, + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - archived: <boolean> + associations: + - fromObjectTypeId: <string> + id: <string> + toObjectTypeId: <string> + createdAt: <dateTime> + name: <string> + updatedAt: <dateTime> + - fromObjectTypeId: <string> + id: <string> + toObjectTypeId: <string> + createdAt: <dateTime> + name: <string> + updatedAt: <dateTime> + fullyQualifiedName: <string> + id: <string> + labels: + plural: <string> + singular: <string> + name: <string> + objectTypeId: <string> + properties: + - description: <string> + fieldType: <string> + groupName: <string> + label: <string> + name: <string> + options: + - hidden: <boolean> + label: <string> + value: <string> + displayOrder: <integer> + description: <string> + - hidden: <boolean> + label: <string> + value: <string> + displayOrder: <integer> + description: <string> + type: <string> + createdUserId: <string> + hidden: <boolean> + modificationMetadata: + archivable: <boolean> + readOnlyDefinition: <boolean> + readOnlyValue: <boolean> + readOnlyOptions: <boolean> + displayOrder: <integer> + showCurrencySymbol: <boolean> + hubspotDefined: <boolean> + formField: <boolean> + createdAt: <dateTime> + archivedAt: <dateTime> + archived: <boolean> + referencedObjectType: <string> + calculationFormula: <string> + hasUniqueValue: <boolean> + updatedUserId: <string> + calculated: <boolean> + externalOptions: <boolean> + updatedAt: <dateTime> + - description: <string> + fieldType: <string> + groupName: <string> + label: <string> + name: <string> + options: + - hidden: <boolean> + label: <string> + value: <string> + displayOrder: <integer> + description: <string> + - hidden: <boolean> + label: <string> + value: <string> + displayOrder: <integer> + description: <string> + type: <string> + createdUserId: <string> + hidden: <boolean> + modificationMetadata: + archivable: <boolean> + readOnlyDefinition: <boolean> + readOnlyValue: <boolean> + readOnlyOptions: <boolean> + displayOrder: <integer> + showCurrencySymbol: <boolean> + hubspotDefined: <boolean> + formField: <boolean> + createdAt: <dateTime> + archivedAt: <dateTime> + archived: <boolean> + referencedObjectType: <string> + calculationFormula: <string> + hasUniqueValue: <boolean> + updatedUserId: <string> + calculated: <boolean> + externalOptions: <boolean> + updatedAt: <dateTime> + requiredProperties: + - <string> + - <string> + searchableProperties: + - <string> + - <string> + secondaryDisplayProperties: + - <string> + - <string> + description: <string> + createdAt: <dateTime> + primaryDisplayProperty: <string> + updatedAt: <dateTime> + - archived: <boolean> + associations: + - fromObjectTypeId: <string> + id: <string> + toObjectTypeId: <string> + createdAt: <dateTime> + name: <string> + updatedAt: <dateTime> + - fromObjectTypeId: <string> + id: <string> + toObjectTypeId: <string> + createdAt: <dateTime> + name: <string> + updatedAt: <dateTime> + fullyQualifiedName: <string> + id: <string> + labels: + plural: <string> + singular: <string> + name: <string> + objectTypeId: <string> + properties: + - description: <string> + fieldType: <string> + groupName: <string> + label: <string> + name: <string> + options: + - hidden: <boolean> + label: <string> + value: <string> + displayOrder: <integer> + description: <string> + - hidden: <boolean> + label: <string> + value: <string> + displayOrder: <integer> + description: <string> + type: <string> + createdUserId: <string> + hidden: <boolean> + modificationMetadata: + archivable: <boolean> + readOnlyDefinition: <boolean> + readOnlyValue: <boolean> + readOnlyOptions: <boolean> + displayOrder: <integer> + showCurrencySymbol: <boolean> + hubspotDefined: <boolean> + formField: <boolean> + createdAt: <dateTime> + archivedAt: <dateTime> + archived: <boolean> + referencedObjectType: <string> + calculationFormula: <string> + hasUniqueValue: <boolean> + updatedUserId: <string> + calculated: <boolean> + externalOptions: <boolean> + updatedAt: <dateTime> + - description: <string> + fieldType: <string> + groupName: <string> + label: <string> + name: <string> + options: + - hidden: <boolean> + label: <string> + value: <string> + displayOrder: <integer> + description: <string> + - hidden: <boolean> + label: <string> + value: <string> + displayOrder: <integer> + description: <string> + type: <string> + createdUserId: <string> + hidden: <boolean> + modificationMetadata: + archivable: <boolean> + readOnlyDefinition: <boolean> + readOnlyValue: <boolean> + readOnlyOptions: <boolean> + displayOrder: <integer> + showCurrencySymbol: <boolean> + hubspotDefined: <boolean> + formField: <boolean> + createdAt: <dateTime> + archivedAt: <dateTime> + archived: <boolean> + referencedObjectType: <string> + calculationFormula: <string> + hasUniqueValue: <boolean> + updatedUserId: <string> + calculated: <boolean> + externalOptions: <boolean> + updatedAt: <dateTime> + requiredProperties: + - <string> + - <string> + searchableProperties: + - <string> + - <string> + secondaryDisplayProperties: + - <string> + - <string> + description: <string> + createdAt: <dateTime> + primaryDisplayProperty: <string> + updatedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "non6d": [ + "<string>", + "<string>" + ], + "nulla5b": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_e2": "<string>", + "aliquip_16": "<string>", + "in_815": "<string>", + "in8c": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempord": [ + "<string>", + "<string>" + ], + "eua": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempor__d": [ + "<string>", + "<string>" + ], + "est90": [ + "<string>", + "<string>" + ] + } + } + ] + } + /media-bridge/v1/{appId}/schemas/{objectType}/associations: + post: + tags: + - Media Bridge API > Schemas + summary: post-/media-bridge/v1/{app Id}/schemas/{object Type}/associations + requestBody: + content: + application/json: + schema: + type: object + example: + fromObjectTypeId: <string> + toObjectTypeId: <string> + name: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: appId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: j, + - name: objectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + fromObjectTypeId: <string> + id: <string> + toObjectTypeId: <string> + createdAt: <dateTime> + name: <string> + updatedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "non6d": [ + "<string>", + "<string>" + ], + "nulla5b": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_e2": "<string>", + "aliquip_16": "<string>", + "in_815": "<string>", + "in8c": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempord": [ + "<string>", + "<string>" + ], + "eua": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempor__d": [ + "<string>", + "<string>" + ], + "est90": [ + "<string>", + "<string>" + ] + } + } + ] + } + /media-bridge/v1/{appId}/schemas/{objectType}: + get: + tags: + - Media Bridge API > Schemas + summary: get-/media-bridge/v1/{app Id}/schemas/{object Type} + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: appId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: j, + - name: objectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + archived: <boolean> + associations: + - fromObjectTypeId: <string> + id: <string> + toObjectTypeId: <string> + createdAt: <dateTime> + name: <string> + updatedAt: <dateTime> + - fromObjectTypeId: <string> + id: <string> + toObjectTypeId: <string> + createdAt: <dateTime> + name: <string> + updatedAt: <dateTime> + fullyQualifiedName: <string> + id: <string> + labels: + plural: <string> + singular: <string> + name: <string> + objectTypeId: <string> + properties: + - description: <string> + fieldType: <string> + groupName: <string> + label: <string> + name: <string> + options: + - hidden: <boolean> + label: <string> + value: <string> + displayOrder: <integer> + description: <string> + - hidden: <boolean> + label: <string> + value: <string> + displayOrder: <integer> + description: <string> + type: <string> + createdUserId: <string> + hidden: <boolean> + modificationMetadata: + archivable: <boolean> + readOnlyDefinition: <boolean> + readOnlyValue: <boolean> + readOnlyOptions: <boolean> + displayOrder: <integer> + showCurrencySymbol: <boolean> + hubspotDefined: <boolean> + formField: <boolean> + createdAt: <dateTime> + archivedAt: <dateTime> + archived: <boolean> + referencedObjectType: <string> + calculationFormula: <string> + hasUniqueValue: <boolean> + updatedUserId: <string> + calculated: <boolean> + externalOptions: <boolean> + updatedAt: <dateTime> + - description: <string> + fieldType: <string> + groupName: <string> + label: <string> + name: <string> + options: + - hidden: <boolean> + label: <string> + value: <string> + displayOrder: <integer> + description: <string> + - hidden: <boolean> + label: <string> + value: <string> + displayOrder: <integer> + description: <string> + type: <string> + createdUserId: <string> + hidden: <boolean> + modificationMetadata: + archivable: <boolean> + readOnlyDefinition: <boolean> + readOnlyValue: <boolean> + readOnlyOptions: <boolean> + displayOrder: <integer> + showCurrencySymbol: <boolean> + hubspotDefined: <boolean> + formField: <boolean> + createdAt: <dateTime> + archivedAt: <dateTime> + archived: <boolean> + referencedObjectType: <string> + calculationFormula: <string> + hasUniqueValue: <boolean> + updatedUserId: <string> + calculated: <boolean> + externalOptions: <boolean> + updatedAt: <dateTime> + requiredProperties: + - <string> + - <string> + searchableProperties: + - <string> + - <string> + secondaryDisplayProperties: + - <string> + - <string> + description: <string> + createdAt: <dateTime> + primaryDisplayProperty: <string> + updatedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "non6d": [ + "<string>", + "<string>" + ], + "nulla5b": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_e2": "<string>", + "aliquip_16": "<string>", + "in_815": "<string>", + "in8c": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempord": [ + "<string>", + "<string>" + ], + "eua": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempor__d": [ + "<string>", + "<string>" + ], + "est90": [ + "<string>", + "<string>" + ] + } + } + ] + } + patch: + tags: + - Media Bridge API > Schemas + summary: patch-/media-bridge/v1/{app Id}/schemas/{object Type} + requestBody: + content: + application/json: + schema: + type: object + example: + clearDescription: <boolean> + secondaryDisplayProperties: + - <string> + - <string> + requiredProperties: + - <string> + - <string> + searchableProperties: + - <string> + - <string> + primaryDisplayProperty: <string> + description: <string> + restorable: <boolean> + labels: + plural: <string> + singular: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: appId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: j, + - name: objectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + archived: <boolean> + fullyQualifiedName: <string> + id: <string> + labels: + plural: <string> + singular: <string> + name: <string> + objectTypeId: <string> + requiredProperties: + - <string> + - <string> + searchableProperties: + - <string> + - <string> + secondaryDisplayProperties: + - <string> + - <string> + description: <string> + createdAt: <dateTime> + portalId: <integer> + primaryDisplayProperty: <string> + updatedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "non6d": [ + "<string>", + "<string>" + ], + "nulla5b": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_e2": "<string>", + "aliquip_16": "<string>", + "in_815": "<string>", + "in8c": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempord": [ + "<string>", + "<string>" + ], + "eua": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempor__d": [ + "<string>", + "<string>" + ], + "est90": [ + "<string>", + "<string>" + ] + } + } + ] + } + /media-bridge/v1/{appId}/schemas/{objectType}/associations/{associationId}: + delete: + tags: + - Media Bridge API > Schemas + summary: >- + delete-/media-bridge/v1/{app Id}/schemas/{object + Type}/associations/{association Id} + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: appId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: j, + - name: objectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + - name: associationId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "non6d": [ + "<string>", + "<string>" + ], + "nulla5b": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_e2": "<string>", + "aliquip_16": "<string>", + "in_815": "<string>", + "in8c": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempord": [ + "<string>", + "<string>" + ], + "eua": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempor__d": [ + "<string>", + "<string>" + ], + "est90": [ + "<string>", + "<string>" + ] + } + } + ] + } + /media-bridge/v1/{appId}/properties/{objectType}/batch/archive: + post: + tags: + - Media Bridge API > Properties + summary: post-/media-bridge/v1/{app Id}/properties/{object Type}/batch/archive + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - name: <string> + - name: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: appId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: j, + - name: objectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "non6d": [ + "<string>", + "<string>" + ], + "nulla5b": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_e2": "<string>", + "aliquip_16": "<string>", + "in_815": "<string>", + "in8c": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempord": [ + "<string>", + "<string>" + ], + "eua": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempor__d": [ + "<string>", + "<string>" + ], + "est90": [ + "<string>", + "<string>" + ] + } + } + ] + } + /media-bridge/v1/{appId}/properties/{objectType}/{propertyName}: + get: + tags: + - Media Bridge API > Properties + summary: get-/media-bridge/v1/{app Id}/properties/{object Type}/{property Name} + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + - name: properties + in: query + schema: + type: string + example: <string> + - name: appId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: j, + - name: objectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + - name: propertyName + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + allowedObjectTypes: + - innerId: <integer> + metaTypeId: <integer> + - innerId: <integer> + metaTypeId: <integer> + calculated: <boolean> + createdAt: <long> + createdUserId: <long> + currencyPropertyName: <string> + deleted: <boolean> + description: <string> + displayMode: current_value + displayOrder: <integer> + externalOptions: <boolean> + externalOptionsReferenceType: <string> + favorited: <boolean> + favoritedOrder: <integer> + fieldType: <string> + formField: <boolean> + fromUserId: <long> + groupName: <string> + hasUniqueValue: <boolean> + hidden: <boolean> + hubspotDefined: <boolean> + isCustomizedDefault: <boolean> + isMultiValued: <boolean> + isPartial: <boolean> + label: <string> + mutableDefinitionNotDeletable: <boolean> + name: <string> + numberDisplayHint: unformatted + optionSortStrategy: ALPHABETICAL + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + optionsAreMutable: <boolean> + portalId: <long> + readOnlyDefinition: <boolean> + readOnlyValue: <boolean> + referencedObjectType: TASK + searchTextAnalysisMode: NONE + searchableInGlobalSearch: <boolean> + showCurrencySymbol: <boolean> + textDisplayHint: unformatted_single_line + type: number + updatedAt: <long> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "non6d": [ + "<string>", + "<string>" + ], + "nulla5b": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_e2": "<string>", + "aliquip_16": "<string>", + "in_815": "<string>", + "in8c": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempord": [ + "<string>", + "<string>" + ], + "eua": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempor__d": [ + "<string>", + "<string>" + ], + "est90": [ + "<string>", + "<string>" + ] + } + } + ] + } + delete: + tags: + - Media Bridge API > Properties + summary: >- + delete-/media-bridge/v1/{app Id}/properties/{object Type}/{property + Name} + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: appId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: j, + - name: objectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + - name: propertyName + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "non6d": [ + "<string>", + "<string>" + ], + "nulla5b": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_e2": "<string>", + "aliquip_16": "<string>", + "in_815": "<string>", + "in8c": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempord": [ + "<string>", + "<string>" + ], + "eua": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempor__d": [ + "<string>", + "<string>" + ], + "est90": [ + "<string>", + "<string>" + ] + } + } + ] + } + patch: + tags: + - Media Bridge API > Properties + summary: patch-/media-bridge/v1/{app Id}/properties/{object Type}/{property Name} + requestBody: + content: + application/json: + schema: + type: object + example: + groupName: <string> + hidden: <boolean> + options: + - displayOrder: <integer> + hidden: <boolean> + label: <string> + value: <string> + description: <string> + - displayOrder: <integer> + hidden: <boolean> + label: <string> + value: <string> + description: <string> + displayOrder: <integer> + description: <string> + calculationFormula: <string> + label: <string> + hasUniqueValue: <boolean> + type: datetime + fieldType: select + formField: <boolean> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: appId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: j, + - name: objectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + - name: propertyName + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + allowedObjectTypes: + - innerId: <integer> + metaTypeId: <integer> + - innerId: <integer> + metaTypeId: <integer> + calculated: <boolean> + createdAt: <long> + createdUserId: <long> + currencyPropertyName: <string> + deleted: <boolean> + description: <string> + displayMode: current_value + displayOrder: <integer> + externalOptions: <boolean> + externalOptionsReferenceType: <string> + favorited: <boolean> + favoritedOrder: <integer> + fieldType: <string> + formField: <boolean> + fromUserId: <long> + groupName: <string> + hasUniqueValue: <boolean> + hidden: <boolean> + hubspotDefined: <boolean> + isCustomizedDefault: <boolean> + isMultiValued: <boolean> + isPartial: <boolean> + label: <string> + mutableDefinitionNotDeletable: <boolean> + name: <string> + numberDisplayHint: unformatted + optionSortStrategy: ALPHABETICAL + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + optionsAreMutable: <boolean> + portalId: <long> + readOnlyDefinition: <boolean> + readOnlyValue: <boolean> + referencedObjectType: TASK + searchTextAnalysisMode: NONE + searchableInGlobalSearch: <boolean> + showCurrencySymbol: <boolean> + textDisplayHint: unformatted_single_line + type: number + updatedAt: <long> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "non6d": [ + "<string>", + "<string>" + ], + "nulla5b": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_e2": "<string>", + "aliquip_16": "<string>", + "in_815": "<string>", + "in8c": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempord": [ + "<string>", + "<string>" + ], + "eua": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempor__d": [ + "<string>", + "<string>" + ], + "est90": [ + "<string>", + "<string>" + ] + } + } + ] + } + /media-bridge/v1/{appId}/properties/{objectType}/batch/read: + post: + tags: + - Media Bridge API > Properties + summary: post-/media-bridge/v1/{app Id}/properties/{object Type}/batch/read + requestBody: + content: + application/json: + schema: + type: object + example: + archived: <boolean> + inputs: + - name: <string> + - name: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: appId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: j, + - name: objectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - allowedObjectTypes: + - innerId: <integer> + metaTypeId: <integer> + - innerId: <integer> + metaTypeId: <integer> + calculated: <boolean> + createdAt: <long> + createdUserId: <long> + currencyPropertyName: <string> + deleted: <boolean> + description: <string> + displayMode: current_value + displayOrder: <integer> + externalOptions: <boolean> + externalOptionsReferenceType: <string> + favorited: <boolean> + favoritedOrder: <integer> + fieldType: <string> + formField: <boolean> + fromUserId: <long> + groupName: <string> + hasUniqueValue: <boolean> + hidden: <boolean> + hubspotDefined: <boolean> + isCustomizedDefault: <boolean> + isMultiValued: <boolean> + isPartial: <boolean> + label: <string> + mutableDefinitionNotDeletable: <boolean> + name: <string> + numberDisplayHint: currency + optionSortStrategy: DISPLAY_ORDER + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + optionsAreMutable: <boolean> + portalId: <long> + readOnlyDefinition: <boolean> + readOnlyValue: <boolean> + referencedObjectType: LEAD + searchTextAnalysisMode: NONE + searchableInGlobalSearch: <boolean> + showCurrencySymbol: <boolean> + textDisplayHint: multi_line + type: currency_number + updatedAt: <long> + - allowedObjectTypes: + - innerId: <integer> + metaTypeId: <integer> + - innerId: <integer> + metaTypeId: <integer> + calculated: <boolean> + createdAt: <long> + createdUserId: <long> + currencyPropertyName: <string> + deleted: <boolean> + description: <string> + displayMode: current_value + displayOrder: <integer> + externalOptions: <boolean> + externalOptionsReferenceType: <string> + favorited: <boolean> + favoritedOrder: <integer> + fieldType: <string> + formField: <boolean> + fromUserId: <long> + groupName: <string> + hasUniqueValue: <boolean> + hidden: <boolean> + hubspotDefined: <boolean> + isCustomizedDefault: <boolean> + isMultiValued: <boolean> + isPartial: <boolean> + label: <string> + mutableDefinitionNotDeletable: <boolean> + name: <string> + numberDisplayHint: currency + optionSortStrategy: ALPHABETICAL + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + optionsAreMutable: <boolean> + portalId: <long> + readOnlyDefinition: <boolean> + readOnlyValue: <boolean> + referencedObjectType: SCORE_CONFIGURATION + searchTextAnalysisMode: NONE + searchableInGlobalSearch: <boolean> + showCurrencySymbol: <boolean> + textDisplayHint: domain_name + type: string + updatedAt: <long> + startedAt: <dateTime> + status: COMPLETE + requestedAt: <dateTime> + links: + aliqua_a: <string> + proident_6d5: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - allowedObjectTypes: + - innerId: <integer> + metaTypeId: <integer> + - innerId: <integer> + metaTypeId: <integer> + calculated: <boolean> + createdAt: <long> + createdUserId: <long> + currencyPropertyName: <string> + deleted: <boolean> + description: <string> + displayMode: current_value + displayOrder: <integer> + externalOptions: <boolean> + externalOptionsReferenceType: <string> + favorited: <boolean> + favoritedOrder: <integer> + fieldType: <string> + formField: <boolean> + fromUserId: <long> + groupName: <string> + hasUniqueValue: <boolean> + hidden: <boolean> + hubspotDefined: <boolean> + isCustomizedDefault: <boolean> + isMultiValued: <boolean> + isPartial: <boolean> + label: <string> + mutableDefinitionNotDeletable: <boolean> + name: <string> + numberDisplayHint: currency + optionSortStrategy: ALPHABETICAL + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + optionsAreMutable: <boolean> + portalId: <long> + readOnlyDefinition: <boolean> + readOnlyValue: <boolean> + referencedObjectType: BET_DELIVERABLE_SERVICE + searchTextAnalysisMode: NOT_ANALYZED_TEXT + searchableInGlobalSearch: <boolean> + showCurrencySymbol: <boolean> + textDisplayHint: multi_line + type: phone_number + updatedAt: <long> + - allowedObjectTypes: + - innerId: <integer> + metaTypeId: <integer> + - innerId: <integer> + metaTypeId: <integer> + calculated: <boolean> + createdAt: <long> + createdUserId: <long> + currencyPropertyName: <string> + deleted: <boolean> + description: <string> + displayMode: current_value + displayOrder: <integer> + externalOptions: <boolean> + externalOptionsReferenceType: <string> + favorited: <boolean> + favoritedOrder: <integer> + fieldType: <string> + formField: <boolean> + fromUserId: <long> + groupName: <string> + hasUniqueValue: <boolean> + hidden: <boolean> + hubspotDefined: <boolean> + isCustomizedDefault: <boolean> + isMultiValued: <boolean> + isPartial: <boolean> + label: <string> + mutableDefinitionNotDeletable: <boolean> + name: <string> + numberDisplayHint: formatted + optionSortStrategy: ALPHABETICAL + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + optionsAreMutable: <boolean> + portalId: <long> + readOnlyDefinition: <boolean> + readOnlyValue: <boolean> + referencedObjectType: CAMPAIGN_TEMPLATE_STEP + searchTextAnalysisMode: NONE + searchableInGlobalSearch: <boolean> + showCurrencySymbol: <boolean> + textDisplayHint: unformatted_single_line + type: date + updatedAt: <long> + startedAt: <dateTime> + status: CANCELED + numErrors: <integer> + requestedAt: <dateTime> + links: + officia8: <string> + iddb: <string> + tempor1d: <string> + errors: + - category: <string> + context: + inc1: + - <string> + - <string> + veniam_edf: + - <string> + - <string> + ea0c: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + reprehenderita84: + - <string> + - <string> + Lorem_59: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + amet_: + - <string> + - <string> + voluptate557: + - <string> + - <string> + dolord2f: + - <string> + - <string> + dolore_6: + - <string> + - <string> + links: + consectetur_81d: <string> + Excepteur_cd_: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + - category: <string> + context: + dolor_e: + - <string> + - <string> + Excepteurd: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + magna_13: + - <string> + - <string> + commodo29f: + - <string> + - <string> + in_e66: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + pariatur3c: + - <string> + - <string> + pariatur_47: + - <string> + - <string> + doloref_: + - <string> + - <string> + links: + est9c4: <string> + ut_: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "non6d": [ + "<string>", + "<string>" + ], + "nulla5b": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_e2": "<string>", + "aliquip_16": "<string>", + "in_815": "<string>", + "in8c": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempord": [ + "<string>", + "<string>" + ], + "eua": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempor__d": [ + "<string>", + "<string>" + ], + "est90": [ + "<string>", + "<string>" + ] + } + } + ] + } + /media-bridge/v1/{appId}/properties/{objectType}: + get: + tags: + - Media Bridge API > Properties + summary: get-/media-bridge/v1/{app Id}/properties/{object Type} + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + - name: properties + in: query + schema: + type: string + example: <string> + - name: appId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: j, + - name: objectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - description: <string> + fieldType: <string> + groupName: <string> + label: <string> + name: <string> + options: + - hidden: <boolean> + label: <string> + value: <string> + displayOrder: <integer> + description: <string> + - hidden: <boolean> + label: <string> + value: <string> + displayOrder: <integer> + description: <string> + type: <string> + createdUserId: <string> + hidden: <boolean> + modificationMetadata: + archivable: <boolean> + readOnlyDefinition: <boolean> + readOnlyValue: <boolean> + readOnlyOptions: <boolean> + displayOrder: <integer> + showCurrencySymbol: <boolean> + hubspotDefined: <boolean> + formField: <boolean> + createdAt: <dateTime> + archivedAt: <dateTime> + archived: <boolean> + referencedObjectType: <string> + calculationFormula: <string> + hasUniqueValue: <boolean> + updatedUserId: <string> + calculated: <boolean> + externalOptions: <boolean> + updatedAt: <dateTime> + - description: <string> + fieldType: <string> + groupName: <string> + label: <string> + name: <string> + options: + - hidden: <boolean> + label: <string> + value: <string> + displayOrder: <integer> + description: <string> + - hidden: <boolean> + label: <string> + value: <string> + displayOrder: <integer> + description: <string> + type: <string> + createdUserId: <string> + hidden: <boolean> + modificationMetadata: + archivable: <boolean> + readOnlyDefinition: <boolean> + readOnlyValue: <boolean> + readOnlyOptions: <boolean> + displayOrder: <integer> + showCurrencySymbol: <boolean> + hubspotDefined: <boolean> + formField: <boolean> + createdAt: <dateTime> + archivedAt: <dateTime> + archived: <boolean> + referencedObjectType: <string> + calculationFormula: <string> + hasUniqueValue: <boolean> + updatedUserId: <string> + calculated: <boolean> + externalOptions: <boolean> + updatedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "non6d": [ + "<string>", + "<string>" + ], + "nulla5b": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_e2": "<string>", + "aliquip_16": "<string>", + "in_815": "<string>", + "in8c": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempord": [ + "<string>", + "<string>" + ], + "eua": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempor__d": [ + "<string>", + "<string>" + ], + "est90": [ + "<string>", + "<string>" + ] + } + } + ] + } + post: + tags: + - Media Bridge API > Properties + summary: post-/media-bridge/v1/{app Id}/properties/{object Type} + requestBody: + content: + application/json: + schema: + type: object + example: + fieldType: html + groupName: <string> + label: <string> + name: <string> + type: date + hidden: <boolean> + displayOrder: <integer> + description: <string> + formField: <boolean> + referencedObjectType: <string> + options: + - displayOrder: <integer> + hidden: <boolean> + label: <string> + value: <string> + description: <string> + - displayOrder: <integer> + hidden: <boolean> + label: <string> + value: <string> + description: <string> + calculationFormula: <string> + hasUniqueValue: <boolean> + externalOptions: <boolean> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: appId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: j, + - name: objectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + allowedObjectTypes: + - innerId: <integer> + metaTypeId: <integer> + - innerId: <integer> + metaTypeId: <integer> + calculated: <boolean> + createdAt: <long> + createdUserId: <long> + currencyPropertyName: <string> + deleted: <boolean> + description: <string> + displayMode: current_value + displayOrder: <integer> + externalOptions: <boolean> + externalOptionsReferenceType: <string> + favorited: <boolean> + favoritedOrder: <integer> + fieldType: <string> + formField: <boolean> + fromUserId: <long> + groupName: <string> + hasUniqueValue: <boolean> + hidden: <boolean> + hubspotDefined: <boolean> + isCustomizedDefault: <boolean> + isMultiValued: <boolean> + isPartial: <boolean> + label: <string> + mutableDefinitionNotDeletable: <boolean> + name: <string> + numberDisplayHint: unformatted + optionSortStrategy: ALPHABETICAL + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + optionsAreMutable: <boolean> + portalId: <long> + readOnlyDefinition: <boolean> + readOnlyValue: <boolean> + referencedObjectType: TASK + searchTextAnalysisMode: NONE + searchableInGlobalSearch: <boolean> + showCurrencySymbol: <boolean> + textDisplayHint: unformatted_single_line + type: number + updatedAt: <long> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "non6d": [ + "<string>", + "<string>" + ], + "nulla5b": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_e2": "<string>", + "aliquip_16": "<string>", + "in_815": "<string>", + "in8c": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempord": [ + "<string>", + "<string>" + ], + "eua": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempor__d": [ + "<string>", + "<string>" + ], + "est90": [ + "<string>", + "<string>" + ] + } + } + ] + } + /media-bridge/v1/{appId}/properties/{objectType}/batch/create: + post: + tags: + - Media Bridge API > Properties + summary: post-/media-bridge/v1/{app Id}/properties/{object Type}/batch/create + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - fieldType: radio + groupName: <string> + label: <string> + name: <string> + type: datetime + hidden: <boolean> + displayOrder: <integer> + description: <string> + formField: <boolean> + referencedObjectType: <string> + options: + - displayOrder: <integer> + hidden: <boolean> + label: <string> + value: <string> + description: <string> + - displayOrder: <integer> + hidden: <boolean> + label: <string> + value: <string> + description: <string> + calculationFormula: <string> + hasUniqueValue: <boolean> + externalOptions: <boolean> + - fieldType: text + groupName: <string> + label: <string> + name: <string> + type: number + hidden: <boolean> + displayOrder: <integer> + description: <string> + formField: <boolean> + referencedObjectType: <string> + options: + - displayOrder: <integer> + hidden: <boolean> + label: <string> + value: <string> + description: <string> + - displayOrder: <integer> + hidden: <boolean> + label: <string> + value: <string> + description: <string> + calculationFormula: <string> + hasUniqueValue: <boolean> + externalOptions: <boolean> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: appId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: j, + - name: objectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - allowedObjectTypes: + - innerId: <integer> + metaTypeId: <integer> + - innerId: <integer> + metaTypeId: <integer> + calculated: <boolean> + createdAt: <long> + createdUserId: <long> + currencyPropertyName: <string> + deleted: <boolean> + description: <string> + displayMode: current_value + displayOrder: <integer> + externalOptions: <boolean> + externalOptionsReferenceType: <string> + favorited: <boolean> + favoritedOrder: <integer> + fieldType: <string> + formField: <boolean> + fromUserId: <long> + groupName: <string> + hasUniqueValue: <boolean> + hidden: <boolean> + hubspotDefined: <boolean> + isCustomizedDefault: <boolean> + isMultiValued: <boolean> + isPartial: <boolean> + label: <string> + mutableDefinitionNotDeletable: <boolean> + name: <string> + numberDisplayHint: currency + optionSortStrategy: DISPLAY_ORDER + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + optionsAreMutable: <boolean> + portalId: <long> + readOnlyDefinition: <boolean> + readOnlyValue: <boolean> + referencedObjectType: LEAD + searchTextAnalysisMode: NONE + searchableInGlobalSearch: <boolean> + showCurrencySymbol: <boolean> + textDisplayHint: multi_line + type: currency_number + updatedAt: <long> + - allowedObjectTypes: + - innerId: <integer> + metaTypeId: <integer> + - innerId: <integer> + metaTypeId: <integer> + calculated: <boolean> + createdAt: <long> + createdUserId: <long> + currencyPropertyName: <string> + deleted: <boolean> + description: <string> + displayMode: current_value + displayOrder: <integer> + externalOptions: <boolean> + externalOptionsReferenceType: <string> + favorited: <boolean> + favoritedOrder: <integer> + fieldType: <string> + formField: <boolean> + fromUserId: <long> + groupName: <string> + hasUniqueValue: <boolean> + hidden: <boolean> + hubspotDefined: <boolean> + isCustomizedDefault: <boolean> + isMultiValued: <boolean> + isPartial: <boolean> + label: <string> + mutableDefinitionNotDeletable: <boolean> + name: <string> + numberDisplayHint: currency + optionSortStrategy: ALPHABETICAL + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + optionsAreMutable: <boolean> + portalId: <long> + readOnlyDefinition: <boolean> + readOnlyValue: <boolean> + referencedObjectType: SCORE_CONFIGURATION + searchTextAnalysisMode: NONE + searchableInGlobalSearch: <boolean> + showCurrencySymbol: <boolean> + textDisplayHint: domain_name + type: string + updatedAt: <long> + startedAt: <dateTime> + status: COMPLETE + requestedAt: <dateTime> + links: + aliqua_a: <string> + proident_6d5: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - allowedObjectTypes: + - innerId: <integer> + metaTypeId: <integer> + - innerId: <integer> + metaTypeId: <integer> + calculated: <boolean> + createdAt: <long> + createdUserId: <long> + currencyPropertyName: <string> + deleted: <boolean> + description: <string> + displayMode: current_value + displayOrder: <integer> + externalOptions: <boolean> + externalOptionsReferenceType: <string> + favorited: <boolean> + favoritedOrder: <integer> + fieldType: <string> + formField: <boolean> + fromUserId: <long> + groupName: <string> + hasUniqueValue: <boolean> + hidden: <boolean> + hubspotDefined: <boolean> + isCustomizedDefault: <boolean> + isMultiValued: <boolean> + isPartial: <boolean> + label: <string> + mutableDefinitionNotDeletable: <boolean> + name: <string> + numberDisplayHint: currency + optionSortStrategy: ALPHABETICAL + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + optionsAreMutable: <boolean> + portalId: <long> + readOnlyDefinition: <boolean> + readOnlyValue: <boolean> + referencedObjectType: BET_DELIVERABLE_SERVICE + searchTextAnalysisMode: NOT_ANALYZED_TEXT + searchableInGlobalSearch: <boolean> + showCurrencySymbol: <boolean> + textDisplayHint: multi_line + type: phone_number + updatedAt: <long> + - allowedObjectTypes: + - innerId: <integer> + metaTypeId: <integer> + - innerId: <integer> + metaTypeId: <integer> + calculated: <boolean> + createdAt: <long> + createdUserId: <long> + currencyPropertyName: <string> + deleted: <boolean> + description: <string> + displayMode: current_value + displayOrder: <integer> + externalOptions: <boolean> + externalOptionsReferenceType: <string> + favorited: <boolean> + favoritedOrder: <integer> + fieldType: <string> + formField: <boolean> + fromUserId: <long> + groupName: <string> + hasUniqueValue: <boolean> + hidden: <boolean> + hubspotDefined: <boolean> + isCustomizedDefault: <boolean> + isMultiValued: <boolean> + isPartial: <boolean> + label: <string> + mutableDefinitionNotDeletable: <boolean> + name: <string> + numberDisplayHint: formatted + optionSortStrategy: ALPHABETICAL + options: + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + - description: <string> + displayOrder: <integer> + doubleData: <number> + hidden: <boolean> + label: <string> + readOnly: <boolean> + value: <string> + optionsAreMutable: <boolean> + portalId: <long> + readOnlyDefinition: <boolean> + readOnlyValue: <boolean> + referencedObjectType: CAMPAIGN_TEMPLATE_STEP + searchTextAnalysisMode: NONE + searchableInGlobalSearch: <boolean> + showCurrencySymbol: <boolean> + textDisplayHint: unformatted_single_line + type: date + updatedAt: <long> + startedAt: <dateTime> + status: CANCELED + numErrors: <integer> + requestedAt: <dateTime> + links: + officia8: <string> + iddb: <string> + tempor1d: <string> + errors: + - category: <string> + context: + inc1: + - <string> + - <string> + veniam_edf: + - <string> + - <string> + ea0c: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + reprehenderita84: + - <string> + - <string> + Lorem_59: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + amet_: + - <string> + - <string> + voluptate557: + - <string> + - <string> + dolord2f: + - <string> + - <string> + dolore_6: + - <string> + - <string> + links: + consectetur_81d: <string> + Excepteur_cd_: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + - category: <string> + context: + dolor_e: + - <string> + - <string> + Excepteurd: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + magna_13: + - <string> + - <string> + commodo29f: + - <string> + - <string> + in_e66: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + pariatur3c: + - <string> + - <string> + pariatur_47: + - <string> + - <string> + doloref_: + - <string> + - <string> + links: + est9c4: <string> + ut_: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "non6d": [ + "<string>", + "<string>" + ], + "nulla5b": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_e2": "<string>", + "aliquip_16": "<string>", + "in_815": "<string>", + "in8c": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempord": [ + "<string>", + "<string>" + ], + "eua": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempor__d": [ + "<string>", + "<string>" + ], + "est90": [ + "<string>", + "<string>" + ] + } + } + ] + } + /media-bridge/v1/events/attention-span: + post: + tags: + - Media Bridge API > Events + summary: post-/media-bridge/v1/events/attention-span + requestBody: + content: + application/json: + schema: + type: object + example: {} + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + contactId: <long> + mediaBridgeId: <long> + mediaBridgeObjectCoordinates: <string> + mediaBridgeObjectTypeId: <string> + mediaName: <string> + mediaType: OTHER + occurredTimestamp: <long> + percentRange: <string> + portalId: <integer> + providerId: <integer> + sessionId: <string> + totalPercentPlayed: <number> + mediaUrl: <string> + rawData: <string> + pageId: <long> + pageName: <string> + pageObjectCoordinates: <string> + totalSecondsPlayed: <integer> + pageUrl: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "non6d": [ + "<string>", + "<string>" + ], + "nulla5b": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_e2": "<string>", + "aliquip_16": "<string>", + "in_815": "<string>", + "in8c": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempord": [ + "<string>", + "<string>" + ], + "eua": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempor__d": [ + "<string>", + "<string>" + ], + "est90": [ + "<string>", + "<string>" + ] + } + } + ] + } + /media-bridge/v1/events/media-played-percent: + post: + tags: + - Media Bridge API > Events + summary: post-/media-bridge/v1/events/media-played-percent + requestBody: + content: + application/json: + schema: + type: object + example: {} + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + contactId: <long> + mediaBridgeId: <long> + mediaBridgeObjectCoordinates: <string> + mediaBridgeObjectTypeId: <string> + mediaName: <string> + mediaType: VIDEO + occurredTimestamp: <long> + playedPercent: <integer> + portalId: <integer> + providerId: <integer> + sessionId: <string> + mediaUrl: <string> + pageId: <long> + pageName: <string> + pageObjectCoordinates: <string> + pageUrl: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "non6d": [ + "<string>", + "<string>" + ], + "nulla5b": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_e2": "<string>", + "aliquip_16": "<string>", + "in_815": "<string>", + "in8c": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempord": [ + "<string>", + "<string>" + ], + "eua": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempor__d": [ + "<string>", + "<string>" + ], + "est90": [ + "<string>", + "<string>" + ] + } + } + ] + } + /media-bridge/v1/events/media-played: + post: + tags: + - Media Bridge API > Events + summary: post-/media-bridge/v1/events/media-played + requestBody: + content: + application/json: + schema: + type: object + example: {} + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + contactId: <long> + mediaBridgeId: <long> + mediaBridgeObjectCoordinates: <string> + mediaBridgeObjectTypeId: <string> + mediaName: <string> + mediaType: DOCUMENT + occurredTimestamp: <long> + portalId: <integer> + providerId: <integer> + sessionId: <string> + state: STARTED + mediaUrl: <string> + pageId: <long> + pageName: <string> + iframeUrl: <string> + pageObjectCoordinates: <string> + pageUrl: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "non6d": [ + "<string>", + "<string>" + ], + "nulla5b": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_e2": "<string>", + "aliquip_16": "<string>", + "in_815": "<string>", + "in8c": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempord": [ + "<string>", + "<string>" + ], + "eua": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempor__d": [ + "<string>", + "<string>" + ], + "est90": [ + "<string>", + "<string>" + ] + } + } + ] + } + /media-bridge/v1/{appId}/properties/{objectType}/groups: + get: + tags: + - Media Bridge API > Groups + summary: get-/media-bridge/v1/{app Id}/properties/{object Type}/groups + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: appId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: j, + - name: objectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - archived: <boolean> + label: <string> + name: <string> + displayOrder: <integer> + - archived: <boolean> + label: <string> + name: <string> + displayOrder: <integer> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "non6d": [ + "<string>", + "<string>" + ], + "nulla5b": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_e2": "<string>", + "aliquip_16": "<string>", + "in_815": "<string>", + "in8c": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempord": [ + "<string>", + "<string>" + ], + "eua": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempor__d": [ + "<string>", + "<string>" + ], + "est90": [ + "<string>", + "<string>" + ] + } + } + ] + } + post: + tags: + - Media Bridge API > Groups + summary: post-/media-bridge/v1/{app Id}/properties/{object Type}/groups + requestBody: + content: + application/json: + schema: + type: object + example: + label: <string> + name: <string> + displayOrder: <integer> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: appId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: j, + - name: objectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + archived: <boolean> + label: <string> + name: <string> + displayOrder: <integer> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "non6d": [ + "<string>", + "<string>" + ], + "nulla5b": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_e2": "<string>", + "aliquip_16": "<string>", + "in_815": "<string>", + "in8c": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempord": [ + "<string>", + "<string>" + ], + "eua": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempor__d": [ + "<string>", + "<string>" + ], + "est90": [ + "<string>", + "<string>" + ] + } + } + ] + } + /media-bridge/v1/{appId}/properties/{objectType}/groups/{groupName}: + get: + tags: + - Media Bridge API > Groups + summary: >- + get-/media-bridge/v1/{app Id}/properties/{object Type}/groups/{group + Name} + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: appId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: j, + - name: objectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + - name: groupName + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + archived: <boolean> + label: <string> + name: <string> + displayOrder: <integer> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "non6d": [ + "<string>", + "<string>" + ], + "nulla5b": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_e2": "<string>", + "aliquip_16": "<string>", + "in_815": "<string>", + "in8c": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempord": [ + "<string>", + "<string>" + ], + "eua": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempor__d": [ + "<string>", + "<string>" + ], + "est90": [ + "<string>", + "<string>" + ] + } + } + ] + } + delete: + tags: + - Media Bridge API > Groups + summary: >- + delete-/media-bridge/v1/{app Id}/properties/{object Type}/groups/{group + Name} + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: appId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: j, + - name: objectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + - name: groupName + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "non6d": [ + "<string>", + "<string>" + ], + "nulla5b": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_e2": "<string>", + "aliquip_16": "<string>", + "in_815": "<string>", + "in8c": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempord": [ + "<string>", + "<string>" + ], + "eua": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempor__d": [ + "<string>", + "<string>" + ], + "est90": [ + "<string>", + "<string>" + ] + } + } + ] + } + patch: + tags: + - Media Bridge API > Groups + summary: >- + patch-/media-bridge/v1/{app Id}/properties/{object Type}/groups/{group + Name} + requestBody: + content: + application/json: + schema: + type: object + example: + displayOrder: <integer> + label: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: appId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: j, + - name: objectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + - name: groupName + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + archived: <boolean> + label: <string> + name: <string> + displayOrder: <integer> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "non6d": [ + "<string>", + "<string>" + ], + "nulla5b": [ + "<string>", + "<string>" + ] + }, + "links": { + "consequat_e2": "<string>", + "aliquip_16": "<string>", + "in_815": "<string>", + "in8c": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempord": [ + "<string>", + "<string>" + ], + "eua": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "tempor__d": [ + "<string>", + "<string>" + ], + "est90": [ + "<string>", + "<string>" + ] + } + } + ] + } + /cms/v3/site-search/indexed-data/{contentId}: + get: + tags: + - Site Search API > Public + summary: Get indexed properties. + description: >- + For a given account and document ID (page ID, blog post ID, HubDB row + ID, etc.), return all indexed data for that document. This is useful + when debugging why a particular document is not returned from a custom + search. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: type + in: query + schema: + type: string + description: >- + The type of document. Can be one of `SITE_PAGE`, `BLOG_POST`, or + `KNOWLEDGE_ARTICLE`. + example: KNOWLEDGE_ARTICLE + - name: contentId + in: path + schema: + type: string + required: true + description: >- + (Required) ID of the target document when searching for indexed + properties. + example: Qc`Z(z5W0@ + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + fields: + nulla18: + metadataField: <boolean> + name: <string> + value: {} + values: [] + veniam42: + metadataField: <boolean> + name: <string> + value: {} + values: [] + id: <string> + type: LANDING_PAGE + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "et_c": [ + "<string>", + "<string>" + ] + }, + "links": { + "dolore_24": "<string>", + "sedf8": "<string>", + "Excepteur_f": "<string>", + "eud": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "Lorema38": [ + "<string>", + "<string>" + ], + "nulla44": [ + "<string>", + "<string>" + ], + "qui_b30": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "velit_2e5": [ + "<string>", + "<string>" + ] + } + } + ] + } + /cms/v3/site-search/search: + get: + tags: + - Site Search API > Public + summary: Search your site. + description: >- + Returns any website content matching the given search criteria for a + given HubSpot account. Searches can be filtered by content type, domain, + or URL path. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: q + in: query + schema: + type: string + description: The term to search for. + example: <string> + - name: limit + in: query + schema: + type: string + description: >- + Specifies the number of results to be returned in a single response. + Defaults to `10`. Maximum value is `100`. + example: <integer> + - name: offset + in: query + schema: + type: string + description: >- + Used to page through the results. If there are more results than + specified by the `limit` parameter, you will need to use the value + of offset returned in the previous request to get the next set of + results. + example: <integer> + - name: language + in: query + schema: + type: string + description: >- + Specifies the language of content to be searched. This value must be + a valid [ISO 639-1 language + code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) (e.g. + `es` for Spanish) + example: fr-bf + - name: matchPrefix + in: query + schema: + type: string + description: >- + Inverts the behavior of the pathPrefix filter when set to `false`. + Defaults to `true`. + example: <boolean> + - name: autocomplete + in: query + schema: + type: string + description: >- + Specifies whether or not you are showing autocomplete results. + Defaults to false. + example: <boolean> + - name: popularityBoost + in: query + schema: + type: string + description: >- + Specifies how strongly a result is boosted based on its view count. + Defaults to 1.0. + example: <number> + - name: boostLimit + in: query + schema: + type: string + description: >- + Specifies the maximum amount a result will be boosted based on its + view count. Defaults to 5.0. Read more about elasticsearch boosting + [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-boost.html). + example: <number> + - name: boostRecent + in: query + schema: + type: string + description: >- + Specifies a relative time window where scores of documents published + outside this time window decay. This can only be used for blog + posts. For example, boostRecent=10d will boost documents published + within the last 10 days. Supported timeunits are ms (milliseconds), + s (seconds), m (minutes), h (hours), d (days). + example: <string> + - name: tableId + in: query + schema: + type: string + description: >- + Specifies a specific HubDB table to search. Only returns results + from the specified table. Can be used in tandem with the + `hubdbQuery` parameter to further filter results. + example: <long> + - name: hubdbQuery + in: query + schema: + type: string + description: Specify a HubDB query to further filter the search results. + example: <string> + - name: domain + in: query + schema: + type: string + description: >- + A domain to match search results for. Multiple domains can be + provided with &. + example: <string> + - name: domain + in: query + schema: + type: string + description: >- + A domain to match search results for. Multiple domains can be + provided with &. + example: <string> + - name: type + in: query + schema: + type: string + description: >- + Specifies the type of content to search. Can be one or more of + SITE_PAGE, LANDING_PAGE, BLOG_POST, LISTING_PAGE, and + KNOWLEDGE_ARTICLE. Defaults to all content types except LANDING_PAGE + and KNOWLEDGE_ARTICLE + example: LISTING_PAGE + - name: type + in: query + schema: + type: string + description: >- + Specifies the type of content to search. Can be one or more of + SITE_PAGE, LANDING_PAGE, BLOG_POST, LISTING_PAGE, and + KNOWLEDGE_ARTICLE. Defaults to all content types except LANDING_PAGE + and KNOWLEDGE_ARTICLE + example: LANDING_PAGE + - name: pathPrefix + in: query + schema: + type: string + description: >- + Specifies a path prefix to filter search results. Will only return + results with URL paths that start with the specified parameter. Can + be used multiple times. + example: <string> + - name: pathPrefix + in: query + schema: + type: string + description: >- + Specifies a path prefix to filter search results. Will only return + results with URL paths that start with the specified parameter. Can + be used multiple times. + example: <string> + - name: property + in: query + schema: + type: string + description: >- + Specifies which properties to include in the search. Options include + `title`, `description`, and `html`. All properties will be searched + by default. + example: <string> + - name: property + in: query + schema: + type: string + description: >- + Specifies which properties to include in the search. Options include + `title`, `description`, and `html`. All properties will be searched + by default. + example: <string> + - name: length + in: query + schema: + type: string + description: >- + Specifies the length of the search results. Can be set to `LONG` or + `SHORT`. `SHORT` will return the first 128 characters of the + content's meta description. `LONG` will build a more detailed + content snippet based on the html/content of the page. + example: SHORT + - name: groupId + in: query + schema: + type: string + description: >- + Specifies which blog(s) to be searched by blog ID. Can be used + multiple times to search more than one blog. + example: <long> + - name: groupId + in: query + schema: + type: string + description: >- + Specifies which blog(s) to be searched by blog ID. Can be used + multiple times to search more than one blog. + example: <long> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + limit: <integer> + offset: <integer> + page: <integer> + results: + - domain: <string> + id: <integer> + score: <number> + type: LANDING_PAGE + url: <string> + combinedId: <string> + description: <string> + language: de-ch + title: <string> + tags: + - <string> + - <string> + rowId: <long> + featuredImageUrl: <string> + authorFullName: <string> + tableId: <long> + publishedDate: <long> + category: <string> + subcategory: <string> + - domain: <string> + id: <integer> + score: <number> + type: LANDING_PAGE + url: <string> + combinedId: <string> + description: <string> + language: en-nr + title: <string> + tags: + - <string> + - <string> + rowId: <long> + featuredImageUrl: <string> + authorFullName: <string> + tableId: <long> + publishedDate: <long> + category: <string> + subcategory: <string> + total: <integer> + searchTerm: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "et_c": [ + "<string>", + "<string>" + ] + }, + "links": { + "dolore_24": "<string>", + "sedf8": "<string>", + "Excepteur_f": "<string>", + "eud": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "Lorema38": [ + "<string>", + "<string>" + ], + "nulla44": [ + "<string>", + "<string>" + ], + "qui_b30": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "velit_2e5": [ + "<string>", + "<string>" + ] + } + } + ] + } diff --git a/server/node-service/src/plugins/hubspot/specsV4/CRM API Collections.json b/server/node-service/src/plugins/hubspot/specsV4/CRM API Collections.json new file mode 100644 index 000000000..de1810ae5 --- /dev/null +++ b/server/node-service/src/plugins/hubspot/specsV4/CRM API Collections.json @@ -0,0 +1,59105 @@ +openapi: 3.0.0 +info: + title: CRM API Collections + description: >- + The HubSpot CRM is a dynamic platform that can be greatly enhanced with our + APIs. This collection is a curated collection of the CRM APIs that are + particularly useful for developers who are working to integrate with the CRM + system. Note that this selection is not exhaustive of all available APIs. + Our CRM APIs adhere to [rate + limits](https://developers.hubspot.com/docs/api/usage-details#rate-limits) + and are compatible with + [OAuth](https://developers.hubspot.com/docs-beta/working-with-oauth) + authentication. We recommend that developers familiarize themselves with our + [API Usage + Guidelines](https://developers.hubspot.com/docs/api/usage-details) to ensure + best practices are followed. To begin testing your integrations, you can + create a [developer + account](https://app.hubspot.com/signup/developers?_ga=2.149421939.43705693.1704397911-1436923414.1704397911&_gl=1\*4emdjz\*_ga\*MTQ0MzYyMTQzNi4xNzA0NDcxNTY5\*_ga_LXTM6CQ0XK\*MTcwNDQ3MTU2OC4xLjEuMTcwNDQ3MTc5MS41My4wLjA.), + which allows you to generate [test + accounts](https://developers.hubspot.com/docs/api/creating-test-accounts) + and develop an application to initiate OAuth procedures. + + + **Fork the collections using Run in Postman:** + + + [<img src="https://run.pstmn.io/button.svg" alt="Run In + Postman">](https://app.getpostman.com/run-collection/26126890-fa75a62c-7a82-4c9e-ad99-edb189d8a73e?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D26126890-fa75a62c-7a82-4c9e-ad99-edb189d8a73e%26entityType%3Dcollection%26workspaceId%3Dd7645f33-539d-49c6-9e0c-efa6faae355d) + version: 1.0.0 +servers: + - url: http://{{baseurl}} +components: + securitySchemes: + oauth2Auth: + type: http + scheme: oauth2 + apikeyAuth: + type: http + scheme: apikey +security: + - oauth2Auth: [] +tags: + - name: Associations V3 API + description: "here is a\_[new version of the Associations API](https://developers.hubspot.com/docs/api/crm/associations/v4)\_that adds the ability to create multiple types of associations between two object types.\n\nAssociations represent the relationships between objects and activities in the HubSpot CRM. You can use the associations endpoints to create, retrieve, or remove associations in bulk. You can associate the following objects or engagements via the Associations API:\n\n- **`Contacts`**\n \n- **`Companies`**\n \n- **`Deals`**\n \n- **`Tickets`**\n \n- **`Calls`**\n \n- **`Quotes`**\n \n- **`Line_items`**\n \n- **`Meetings`**\n \n- **`Products`**\n \n- **`Feedback_submissions`**\n \n- **`Custom objects`**\_(the name of your object)\n \n\nLearn more about objects, records, properties, and associations APIs in the\_[Understanding the CRM](https://developers.hubspot.com/docs-beta/crm/understanding-the-crm?_ga=2.21847609.341006870.1586180142-500942594.1573763828)\_guide. For more general information about objects and records in HubSpot,\_[ learn how to manage your CRM database](https://knowledge.hubspot.com/contacts/a-guide-to-using-records?_ga=2.22901305.341006870.1586180142-500942594.1573763828)[.](https://knowledge.hubspot.com/contacts-user-guide?utm_campaign=UserGuides&utm_source=Developers)\n\n**Please note**: this API\_doesn't\_support parent-child associations or special contact-to-company associations. Learn more about how you can use these associations with the\_[previous version of the associations API](https://developers.hubspot.com/docs/methods/crm-associations/associate-objects).\n\n## Association definitions\n\nAssociations are defined by object and direction. Association types are unidirectional, which means you'll need to use a different definition depending on the starting object type. For example:\n\n- To see all tickets associated with a contact, you would define the association with the request URL\_`/crm/v3/associations/`**`Contacts`**`/`**`Tickets`**`/batch/read`\_and identify the contact in the request body by its\_`objectId`. In this example, Contacts is the\__fromObjectType_, and Tickets is the\__toObjectType_.\n \n- To associate a contact record to a custom object record, where your custom object is Pets, you would define the association with the request URL\_`/crm/v3/associations/`**`Pets`**`/`**`Contacts`**`/batch/create`\_and identify the contact and pet records you want to associate in the request body by their\_`objectIds`. In this example, Pets is the\__fromObjectType_, and Contacts is the\__toObjectType_.\n \n\nTo view all the defined association types between objects, make a\_`GET`\_request to\_`/crm/v3/associations/{fromObjectType}/{toObjectType}/types`." + - name: Associations V3 API > Batch + - name: Associations V3 Schema API + - name: Associations V3 Schema API > Types + - name: Associations V4 API + description: "For the previous version, please see the documentation for the\_[v3 Associations API](https://developers.hubspot.com/docs/api/crm/associations/v3).\n\nAssociations represent the relationships between objects and activities in the HubSpot CRM. Record associations can exist between records of different objects (e.g., Contact to Company), as well as within the same object (e.g., Company to Company). You can use the associations endpoints to create, retrieve, update, or delete associations between records, or records and activities.\n\nThe association schema endpoints allow you to view the supported types of associations in your account, as well as create your own association types, and assign labels to your record relationships. Association labels are supported between contacts, companies, deals, tickets, and custom objects, and can be\_[used across HubSpot in tools](https://knowledge.hubspot.com/crm-setup/create-and-use-association-labels#use-association-labels-in-hubspot-tools), such as lists and workflows.\n\nLearn more about objects, records, properties, and associations APIs in the\_[Understanding the CRM](https://developers.hubspot.com/docs-beta/crm/understanding-the-crm?_ga=2.21847609.341006870.1586180142-500942594.1573763828)\_guide.\_\n\n**Please note**: the v4 Associations\_API is supported in Version 9.0.0 or later of the NodeJS HubSpot Client.\n\n## HubSpot defined association types\n\nHubSpot provides a set of predefined association types (e.g., unlabeled contact to company), but account admins can\_[define their own association labels](https://knowledge.hubspot.com/crm-setup/create-and-use-association-labels)\_to provide additional context for record relationships (e.g., manager and employee). There are two HubSpot-defined association types:\_\n\n- **Primary:**\_the main company that the other record is associated with. Primary associations can be used in HubSpot tools such as\_[lists and workflows](https://knowledge.hubspot.com/crm-setup/associations-enhancements-beta#use-associations-in-hubspot-tools). For records with multiple associated companies, this API supports changing which company is considered the primary.\n \n- **Unlabeled:**\_an association type added when any contact, company, deal, ticket, or custom object record is associated. This type denotes that an association exists, and will always returned in responses with a\_**label**\_value of\_**`null`**. When a record has a primary association or a custom association label, those types will be listed alongside the unlabeled association type.\n \n\nYou can view all of the HubSpot-defined association types in\_[this section](https://developers.hubspot.com/docs/api/crm/associations#association-type-ids)." + - name: Associations V4 API > Batch + - name: Associations V4 API > Basic + - name: Associations V4 Schema API + - name: Associations V4 Schema API > Definitions + - name: Flexible Associations V4 API + - name: Flexible Associations V4 API > Batch + - name: Flexible Associations V4 API > Associations + - name: Carts API + description: "Use the carts API to create and manage data related to ecommerce purchases in HubSpot. This can be especially useful for keeping HubSpot data synced with external ecommerce platforms, such as Shopify and NetSuite.\n\nFor example, use the API to sync cart data with Shopify, including associating the cart with an order and contact record.\n\n## Create carts\n\nTo create a cart, make a\_`POST`\_request to\_`crm/v3/objects/cart`.\n\nIn the request body, you can include the\_`properties`\_and\_`associations`\_objects to set property values and associate the cart with other CRM objects (e.g., contacts and line items). Learn more about order properties and associations below.\n\n### Properties\n\nCart details are stored in cart properties. HubSpot provides a set of\_[default cart properties](https://developers.hubspot.com/docs/api/commerce/carts#cart-properties), but you can also create your own custom properties using the\_[properties API](https://developers.hubspot.com/docs/api/crm/properties).\n\nTo include properties when creating a cart, add them as fields in a\_`properties`\_object in the request body.For example, the request body below would create a cart with some basic product details based on the information provided by the buyer at checkout." + - name: Carts API > Batch + - name: Carts API > Basic + - name: Carts API > Search + - name: Commerce Payments API + description: "Use the payments API to fetch information about an account's\_[payments](https://knowledge.hubspot.com/payments/manage-payments). This is a read-only API, so it cannot be used for creating new or managing existing payments.\_\n\nFor example, use this API to\_[fetch all refunded payments](https://developers.hubspot.com/docs/api/commerce/payments#search-for-payments-by-properties)\_in an account.\n\n## Requirements\n\nTo use this API, the account must be set up to collect payments through either\_[HubSpot payments](https://knowledge.hubspot.com/payments/set-up-payments)\_or\_[Stripe payment processing](https://knowledge.hubspot.com/payments/connect-your-stripe-account-as-a-payment-processor-in-hubspot)." + - name: Commerce Payments API > Batch + - name: Commerce Payments API > Basic + - name: Commerce Payments API > Search + - name: Commerce Subscriptions API + description: "Use the subscriptions API to fetch information about an account's\_[commerce subscriptions](https://knowledge.hubspot.com/payments/manage-subscriptions-for-recurring-payments). This is a read-only API, so it cannot be used for creating new or managing existing subscriptions. If you're looking for the API for managing marketing email subscriptions instead, check out the\_[subscription preferences API](https://developers.hubspot.com/docs/api/marketing-api/subscriptions-preferences).\n\nFor example, use this API to\_[fetch all currently active subscriptions](https://developers.hubspot.com/docs/api/commerce/subscriptions#search-for-subscriptions-by-properties).\n\n## Requirements\n\nTo use this API, the account must be set up to collect payments through either\_[HubSpot payments](https://knowledge.hubspot.com/payments/set-up-payments)\_or\_[Stripe payment processing](https://knowledge.hubspot.com/payments/connect-your-stripe-account-as-a-payment-processor-in-hubspot)." + - name: Commerce Subscriptions API > Batch + - name: Commerce Subscriptions API > Basic + - name: Commerce Subscriptions API > Search + - name: Companies API + description: "In HubSpot, companies store information about the organizations that interact with your business. The companies endpoints allow you to manage create and manage company records, as well as sync company data between HubSpot and other systems.\_\n\nLearn more about objects, records, properties, and associations APIs in the\_[Understanding the CRM](https://developers.hubspot.com/docs-beta/crm/understanding-the-crm?_ga=2.21847609.341006870.1586180142-500942594.1573763828)\_guide. For more general information about objects and records in HubSpot,\_[ learn how to manage your CRM database](https://knowledge.hubspot.com/contacts/a-guide-to-using-records?_ga=2.22901305.341006870.1586180142-500942594.1573763828)[.](https://knowledge.hubspot.com/contacts-user-guide?utm_campaign=UserGuides&utm_source=Developers)\n\n## Create companies\n\nTo create new companies, make a\_`POST`\_request to\_`/crm/v3/objects/companies`.\n\nIn your request, include your company data in a\_properties\_object. You can also add an\_associations\_object to associate your new company with existing records (e.g., contacts, deals), or activities (e.g., meetings, notes).\n\n### Properties\n\nCompany details are stored in company properties. There are\_[default HubSpot company properties](https://knowledge.hubspot.com/companies/hubspot-crm-default-company-properties), but you can also\_[create custom properties](https://knowledge.hubspot.com/contacts/manage-your-properties?_ga=2.135700019.341006870.1586180142-500942594.1573763828#create-custom-properties).\n\nWhen creating a new company, you should include\_at least one\_of the following properties in your request:\_`name`\_or\_`domain`. It is recommended to always include\_`domain`, because domain names are the\_[primary unique identifier ](https://knowledge.hubspot.com/crm-setup/deduplication-of-contacts-companies-deals-tickets#automatic-deduplication-in-hubspot)\_\_to avoid duplicate companies in HubSpot.\_If a company has\_[multiple domains](https://knowledge.hubspot.com/companies/add-multiple-domain-names-to-a-company-record), you can add them through the API by using the\_`hs_additional_domains`\_field with semicolons separating each domain. For example:\_`\"hs_additional_domains\" : \"domain.com; domain2.com; domain3.com\"`.\n\nTo view all available properties, you can retrieve a list of your account's company properties by making a\_`GET`\_request to\_`/crm/v3/properties/companies`. Learn more about the the\_[ properties API](https://developers.hubspot.com/docs/api/crm/properties).\n\n**Please note:**\_if you've included\_`lifecyclestage`\_in your request, values must refer to the lifecycle stage's internal name. The internal names of default stages are\_text\_values, and do not change even if you edit the stage's\_[label](https://knowledge.hubspot.com/crm-setup/manage-your-properties#:~:text=the%20properties%20settings.-,Label/Name%3A,-enter%20a%20unique)(e.g.,\_`subscriber`\_or\_`marketingqualifiedlead`). The internal names of\_[custom stages ](https://knowledge.hubspot.com/crm-setup/create-and-customize-lifecycle-stages)\_are\_numeric\_values. You can find a stage's internal ID in your\_[lifecycle stage settings, ](https://knowledge.hubspot.com/crm-setup/create-and-customize-lifecycle-stages#:~:text=To%20edit%20a%20lifecycle%20stage%2C%20hover%20over%20the%20stage%20and%20click%20Edit.%20In%20the%20right%20panel%2C%20edit%20the%20Stage%20name%2C%20then%20click%20Edit%20lifecycle%20stage%20to%20confirm.%20Click%20the%20code%20codcode%20icon%20to%20view%20the%20stage%27s%20internal%20ID%2C%20which%20is%20used%20by%20integrations%20and%20APIs.)\_or by retrieving the lifecycle stage property via API." + - name: Companies API > Batch + - name: Companies API > Basic + - name: Companies API > Public_Object + - name: Companies API > GDPR + - name: Companies API > Search + - name: Contacts API + description: "In HubSpot, contacts store information about the individual people that interact with your business. The contacts endpoints allow you to create and manage contact records in your HubSpot account, as well as sync contact data between HubSpot and other systems.\n\nLearn more about objects, records, properties, and associations APIs in the\_[Understanding the CRM](https://developers.hubspot.com/docs-beta/crm/understanding-the-crm?_ga=2.21847609.341006870.1586180142-500942594.1573763828)\_guide. For more general information about objects and records in HubSpot,\_[learn how to manage your CRM database](https://knowledge.hubspot.com/contacts-user-guide?utm_campaign=UserGuides&utm_source=Developers&_ga=2.22901305.341006870.1586180142-500942594.1573763828).\n\n## Create contacts\n\nTo create new contacts, make a\_`POST`\_request to\_`/crm/v3/objects/contacts`.\n\nIn your request, include your contact data in a\_properties\_object. You can also add an\_associations\_object to associate your new contact with existing records (e.g., companies, deals), or activities (e.g., meetings, notes).\n\n### Properties\n\nContact details are stored in contact properties. There are\_[default HubSpot contact properties](https://knowledge.hubspot.com/articles/kcs_article/contacts/hubspots-default-contact-properties?_ga=2.135700019.341006870.1586180142-500942594.1573763828), but you can also\_[create custom contact properties](https://knowledge.hubspot.com/contacts/manage-your-properties?_ga=2.135700019.341006870.1586180142-500942594.1573763828#create-custom-properties).\n\nWhen creating a new contact, you should include\_at least one\_of the following properties in your request:\_`email`,\_`firstname`, or\_`lastname`. It is recommended to always include\_`email`, because email address is the\_[primary unique identifier ](https://knowledge.hubspot.com/crm-setup/deduplication-of-contacts-companies-deals-tickets#automatic-deduplication-in-hubspot)\_\_to avoid duplicate contacts in HubSpot.\n\nTo view all available properties, you can retrieve a list of your account's contact properties by making a\_`GET`\_request to\_`/crm/v3/properties/contacts`. Learn more about the the\_[ properties API](https://developers.hubspot.com/docs/api/crm/properties).\n\n**Please note**: if you've included\_`lifecyclestage`\_in your request, values must refer to the lifecycle stage's internal name. The internal names of default stages are\_text\_values, and do not change even if you edit the stage's\_[label](https://knowledge.hubspot.com/crm-setup/manage-your-properties#:~:text=the%20properties%20settings.-,Label/Name%3A,-enter%20a%20unique)(e.g.,\_`subscriber`\_or\_`marketingqualifiedlead`). The internal names of\_[custom stages](https://knowledge.hubspot.com/crm-setup/create-and-customize-lifecycle-stages)are\_numeric\_values. You can find a stage's internal ID in your\_[lifecycle stage settings,](https://knowledge.hubspot.com/crm-setup/create-and-customize-lifecycle-stages#:~:text=To%20edit%20a%20lifecycle%20stage%2C%20hover%20over%20the%20stage%20and%20click%20Edit.%20In%20the%20right%20panel%2C%20edit%20the%20Stage%20name%2C%20then%20click%20Edit%20lifecycle%20stage%20to%20confirm.%20Click%20the%20code%20codcode%20icon%20to%20view%20the%20stage%27s%20internal%20ID%2C%20which%20is%20used%20by%20integrations%20and%20APIs.)or by retrieving the lifecycle stage property via API." + - name: Contacts API > Batch + - name: Contacts API > Basic + - name: Contacts API > Public_Object + - name: Contacts API > GDPR + - name: Contacts API > Search + - name: CRM Cards API + description: "Within a\_[public app](https://developers.hubspot.com/docs/api/creating-an-app), you can create custom CRM cards to display information from other systems on HubSpot contact, company, deal, and ticket records. Each app can include up to 25 CRM cards.\n\n**Please note:**\_the CRM cards referenced in this article are different from the custom cards you can\_[create as UI extensions with projects](https://developers.hubspot.com/docs/platform/create-ui-extensions). The CRM cards included in this article are intended for use with public apps, while UI extensions offer more flexibility, customizability, and interactivity using a more modern toolset.\n\nIf you're not building a public app, check out the\_check out the\_[CRM development tools overview](https://developers.hubspot.com/docs/platform/crm-development-tools-overview)\_to see if React-based UI extensions will work better for your use case.\n\n**Example use case:**\_you're building an integration for the App Marketplace for your bug tracking software. You want to be able to surface tracked bugs on contact records so that support reps can reference them when working with customers.\_Your app can define a custom card that displays this info right on the HubSpot contact record. \n\n<img src=\"https://developers.hubspot.com/hs-fs/hubfs/CRM_Card_1.png?width=467&name=CRM_Card_1.png\" alt=\"\">\n\nCards can be defined as part of your app’s feature settings. Once the app is installed and a user views the target CRM records, HubSpot makes an outbound request to the app, retrieves the relevant data, and displays it in a card on the record page. Apps can also specify custom actions the user can take based on this information. For example, your app could include an action to open a modal for displaying the app's own UI in HubSpot. \n\n<img src=\"https://developers.hubspot.com/hs-fs/hubfs/CRM_card_diagram.png?width=1326&name=CRM_card_diagram.png\" alt=\"\">\n\n## Scope requirements\n\nTo create custom CRM cards, your app has to request the OAuth scopes needed to modify the CRM records where your card will appear. For example, for a CRM card to appear on contact records, the app must have the\_`crm.objects.contacts.read`\_and\_`crm.objects.contacts.write`\_scopes. If you later need to remove CRM object scopes from your app, you'll first need to delete all existing cards for those object types.\n\nSee the OAuth documentation for\_[more details about scopes](https://developers.hubspot.com/docs-beta/working-with-oauth)\_and setting up the authorization URL for your app.\n\n## Create a CRM card\n\nYou can create CRM cards for your app either through the API or by editing your app in your developer account. To learn more about configuring a card through the API, check out the\_Endpoints\_tab at the top of the article.\n\nTo create a CRM card using HubSpot's UI:\n\n- In your HubSpot developer account, navigate to\_**Apps**\_in the main navigation.\n \n- Select the\_**app**\_where you want to add a card.\n \n- In the left sidebar menu, select\_**CRM cards**.\n \n\nBelow, learn more about the configuration options in each tab.\n\nUI extensions built using developer projects offer more flexible ways to display data and allow user interaction, including displaying external content in frames. If using a private app is feasible for your integration, check out the\_[UI extensions quickstart guide](https://developers.hubspot.com/docs/platform/ui-extensions-quickstart)\_to get started, or\_[view HubSpot's example projects](https://developers.hubspot.com/docs/platform/sample-projects)\_to see examples of what's possible.\n\n## Data request\n\nWhen a user HubSpot views a CRM record that the CRM card is on, HubSpot will make a data fetch request to the integration. This request is made to the specified target URL, which includes a set of default query parameters, along with extra parameters containing property data as specified in the card's settings.\_\n\n<img src=\"https://developers.hubspot.com/hs-fs/hubfs/Knowledge_Base_2023/private-app-create-crm-card-data-request-tab.png?width=973&height=737&name=private-app-create-crm-card-data-request-tab.png\" alt=\"\">\n\n- In the\__Data fetch URL_\_field, enter the\_**URL**\_that you'll be fetching data from. In the API, this URL is added to the\_`targetUrl`\_field.\_\n \n- In the\__Target record types_\_section, click to toggle the\_**switches**\_on to select which CRM records the card will appear on. Then, Use the\_**Properties sent from HubSpot**\_dropdown menus to select the\_**HubSpot properties**\_that will be included as query parameters in the request URL. In the API, each record type and its corresponding properties are added as objects in the\_`objectTypes`\_array.\n \n\nJSON\n\n```\n// Example data fetch configuration\n{\n \"title\": \"New CRM Card\",\n \"fetch\": {\n \"targetUrl\": \"https://www.example.com/demo-fetch\",\n \"objectTypes\": [\n {\n \"name\": \"contacts\",\n \"propertiesToSend\": [\n \"firstname\",\n \"email\",\n \"lastname\"\n ]\n }\n ]\n }\n...\n}\n\n ```\n\nCopy\n\n### Example request\n\nThe above configuration would result in HubSpot sending its\_`GET`\_request as follows.\n\n```\nhttps://www.example.com/demo-fetch?userId=12345&userEmail=loggedinuser@hubspot.com&associatedObjectId=53701&associatedObjectType=CONTACT&portalId=987654&firstname=Tim&email=timrobinson@itysl.com&lastname=Robinson\n\n ```\n\nCopy\n\nUse this table to describe parameters / fields\n\n| PARAMETER | TYPE | DESCRIPTION |\n| --- | --- | --- |\n| `userId` | Default | The ID of the HubSpot user that loaded the CRM record. |\n| `userEmail` | Default | The email address of the user that loaded the CRM record. |\n| `associatedObjectId` | Default | The ID of the CRM record that loaded. |\n| `associatedObjectType` | Default | The type of CRM record that loaded (e.g., contact, company, deal). |\n| `portalId` | Default | The ID of the HubSpot account where the CRM record loaded. |\n| `firstname` | Custom | The contact's first name, as specified in the\__Properties sent from HubSpot_\_dropdown menu (in-app) and\_`propertiesToSend`\_array (API). |\n| `email` | Custom | The contact's email address, as specified in the\__Properties sent from HubSpot_\_dropdown menu (in-app) and\_`propertiesToSend`\_array (API). |\n| `lastname` | Custom | The contact's last name, as specified in the\__Properties sent from HubSpot_\_dropdown menu (in-app) and\_`propertiesToSend`\_array (API). |\n\n**Please note:**\_requests will timeout after five seconds. Within that, a connection must be made within three seconds." + - name: CRM Cards API > Cards + - name: CRM Cards API > SampleResponse + - name: Custom Objects API + description: "In each HubSpot account, there are the standard CRM objects: contacts, companies, deals, and tickets. To represent and organize your CRM data based on your business needs, you can also create custom objects. You can\_[create a custom object](https://knowledge.hubspot.com/crm-setup/create-custom-objects)\_in HubSpot, or use the custom objects API to define custom objects, properties, and associations to other CRM objects.\_\n\nBelow, learn how to create and manage custom objects through the API, and see a\_[walkthrough of creating an example custom object](https://developers.hubspot.com/docs/api/crm/crm-custom-objects#custom-object-example).\n\nTo learn more about creating custom objects, check out the following posts on the HubSpot developer blog:\n\n- [How to build scalable custom objects](https://developers.hubspot.com/blog/how-to-think-like-an-architect-by-building-scalable-custom-objects)\n \n- [How to build custom objects using private apps](https://developers.hubspot.com/blog/how-to-build-a-custom-object-using-private-apps)\n \n\n**Please note:**\_custom objects are specific to each account, and depending on your subscription, there are limits on the number of custom objects you can create. Learn more about your limits in the\_[HubSpot Products & Services catalog](https://legal.hubspot.com/hubspot-product-and-services-catalog).\n\n## Authentication methods\n\nYou can create, read, and update custom objects using one of the following methods of authentication:\n\n- [OAuth](https://developers.hubspot.com/docs/api/custom-objects-schema-pilot)\n \n- [Private app access tokens](https://developers.hubspot.com/docs/api/private-apps#make-api-calls-with-your-app-s-access-token)\n \n\n**Please note:**\_as of November 30, 2022, HubSpot API Keys are being deprecated and are no longer supported. Continued use of HubSpot API Keys is a security risk to your account and data. During this deprecation phase, HubSpot may deactivate your key at any time.\n\nYou should instead authenticate using a private app access token or OAuth. Learn more about\_[this change](https://developers.hubspot.com/changelog/upcoming-api-key-sunset)\_and how to\_[migrate an API key integration](https://developers.hubspot.com/docs/api/migrate-an-api-key-integration-to-a-private-app)\_to use a private app instead." + - name: Custom Objects API > Batch + - name: Custom Objects API > Basic + - name: Custom Objects API > Public_Object + - name: Custom Objects API > GDPR + - name: Custom Objects API > Search + - name: Deals API + description: "In HubSpot, deals represent transactions with contacts or companies. Deals are tracked through your sales process in\_[pipeline stages](https://knowledge.hubspot.com/crm-deals/set-up-and-customize-your-deal-pipelines-and-deal-stages)\_until they're won or lost. The deals endpoints allow you to manage create and manage deal records, as well as sync deal data between HubSpot and other systems.\_\n\nLearn more about objects, records, properties, and associations APIs in the\_[Understanding the CRM](https://developers.hubspot.com/docs-beta/crm/understanding-the-crm?_ga=2.21847609.341006870.1586180142-500942594.1573763828)\_guide. For more general information about objects and records in HubSpot,\_[ learn how to manage your CRM database](https://knowledge.hubspot.com/contacts/a-guide-to-using-records?_ga=2.22901305.341006870.1586180142-500942594.1573763828)[.](https://knowledge.hubspot.com/contacts-user-guide?utm_campaign=UserGuides&utm_source=Developers)\n\n## Create deals\n\nTo create new deals, make a\_`POST`\_request to\_`/crm/v3/objects/deals`.\n\nIn your request, include your deal data in a\_properties\_object. You can also add an\_associations\_object to associate your new deal with existing records (e.g., contacts, companies), or activities (e.g., meetings, notes).\n\n### Properties\n\nDeal details are stored in deal properties. There are\_[default HubSpot deal properties](https://knowledge.hubspot.com/crm-deals/hubspots-default-deal-properties), but you can also\_[create custom properties](https://knowledge.hubspot.com/contacts/manage-your-properties?_ga=2.135700019.341006870.1586180142-500942594.1573763828#create-custom-properties).\n\nWhen creating a new deal, you should include\_the following properties in your request:\_`dealname`,\_`dealstage`\_and if you have multiple pipelines,\_`pipeline`.\_If a pipeline isn't specified, the default pipeline will be used.\_\n\nTo view all available properties, you can retrieve a list of your account's deal properties by making a\_`GET`\_request to\_`/crm/v3/properties/deals`. Learn more about the the\_[ properties API](https://developers.hubspot.com/docs/api/crm/properties).\n\n**Please note**: you must use the internal ID of a deal stage or pipeline when creating a deal via the API. The internal ID will also be returned when you retrieve deals via the API. You can find a deal stage's or pipeline's internal ID in your\_[ deal pipeline settings.](https://knowledge.hubspot.com/crm-deals/set-up-and-customize-your-deal-pipelines-and-deal-stages#to-customize-your-deal-stages:~:text=To%20view%20the%20internal%20name%20for%20a%20deal%20stage%2C%20hover%20over%20the%20stage%20and%20click%20the%20code%20code%20icon.%20The%20internal%20name%20is%20used%20by%20integrations%20and%20the%20API.)" + - name: Deals API > Batch + - name: Deals API > Basic + - name: Deals API > Public_Object + - name: Deals API > GDPR + - name: Deals API > Search + - name: Deal Splits API + description: "If your HubSpot account has a\__Sales Hub\_Enterprise_\_subscription, you can set up\_[deal splits](https://knowledge.hubspot.com/records/split-deal-credit-among-users)\_to split credit for deal amounts between multiple users. Once\_[deal splits are turned on](https://knowledge.hubspot.com/records/split-deal-credit-among-users#turn-on-deal-splits)\_in your HubSpot account, you can use the deal splits API to create new deal splits or view and update existing splits.\n\n## Create or update deal splits\n\nTo add new splits or update existing splits for deals, make a\_`POST`\_request to\_`crm/v3/objects/deals/splits/batch/upsert`.\n\nIn your request, include the following fields for each deal:\n\nUse this table to describe parameters / fields\n\n| FIELD | DESCRIPTION |\n| --- | --- |\n| `id` | The ID of the deal. You can retrieve this via the\_[deals API](https://developers.hubspot.com/docs/api/crm/deals#retrieve-deals). |\n| `splits` | An array that contains the user to assign a split to, and the percentage of the deal amount to assign. In the array, include the following fields:<br><br>`ownerId`: the\_[owner ID](https://developers.hubspot.com/docs/api/crm/owners)\_assigned to the HubSpot user.<br><br>`percentage`: the percentage of the deal amount to assign to the owner. |\n\nWhen adding deal splits, the deal's owner must be included as a split owner, the split percentages must add up to 1.0, and you must meet the limits for the split user maximum and split percentage minimum set in your\_[deal split settings.](https://knowledge.hubspot.com/records/split-deal-credit-among-users#turn-on-deal-splits)If any deals included in the batch request fail validation for these requirements, the request will result in an error." + - name: Deal Splits API > Batch + - name: Discounts API + description: >- + When you're [creating a quote in + HubSpot](https://developers.hubspot.com/docs/api/crm/quotes), you can + create and associate a discount as part of the pricing details of the + quote. + + + ## Create a discount + + + Discounts are used in conjunction with + [fees](https://developers.hubspot.com/docs/api/crm/fees) and + [taxes](https://developers.hubspot.com/docs/api/crm/taxes) when + determining the pricing details for a quote. Any discounts you associate + with your quote will be applied first, followed by associated fees, and + then any associated taxes will apply. + + + JSON + + + ``` + + // POST request to https://api.hubspi.com/crm/v3/objects/discount + + { + "properties": { + "hs_label": "A fixed, one-time discount", + "hs_duration": "ONCE", + "hs_type": "PERCENT", + "hs_value": "50", + "hs_sort_order": "2" + } + } + + ``` + + After you create a discount, you can use its ID to associate it with a + quote. To retrieve a list of discounts you've created, you can make a + `GET` request to `/crm/v3/objects/discount`. + + + To view all available endpoints and their required fields, click the + Endpoints tab at the top of this article. + - name: Discounts API > Batch + - name: Discounts API > Basic + - name: Discounts API > Public_Object + - name: Discounts API > GDPR + - name: Discounts API > Search + - name: Exports API + description: "Use the exports API to export records and property data from your HubSpot account, retrieve a URL to download an export file, or see the status of an export. Within HubSpot, you can also\_[export records](https://knowledge.hubspot.com/crm-setup/export-contacts-companies-deals-or-tickets)\_or\_[view a log of past exports in your account.](https://knowledge.hubspot.com/crm-setup/view-a-log-of-your-users-exports-in-your-account)\n\n## Start an export\n\nTo start an export, make a\_`POST`\_request to\_`/crm/v3/exports/export/async`. Your request body should specify information such as the file format, the object and properties you want to export, and the type of export you're completing (e.g., exporting an object view or a list). You can also filter the property data to be exported based on specific operators.\n\nFor\_both\_view and list exports, you can include the following fields in your request:\n\nUse this table to describe parameters / fields\n\n| PARAMETER | DESCRIPTION |\n| --- | --- |\n| `exportType` | The type of export, either\_`VIEW`\_(exports a view from an object index page) or\_`LIST`\_(exports a list). |\n| `format` | The file format. Options include\_`XLSX`,\_`CSV`, or\_`XLS`. |\n| `exportName` | The name of the export. |\n| `language` | The language of the export file. Options include\_`DE`,\_`EN`,\_`ES`,\_`FI`,\_`FR`,\_`IT`,\_`JA`,\_`NL`,\_`PL`,\_`PT`, or\_`SV`. Learn more about\_[supported languages.](https://knowledge.hubspot.com/account/hubspot-language-offerings) |\n| `objectType` | The name or ID of the object you're exporting. For standard objects, you can use the object's name (e.g.,\_`CONTACT`), but for custom objects, you must use the\_`objectTypeId`\_value. You can retrieve this value by making a\_`GET`\_request to\_`/crm/v3/schemas`. |\n| `associatedObjectType` | The name or ID of an associated object to include in the export. If you include an associated object, the export will contain the associated record IDs of that object and the records' primary display property value (e.g., name). You can export only one associated object per request. |\n| `objectProperties` | A list of the properties you want included in your export. |" + - name: Exports API > Public_Exports + - name: Exports API > Core + - name: Feedback Submissions API + description: "**Please note:** this API is currently under development and is subject to change based on testing and feedback. By using these endpoints you agree to adhere to HubSpot's [Developer Terms](https://legal.hubspot.com/developer-terms) & [Developer Beta Terms](https://legal.hubspot.com/developerbetaterms?). You also acknowledge and understand the risk associated with testing an unstable API.\n\nIn HubSpot, feedback submissions store information submitted to a feedback survey. Surveys in HubSpot include\_[Net Promoter Score (NPS)](https://knowledge.hubspot.com/customer-feedback/how-do-i-send-a-customer-loyalty-survey),\_[Customer Satisfaction (CSAT)](https://knowledge.hubspot.com/customer-feedback/create-and-send-customer-satisfaction-surveys),\_[Customer Effort Score (CES)](https://knowledge.hubspot.com/customer-feedback/how-do-i-send-a-customer-support-survey), and\_[custom surveys](https://knowledge.hubspot.com/customer-feedback/create-a-custom-survey). Using the feedback submission endpoints, you can retrieve submission data about your feedback surveys.\n\nLearn more about objects, properties, and associations APIs in the\_[Understanding the CRM](https://developers.hubspot.com/docs-beta/crm/understanding-the-crm?_ga=2.21847609.341006870.1586180142-500942594.1573763828)\_guide.\n\n**Please note**: the feedback submissions endpoints are currently read only. Feedback submissions cannot be submitted or edited through the API." + - name: Feedback Submissions API > Batch + - name: Feedback Submissions API > Basic + - name: Feedback Submissions API > Public_Object + - name: Feedback Submissions API > GDPR + - name: Feedback Submissions API > Search + - name: Fees API + description: "When you're\_[creating a quote in HubSpot](https://developers.hubspot.com/docs/api/crm/quotes), you can create and associate a fee as part of the pricing details of the quote.\n\n## Create a fee\n\nFees are used in conjunction with\_[discounts](https://developers.hubspot.com/docs/api/crm/discounts)\_and\_[taxes](https://developers.hubspot.com/docs/api/crm/taxes)\_when determining the pricing details for a quote. Any discounts you associate with your quote will be applied first, followed by associated fees, and then any associated taxes will apply." + - name: Fees API > Batch + - name: Fees API > Basic + - name: Fees API > Public_Object + - name: Fees API > GDPR + - name: Fees API > Search + - name: Goals API + description: "In HubSpot, goals are used to create user-specific quotas for their sales and services teams based on templates provided by HubSpot. The goals API allow you to retrieve goals data in your HubSpot account.\_\n\nLearn more about\_[using goals in HubSpot](https://knowledge.hubspot.com/reports/create-goals).\n\n## Retrieve goals\n\nYou can retrieve an individual goal or all goals in your account.\n\n- To request all goals, make a\_`GET`\_request to\_`/crm/v3/objects/goal_targets`.\n \n- To retrieve an individual goal, make a\_`GET`\_request to\_`/crm/v3/objects/goal_targets/{goalTargetId}/`.\n \n- To retrieve goals that meet a specific set of criteria, you can make a\_`POST`\_request to the search endpoint and include filters in the request body.\_Learn more about\_[searching the CRM](https://developers.hubspot.com/docs/api/crm/search).\n \n\nFor example, to retrieve a goal with an ID of\_`44027423340`, the request URL would be the following:\n\n`https://api.hubapi.com/crm/v3/objects/goal_targets/44027423340/`" + - name: Goals API > Batch + - name: Goals API > Basic + - name: Goals API > Public_Object + - name: Goals API > GDPR + - name: Goals API > Search + - name: Imports API + description: >- + Use the imports API to import CRM records and activities into your HubSpot + account, such as contacts, companies, and notes. Once imported, you can + access and update records and activities through the various CRM API + endpoints, including the [contacts + API,](https://developers.hubspot.com/docs/api/crm/contacts) [associations + API](https://developers.hubspot.com/docs/api/crm/associations), and + [engagements + APIs.](https://developers.hubspot.com/docs/api/crm/engagements) You can + also [import records and activities using the guided import tool in + HubSpot](https://knowledge.hubspot.com/crm-setup/import-objects). + + + **Important Note on Auto-Generated Headers for HubSpot Imports API + Requests** + + + When utilizing this Postman collection for making requests to HubSpot's + Imports API, please ensure that you have the **correct auto-generated + headers** included in every request. The absence of these headers may + result in requests failing before they even reach our processing stack, + leading to errors that could be difficult to debug. + + + **Key Header Requirement:** + + + - `Authorization`: Ensure that your request headers include a valid + `Authorization` token (e.g., `Bearer {access_token}`). This token is + crucial for authenticating your request with the HubSpot API. + + - `Content-Type`: For requests that involve data payloads, such as POST or + PUT requests, make sure the `Content-Type` is correctly set to + `multipart/form-data` or the appropriate type based on the data you are + sending. + + + **Please note:** if you receive an error, check if there are any duplicate + headers, such as `Content-Type`. This may occur if you're using Postman or + if it's included in the header of your Python script. Remove the duplicate + before completing the request. + + In addition, when making requests with `Content-Type: + multipart/form-data`, it is essential to include the `boundary` parameter + in the header. This parameter is crucial for correctly parsing the + multipart form data by the API. + + + **Troubleshooting:** + + + - If you encounter errors, verify that your access token has not expired + and that you have permission to access the Imports API. + + - Double-check that the `Content-Type` header matches the type of data you + are submitting in your request body. + + + For more detailed documentation and examples, refer to the [HubSpot + Imports API + Documentation](https://developers.hubspot.com/docs/api/crm/imports). + - name: Imports API > Core + - name: Imports API > Public_Imports + - name: Leads API + description: "In HubSpot,\_[leads](https://knowledge.hubspot.com/prospecting/set-up-leads)\_are contacts or companies that are potential customers who have shown interest in your products or services. The leads endpoints allow you to create and manage lead records in your HubSpot account, as well as sync lead data between HubSpot and other systems.\n\nBefore using the API, be sure leads have been\_[set up in your account](https://knowledge.hubspot.com/prospecting/set-up-leads).\_\n\nLearn more about objects, records, properties, and associations APIs in the\_[Understanding the CRM](https://developers.hubspot.com/docs-beta/crm/understanding-the-crm?_ga=2.21847609.341006870.1586180142-500942594.1573763828)\_guide. For more general information about objects and records in HubSpot,\_[learn how to manage your CRM database](https://knowledge.hubspot.com/contacts-user-guide?utm_campaign=UserGuides&utm_source=Developers&_ga=2.22901305.341006870.1586180142-500942594.1573763828).\n\n## Create leads\n\nTo create new contacts, make a\_`POST`\_request to\_`/crm/v3/objects/leads`.\n\nIn the request body, include any details about the lead in a\_`properties`\_object. Your new lead:\n\n- Must have a lead name, specified using the hs_lead_name property.\n \n- Must be associated with an existing contacts.\_\n \n- Should only be assigned to a user with a\_[seat](https://knowledge.hubspot.com/account-management/manage-seats). (Leads can only be worked via the workspace).\n \n- For example, to create a warm lead named “Jane Doe” who has a type of New Business, your request body would resemble the following:\n \n\nJSON\n\n```\n// Example POST request to /crm/v3/objects/leads\n\"associations\": [\n{\n\"types\": [\n{\n\"associationCategory\": \"HUBSPOT_DEFINED\",\n\"associationTypeId\":578\n}\n],\n\"to\": {\n\"id\": \"YOUR_CONTACT_ID\"\n}\n}\n]\n\"properties\": {\n \"hs_lead_name\": \"Jane Doe\",\n \"hs_lead_type\": \"NEW BUSINESS\",\n \"hs_lead_label\": \"WARM\"\n}\n\n ```" + - name: Leads API > Batch + - name: Leads API > Basic + - name: Leads API > Search + - name: Line Items API + description: "In HubSpot, line items are individual instances of\_[products](https://developers.hubspot.com/docs-beta/crm/products). When a product is attached to a deal, it becomes a line item. You can create line items that are unique to an individual quote, but they will not be added to your product library.\_The line items endpoints allow you to manage this data and sync it between HubSpot and other systems.\n\n**Example use case:**\_when creating a set of\_[quotes](https://developers.hubspot.com/docs/api/crm/quotes)\_for sales reps to send to potential buyers, you can use this API to create standalone line items per quote, as well as line items that are attached to existing products.\n\n## Create a line item\n\nTo create a line item, make a\_`POST`\_request to\_`/crm/v3/objects/line_items`. In the post body, include the line item's details, such as name, quantity, and price.\n\nTo create a line item based on an existing product (created through the\_[products API](https://developers.hubspot.com/docs/api/crm/products)\_or\_[in HubSpot](https://knowledge.hubspot.com/products/how-do-i-use-products)), include\_`hs_product_id`\_in the post body.\_\n\nYou can also associate the line item with deals, quotes, invoices, payment links or subscriptions, by including an\_`associations`\_array in the post body. For example, the post body below would create a line item named \"New standalone line item\" that's associated with a deal (ID:\_`12345`)." + - name: Line Items API > Batch + - name: Line Items API > Basic + - name: Line Items API > Public_Object + - name: Line Items API > GDPR + - name: Line Items API > Search + - name: Lists API + description: "Lists are a collection of records of the same object type that can be used for record segmentation, filtering, and grouping to serve your business needs. You can create contact, company, deal, or custom object lists. The v3 Lists API allows you to create, edit, and fetch lists.\_\n\nA list consists of a list definition and list memberships:\n\n- List definition: stores essential information about the list.\_\n \n- List memberships: mappings between the list and object record.\n \n\nThe\_[legacy v1 Lists API](https://legacydocs.hubspot.com/docs/methods/lists/contact-lists-overview)will be sunset starting May 30th, 2025. If you were previously using the v1 Lists API, review the\_[guide below](https://developers.hubspot.com/docs/api/crm/lists#migrate-from-v1-to-v3-api-endpoints)\_to transition to the v3 API.\n\n## List processing types\n\nThere are three types of list processing types:\_`MANUAL`,\_`DYNAMIC`, and\_`SNAPSHOT`.\_\n\n`MANUAL`: this processing type indicates that object records can only be added to or removed from the list via manual actions by the user or API call. There is no list processing or list membership management done in the background by HubSpot's systems. This type of list is helpful for when you need a set list of records that won't change unless manually updated.\n\n`DYNAMIC`: this processing type gives the possibility to specify\_[list filters](https://developers.hubspot.com/docs/api/crm/lists-filters)\_to match records that will become list members. This type of list is processed in the background by HubSpot to ensure that the list only contains records that match the list's filters. Whenever a record changes, it is reevaluated against the list's filters and either added to or removed from it.\_ This type of list is helpful for when you want to keep a running list that you expect to change over time.\n\n`SNAPSHOT`:\_[list filters](https://developers.hubspot.com/docs/api/crm/lists-filters)\_are specified at the time of list creation. After initial processing is completed, records can only be added to or removed from the list by manual actions. This type of list is helpful for when you want to create a list of records based on specific criteria, but don't want that list to change automatically after initial processing.\n\n## Create a list\n\nTo create a list, make a\_`POST`\_request to\_`/crm/v3/lists/`.\n\nIn the request body, you must include the following parameters:\_`name`,\_`objectTypeId`, and\_`processingType`. The\_`filterBranch`\_parameter is optional, and can be included to create branching logic for\_`DYNAMIC`\_and\_`SNAPSHOT`\_type lists. Learn more about\_[configuring list filters and branches](https://developers.hubspot.com/docs/api/crm/lists-filters).\n\nOnce created, a\_`listID`\_(the ILS list ID) will be generated. This ID is used for future updates and modifications.\n\nJSON\n\n```\n// Example request body\n{\n \"name\": \"My static list\",\n \"objectTypeId\":\"0-1\",\n \"processingType\":\"MANUAL\"\n}\n\n ```" + - name: Lists API > Memberships + - name: Lists API > Lists + - name: Objects API + description: >- + CRM objects such as companies, contacts, deals, line items, products, + tickets, and quotes are standard objects in HubSpot’s CRM. These core + building blocks support custom properties, store critical information, and + play a central role in the HubSpot application. + + + ## Supported Object Types + + + This API provides access to collections of CRM objects, which return a map + of property names to values. Each object type has its own set of default + properties, which can be found by exploring the [CRM Object Properties + API](https://developers.hubspot.com/docs/methods/crm-properties/crm-properties-overview). + + + | Object Type | Properties returned by default | + + | --- | --- | + + | `companies` | `name`, `domain` | + + | `contacts` | `firstname`, `lastname`, `email` | + + | `deals` | `dealname`, `amount`, `closedate`, `pipeline`, `dealstage` | + + | `products` | `name`, `description`, `price` | + + | `tickets` | `content`, `hs_pipeline`, `hs_pipeline_stage`, + `hs_ticket_category`, `hs_ticket_priority`, `subject` | + + + Find a list of all properties for an object type using the [CRM Object + Properties](https://developers.hubspot.com/docs/methods/crm-properties/get-properties) + API. e.g. `GET https://api.hubapi.com/properties/v2/companies/properties`. + Change the properties returned in the response using the `properties` + array in the request body. + - name: Objects API > Batch + - name: Objects API > Basic + - name: Objects API > Public_Object + - name: Objects API > GDPR + - name: Objects API > Search + - name: Orders API + description: "Use the orders API to create and manage data related to ecommerce purchases in HubSpot. This can be especially useful for keeping HubSpot data synced with external ecommerce platforms, such as Shopify and NetSuite.\n\nFor example, when a buyer adds a set of products to their cart and makes a purchase, store that purchase as an individual order. You can then update that order with tracking information once the shipping label has been printed. Because this information is stored in a property, you can reference it in emails that you send to notify customers that their package is on the way.\_\n\n## Create orders\n\nTo create an order, make a\_`POST`\_request to\_`crm/v3/objects/order`.\n\nIn the request body, you can include the\_`properties`\_and\_`associations`\_objects to set property values and associate the order with other CRM objects (e.g., contacts and line items). Learn more about order properties and associations below.\n\n### Properties\n\nOrder details are stored in order properties. HubSpot provides a set of\_[default order properties](https://developers.hubspot.com/docs/api/commerce/orders#order-properties), but you can also create your own custom properties using the\_[properties API](https://developers.hubspot.com/docs/api/crm/properties).\n\nTo include properties when creating an order, add them as fields in a\_`properties`\_object in the request body." + - name: Orders API > Batch + - name: Orders API > Basic + - name: Orders API > Search + - name: Owners API + description: "HubSpot owners\_[assign](https://knowledge.hubspot.com/contacts/how-to-set-an-owner)\_specific users to records, activities, or marketing tasks, and can be used in personalization tokens for your content.\_Owners are automatically created and updated in HubSpot when new users are added or existing owners are synced from\_[Salesforce](https://knowledge.hubspot.com/articles/kcs_article/salesforce/how-will-a-salesforce-owner-will-be-recognized-by-hubspot).\n\nThe owners API endpoints are read-only, so you can use them to retrieve an owner's identifying details, including the owner ID. This identifier can then be used to assign ownership to CRM records in HubSpot, via an integration, or via property change API calls.\n\n## Retrieve a list of owners\n\nTo retrieve the owners in your account, make a\_`GET`\_request to\_`/crm/v3/owners`. The response will return each user's name, email, ID values, create/update dates, and if applicable, team information. Two ID values are returned, which are used for different purposes:\n\n- `id`: the ID of the owner. This value should be used when retrieving information about a specific owner, and when assigning an owner to a record or activity.\n \n- `userId`: the ID of the user. This value can be used to specify users in the\_[settings API](https://developers.hubspot.com/docs/api/settings/user-provisioning), but will result in an error if it is used to assign ownership.\n \n\n## Retrieve information about an individual owner\n\nTo retrieve a specific owner, make a\_`GET`\_request to\_`/crm/v3/owners/{ownerId}`. You should use the\_`id`\_value to specify the owner for which you want more details.\n\n**Please note**: the\_`updatedAt`\_value in the response changes based on updates to the Owner object itself. It will not be updated for changes to the User object. For example, changing a user's permissions will\_not\_update the\_`updatedAt`\_value." + - name: Owners API > Owners + - name: Payments API + description: "Use the payments API to fetch information about an account's\_[payments](https://knowledge.hubspot.com/payments/manage-payments). This is a read-only API, so it cannot be used for creating new or managing existing payments.\_\n\nFor example, use this API to\_[fetch all refunded payments](https://developers.hubspot.com/docs/api/commerce/payments#search-for-payments-by-properties)\_in an account.\n\n## Requirements\n\nTo use this API, the account must be set up to collect payments through either\_[HubSpot payments](https://knowledge.hubspot.com/payments/set-up-payments)\_or\_[Stripe payment processing](https://knowledge.hubspot.com/payments/connect-your-stripe-account-as-a-payment-processor-in-hubspot).\n\n## Retrieve payments\n\nDepending on the information you need, there are a few ways to retrieve payments:\n\n- To retrieve all payments, make a\_`GET`\_request to\_`crm/v3/objects/commerce_payments`.\n \n- To retrieve a payment, make a\_`GET`\_request to the above URL and specify an payment ID. For example:\_`crm/v3/objects/commerce_payments/44446244097`.\n \n- To retrieve payments that meet a specific set of criteria, you can make a\_`POST`\_request to the search endpoint and include filters in the request body." + - name: Payments API > Batch + - name: Payments API > Basic + - name: Payments API > Search + - name: Pipelines API + description: "In HubSpot, a pipeline is where deal stages or or ticket statuses are set. For sales, pipelines can be used to predict revenue and identify roadblocks. For service, pipelines can be used to manage ticket statuses and analyze blockers.\_\n\nEach stage in a pipeline is identified by a unique internal ID, meaning it can only be a member of one pipeline. Each pipeline always has at least one stage, and each account has at least one pipeline.\n\n### Default pipelines\n\nEvery account initially contains a default pipeline with the\_`pipelineId`\_“default.” On accounts with a single pipeline, the pipeline property for any object will automatically be set to “default” as well. On accounts with multiple pipelines, if you're setting a stage that isn’t in the default pipeline, you'll also need to set the corresponding pipeline property.\n\n### Multiple pipelines\n\nOnly Sales Hub Professional or Enterprise accounts can create\_[multiple deal pipelines](https://knowledge.hubspot.com/deals/set-up-and-customize-your-deal-pipelines-and-deal-stages).\n\nSimilarly, you must have a Service Hub Professional or Enterprise subscription to create multiple\_[ticket pipelines](https://knowledge.hubspot.com/tickets/customize-ticket-pipelines-and-statuses).\_\n\nLearn more about HubSpot’s subscription levels\_[here](https://legal.hubspot.com/hubspot-product-and-services-catalog?_ga=2.8754549.1572367158.1578321647-500942594.1573763828#ServiceHub).\n\n**Example use cases:**\_When working with deals, an account might have one pipeline for “New Sales\" and another for “Contract Renewals.\" For tickets, you might have a main support queue and a separate one for escalations. Each of those queues would be a separate ticket pipeline. The pipelines endpoints can be used to sync one pipeline or another to an external CRM." + - name: Pipelines API > Pipeline Stage Audits + - name: Pipelines API > Pipelines + - name: Pipelines API > Pipeline Audits + - name: Pipelines API > Pipeline Stages + - name: Products API + description: "In HubSpot, products represent the goods or services you sell. Building a\_[product library](https://knowledge.hubspot.com/deals/how-do-i-use-products)\_allows you to quickly add products to deals, generate quotes, and report on product performance.\_The products endpoints allow you to manage this data and sync it between HubSpot and other systems.\n\nProducts, along with companies, contacts, deals, tickets, line items, and quotes, are objects in the HubSpot CRM. Learn more about object properties, associations, relationships, and more in our\_[Understanding the CRM Objects](https://developers.hubspot.com/docs-beta/crm/understanding-the-crm)\_guide.\n\n**Example use case:**\_so that sales reps can easily add goods and services to deals, quotes, and more, use the products API to import your product catalog into HubSpot.\n\n## Create a product\n\nTo create a product make a\_`POST`\_request to\_`crm/v3/objects/products`. In the request body, include any product properties that you'd like to set on create. You can later update a product's properties through a\_`PATCH`\_request to the same endpoint.\n\nTo see all available product properties, make a\_`GET`\_request to the\_[properties API](https://developers.hubspot.com/docs/api/crm/properties). To retrieve product properties, the request URL will be\_`/crm/v3/properties/products`.\n\nJSON\n\n```\n// POST request to crm/v3/objects/products\n{\n \"name\": \"Implementation Service\",\n \"price\": \"6000.00\",\n \"hs_sku\": \"123456\",\n \"description\": \"Onboarding service for data product\",\n \"hs_cost_of_goods_sold\": \"600.00\",\n \"hs_recurring_billing_period\": \"P12M\"\n}\n\n ```\n\nCopyNote that the value for\_`hs_recurring_billing_period`\_is formatted as\_`P#M`, where # is the number of months." + - name: Products API > Batch + - name: Products API > Basic + - name: Products API > Public_Object + - name: Products API > GDPR + - name: Products API > Search + - name: Quotes API + description: "Use the quotes API to create, manage, and retrieve sales quotes for sharing pricing information with potential buyers. Once configured, a quote can be shared with a buyer either at a specified URL or through PDF. Users can also\_[manage quotes in HubSpot](https://knowledge.hubspot.com/quotes/use-quotes#manage-quotes)\_to add details, update associations, and more.\n\nIf you’ve set up either\_[HubSpot payments](https://knowledge.hubspot.com/payments/set-up-payments)\_or\_[Stripe payment processing](https://knowledge.hubspot.com/payments/connect-your-stripe-account-as-a-payment-processor-in-hubspot), you can configure a quote to be payable through this API. Learn more about\_[payable quotes](https://developers.hubspot.com/docs/api/crm/quotes#enable-payments). \n\n<img src=\"https://developers.hubspot.com/hs-fs/hubfs/Knowledge_Base_2023/example-quote-api.png?width=563&height=642&name=example-quote-api.png\" alt=\"\">\n\nExample use case:\_You need to create a contract proposal for a customer who is interested in purchasing one of your annual SEO auditing service packages.\n\nBelow, learn how to create a quote through the API and configure its various properties, associations, states, and more.\n\n## Overview\n\nThe quote creation process can be broken up into the following steps:\n\n1. **Create a quote:**\_create a quote with a few details, such as name and expiration date. You can also configure the quote to\_[enable e-signatures](https://developers.hubspot.com/docs/api/crm/quotes#enable-e-signatures)\_and\_[payments](https://developers.hubspot.com/docs/api/crm/quotes#enable-payments).\_\n \n2. **Set up associations:**\_associate the quote with other types of CRM objects, such as line items, a quote template, a deal, and more. During the next step, the quote will inherit property values from some of these associated records as well as the account's settings.\n \n3. **Set the quote state:**\_set the quote's state to reflect its readiness to be shared with buyers. When you set the quote's state, such as making it an editable draft or fully published and publicly accessible quote, it will\_[inherit certain properties](https://developers.hubspot.com/docs/api/crm/quotes#properties-set-by-quote-state)\_from its associated CRM records and account settings.\n \n4. **Share the quote:**\_once a quote has been published, you can share it with your buyers." + - name: Quotes API > Batch + - name: Quotes API > Basic + - name: Quotes API > Public_Object + - name: Quotes API > GDPR + - name: Quotes API > Search + - name: Taxes API + description: "When you're\_[creating a quote in HubSpot](https://developers.hubspot.com/docs/api/crm/quotes), you can create and associate a tax as part of the pricing details of the quote.\n\n## Create a tax\n\nTaxes are used in conjunction with\_[discounts](https://developers.hubspot.com/docs/api/crm/discounts)\_and\_[fees](https://developers.hubspot.com/docs/api/crm/fees)\_when determining the pricing details for a quote. Any discounts you associate with your quote will be applied first, followed by associated fees, and then any associated taxes will apply.\n\nJSON\n\n```\n// POST request to https://api.hubspi.com/crm/v3/objects/tax\n{\n \"properties\": {\n \"hs_label\": \"A percentage-based tax of 6.5%\",\n \"hs_type\": \"PERCENT\",\n \"hs_value\": \"6.5\"\n }\n}\n\n ```\n\nCopy\n\nAfter you create a tax, you can use its ID to associate it with a quote. To retrieve a list of taxes you've created, you can make a\_`GET`\_request to\_`/crm/v3/objects/tax`." + - name: Taxes API > Batch + - name: Taxes API > Basic + - name: Taxes API > Public_Object + - name: Taxes API > GDPR + - name: Taxes API > Search + - name: Tickets API + description: "In HubSpot, tickets represents customer requests for help. Tickets are tracked through your support process in\_[pipeline statuses](https://knowledge.hubspot.com/tickets/customize-ticket-pipelines-and-statuses)\_until they're closed. The tickets endpoints allow you to manage create and manage ticket records, as well as sync ticket data between HubSpot and other systems.\_\n\nLearn more about objects, records, properties, and associations APIs in the\_[Understanding the CRM](https://developers.hubspot.com/docs-beta/crm/understanding-the-crm?_ga=2.21847609.341006870.1586180142-500942594.1573763828)\_guide. For more general information about objects and records in HubSpot,\_[ learn how to manage your CRM database](https://knowledge.hubspot.com/contacts/a-guide-to-using-records?_ga=2.22901305.341006870.1586180142-500942594.1573763828)[.](https://knowledge.hubspot.com/contacts-user-guide?utm_campaign=UserGuides&utm_source=Developers)\n\n## Create tickets\n\nTo create new tickets, make a\_`POST`\_request to\_`/crm/v3/objects/tickets`.\n\nIn your request, include your ticket data in a\_properties\_object. You can also add an\_associations\_object to associate your new ticket with existing records (e.g., contacts, companies), or activities (e.g., meetings, notes).\n\n### Properties\n\nTicket details are stored in ticket properties. There are\_[default HubSpot ticket properties](https://knowledge.hubspot.com/tickets/hubspots-default-ticket-properties), but you can also\_[create custom properties](https://knowledge.hubspot.com/contacts/manage-your-properties?_ga=2.135700019.341006870.1586180142-500942594.1573763828#create-custom-properties).\n\nWhen creating a new ticket, you should include the following properties in your request:\_`subject`\_(the ticket's name),\_`hs_pipeline_stage`\_(the ticket's status) and if you have multiple pipelines,\_`hs_pipeline`.\_If a pipeline isn't specified, the default pipeline will be used.\n\nTo view all available properties, you can retrieve a list of your account's ticket properties by making a\_`GET`\_request to\_`/crm/v3/properties/tickets`. Learn more about the the\_[ properties API](https://developers.hubspot.com/docs/api/crm/properties).\n\n**Please note**: you must use the internal ID of a ticket status or pipeline when creating a ticket via the API. The internal ID is a number, which will also be returned when you retrieve tickets via the API. You can find a ticket status or pipeline's internal ID in your\_[ ticket pipeline settings.](https://knowledge.hubspot.com/tickets/customize-ticket-pipelines-and-statuses)" + - name: Tickets API > Batch + - name: Tickets API > Basic + - name: Tickets API > Public_Object + - name: Tickets API > GDPR + - name: Tickets API > Search + - name: Limits Tracking API + description: >- + Use the limits tracking API to view limits and usage for CRM data + including records, associations, pipelines, and properties. + + + ### [Use cases for this + API](https://developers.hubspot.com/docs/reference/api/crm/limits-tracking#use-cases) + + + Before importing a large file of contacts, you want to check how many + contact records you've created compared to your account's limit. + + + #### Related guide: + + + [Limits tracking + guide](https://developers.hubspot.com/docs/guides/api/crm/limits-tracking) + - name: Limits Tracking API > Limits + - name: Invoices API + - name: Invoices API > Batch + - name: Invoices API > Basic + - name: Invoices API > Search +paths: + /crm/v3/associations/{fromObjectType}/{toObjectType}/batch/create: + post: + tags: + - Associations V3 API > Batch + summary: Create a batch of associations + description: Associate all pairs of objects identified in the request body. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - from: + id: <string> + to: + id: <string> + type: <string> + - from: + id: <string> + to: + id: <string> + type: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: fromObjectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + - name: toObjectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - from: + id: <string> + to: + id: <string> + type: <string> + - from: + id: <string> + to: + id: <string> + type: <string> + startedAt: <dateTime> + status: PROCESSING + requestedAt: <dateTime> + links: + eu_5: <string> + nulla21c: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - from: + id: <string> + to: + id: <string> + type: <string> + - from: + id: <string> + to: + id: <string> + type: <string> + startedAt: <dateTime> + status: CANCELED + numErrors: <integer> + requestedAt: <dateTime> + links: + in_9: <string> + errors: + - category: <string> + context: + in_b8c: + - <string> + - <string> + laborum_af0: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + anim66b: + - <string> + - <string> + do_70: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + quic1: + - <string> + - <string> + in__9: + - <string> + - <string> + links: + aute_ac5: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + - category: <string> + context: + etd: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + Excepteur_f: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + in_738: + - <string> + - <string> + links: + do_d: <string> + irure_95e: <string> + deserunt_4ab: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "elit_97": [ + "<string>", + "<string>" + ] + }, + "links": { + "veniambad": "<string>", + "exercitation__3": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "magna_dc": [ + "<string>", + "<string>" + ], + "dolore_3f": [ + "<string>", + "<string>" + ], + "voluptateb_": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "veniam_e5": [ + "<string>", + "<string>" + ], + "commodo_ceb": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/associations/{fromObjectType}/{toObjectType}/batch/read: + post: + tags: + - Associations V3 API > Batch + summary: Read a batch of associations + description: >- + Get the IDs of all `{toObjectType}` objects associated with those + specified in the request body. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: fromObjectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + - name: toObjectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - from: + id: <string> + to: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + - from: + id: <string> + to: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + startedAt: <dateTime> + status: PROCESSING + requestedAt: <dateTime> + links: + tempor_3b: <string> + proident_71b: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - from: + id: <string> + to: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + - from: + id: <string> + to: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + startedAt: <dateTime> + status: PROCESSING + numErrors: <integer> + requestedAt: <dateTime> + links: + dolor2e: <string> + adipisicingd1e: <string> + errors: + - category: <string> + context: + culpa_8: + - <string> + - <string> + aliquip5: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + ut_d5: + - <string> + - <string> + ipsum9d: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + cupidatataa: + - <string> + - <string> + minim_63: + - <string> + - <string> + ametc2: + - <string> + - <string> + sed__1: + - <string> + - <string> + links: + laboris_76: <string> + utb: <string> + mollit_698: <string> + cupidatat_4c8: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + - category: <string> + context: + laboris__: + - <string> + - <string> + minim_b: + - <string> + - <string> + dolor_78: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + in36a: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + minim04c: + - <string> + - <string> + proident_d: + - <string> + - <string> + links: + laboris_9c3: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "elit_97": [ + "<string>", + "<string>" + ] + }, + "links": { + "veniambad": "<string>", + "exercitation__3": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "magna_dc": [ + "<string>", + "<string>" + ], + "dolore_3f": [ + "<string>", + "<string>" + ], + "voluptateb_": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "veniam_e5": [ + "<string>", + "<string>" + ], + "commodo_ceb": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/associations/{fromObjectType}/{toObjectType}/batch/archive: + post: + tags: + - Associations V3 API > Batch + summary: Archive a batch of associations + description: >- + Remove the associations between all pairs of objects identified in the + request body. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - from: + id: <string> + to: + id: <string> + type: <string> + - from: + id: <string> + to: + id: <string> + type: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: fromObjectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + - name: toObjectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "elit_97": [ + "<string>", + "<string>" + ] + }, + "links": { + "veniambad": "<string>", + "exercitation__3": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "magna_dc": [ + "<string>", + "<string>" + ], + "dolore_3f": [ + "<string>", + "<string>" + ], + "voluptateb_": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "veniam_e5": [ + "<string>", + "<string>" + ], + "commodo_ceb": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/associations/{fromObjectType}/{toObjectType}/types: + get: + tags: + - Associations V3 Schema API > Types + summary: List association types + description: List all the valid association types available between two object types + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: fromObjectType + in: path + schema: + type: string + required: true + example: <string> + - name: toObjectType + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - id: <string> + name: <string> + - id: <string> + name: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "voluptate_f1": [ + "<string>", + "<string>" + ], + "cillum7": [ + "<string>", + "<string>" + ], + "ut_0b": [ + "<string>", + "<string>" + ], + "laboris93": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "nostrud_cb": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "tempor_6": [ + "<string>", + "<string>" + ] + }, + "links": { + "commodo_7": "<string>", + "dolor65": "<string>", + "exercitation82": "<string>" + } + } + /crm/v4/associations/{fromObjectType}/{toObjectType}/batch/labels/archive: + post: + tags: + - Flexible Associations V4 API > Batch + summary: Delete Specific Labels + description: >- + Batch delete specific association labels for objects. Deleting an + unlabeled association will also delete all labeled associations between + those two objects + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - from: + id: <string> + to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - from: + id: <string> + to: + id: <string> + types: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: fromObjectType + in: path + schema: + type: string + required: true + example: <string> + - name: toObjectType + in: path + schema: + type: string + required: true + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "eub4e": [ + "<string>", + "<string>" + ], + "non_3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "sint874": [ + "<string>", + "<string>" + ], + "anim_2a": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "veniam_57": [ + "<string>", + "<string>" + ], + "proident62": [ + "<string>", + "<string>" + ], + "minim_a7": [ + "<string>", + "<string>" + ], + "laborum5": [ + "<string>", + "<string>" + ] + }, + "links": { + "aute_2": "<string>", + "ex_32": "<string>", + "nulla__1e": "<string>" + } + } + /crm/v4/associations/{fromObjectType}/{toObjectType}/batch/read: + post: + tags: + - Flexible Associations V4 API > Batch + summary: Read + description: >- + Batch read associations for objects to specific object type. The 'after' + field in a returned paging object can be added alongside the 'id' to + retrieve the next page of associations from that objectId. The 'link' + field is deprecated and should be ignored. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + after: <string> + - id: <string> + after: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: fromObjectType + in: path + schema: + type: string + required: true + example: <string> + - name: toObjectType + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - from: + id: <string> + to: + - associationTypes: + - category: USER_DEFINED + typeId: <integer> + label: <string> + - category: USER_DEFINED + typeId: <integer> + label: <string> + toObjectId: <integer> + - associationTypes: + - category: INTEGRATOR_DEFINED + typeId: <integer> + label: <string> + - category: USER_DEFINED + typeId: <integer> + label: <string> + toObjectId: <integer> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + - from: + id: <string> + to: + - associationTypes: + - category: USER_DEFINED + typeId: <integer> + label: <string> + - category: HUBSPOT_DEFINED + typeId: <integer> + label: <string> + toObjectId: <integer> + - associationTypes: + - category: INTEGRATOR_DEFINED + typeId: <integer> + label: <string> + - category: USER_DEFINED + typeId: <integer> + label: <string> + toObjectId: <integer> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + startedAt: <dateTime> + status: CANCELED + requestedAt: <dateTime> + links: + sita: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - from: + id: <string> + to: + - associationTypes: + - category: INTEGRATOR_DEFINED + typeId: <integer> + label: <string> + - category: INTEGRATOR_DEFINED + typeId: <integer> + label: <string> + toObjectId: <integer> + - associationTypes: + - category: HUBSPOT_DEFINED + typeId: <integer> + label: <string> + - category: INTEGRATOR_DEFINED + typeId: <integer> + label: <string> + toObjectId: <integer> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + - from: + id: <string> + to: + - associationTypes: + - category: HUBSPOT_DEFINED + typeId: <integer> + label: <string> + - category: HUBSPOT_DEFINED + typeId: <integer> + label: <string> + toObjectId: <integer> + - associationTypes: + - category: INTEGRATOR_DEFINED + typeId: <integer> + label: <string> + - category: USER_DEFINED + typeId: <integer> + label: <string> + toObjectId: <integer> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + startedAt: <dateTime> + status: COMPLETE + numErrors: <integer> + errors: + - category: <string> + context: + officia_71d: + - <string> + - <string> + sit_e99: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + deserunt_2: + - <string> + - <string> + nondd: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + quis_08e: + - <string> + - <string> + elit_1f: + - <string> + - <string> + links: + eu_b3: <string> + euc: <string> + reprehenderit_7b: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + occaecat7e: + - <string> + - <string> + elit_2: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + reprehenderit_3e8: + - <string> + - <string> + Duis_b: + - <string> + - <string> + culpa48: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + anim16e: + - <string> + - <string> + aliqua_663: + - <string> + - <string> + quisbf: + - <string> + - <string> + links: + exercitation_34: <string> + essee_: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + non2: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "eub4e": [ + "<string>", + "<string>" + ], + "non_3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "sint874": [ + "<string>", + "<string>" + ], + "anim_2a": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "veniam_57": [ + "<string>", + "<string>" + ], + "proident62": [ + "<string>", + "<string>" + ], + "minim_a7": [ + "<string>", + "<string>" + ], + "laborum5": [ + "<string>", + "<string>" + ] + }, + "links": { + "aute_2": "<string>", + "ex_32": "<string>", + "nulla__1e": "<string>" + } + } + /crm/v4/associations/{fromObjectType}/{toObjectType}/batch/create: + post: + tags: + - Flexible Associations V4 API > Batch + summary: Create + description: Batch create associations for objects + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - from: + id: <string> + to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - from: + id: <string> + to: + id: <string> + types: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: fromObjectType + in: path + schema: + type: string + required: true + example: <string> + - name: toObjectType + in: path + schema: + type: string + required: true + example: <string> + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - fromObjectId: <integer> + fromObjectTypeId: <string> + labels: + - <string> + - <string> + toObjectId: <integer> + toObjectTypeId: <string> + - fromObjectId: <integer> + fromObjectTypeId: <string> + labels: + - <string> + - <string> + toObjectId: <integer> + toObjectTypeId: <string> + startedAt: <dateTime> + status: PROCESSING + requestedAt: <dateTime> + links: + ad_99: <string> + enim_9: <string> + Ut_2: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - fromObjectId: <integer> + fromObjectTypeId: <string> + labels: + - <string> + - <string> + toObjectId: <integer> + toObjectTypeId: <string> + - fromObjectId: <integer> + fromObjectTypeId: <string> + labels: + - <string> + - <string> + toObjectId: <integer> + toObjectTypeId: <string> + startedAt: <dateTime> + status: COMPLETE + numErrors: <integer> + errors: + - category: <string> + context: + consectetur_: + - <string> + - <string> + non_b0: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + non_96: + - <string> + - <string> + sed_717: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + non_c: + - <string> + - <string> + aliqua_26: + - <string> + - <string> + links: + enim43: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + esse8: + - <string> + - <string> + eta45: + - <string> + - <string> + irure_b: + - <string> + - <string> + ad_6: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + dolored23: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + voluptate7: + - <string> + - <string> + id_6: + - <string> + - <string> + links: + amet8f: <string> + qui_22: <string> + sintf: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + ut_a6f: <string> + nisi6: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "eub4e": [ + "<string>", + "<string>" + ], + "non_3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "sint874": [ + "<string>", + "<string>" + ], + "anim_2a": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "veniam_57": [ + "<string>", + "<string>" + ], + "proident62": [ + "<string>", + "<string>" + ], + "minim_a7": [ + "<string>", + "<string>" + ], + "laborum5": [ + "<string>", + "<string>" + ] + }, + "links": { + "aute_2": "<string>", + "ex_32": "<string>", + "nulla__1e": "<string>" + } + } + /crm/v4/associations/{fromObjectType}/{toObjectType}/batch/archive: + post: + tags: + - Flexible Associations V4 API > Batch + summary: Delete + description: Batch delete associations for objects + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - from: + id: <string> + to: + - id: <string> + - id: <string> + - from: + id: <string> + to: + - id: <string> + - id: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: fromObjectType + in: path + schema: + type: string + required: true + example: <string> + - name: toObjectType + in: path + schema: + type: string + required: true + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "eub4e": [ + "<string>", + "<string>" + ], + "non_3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "sint874": [ + "<string>", + "<string>" + ], + "anim_2a": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "veniam_57": [ + "<string>", + "<string>" + ], + "proident62": [ + "<string>", + "<string>" + ], + "minim_a7": [ + "<string>", + "<string>" + ], + "laborum5": [ + "<string>", + "<string>" + ] + }, + "links": { + "aute_2": "<string>", + "ex_32": "<string>", + "nulla__1e": "<string>" + } + } + /crm/v4/associations/{fromObjectType}/{toObjectType}/batch/associate/default: + post: + tags: + - Flexible Associations V4 API > Batch + summary: ' Create Default Associations' + description: >- + Create the default (most generic) association type between two object + types + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - from: + id: <string> + to: + id: <string> + - from: + id: <string> + to: + id: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: fromObjectType + in: path + schema: + type: string + required: true + example: <string> + - name: toObjectType + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - associationSpec: + associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + from: + id: <string> + to: + id: <string> + - associationSpec: + associationCategory: USER_DEFINED + associationTypeId: <integer> + from: + id: <string> + to: + id: <string> + startedAt: <dateTime> + status: CANCELED + numErrors: <integer> + errors: + - category: <string> + context: + velitff: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + consectetur_c7: + - <string> + - <string> + ipsum_23: + - <string> + - <string> + essed: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + in_25: + - <string> + - <string> + Duis_ce: + - <string> + - <string> + links: + dolor_58: <string> + commodo_1: <string> + ex8: <string> + qui_fa: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + in0: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + deserunt_d: + - <string> + - <string> + proident_8e0: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + cillumd7: + - <string> + - <string> + links: + enima: <string> + pariatur_0e2: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + aliqua_537: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "eub4e": [ + "<string>", + "<string>" + ], + "non_3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "sint874": [ + "<string>", + "<string>" + ], + "anim_2a": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "veniam_57": [ + "<string>", + "<string>" + ], + "proident62": [ + "<string>", + "<string>" + ], + "minim_a7": [ + "<string>", + "<string>" + ], + "laborum5": [ + "<string>", + "<string>" + ] + }, + "links": { + "aute_2": "<string>", + "ex_32": "<string>", + "nulla__1e": "<string>" + } + } + /crm/v4/objects/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}: + put: + tags: + - Flexible Associations V4 API > Associations + summary: Create + description: Set association labels between two records. + requestBody: + content: + application/json: + schema: + type: object + example: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: objectType + in: path + schema: + type: string + required: true + example: <string> + - name: objectId + in: path + schema: + type: string + required: true + example: <long> + - name: toObjectType + in: path + schema: + type: string + required: true + example: <string> + - name: toObjectId + in: path + schema: + type: string + required: true + example: <long> + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + fromObjectId: <long> + fromObjectTypeId: <string> + labels: + - <string> + - <string> + toObjectId: <long> + toObjectTypeId: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "eub4e": [ + "<string>", + "<string>" + ], + "non_3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "sint874": [ + "<string>", + "<string>" + ], + "anim_2a": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "veniam_57": [ + "<string>", + "<string>" + ], + "proident62": [ + "<string>", + "<string>" + ], + "minim_a7": [ + "<string>", + "<string>" + ], + "laborum5": [ + "<string>", + "<string>" + ] + }, + "links": { + "aute_2": "<string>", + "ex_32": "<string>", + "nulla__1e": "<string>" + } + } + delete: + tags: + - Flexible Associations V4 API > Associations + summary: Delete + description: deletes all associations between two records. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: objectType + in: path + schema: + type: string + required: true + example: <string> + - name: objectId + in: path + schema: + type: string + required: true + example: <long> + - name: toObjectType + in: path + schema: + type: string + required: true + example: <string> + - name: toObjectId + in: path + schema: + type: string + required: true + example: <long> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "eub4e": [ + "<string>", + "<string>" + ], + "non_3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "sint874": [ + "<string>", + "<string>" + ], + "anim_2a": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "veniam_57": [ + "<string>", + "<string>" + ], + "proident62": [ + "<string>", + "<string>" + ], + "minim_a7": [ + "<string>", + "<string>" + ], + "laborum5": [ + "<string>", + "<string>" + ] + }, + "links": { + "aute_2": "<string>", + "ex_32": "<string>", + "nulla__1e": "<string>" + } + } + /crm/v4/objects/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}: + put: + tags: + - Flexible Associations V4 API > Associations + summary: Create Default + description: >- + Create the default (most generic) association type between two object + types + requestBody: + content: {} + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: fromObjectType + in: path + schema: + type: string + required: true + example: <string> + - name: fromObjectId + in: path + schema: + type: string + required: true + example: <long> + - name: toObjectType + in: path + schema: + type: string + required: true + example: <string> + - name: toObjectId + in: path + schema: + type: string + required: true + example: <long> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - associationSpec: + associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + from: + id: <string> + to: + id: <string> + - associationSpec: + associationCategory: USER_DEFINED + associationTypeId: <integer> + from: + id: <string> + to: + id: <string> + startedAt: <dateTime> + status: CANCELED + numErrors: <integer> + errors: + - category: <string> + context: + velitff: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + consectetur_c7: + - <string> + - <string> + ipsum_23: + - <string> + - <string> + essed: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + in_25: + - <string> + - <string> + Duis_ce: + - <string> + - <string> + links: + dolor_58: <string> + commodo_1: <string> + ex8: <string> + qui_fa: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + in0: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + deserunt_d: + - <string> + - <string> + proident_8e0: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + cillumd7: + - <string> + - <string> + links: + enima: <string> + pariatur_0e2: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + aliqua_537: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "eub4e": [ + "<string>", + "<string>" + ], + "non_3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "sint874": [ + "<string>", + "<string>" + ], + "anim_2a": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "veniam_57": [ + "<string>", + "<string>" + ], + "proident62": [ + "<string>", + "<string>" + ], + "minim_a7": [ + "<string>", + "<string>" + ], + "laborum5": [ + "<string>", + "<string>" + ] + }, + "links": { + "aute_2": "<string>", + "ex_32": "<string>", + "nulla__1e": "<string>" + } + } + /crm/v4/objects/{objectType}/{objectId}/associations/{toObjectType}: + get: + tags: + - Flexible Associations V4 API > Associations + summary: List + description: List all associations of an object by object type. Limit 1000 per call. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: limit + in: query + schema: + type: integer + description: The maximum number of results to display per page. + example: '500' + - name: objectType + in: path + schema: + type: string + required: true + example: <string> + - name: objectId + in: path + schema: + type: string + required: true + example: <long> + - name: toObjectType + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - associationTypes: + - category: HUBSPOT_DEFINED + typeId: <integer> + label: <string> + - category: INTEGRATOR_DEFINED + typeId: <integer> + label: <string> + toObjectId: <integer> + - associationTypes: + - category: HUBSPOT_DEFINED + typeId: <integer> + label: <string> + - category: USER_DEFINED + typeId: <integer> + label: <string> + toObjectId: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "eub4e": [ + "<string>", + "<string>" + ], + "non_3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "sint874": [ + "<string>", + "<string>" + ], + "anim_2a": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "veniam_57": [ + "<string>", + "<string>" + ], + "proident62": [ + "<string>", + "<string>" + ], + "minim_a7": [ + "<string>", + "<string>" + ], + "laborum5": [ + "<string>", + "<string>" + ] + }, + "links": { + "aute_2": "<string>", + "ex_32": "<string>", + "nulla__1e": "<string>" + } + } + /crm/v4/associations/usage/high-usage-report/{userId}: + post: + tags: + - Associations V4 API + summary: Report + description: >- + Requests a report of all objects in the portal which have a high usage + of associations + requestBody: + content: {} + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: userId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <integer> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + enqueueTime: + dateOnly: <boolean> + timeZoneShift: <integer> + value: <integer> + userEmail: <string> + userId: <integer> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ex_e": [ + "<string>", + "<string>" + ] + }, + "links": { + "qui_3": "<string>" + }, + "errors": [ + { + "message": "labore dolore deserunt fugiat Duis", + "subCategory": "voluptate ipsum magna", + "code": "dolore nisi nulla", + "in": "qui ut sed aute", + "context": { + "tempor_4c": [ + "dolore", + "" + ] + } + }, + { + "message": "et", + "subCategory": "anim tempor in", + "code": "enim tempor proident dolore", + "in": "labore Lorem dolor", + "context": { + "id67_": [ + "in laboris", + "amet nisi ex" + ], + "sed9": [ + "qui et Exce", + "amet laboris dolor quis" + ], + "id_": [ + "voluptate laboris", + "deserunt incididunt" + ], + "est8": [ + "anim", + "et laborum" + ] + } + } + ] + } + /crm/v4/associations/{fromObjectType}/{toObjectType}/labels: + get: + tags: + - Associations V4 Schema API > Definitions + summary: Read + description: Returns all association types between two object types + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: fromObjectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + - name: toObjectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - category: HUBSPOT_DEFINED + typeId: <integer> + label: <string> + - category: HUBSPOT_DEFINED + typeId: <integer> + label: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "sit_6": [ + "<string>", + "<string>" + ] + }, + "links": { + "ipsum_0": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "non1f9": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "occaecatd": [ + "<string>", + "<string>" + ] + } + } + ] + } + put: + tags: + - Associations V4 Schema API > Definitions + summary: Update + description: Update a user defined association definition + requestBody: + content: + application/json: + schema: + type: object + example: + associationTypeId: <integer> + label: <string> + inverseLabel: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: fromObjectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + - name: toObjectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "sit_6": [ + "<string>", + "<string>" + ] + }, + "links": { + "ipsum_0": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "non1f9": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "occaecatd": [ + "<string>", + "<string>" + ] + } + } + ] + } + post: + tags: + - Associations V4 Schema API > Definitions + summary: Create + description: Create a user defined association definition + requestBody: + content: + application/json: + schema: + type: object + example: + label: <string> + name: <string> + inverseLabel: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: fromObjectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + - name: toObjectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - category: HUBSPOT_DEFINED + typeId: <integer> + label: <string> + - category: HUBSPOT_DEFINED + typeId: <integer> + label: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "sit_6": [ + "<string>", + "<string>" + ] + }, + "links": { + "ipsum_0": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "non1f9": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "occaecatd": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v4/associations/{fromObjectType}/{toObjectType}/labels/{associationTypeId}: + delete: + tags: + - Associations V4 Schema API > Definitions + summary: Delete + description: Deletes an association definition + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: fromObjectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + - name: toObjectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + - name: associationTypeId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <integer> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "sit_6": [ + "<string>", + "<string>" + ] + }, + "links": { + "ipsum_0": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "non1f9": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "occaecatd": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/carts/batch/read: + post: + tags: + - Carts API > Batch + summary: Read a batch of carts by internal ID, or unique property values + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + properties: + - <string> + - <string> + propertiesWithHistory: + - <string> + - <string> + idProperty: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + in_c7: <string> + amet53: <string> + consectetur_f: <string> + esse_c9: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + ut_6d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + anim_0: <string> + consequat_3a7: <string> + et030: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + quis53a: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + startedAt: <dateTime> + status: PROCESSING + requestedAt: <dateTime> + links: + inf9: <string> + laboris_9b: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + exercitation_3: <string> + nulla_3f2: <string> + labore15: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + etb1: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + consequatc01: <string> + exf2a: <string> + inf79: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + adipisicing_49e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + aliqua8: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + voluptate_e4: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + incididunta0: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + startedAt: <dateTime> + status: COMPLETE + numErrors: <integer> + requestedAt: <dateTime> + links: + ut_a4e: <string> + quis0_5: <string> + errors: + - category: <string> + context: + cillum_7d0: + - <string> + - <string> + consecteturdc7: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + in44: + - <string> + - <string> + aute_d: + - <string> + - <string> + est_3: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + culpa8e7: + - <string> + - <string> + in_: + - <string> + - <string> + links: + non_3: <string> + culpa_da1: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + - category: <string> + context: + pariatur3: + - <string> + - <string> + et_f: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + do_775: + - <string> + - <string> + eiusmod_775: + - <string> + - <string> + culpa14: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + est_5: + - <string> + - <string> + links: + in45: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "in_1a0": [ + "<string>", + "<string>" + ], + "amet_8": [ + "<string>", + "<string>" + ], + "consequat15_": [ + "<string>", + "<string>" + ], + "ullamco_37": [ + "<string>", + "<string>" + ] + }, + "links": { + "dolor424": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "non_edb": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "minim_c_": [ + "<string>", + "<string>" + ], + "veniam43": [ + "<string>", + "<string>" + ], + "fugiatd": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/carts/batch/archive: + post: + tags: + - Carts API > Batch + summary: Archive a batch of carts by ID + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "in_1a0": [ + "<string>", + "<string>" + ], + "amet_8": [ + "<string>", + "<string>" + ], + "consequat15_": [ + "<string>", + "<string>" + ], + "ullamco_37": [ + "<string>", + "<string>" + ] + }, + "links": { + "dolor424": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "non_edb": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "minim_c_": [ + "<string>", + "<string>" + ], + "veniam43": [ + "<string>", + "<string>" + ], + "fugiatd": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/carts/batch/create: + post: + tags: + - Carts API > Batch + summary: Create a batch of carts + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - associations: + - to: + id: <string> + types: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + properties: + dolore51: <string> + labore_747: <string> + - associations: + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + properties: + ex9a: <string> + elit36: <string> + in_5e6: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + in_c7: <string> + amet53: <string> + consectetur_f: <string> + esse_c9: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + ut_6d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + anim_0: <string> + consequat_3a7: <string> + et030: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + quis53a: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + startedAt: <dateTime> + status: PROCESSING + requestedAt: <dateTime> + links: + inf9: <string> + laboris_9b: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + exercitation_3: <string> + nulla_3f2: <string> + labore15: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + etb1: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + consequatc01: <string> + exf2a: <string> + inf79: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + adipisicing_49e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + aliqua8: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + voluptate_e4: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + incididunta0: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + startedAt: <dateTime> + status: COMPLETE + numErrors: <integer> + requestedAt: <dateTime> + links: + ut_a4e: <string> + quis0_5: <string> + errors: + - category: <string> + context: + cillum_7d0: + - <string> + - <string> + consecteturdc7: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + in44: + - <string> + - <string> + aute_d: + - <string> + - <string> + est_3: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + culpa8e7: + - <string> + - <string> + in_: + - <string> + - <string> + links: + non_3: <string> + culpa_da1: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + - category: <string> + context: + pariatur3: + - <string> + - <string> + et_f: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + do_775: + - <string> + - <string> + eiusmod_775: + - <string> + - <string> + culpa14: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + est_5: + - <string> + - <string> + links: + in45: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "in_1a0": [ + "<string>", + "<string>" + ], + "amet_8": [ + "<string>", + "<string>" + ], + "consequat15_": [ + "<string>", + "<string>" + ], + "ullamco_37": [ + "<string>", + "<string>" + ] + }, + "links": { + "dolor424": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "non_edb": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "minim_c_": [ + "<string>", + "<string>" + ], + "veniam43": [ + "<string>", + "<string>" + ], + "fugiatd": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/carts/batch/update: + post: + tags: + - Carts API > Batch + summary: Update a batch of carts + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + properties: + sunt_c6: <string> + temporf89: <string> + idProperty: <string> + - id: <string> + properties: + cillum_6: <string> + est_0: <string> + idProperty: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + in_c7: <string> + amet53: <string> + consectetur_f: <string> + esse_c9: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + ut_6d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + anim_0: <string> + consequat_3a7: <string> + et030: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + quis53a: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + startedAt: <dateTime> + status: PROCESSING + requestedAt: <dateTime> + links: + inf9: <string> + laboris_9b: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + exercitation_3: <string> + nulla_3f2: <string> + labore15: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + etb1: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + consequatc01: <string> + exf2a: <string> + inf79: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + adipisicing_49e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + aliqua8: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + voluptate_e4: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + incididunta0: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + startedAt: <dateTime> + status: COMPLETE + numErrors: <integer> + requestedAt: <dateTime> + links: + ut_a4e: <string> + quis0_5: <string> + errors: + - category: <string> + context: + cillum_7d0: + - <string> + - <string> + consecteturdc7: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + in44: + - <string> + - <string> + aute_d: + - <string> + - <string> + est_3: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + culpa8e7: + - <string> + - <string> + in_: + - <string> + - <string> + links: + non_3: <string> + culpa_da1: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + - category: <string> + context: + pariatur3: + - <string> + - <string> + et_f: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + do_775: + - <string> + - <string> + eiusmod_775: + - <string> + - <string> + culpa14: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + est_5: + - <string> + - <string> + links: + in45: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "in_1a0": [ + "<string>", + "<string>" + ], + "amet_8": [ + "<string>", + "<string>" + ], + "consequat15_": [ + "<string>", + "<string>" + ], + "ullamco_37": [ + "<string>", + "<string>" + ] + }, + "links": { + "dolor424": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "non_edb": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "minim_c_": [ + "<string>", + "<string>" + ], + "veniam43": [ + "<string>", + "<string>" + ], + "fugiatd": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/carts/{cartId}: + get: + tags: + - Carts API > Basic + summary: Read + description: >- + Read an Object identified by `{cartId}`. `{cartId}` refers to the + internal object ID by default, or optionally any unique property value + as specified by the `idProperty` query param. Control what is returned + via the `properties` query param. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: cartId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + dolor_e: <string> + sunt_2: <string> + ullamco3: <string> + sit_1__: <string> + updatedAt: <dateTime> + associations: + minim_7: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + sit98: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + aliquip_8: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + Ut_c5_: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + utd99: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + consectetur99_: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "in_1a0": [ + "<string>", + "<string>" + ], + "amet_8": [ + "<string>", + "<string>" + ], + "consequat15_": [ + "<string>", + "<string>" + ], + "ullamco_37": [ + "<string>", + "<string>" + ] + }, + "links": { + "dolor424": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "non_edb": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "minim_c_": [ + "<string>", + "<string>" + ], + "veniam43": [ + "<string>", + "<string>" + ], + "fugiatd": [ + "<string>", + "<string>" + ] + } + } + ] + } + delete: + tags: + - Carts API > Basic + summary: Archive + description: Move an Object identified by `{cartId}` to the recycling bin. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: cartId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "in_1a0": [ + "<string>", + "<string>" + ], + "amet_8": [ + "<string>", + "<string>" + ], + "consequat15_": [ + "<string>", + "<string>" + ], + "ullamco_37": [ + "<string>", + "<string>" + ] + }, + "links": { + "dolor424": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "non_edb": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "minim_c_": [ + "<string>", + "<string>" + ], + "veniam43": [ + "<string>", + "<string>" + ], + "fugiatd": [ + "<string>", + "<string>" + ] + } + } + ] + } + patch: + tags: + - Carts API > Basic + summary: Update + description: >- + Perform a partial update of an Object identified by `{cartId}`. + `{cartId}` refers to the internal object ID by default, or optionally + any unique property value as specified by the `idProperty` query param. + Provided property values will be overwritten. Read-only and non-existent + properties will be ignored. Properties values can be cleared by passing + an empty string. + requestBody: + content: + application/json: + schema: + type: object + example: + properties: + aliquip_f5: <string> + elit_a6: <string> + cupidatat3: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: cartId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + incididunt_cf: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + sit_30_: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + dolore_9d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + nostrud_33: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "in_1a0": [ + "<string>", + "<string>" + ], + "amet_8": [ + "<string>", + "<string>" + ], + "consequat15_": [ + "<string>", + "<string>" + ], + "ullamco_37": [ + "<string>", + "<string>" + ] + }, + "links": { + "dolor424": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "non_edb": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "minim_c_": [ + "<string>", + "<string>" + ], + "veniam43": [ + "<string>", + "<string>" + ], + "fugiatd": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/carts: + get: + tags: + - Carts API > Basic + summary: List + description: >- + Read a page of carts. Control what is returned via the `properties` + query param. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: limit + in: query + schema: + type: integer + description: The maximum number of results to display per page. + example: '10' + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + anim_7a: <string> + velit89f: <string> + in013: <string> + in_701: <string> + updatedAt: <dateTime> + associations: + sint68a: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + sint97: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + estdab: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + cupidatat_2a: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + Ut_0: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + essebb2: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + Excepteur_dc: <string> + updatedAt: <dateTime> + associations: + exercitationa: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + et_f6f: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + deseruntae: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + adipisicing_1a: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "in_1a0": [ + "<string>", + "<string>" + ], + "amet_8": [ + "<string>", + "<string>" + ], + "consequat15_": [ + "<string>", + "<string>" + ], + "ullamco_37": [ + "<string>", + "<string>" + ] + }, + "links": { + "dolor424": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "non_edb": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "minim_c_": [ + "<string>", + "<string>" + ], + "veniam43": [ + "<string>", + "<string>" + ], + "fugiatd": [ + "<string>", + "<string>" + ] + } + } + ] + } + post: + tags: + - Carts API > Basic + summary: Create + description: >- + Create a cart with the given properties and return a copy of the object, + including the ID. Documentation and examples for creating standard carts + is provided. + requestBody: + content: + application/json: + schema: + type: object + example: + associations: + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + properties: + do4c: <string> + dolorc: <string> + culpa_58: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + incididunt_cf: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + sit_30_: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + dolore_9d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + nostrud_33: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "in_1a0": [ + "<string>", + "<string>" + ], + "amet_8": [ + "<string>", + "<string>" + ], + "consequat15_": [ + "<string>", + "<string>" + ], + "ullamco_37": [ + "<string>", + "<string>" + ] + }, + "links": { + "dolor424": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "non_edb": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "minim_c_": [ + "<string>", + "<string>" + ], + "veniam43": [ + "<string>", + "<string>" + ], + "fugiatd": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/carts/search: + post: + tags: + - Carts API > Search + summary: post-/crm/v3/objects/carts/search + requestBody: + content: + application/json: + schema: + type: object + example: + after: <string> + filterGroups: + - filters: + - operator: IN + propertyName: <string> + highValue: <string> + values: + - <string> + - <string> + value: <string> + - operator: IN + propertyName: <string> + highValue: <string> + values: + - <string> + - <string> + value: <string> + - filters: + - operator: NOT_HAS_PROPERTY + propertyName: <string> + highValue: <string> + values: + - <string> + - <string> + value: <string> + - operator: HAS_PROPERTY + propertyName: <string> + highValue: <string> + values: + - <string> + - <string> + value: <string> + limit: <integer> + properties: + - <string> + - <string> + sorts: + - <string> + - <string> + query: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + Duis36: <string> + ex_c_c: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + minim_52: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + fugiat_1: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + qui_d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + dolore_fb6: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "in_1a0": [ + "<string>", + "<string>" + ], + "amet_8": [ + "<string>", + "<string>" + ], + "consequat15_": [ + "<string>", + "<string>" + ], + "ullamco_37": [ + "<string>", + "<string>" + ] + }, + "links": { + "dolor424": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "non_edb": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "minim_c_": [ + "<string>", + "<string>" + ], + "veniam43": [ + "<string>", + "<string>" + ], + "fugiatd": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/commerce_payments/batch/read: + post: + tags: + - Commerce Payments API > Batch + summary: >- + Read a batch of commerce payments by internal ID, or unique property + values + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + properties: + - <string> + - <string> + propertiesWithHistory: + - <string> + - <string> + idProperty: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + eiusmodd: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + ut_3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + non_3: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + laborum4: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + deseruntcbc: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + startedAt: <dateTime> + status: PROCESSING + requestedAt: <dateTime> + links: + officia_8bf: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + nostrud__: <string> + officia_535: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + eiusmod_c87: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + ullamco_f53: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + Excepteur_6_: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + cillumf7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + startedAt: <dateTime> + status: PROCESSING + numErrors: <integer> + requestedAt: <dateTime> + links: + nostrud_48: <string> + laboris_87: <string> + errors: + - category: <string> + context: + sed_2d: + - <string> + - <string> + mollit5d: + - <string> + - <string> + id_f0c: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + exercitation6_8: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + ut3a: + - <string> + - <string> + non_13: + - <string> + - <string> + ea_81: + - <string> + - <string> + links: + tempor_e6: <string> + incididuntcee: <string> + aute_396: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + - category: <string> + context: + autea98: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + laborisa1: + - <string> + - <string> + Lorem_28: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + in37: + - <string> + - <string> + do_e5: + - <string> + - <string> + links: + tempor8c: <string> + Lorem37: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "dolor_f": [ + "<string>", + "<string>" + ], + "minimf": [ + "<string>", + "<string>" + ], + "ullamco25e": [ + "<string>", + "<string>" + ] + }, + "links": { + "laboris_7": "<string>", + "Lorem_378": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "irureff9": [ + "<string>", + "<string>" + ], + "quis3cf": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "non86": [ + "<string>", + "<string>" + ], + "enim_3e5": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/commerce_payments/batch/archive: + post: + tags: + - Commerce Payments API > Batch + summary: Archive a batch of commerce payments by ID + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "dolor_f": [ + "<string>", + "<string>" + ], + "minimf": [ + "<string>", + "<string>" + ], + "ullamco25e": [ + "<string>", + "<string>" + ] + }, + "links": { + "laboris_7": "<string>", + "Lorem_378": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "irureff9": [ + "<string>", + "<string>" + ], + "quis3cf": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "non86": [ + "<string>", + "<string>" + ], + "enim_3e5": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/commerce_payments/batch/create: + post: + tags: + - Commerce Payments API > Batch + summary: Create a batch of commerce payments + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - associations: + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + properties: + proident_6: <string> + - associations: + - to: + id: <string> + types: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + properties: + amet_4ee: <string> + Excepteur_43: <string> + suntb: <string> + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + eiusmodd: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + ut_3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + non_3: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + laborum4: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + deseruntcbc: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + startedAt: <dateTime> + status: PROCESSING + requestedAt: <dateTime> + links: + officia_8bf: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + nostrud__: <string> + officia_535: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + eiusmod_c87: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + ullamco_f53: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + Excepteur_6_: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + cillumf7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + startedAt: <dateTime> + status: PROCESSING + numErrors: <integer> + requestedAt: <dateTime> + links: + nostrud_48: <string> + laboris_87: <string> + errors: + - category: <string> + context: + sed_2d: + - <string> + - <string> + mollit5d: + - <string> + - <string> + id_f0c: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + exercitation6_8: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + ut3a: + - <string> + - <string> + non_13: + - <string> + - <string> + ea_81: + - <string> + - <string> + links: + tempor_e6: <string> + incididuntcee: <string> + aute_396: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + - category: <string> + context: + autea98: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + laborisa1: + - <string> + - <string> + Lorem_28: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + in37: + - <string> + - <string> + do_e5: + - <string> + - <string> + links: + tempor8c: <string> + Lorem37: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "dolor_f": [ + "<string>", + "<string>" + ], + "minimf": [ + "<string>", + "<string>" + ], + "ullamco25e": [ + "<string>", + "<string>" + ] + }, + "links": { + "laboris_7": "<string>", + "Lorem_378": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "irureff9": [ + "<string>", + "<string>" + ], + "quis3cf": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "non86": [ + "<string>", + "<string>" + ], + "enim_3e5": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/commerce_payments/batch/update: + post: + tags: + - Commerce Payments API > Batch + summary: Update a batch of commerce payments + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + properties: + cillum19f: <string> + aliquip_f4: <string> + idProperty: <string> + - id: <string> + properties: + do_443: <string> + ipsum6_d: <string> + idProperty: <string> + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + eiusmodd: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + ut_3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + non_3: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + laborum4: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + deseruntcbc: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + startedAt: <dateTime> + status: PROCESSING + requestedAt: <dateTime> + links: + officia_8bf: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + nostrud__: <string> + officia_535: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + eiusmod_c87: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + ullamco_f53: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + Excepteur_6_: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + cillumf7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + startedAt: <dateTime> + status: PROCESSING + numErrors: <integer> + requestedAt: <dateTime> + links: + nostrud_48: <string> + laboris_87: <string> + errors: + - category: <string> + context: + sed_2d: + - <string> + - <string> + mollit5d: + - <string> + - <string> + id_f0c: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + exercitation6_8: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + ut3a: + - <string> + - <string> + non_13: + - <string> + - <string> + ea_81: + - <string> + - <string> + links: + tempor_e6: <string> + incididuntcee: <string> + aute_396: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + - category: <string> + context: + autea98: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + laborisa1: + - <string> + - <string> + Lorem_28: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + in37: + - <string> + - <string> + do_e5: + - <string> + - <string> + links: + tempor8c: <string> + Lorem37: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "dolor_f": [ + "<string>", + "<string>" + ], + "minimf": [ + "<string>", + "<string>" + ], + "ullamco25e": [ + "<string>", + "<string>" + ] + }, + "links": { + "laboris_7": "<string>", + "Lorem_378": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "irureff9": [ + "<string>", + "<string>" + ], + "quis3cf": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "non86": [ + "<string>", + "<string>" + ], + "enim_3e5": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/commerce_payments/{commercePaymentId}: + get: + tags: + - Commerce Payments API > Basic + summary: Read + description: >- + Read a payment identified by its ID. Include an optional `properties` + query parameter to control the properties that are returned. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested payment, they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested payment, they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested payment, they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested payment, they will be ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type. + example: <string> + - name: commercePaymentId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + commodo_2: <string> + updatedAt: <dateTime> + associations: + esse8: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + eiusmod_3: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + dolor_fe: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + Ut_c21: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + sed82: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "dolor_f": [ + "<string>", + "<string>" + ], + "minimf": [ + "<string>", + "<string>" + ], + "ullamco25e": [ + "<string>", + "<string>" + ] + }, + "links": { + "laboris_7": "<string>", + "Lorem_378": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "irureff9": [ + "<string>", + "<string>" + ], + "quis3cf": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "non86": [ + "<string>", + "<string>" + ], + "enim_3e5": [ + "<string>", + "<string>" + ] + } + } + ] + } + delete: + tags: + - Commerce Payments API > Basic + summary: Archive + description: Move an Object identified by `{commercePaymentId}` to the recycling bin. + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: commercePaymentId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "dolor_f": [ + "<string>", + "<string>" + ], + "minimf": [ + "<string>", + "<string>" + ], + "ullamco25e": [ + "<string>", + "<string>" + ] + }, + "links": { + "laboris_7": "<string>", + "Lorem_378": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "irureff9": [ + "<string>", + "<string>" + ], + "quis3cf": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "non86": [ + "<string>", + "<string>" + ], + "enim_3e5": [ + "<string>", + "<string>" + ] + } + } + ] + } + patch: + tags: + - Commerce Payments API > Basic + summary: Update + description: >- + Perform a partial update of an Object identified by + `{commercePaymentId}`. `{commercePaymentId}` refers to the internal + object ID by default, or optionally any unique property value as + specified by the `idProperty` query param. Provided property values will + be overwritten. Read-only and non-existent properties will be ignored. + Properties values can be cleared by passing an empty string. + requestBody: + content: + application/json: + schema: + type: object + example: + properties: + occaecat_c: <string> + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: commercePaymentId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + sed_6: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + et0a4: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "dolor_f": [ + "<string>", + "<string>" + ], + "minimf": [ + "<string>", + "<string>" + ], + "ullamco25e": [ + "<string>", + "<string>" + ] + }, + "links": { + "laboris_7": "<string>", + "Lorem_378": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "irureff9": [ + "<string>", + "<string>" + ], + "quis3cf": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "non86": [ + "<string>", + "<string>" + ], + "enim_3e5": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/commerce_payments: + get: + tags: + - Commerce Payments API > Basic + summary: List + description: >- + Read a page of commerce payments. Control what is returned via the + `properties` query param. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: limit + in: query + schema: + type: integer + description: The maximum number of results to display per page. + example: '10' + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + id_2: <string> + updatedAt: <dateTime> + associations: + Duis_f: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + veniam_f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + amet_3b4: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + in586: <string> + id_dbd: <string> + updatedAt: <dateTime> + associations: + reprehenderit_e4: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + irure_c2: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + ipsum_8: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + dolor_3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "dolor_f": [ + "<string>", + "<string>" + ], + "minimf": [ + "<string>", + "<string>" + ], + "ullamco25e": [ + "<string>", + "<string>" + ] + }, + "links": { + "laboris_7": "<string>", + "Lorem_378": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "irureff9": [ + "<string>", + "<string>" + ], + "quis3cf": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "non86": [ + "<string>", + "<string>" + ], + "enim_3e5": [ + "<string>", + "<string>" + ] + } + } + ] + } + post: + tags: + - Commerce Payments API > Basic + summary: Create + description: >- + Create a commerce payment with the given properties and return a copy of + the object, including the ID. Documentation and examples for creating + standard commerce payments is provided. + requestBody: + content: + application/json: + schema: + type: object + example: + associations: + - to: + id: <string> + types: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + properties: + et_66: <string> + Ut98a: <string> + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + sed_6: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + et0a4: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "dolor_f": [ + "<string>", + "<string>" + ], + "minimf": [ + "<string>", + "<string>" + ], + "ullamco25e": [ + "<string>", + "<string>" + ] + }, + "links": { + "laboris_7": "<string>", + "Lorem_378": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "irureff9": [ + "<string>", + "<string>" + ], + "quis3cf": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "non86": [ + "<string>", + "<string>" + ], + "enim_3e5": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/commerce_payments/search: + post: + tags: + - Commerce Payments API > Search + summary: post-/crm/v3/objects/commerce payments/search + requestBody: + content: + application/json: + schema: + type: object + example: + after: <string> + filterGroups: + - filters: + - operator: BETWEEN + propertyName: <string> + highValue: <string> + values: + - <string> + - <string> + value: <string> + - operator: EQ + propertyName: <string> + highValue: <string> + values: + - <string> + - <string> + value: <string> + - filters: + - operator: NOT_CONTAINS_TOKEN + propertyName: <string> + highValue: <string> + values: + - <string> + - <string> + value: <string> + - operator: NOT_HAS_PROPERTY + propertyName: <string> + highValue: <string> + values: + - <string> + - <string> + value: <string> + limit: <integer> + properties: + - <string> + - <string> + sorts: + - <string> + - <string> + query: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + id5: <string> + ad96: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + commodo_e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + eiusmod3: <string> + consequat9: <string> + reprehenderit223: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + dolore62d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + dof_: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + nisi1: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "dolor_f": [ + "<string>", + "<string>" + ], + "minimf": [ + "<string>", + "<string>" + ], + "ullamco25e": [ + "<string>", + "<string>" + ] + }, + "links": { + "laboris_7": "<string>", + "Lorem_378": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "irureff9": [ + "<string>", + "<string>" + ], + "quis3cf": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "non86": [ + "<string>", + "<string>" + ], + "enim_3e5": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/subscriptions/batch/read: + post: + tags: + - Commerce Subscriptions API > Batch + summary: Read a batch of subscriptions by internal ID, or unique property values + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + properties: + - <string> + - <string> + propertiesWithHistory: + - <string> + - <string> + idProperty: <string> + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + Lorem__a: <string> + non_a7: <string> + sint_9: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + sunte: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + ex_d: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + laboris_b5: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + startedAt: <dateTime> + status: CANCELED + requestedAt: <dateTime> + links: + nulla_0: <string> + exercitation1: <string> + magna_c1: <string> + ullamco_8: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + non81: <string> + aliquipc: <string> + dolor6: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + quis_e6: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + sintcc0: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + ipsum_24: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + aliquipff_: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + velit_c: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + nisib32: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + startedAt: <dateTime> + status: CANCELED + numErrors: <integer> + requestedAt: <dateTime> + links: + tempore5: <string> + culpa_6: <string> + quis894: <string> + minim_0: <string> + errors: + - category: <string> + context: + in_d0e: + - <string> + - <string> + dolor_b8: + - <string> + - <string> + aliquad5: + - <string> + - <string> + nulla_c: + - <string> + - <string> + eu25f: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + eiusmod_2_: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + ullamcoa: + - <string> + - <string> + aliquadb_: + - <string> + - <string> + links: + commodo_9e: <string> + inf: <string> + cupidatat_19: <string> + in6_: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + - category: <string> + context: + in_7: + - <string> + - <string> + doloreef: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + exaf: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + consequat_112: + - <string> + - <string> + links: + do2: <string> + velit_7c: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "essee": [ + "<string>", + "<string>" + ] + }, + "links": { + "sunt_70": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "laboris_": [ + "<string>", + "<string>" + ], + "minim93d": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "irure98": [ + "<string>", + "<string>" + ], + "quis__f": [ + "<string>", + "<string>" + ], + "eae0": [ + "<string>", + "<string>" + ], + "nostrud_86": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/subscriptions/{subscriptionId}: + get: + tags: + - Commerce Subscriptions API > Basic + summary: Read + description: >- + Read an Object identified by `{subscriptionId}`. `{subscriptionId}` + refers to the internal object ID by default, or optionally any unique + property value as specified by the `idProperty` query param. Control + what is returned via the `properties` query param. + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: subscriptionId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + labore_77: <string> + updatedAt: <dateTime> + associations: + ad42: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + Ut72: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "essee": [ + "<string>", + "<string>" + ] + }, + "links": { + "sunt_70": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "laboris_": [ + "<string>", + "<string>" + ], + "minim93d": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "irure98": [ + "<string>", + "<string>" + ], + "quis__f": [ + "<string>", + "<string>" + ], + "eae0": [ + "<string>", + "<string>" + ], + "nostrud_86": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/subscriptions: + get: + tags: + - Commerce Subscriptions API > Basic + summary: List + description: >- + Read a page of subscriptions. Control what is returned via the + `properties` query param. + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: limit + in: query + schema: + type: integer + description: The maximum number of results to display per page. + example: '10' + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + consectetur30: <string> + updatedAt: <dateTime> + associations: + consequat_88b: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + nostrude07: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + cupidatat_9_: <string> + ex_2b0: <string> + Duis_338: <string> + ea_da: <string> + aute__52: <string> + updatedAt: <dateTime> + associations: + voluptatedf: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + ullamco_e17: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "essee": [ + "<string>", + "<string>" + ] + }, + "links": { + "sunt_70": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "laboris_": [ + "<string>", + "<string>" + ], + "minim93d": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "irure98": [ + "<string>", + "<string>" + ], + "quis__f": [ + "<string>", + "<string>" + ], + "eae0": [ + "<string>", + "<string>" + ], + "nostrud_86": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/subscriptions/search: + post: + tags: + - Commerce Subscriptions API > Search + summary: post-/crm/v3/objects/subscriptions/search + requestBody: + content: + application/json: + schema: + type: object + example: + after: <string> + filterGroups: + - filters: + - operator: LTE + propertyName: <string> + highValue: <string> + values: + - <string> + - <string> + value: <string> + - operator: LT + propertyName: <string> + highValue: <string> + values: + - <string> + - <string> + value: <string> + - filters: + - operator: GT + propertyName: <string> + highValue: <string> + values: + - <string> + - <string> + value: <string> + - operator: NEQ + propertyName: <string> + highValue: <string> + values: + - <string> + - <string> + value: <string> + limit: <integer> + properties: + - <string> + - <string> + sorts: + - <string> + - <string> + query: <string> + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + esse_: <string> + magna9d6: <string> + est_d: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + officia_e97: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + commodo_8df: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + dolor_51a: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + in_4e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + Excepteur_62: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "essee": [ + "<string>", + "<string>" + ] + }, + "links": { + "sunt_70": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "laboris_": [ + "<string>", + "<string>" + ], + "minim93d": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "irure98": [ + "<string>", + "<string>" + ], + "quis__f": [ + "<string>", + "<string>" + ], + "eae0": [ + "<string>", + "<string>" + ], + "nostrud_86": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/companies/batch/read: + post: + tags: + - Companies API > Batch + summary: Read a batch of companies by internal ID, or unique property values + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + properties: + - <string> + - <string> + propertiesWithHistory: + - <string> + - <string> + idProperty: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + enim676: <string> + updatedAt: <dateTime> + propertiesWithHistory: + incididunt0: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + adipisicing_c2d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + commodo3f8: <string> + ea4: <string> + updatedAt: <dateTime> + propertiesWithHistory: + ea_db: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PROCESSING + requestedAt: <dateTime> + links: + nonfe8: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + esse4_: <string> + anim_2: <string> + ea997: <string> + Excepteur6d: <string> + updatedAt: <dateTime> + propertiesWithHistory: + Excepteur_9: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + occaecat_70: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + culpa_e7: <string> + sunt14d: <string> + updatedAt: <dateTime> + propertiesWithHistory: + occaecat_d1: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + est3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + qui10e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PENDING + numErrors: <integer> + errors: + - category: <string> + context: + consectetur_f: + - <string> + - <string> + Excepteur34: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + ipsuma7: + - <string> + - <string> + velit_75: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + mollit_5cf: + - <string> + - <string> + links: + id_248: <string> + Duise: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + pariatur_3: + - <string> + - <string> + Ut_2da: + - <string> + - <string> + dolora: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + voluptate70: + - <string> + - <string> + eu_2da: + - <string> + - <string> + laboris90: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + proident812: + - <string> + - <string> + ut_: + - <string> + - <string> + links: + enim6: <string> + ullamco8: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + dolor_c_d: <string> + officia7: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_a": [ + "<string>", + "<string>" + ], + "Ut_2": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "aliquip_1": [ + "<string>", + "<string>" + ], + "eu__e": [ + "<string>", + "<string>" + ], + "fugiat46": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "occaecatb11": [ + "<string>", + "<string>" + ] + }, + "links": { + "aliqua_297": "<string>" + } + } + /crm/v3/objects/companies/batch/create: + post: + tags: + - Companies API > Batch + summary: Create a batch of companies + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - associations: + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + properties: + cillumd41: <string> + nulla_d6: <string> + adipisicing_cef: <string> + ullamco634: <string> + - associations: + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + properties: + et_67d: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + enim676: <string> + updatedAt: <dateTime> + propertiesWithHistory: + incididunt0: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + adipisicing_c2d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + commodo3f8: <string> + ea4: <string> + updatedAt: <dateTime> + propertiesWithHistory: + ea_db: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PROCESSING + requestedAt: <dateTime> + links: + nonfe8: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + esse4_: <string> + anim_2: <string> + ea997: <string> + Excepteur6d: <string> + updatedAt: <dateTime> + propertiesWithHistory: + Excepteur_9: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + occaecat_70: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + culpa_e7: <string> + sunt14d: <string> + updatedAt: <dateTime> + propertiesWithHistory: + occaecat_d1: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + est3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + qui10e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PENDING + numErrors: <integer> + errors: + - category: <string> + context: + consectetur_f: + - <string> + - <string> + Excepteur34: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + ipsuma7: + - <string> + - <string> + velit_75: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + mollit_5cf: + - <string> + - <string> + links: + id_248: <string> + Duise: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + pariatur_3: + - <string> + - <string> + Ut_2da: + - <string> + - <string> + dolora: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + voluptate70: + - <string> + - <string> + eu_2da: + - <string> + - <string> + laboris90: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + proident812: + - <string> + - <string> + ut_: + - <string> + - <string> + links: + enim6: <string> + ullamco8: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + dolor_c_d: <string> + officia7: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_a": [ + "<string>", + "<string>" + ], + "Ut_2": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "aliquip_1": [ + "<string>", + "<string>" + ], + "eu__e": [ + "<string>", + "<string>" + ], + "fugiat46": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "occaecatb11": [ + "<string>", + "<string>" + ] + }, + "links": { + "aliqua_297": "<string>" + } + } + /crm/v3/objects/companies/batch/update: + post: + tags: + - Companies API > Batch + summary: Update a batch of companies by internal ID, or unique property values + requestBody: + content: {} + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + enim676: <string> + updatedAt: <dateTime> + propertiesWithHistory: + incididunt0: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + adipisicing_c2d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + commodo3f8: <string> + ea4: <string> + updatedAt: <dateTime> + propertiesWithHistory: + ea_db: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PROCESSING + requestedAt: <dateTime> + links: + nonfe8: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + esse4_: <string> + anim_2: <string> + ea997: <string> + Excepteur6d: <string> + updatedAt: <dateTime> + propertiesWithHistory: + Excepteur_9: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + occaecat_70: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + culpa_e7: <string> + sunt14d: <string> + updatedAt: <dateTime> + propertiesWithHistory: + occaecat_d1: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + est3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + qui10e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PENDING + numErrors: <integer> + errors: + - category: <string> + context: + consectetur_f: + - <string> + - <string> + Excepteur34: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + ipsuma7: + - <string> + - <string> + velit_75: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + mollit_5cf: + - <string> + - <string> + links: + id_248: <string> + Duise: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + pariatur_3: + - <string> + - <string> + Ut_2da: + - <string> + - <string> + dolora: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + voluptate70: + - <string> + - <string> + eu_2da: + - <string> + - <string> + laboris90: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + proident812: + - <string> + - <string> + ut_: + - <string> + - <string> + links: + enim6: <string> + ullamco8: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + dolor_c_d: <string> + officia7: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_a": [ + "<string>", + "<string>" + ], + "Ut_2": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "aliquip_1": [ + "<string>", + "<string>" + ], + "eu__e": [ + "<string>", + "<string>" + ], + "fugiat46": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "occaecatb11": [ + "<string>", + "<string>" + ] + }, + "links": { + "aliqua_297": "<string>" + } + } + /crm/v3/objects/companies/batch/archive: + post: + tags: + - Companies API > Batch + summary: Archive a batch of companies by ID + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_a": [ + "<string>", + "<string>" + ], + "Ut_2": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "aliquip_1": [ + "<string>", + "<string>" + ], + "eu__e": [ + "<string>", + "<string>" + ], + "fugiat46": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "occaecatb11": [ + "<string>", + "<string>" + ] + }, + "links": { + "aliqua_297": "<string>" + } + } + /crm/v3/objects/companies: + get: + tags: + - Companies API > Basic + summary: List + description: >- + Read a page of companies. Control what is returned via the `properties` + query param. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: limit + in: query + schema: + type: integer + description: The maximum number of results to display per page. + example: '10' + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + nostrud_c: <string> + updatedAt: <dateTime> + propertiesWithHistory: + exercitation__c: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + dolore_59: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + laboris7: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + - createdAt: <dateTime> + id: <string> + properties: + aliquip97: <string> + velitd: <string> + updatedAt: <dateTime> + propertiesWithHistory: + ex_c: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + ipsum0af: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_a": [ + "<string>", + "<string>" + ], + "Ut_2": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "aliquip_1": [ + "<string>", + "<string>" + ], + "eu__e": [ + "<string>", + "<string>" + ], + "fugiat46": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "occaecatb11": [ + "<string>", + "<string>" + ] + }, + "links": { + "aliqua_297": "<string>" + } + } + post: + tags: + - Companies API > Basic + summary: Create + description: >- + Create a company with the given properties and return a copy of the + object, including the ID. Documentation and examples for creating + standard companies is provided. + requestBody: + content: + application/json: + schema: + type: object + example: + associations: + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + properties: + in_c: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + nostrud17e: <string> + occaecat_7: <string> + updatedAt: <dateTime> + propertiesWithHistory: + sint8: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_a": [ + "<string>", + "<string>" + ], + "Ut_2": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "aliquip_1": [ + "<string>", + "<string>" + ], + "eu__e": [ + "<string>", + "<string>" + ], + "fugiat46": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "occaecatb11": [ + "<string>", + "<string>" + ] + }, + "links": { + "aliqua_297": "<string>" + } + } + /crm/v3/objects/companies/{companyId}: + get: + tags: + - Companies API > Basic + summary: Read + description: >- + Read an Object identified by `{companyId}`. `{companyId}` refers to the + internal object ID by default, or optionally any unique property value + as specified by the `idProperty` query param. Control what is returned + via the `properties` query param. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: companyId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + qui6d: <string> + fugiat_87: <string> + Duis339: <string> + commodo_ab3: <string> + nisi_7: <string> + updatedAt: <dateTime> + propertiesWithHistory: + nostrud5d_: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + ex_a6: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_a": [ + "<string>", + "<string>" + ], + "Ut_2": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "aliquip_1": [ + "<string>", + "<string>" + ], + "eu__e": [ + "<string>", + "<string>" + ], + "fugiat46": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "occaecatb11": [ + "<string>", + "<string>" + ] + }, + "links": { + "aliqua_297": "<string>" + } + } + delete: + tags: + - Companies API > Basic + summary: Archive + description: Move an Object identified by `{companyId}` to the recycling bin. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: companyId + in: path + schema: + type: string + required: true + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_a": [ + "<string>", + "<string>" + ], + "Ut_2": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "aliquip_1": [ + "<string>", + "<string>" + ], + "eu__e": [ + "<string>", + "<string>" + ], + "fugiat46": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "occaecatb11": [ + "<string>", + "<string>" + ] + }, + "links": { + "aliqua_297": "<string>" + } + } + patch: + tags: + - Companies API > Basic + summary: Update + description: >- + Perform a partial update of an Object identified by `{companyId}`. + `{companyId}` refers to the internal object ID by default, or optionally + any unique property value as specified by the `idProperty` query param. + Provided property values will be overwritten. Read-only and non-existent + properties will be ignored. Properties values can be cleared by passing + an empty string. + requestBody: + content: + application/json: + schema: + type: object + example: + properties: + reprehenderitd7: <string> + consequat_369: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: companyId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + nostrud17e: <string> + occaecat_7: <string> + updatedAt: <dateTime> + propertiesWithHistory: + sint8: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_a": [ + "<string>", + "<string>" + ], + "Ut_2": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "aliquip_1": [ + "<string>", + "<string>" + ], + "eu__e": [ + "<string>", + "<string>" + ], + "fugiat46": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "occaecatb11": [ + "<string>", + "<string>" + ] + }, + "links": { + "aliqua_297": "<string>" + } + } + /crm/v3/objects/companies/search: + post: + tags: + - Companies API > Search + summary: post-/crm/v3/objects/companies/search do Search + requestBody: + content: {} + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + qui_fed: <string> + updatedAt: <dateTime> + propertiesWithHistory: + dolor_99: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + nisi_24b: <string> + fugiat_b: <string> + nostrud8: <string> + updatedAt: <dateTime> + propertiesWithHistory: + laboris82e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + anim778: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ullamco_a": [ + "<string>", + "<string>" + ], + "Ut_2": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "aliquip_1": [ + "<string>", + "<string>" + ], + "eu__e": [ + "<string>", + "<string>" + ], + "fugiat46": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "occaecatb11": [ + "<string>", + "<string>" + ] + }, + "links": { + "aliqua_297": "<string>" + } + } + /crm/v3/objects/contacts/batch/archive: + post: + tags: + - Contacts API > Batch + summary: Archive a batch of contacts by ID + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "commodo_9": [ + "<string>", + "<string>" + ], + "mollit_f1": [ + "<string>", + "<string>" + ], + "Lorem_d": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "Ut_88_": [ + "<string>", + "<string>" + ], + "nisi__b": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "non_1e": [ + "<string>", + "<string>" + ], + "culpa_8": [ + "<string>", + "<string>" + ], + "ut_d4": [ + "<string>", + "<string>" + ] + }, + "links": { + "pariatur9": "<string>", + "in_a03": "<string>" + } + } + /crm/v3/objects/contacts/batch/update: + post: + tags: + - Contacts API > Batch + summary: Update a batch of contacts by internal ID, or unique property values + requestBody: + content: {} + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + proidentc1: <string> + dolore81: <string> + updatedAt: <dateTime> + propertiesWithHistory: + non0: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + adipisicing2e: <string> + updatedAt: <dateTime> + propertiesWithHistory: + do5_3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: COMPLETE + requestedAt: <dateTime> + links: + incididunt_dd1: <string> + qui_9: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + sunt8c: <string> + nisi52d: <string> + updatedAt: <dateTime> + propertiesWithHistory: + reprehenderit_3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + ullamco_f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + et_e: <string> + cupidatat_c6: <string> + updatedAt: <dateTime> + propertiesWithHistory: + irurec8: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: CANCELED + numErrors: <integer> + errors: + - category: <string> + context: + nulla2: + - <string> + - <string> + velit_3: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + est_3f: + - <string> + - <string> + id8ab: + - <string> + - <string> + dof3: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + ute4: + - <string> + - <string> + links: + ut_bd6: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + laboree90: + - <string> + - <string> + sed37: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + culpa_4b: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + Utb: + - <string> + - <string> + proidenta: + - <string> + - <string> + links: + cillum_b3: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + reprehenderit3: <string> + exercitationc: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "commodo_9": [ + "<string>", + "<string>" + ], + "mollit_f1": [ + "<string>", + "<string>" + ], + "Lorem_d": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "Ut_88_": [ + "<string>", + "<string>" + ], + "nisi__b": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "non_1e": [ + "<string>", + "<string>" + ], + "culpa_8": [ + "<string>", + "<string>" + ], + "ut_d4": [ + "<string>", + "<string>" + ] + }, + "links": { + "pariatur9": "<string>", + "in_a03": "<string>" + } + } + /crm/v3/objects/contacts/batch/create: + post: + tags: + - Contacts API > Batch + summary: Create a batch of contacts + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - associations: + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + properties: + Duis_0: <string> + commodo36: <string> + utdf: <string> + - associations: + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + properties: + ullamcof24: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + proidentc1: <string> + dolore81: <string> + updatedAt: <dateTime> + propertiesWithHistory: + non0: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + adipisicing2e: <string> + updatedAt: <dateTime> + propertiesWithHistory: + do5_3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: COMPLETE + requestedAt: <dateTime> + links: + incididunt_dd1: <string> + qui_9: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + sunt8c: <string> + nisi52d: <string> + updatedAt: <dateTime> + propertiesWithHistory: + reprehenderit_3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + ullamco_f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + et_e: <string> + cupidatat_c6: <string> + updatedAt: <dateTime> + propertiesWithHistory: + irurec8: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: CANCELED + numErrors: <integer> + errors: + - category: <string> + context: + nulla2: + - <string> + - <string> + velit_3: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + est_3f: + - <string> + - <string> + id8ab: + - <string> + - <string> + dof3: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + ute4: + - <string> + - <string> + links: + ut_bd6: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + laboree90: + - <string> + - <string> + sed37: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + culpa_4b: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + Utb: + - <string> + - <string> + proidenta: + - <string> + - <string> + links: + cillum_b3: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + reprehenderit3: <string> + exercitationc: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "commodo_9": [ + "<string>", + "<string>" + ], + "mollit_f1": [ + "<string>", + "<string>" + ], + "Lorem_d": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "Ut_88_": [ + "<string>", + "<string>" + ], + "nisi__b": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "non_1e": [ + "<string>", + "<string>" + ], + "culpa_8": [ + "<string>", + "<string>" + ], + "ut_d4": [ + "<string>", + "<string>" + ] + }, + "links": { + "pariatur9": "<string>", + "in_a03": "<string>" + } + } + /crm/v3/objects/contacts/batch/read: + post: + tags: + - Contacts API > Batch + summary: Read a batch of contacts by internal ID, or unique property values + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + properties: + - <string> + - <string> + propertiesWithHistory: + - <string> + - <string> + idProperty: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + proidentc1: <string> + dolore81: <string> + updatedAt: <dateTime> + propertiesWithHistory: + non0: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + adipisicing2e: <string> + updatedAt: <dateTime> + propertiesWithHistory: + do5_3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: COMPLETE + requestedAt: <dateTime> + links: + incididunt_dd1: <string> + qui_9: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + sunt8c: <string> + nisi52d: <string> + updatedAt: <dateTime> + propertiesWithHistory: + reprehenderit_3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + ullamco_f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + et_e: <string> + cupidatat_c6: <string> + updatedAt: <dateTime> + propertiesWithHistory: + irurec8: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: CANCELED + numErrors: <integer> + errors: + - category: <string> + context: + nulla2: + - <string> + - <string> + velit_3: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + est_3f: + - <string> + - <string> + id8ab: + - <string> + - <string> + dof3: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + ute4: + - <string> + - <string> + links: + ut_bd6: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + laboree90: + - <string> + - <string> + sed37: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + culpa_4b: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + Utb: + - <string> + - <string> + proidenta: + - <string> + - <string> + links: + cillum_b3: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + reprehenderit3: <string> + exercitationc: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "commodo_9": [ + "<string>", + "<string>" + ], + "mollit_f1": [ + "<string>", + "<string>" + ], + "Lorem_d": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "Ut_88_": [ + "<string>", + "<string>" + ], + "nisi__b": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "non_1e": [ + "<string>", + "<string>" + ], + "culpa_8": [ + "<string>", + "<string>" + ], + "ut_d4": [ + "<string>", + "<string>" + ] + }, + "links": { + "pariatur9": "<string>", + "in_a03": "<string>" + } + } + /crm/v3/objects/contacts: + get: + tags: + - Contacts API > Basic + summary: List + description: >- + Read a page of contacts. Control what is returned via the `properties` + query param. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: limit + in: query + schema: + type: integer + description: The maximum number of results to display per page. + example: '10' + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + Utc: <string> + updatedAt: <dateTime> + propertiesWithHistory: + veniam_24: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + ullamco0: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + voluptateb: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + - createdAt: <dateTime> + id: <string> + properties: + reprehenderita8e: <string> + updatedAt: <dateTime> + propertiesWithHistory: + proident_7e1: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + consequat2d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + nullaa4a: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + culpa30: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "commodo_9": [ + "<string>", + "<string>" + ], + "mollit_f1": [ + "<string>", + "<string>" + ], + "Lorem_d": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "Ut_88_": [ + "<string>", + "<string>" + ], + "nisi__b": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "non_1e": [ + "<string>", + "<string>" + ], + "culpa_8": [ + "<string>", + "<string>" + ], + "ut_d4": [ + "<string>", + "<string>" + ] + }, + "links": { + "pariatur9": "<string>", + "in_a03": "<string>" + } + } + post: + tags: + - Contacts API > Basic + summary: Create + description: >- + Create a contact with the given properties and return a copy of the + object, including the ID. Documentation and examples for creating + standard contacts is provided. + requestBody: + content: + application/json: + schema: + type: object + example: + associations: + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + properties: + ea_7b: <string> + ullamco9: <string> + velitb7: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + dolor60: <string> + occaecat_aa: <string> + updatedAt: <dateTime> + propertiesWithHistory: + sed96: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + sita5f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "commodo_9": [ + "<string>", + "<string>" + ], + "mollit_f1": [ + "<string>", + "<string>" + ], + "Lorem_d": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "Ut_88_": [ + "<string>", + "<string>" + ], + "nisi__b": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "non_1e": [ + "<string>", + "<string>" + ], + "culpa_8": [ + "<string>", + "<string>" + ], + "ut_d4": [ + "<string>", + "<string>" + ] + }, + "links": { + "pariatur9": "<string>", + "in_a03": "<string>" + } + } + /crm/v3/objects/contacts/{contactId}: + get: + tags: + - Contacts API > Basic + summary: Read + description: >- + Read an Object identified by `{contactId}`. `{contactId}` refers to the + internal object ID. Control what is returned via the `properties` query + param. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + - name: contactId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + qui_8: <string> + updatedAt: <dateTime> + propertiesWithHistory: + proident_f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + etc: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "commodo_9": [ + "<string>", + "<string>" + ], + "mollit_f1": [ + "<string>", + "<string>" + ], + "Lorem_d": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "Ut_88_": [ + "<string>", + "<string>" + ], + "nisi__b": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "non_1e": [ + "<string>", + "<string>" + ], + "culpa_8": [ + "<string>", + "<string>" + ], + "ut_d4": [ + "<string>", + "<string>" + ] + }, + "links": { + "pariatur9": "<string>", + "in_a03": "<string>" + } + } + delete: + tags: + - Contacts API > Basic + summary: Archive + description: Move an Object identified by `{contactId}` to the recycling bin. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: contactId + in: path + schema: + type: string + required: true + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "commodo_9": [ + "<string>", + "<string>" + ], + "mollit_f1": [ + "<string>", + "<string>" + ], + "Lorem_d": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "Ut_88_": [ + "<string>", + "<string>" + ], + "nisi__b": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "non_1e": [ + "<string>", + "<string>" + ], + "culpa_8": [ + "<string>", + "<string>" + ], + "ut_d4": [ + "<string>", + "<string>" + ] + }, + "links": { + "pariatur9": "<string>", + "in_a03": "<string>" + } + } + patch: + tags: + - Contacts API > Basic + summary: Update + description: >- + Perform a partial update of an Object identified by `{contactId}`. + `{contactId}` refers to the internal object ID. Provided property values + will be overwritten. Read-only and non-existent properties will be + ignored. Properties values can be cleared by passing an empty string. + requestBody: + content: + application/json: + schema: + type: object + example: + properties: + sit3f7: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: contactId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + dolor60: <string> + occaecat_aa: <string> + updatedAt: <dateTime> + propertiesWithHistory: + sed96: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + sita5f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "commodo_9": [ + "<string>", + "<string>" + ], + "mollit_f1": [ + "<string>", + "<string>" + ], + "Lorem_d": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "Ut_88_": [ + "<string>", + "<string>" + ], + "nisi__b": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "non_1e": [ + "<string>", + "<string>" + ], + "culpa_8": [ + "<string>", + "<string>" + ], + "ut_d4": [ + "<string>", + "<string>" + ] + }, + "links": { + "pariatur9": "<string>", + "in_a03": "<string>" + } + } + /crm/v3/objects/contacts/search: + post: + tags: + - Contacts API > Search + summary: post-/crm/v3/objects/contacts/search do Search + requestBody: + content: {} + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + adipisicing3a: <string> + updatedAt: <dateTime> + propertiesWithHistory: + dolor163: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + Duis_eb3: <string> + esse_4: <string> + cillum_d: <string> + updatedAt: <dateTime> + propertiesWithHistory: + laboris_7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + reprehenderit3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "commodo_9": [ + "<string>", + "<string>" + ], + "mollit_f1": [ + "<string>", + "<string>" + ], + "Lorem_d": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "Ut_88_": [ + "<string>", + "<string>" + ], + "nisi__b": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "non_1e": [ + "<string>", + "<string>" + ], + "culpa_8": [ + "<string>", + "<string>" + ], + "ut_d4": [ + "<string>", + "<string>" + ] + }, + "links": { + "pariatur9": "<string>", + "in_a03": "<string>" + } + } + /crm/v3/objects/contacts/batch/upsert: + post: + tags: + - Contacts API + summary: Create or update a batch of contacts by unique property values + description: >- + Create or update records identified by a unique property value as + specified by the `idProperty` query param. `idProperty` query param + refers to a property whose values are unique for the object. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + properties: + utb45: <string> + idProperty: <string> + objectWriteTraceId: <string> + - id: <string> + properties: + Duis2: <string> + nulla_6c_: <string> + idProperty: <string> + objectWriteTraceId: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + new: <boolean> + properties: + dolore7c: <string> + voluptate_69: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + temporc82: + - sourceType: voluptate velit fugiat enim + timestamp: '1973-04-22T10:14:50.399Z' + value: eu elit mollit dolore + sourceId: officia aute qui non ex + sourceLabel: cons + updatedByUserId: 92559225 + - sourceType: dolore occaecat reprehenderit + timestamp: '1964-09-03T09:26:32.629Z' + value: elit cillum + sourceId: aliquip sunt in + sourceLabel: eu + updatedByUserId: -19945934 + quis_6: + - sourceType: sint Ut + timestamp: '1952-07-18T17:48:57.990Z' + value: quis nostrud laboris + sourceId: ad labor + sourceLabel: sit tempor in + updatedByUserId: -15442249 + - sourceType: dolore dolor culpa + timestamp: '1978-09-19T05:01:41.518Z' + value: veniam nisi dolor do + sourceId: ea sint cu + sourceLabel: pariatur nostrud nulla + updatedByUserId: -90970341 + voluptate_4e6: + - sourceType: 'enim voluptate eu ' + timestamp: '1989-05-31T18:01:37.497Z' + value: ex in ut velit te + sourceId: tempor ut + sourceLabel: quis aute Ut + updatedByUserId: 54570308 + - sourceType: quis adipisicing nisi + timestamp: '2007-01-02T23:21:49.154Z' + value: pariat + sourceId: sit commodo e + sourceLabel: consequat eiusmod est ad + updatedByUserId: -68124366 + sunt1: + - sourceType: eiusmod dolore incidid + timestamp: '2020-05-30T10:50:58.292Z' + value: 'tempor ' + sourceId: cillum dolore ullamco id + sourceLabel: commodo labore + updatedByUserId: -54971555 + - sourceType: ex nostrud sit + timestamp: '1996-05-21T14:20:14.493Z' + value: reprehenderit dolore ut deserunt + sourceId: Excepteur dolore in aute + sourceLabel: mollit + updatedByUserId: -55154396 + adipisicing0: + - sourceType: Excepteur eu in + timestamp: '2022-12-18T15:13:42.165Z' + value: cillum consectetur + sourceId: in magna amet + sourceLabel: ad tempor sunt voluptate + updatedByUserId: 32219700 + - sourceType: culpa dolore mollit irure + timestamp: '1947-06-16T15:38:48.046Z' + value: dolore dolor ut incididunt veniam + sourceId: laborum adipisicing d + sourceLabel: irure eiusmod Duis + updatedByUserId: -94971010 + - createdAt: <dateTime> + id: <string> + new: <boolean> + properties: + commodo_12f: <string> + consectetur_8_5: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + proident_4e: + - sourceType: Lorem dolor dolor incididunt ullamco + timestamp: '2011-10-28T03:30:16.189Z' + value: ut dolor aute + sourceId: 'mollit Ut ' + sourceLabel: quis cillum cupidatat aute + updatedByUserId: -48743563 + - sourceType: aute + timestamp: '1964-12-23T06:37:31.070Z' + value: officia + sourceId: veniam dolor Excepteur + sourceLabel: est commodo + updatedByUserId: -17142723 + dolore_5f7: + - sourceType: reprehenderit Excepteur ut et + timestamp: '1989-10-27T15:22:34.628Z' + value: exercitation officia dolor + sourceId: ut consectetur minim proident culpa + sourceLabel: qui non reprehenderit c + updatedByUserId: -76130178 + - sourceType: cillum + timestamp: '1988-12-11T03:42:54.930Z' + value: incididunt a + sourceId: cillum elit dolor + sourceLabel: anim deserunt labore ut ad + updatedByUserId: -52565147 + aliquip_9ac: + - sourceType: sint quis dolor + timestamp: '1947-02-20T05:10:52.699Z' + value: ex mollit Lorem + sourceId: o + sourceLabel: id in ut ex + updatedByUserId: 43402611 + - sourceType: eu deserunt + timestamp: '2010-11-22T11:51:05.431Z' + value: laborum + sourceId: sed incididunt + sourceLabel: cupidatat pariat + updatedByUserId: 62968261 + aute_4: + - sourceType: qui + timestamp: '1995-06-30T22:20:59.888Z' + value: laborum cupidatat conseq + sourceId: ea voluptate + sourceLabel: quis minim elit dolor ea + updatedByUserId: -5111887 + - sourceType: incididunt eiusmod pariatur qui in + timestamp: '2008-03-14T04:56:20.494Z' + value: sint deserunt + sourceId: 'nisi ' + sourceLabel: Excepteur in + updatedByUserId: -25202986 + startedAt: <dateTime> + status: PENDING + requestedAt: <dateTime> + links: + consectetur4: <string> + Duis_594: <string> + dolorea35: <string> + veniam_bc8: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + new: <boolean> + properties: + sit_b8: <string> + Lorem_5a: <string> + ea65: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + sintbe0: + - sourceType: labore sint est + timestamp: '1995-09-12T23:05:12.715Z' + value: esse enim occaecat + sourceId: irure ex do aliquip enim + sourceLabel: Lorem eiusmod in + updatedByUserId: 8177646 + - sourceType: venia + timestamp: '1993-09-15T02:16:56.897Z' + value: sit officia elit aliquip + sourceId: est culpa + sourceLabel: velit amet dolore fugiat + updatedByUserId: -93416837 + - createdAt: <dateTime> + id: <string> + new: <boolean> + properties: + pariaturd3: <string> + ullamco7b: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + ested: + - sourceType: sed cillum mollit amet + timestamp: '1980-11-19T22:58:01.768Z' + value: dolor irure pariatur laborum voluptate + sourceId: enim + sourceLabel: eiusmod co + updatedByUserId: -96780797 + - sourceType: nisi qui fugiat sed ipsum + timestamp: '2011-05-23T10:03:02.137Z' + value: consequat ex sint pariatur + sourceId: dolore adipisicing nostr + sourceLabel: ut est aliqua ea + updatedByUserId: -58974871 + in__: + - sourceType: Ut et Duis officia + timestamp: '1953-10-02T15:14:20.887Z' + value: eu ex incididunt velit + sourceId: sunt + sourceLabel: cupi + updatedByUserId: -19405876 + - sourceType: proident nulla + timestamp: '2012-11-10T01:43:30.246Z' + value: do non fugiat + sourceId: laboris irure ull + sourceLabel: tempor magna ad + updatedByUserId: 9906529 + startedAt: <dateTime> + status: PROCESSING + numErrors: <integer> + requestedAt: <dateTime> + links: + id19e: <string> + errors: + - category: consectetur pariatur sit + context: + ead: + - esse officia + - velit + cupidatat_6ba: + - '' + - in ut + errors: + - message: incididunt elit ullamco + subCategory: reprehenderit mollit in cillum est + code: aliqua eiusmod + in: anim Lorem qui + context: + mollit1: + - ut elit + - sint Dui + Ut_f: + - aute Lorem consequat laboris occaecat + - qui voluptate quis dolore + - message: in cupidatat ex proident + subCategory: non sed et in + code: aliqua incididunt sed + in: dolor s + context: + tempor_61: + - occaecat tempor ea sed Excepteur + - sunt adipisicing labore + reprehenderit_ecc: + - enim Lorem dolore + - do aliquip nisi dolore + links: + quis_6: dolor aute + reprehenderit_d: veniam + eaf9: labori + ea_18: ad magna ut + message: nulla culpa fugiat + status: consectetur elit sed + subCategory: {} + id: nulla pariatur dolore in + - category: aute dolor Duis ea irure + context: + eu6: + - velit non enim + - commodo et sint ad + errors: + - message: nulla + subCategory: Duis id proident anim + code: commodo consectetur enim + in: veniam deserunt nulla magna commodo + context: + occaecat_5be: + - consequat Excepteur + - officia fugiat velit labore + - message: esse + subCategory: eu cillum ut + code: laboris Ut cupid + in: deserunt in non qui + context: + adipisicing_4: + - reprehenderit + - de + id_2: + - ut eu consequat + - enim dolor incididunt fugiat + links: + elitb2: nisi + message: occaecat mollit amet sunt voluptate + status: et labore exercitation in + subCategory: {} + id: Ut esse + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "dolor_5": [ + "<string>", + "<string>" + ], + "aute_d1_": [ + "<string>", + "<string>" + ] + }, + "links": { + "nulla_031": "<string>" + }, + "errors": [ + { + "message": "enim quis sed", + "subCategory": "qui incididun", + "code": "in Lorem aliqua", + "in": "sunt minim cillum velit dolore", + "context": { + "Excepteur_4": [ + "proident nostrud", + "est adipisicing aute" + ], + "deserunt_ff": [ + "Duis", + "magna et Ut ut" + ] + } + }, + { + "message": "eu dolore", + "subCategory": "deserunt veniam mollit magna", + "code": "do", + "in": "dolore Ut cillum magna sunt", + "context": { + "voluptate_1": [ + "Ut dolor ea eu", + "sit dolore elit nisi sint" + ], + "pariatur__": [ + "do Excepteur", + "dolore cupidatat" + ], + "mollit611": [ + "dolore pariatur", + "anim et f" + ] + } + } + ] + } + /crm/v3/extensions/cards-dev/{appId}: + get: + tags: + - CRM Cards API > Cards + summary: Get all cards + description: Returns a list of cards for a given app. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: appId + in: path + schema: + type: string + required: true + example: <integer> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - actions: + baseUrls: + - <string> + - <string> + auditHistory: + - actionType: DELETE + applicationId: <integer> + authSource: EXTERNAL + changedAt: <long> + initiatingUserId: <integer> + objectTypeId: <integer> + - actionType: DELETE + applicationId: <integer> + authSource: EXTERNAL + changedAt: <long> + initiatingUserId: <integer> + objectTypeId: <integer> + display: + properties: + - dataType: BOOLEAN + label: <string> + name: <string> + options: + - label: <string> + name: <string> + type: INFO + - label: <string> + name: <string> + type: SUCCESS + - dataType: BOOLEAN + label: <string> + name: <string> + options: + - label: <string> + name: <string> + type: INFO + - label: <string> + name: <string> + type: DANGER + fetch: + objectTypes: + - name: marketing_events + propertiesToSend: + - <string> + - <string> + - name: marketing_events + propertiesToSend: + - <string> + - <string> + targetUrl: <string> + id: <string> + title: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + - actions: + baseUrls: + - <string> + - <string> + auditHistory: + - actionType: DELETE + applicationId: <integer> + authSource: APP + changedAt: <long> + initiatingUserId: <integer> + objectTypeId: <integer> + - actionType: UPDATE + applicationId: <integer> + authSource: APP + changedAt: <long> + initiatingUserId: <integer> + objectTypeId: <integer> + display: + properties: + - dataType: BOOLEAN + label: <string> + name: <string> + options: + - label: <string> + name: <string> + type: SUCCESS + - label: <string> + name: <string> + type: WARNING + - dataType: BOOLEAN + label: <string> + name: <string> + options: + - label: <string> + name: <string> + type: DEFAULT + - label: <string> + name: <string> + type: WARNING + fetch: + objectTypes: + - name: companies + propertiesToSend: + - <string> + - <string> + - name: contacts + propertiesToSend: + - <string> + - <string> + targetUrl: <string> + id: <string> + title: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex__3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "enim1c": [ + "<string>", + "<string>" + ], + "in_6": [ + "<string>", + "<string>" + ], + "elit_9": [ + "<string>", + "<string>" + ], + "consequate": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "enim_6f": [ + "<string>", + "<string>" + ], + "eiusmod7": [ + "<string>", + "<string>" + ] + }, + "links": { + "in_6d": "<string>", + "ut8e5": "<string>", + "aliqua0c": "<string>" + } + } + post: + tags: + - CRM Cards API > Cards + summary: Create a new card + description: >- + Defines a new card that will become active on an account when this app + is installed. + requestBody: + content: + application/json: + schema: + type: object + example: + actions: + baseUrls: + - <string> + - <string> + display: + properties: + - dataType: CURRENCY + label: <string> + name: <string> + options: + - label: <string> + name: <string> + type: WARNING + - label: <string> + name: <string> + type: DEFAULT + - dataType: EMAIL + label: <string> + name: <string> + options: + - label: <string> + name: <string> + type: INFO + - label: <string> + name: <string> + type: WARNING + fetch: + objectTypes: + - name: companies + propertiesToSend: + - <string> + - <string> + - name: deals + propertiesToSend: + - <string> + - <string> + targetUrl: <string> + cardType: EXTERNAL + serverlessFunction: <string> + title: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: appId + in: path + schema: + type: string + required: true + example: <integer> + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + actions: + baseUrls: + - <string> + - <string> + auditHistory: + - actionType: UPDATE + applicationId: <integer> + authSource: EXTERNAL + changedAt: <long> + initiatingUserId: <integer> + objectTypeId: <integer> + - actionType: DELETE + applicationId: <integer> + authSource: INTERNAL + changedAt: <long> + initiatingUserId: <integer> + objectTypeId: <integer> + display: + properties: + - dataType: LINK + label: <string> + name: <string> + options: + - label: <string> + name: <string> + type: DANGER + - label: <string> + name: <string> + type: INFO + - dataType: DATETIME + label: <string> + name: <string> + options: + - label: <string> + name: <string> + type: DEFAULT + - label: <string> + name: <string> + type: SUCCESS + fetch: + objectTypes: + - name: marketing_events + propertiesToSend: + - <string> + - <string> + - name: marketing_events + propertiesToSend: + - <string> + - <string> + targetUrl: <string> + id: <string> + title: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex__3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "enim1c": [ + "<string>", + "<string>" + ], + "in_6": [ + "<string>", + "<string>" + ], + "elit_9": [ + "<string>", + "<string>" + ], + "consequate": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "enim_6f": [ + "<string>", + "<string>" + ], + "eiusmod7": [ + "<string>", + "<string>" + ] + }, + "links": { + "in_6d": "<string>", + "ut8e5": "<string>", + "aliqua0c": "<string>" + } + } + /crm/v3/extensions/cards-dev/{appId}/{cardId}: + get: + tags: + - CRM Cards API > Cards + summary: Get a card. + description: Returns the definition for a card with the given ID. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: appId + in: path + schema: + type: string + required: true + example: <integer> + - name: cardId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + actions: + baseUrls: + - <string> + - <string> + auditHistory: + - actionType: UPDATE + applicationId: <integer> + authSource: EXTERNAL + changedAt: <long> + initiatingUserId: <integer> + objectTypeId: <integer> + - actionType: DELETE + applicationId: <integer> + authSource: INTERNAL + changedAt: <long> + initiatingUserId: <integer> + objectTypeId: <integer> + display: + properties: + - dataType: LINK + label: <string> + name: <string> + options: + - label: <string> + name: <string> + type: DANGER + - label: <string> + name: <string> + type: INFO + - dataType: DATETIME + label: <string> + name: <string> + options: + - label: <string> + name: <string> + type: DEFAULT + - label: <string> + name: <string> + type: SUCCESS + fetch: + objectTypes: + - name: marketing_events + propertiesToSend: + - <string> + - <string> + - name: marketing_events + propertiesToSend: + - <string> + - <string> + targetUrl: <string> + id: <string> + title: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex__3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "enim1c": [ + "<string>", + "<string>" + ], + "in_6": [ + "<string>", + "<string>" + ], + "elit_9": [ + "<string>", + "<string>" + ], + "consequate": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "enim_6f": [ + "<string>", + "<string>" + ], + "eiusmod7": [ + "<string>", + "<string>" + ] + }, + "links": { + "in_6d": "<string>", + "ut8e5": "<string>", + "aliqua0c": "<string>" + } + } + delete: + tags: + - CRM Cards API > Cards + summary: Delete a card + description: >- + Permanently deletes a card definition with the given ID. Once deleted, + data fetch requests for this card will no longer be sent to your + service. This can't be undone. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: appId + in: path + schema: + type: string + required: true + example: <integer> + - name: cardId + in: path + schema: + type: string + required: true + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex__3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "enim1c": [ + "<string>", + "<string>" + ], + "in_6": [ + "<string>", + "<string>" + ], + "elit_9": [ + "<string>", + "<string>" + ], + "consequate": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "enim_6f": [ + "<string>", + "<string>" + ], + "eiusmod7": [ + "<string>", + "<string>" + ] + }, + "links": { + "in_6d": "<string>", + "ut8e5": "<string>", + "aliqua0c": "<string>" + } + } + patch: + tags: + - CRM Cards API > Cards + summary: Update a card + description: Update a card definition with new details. + requestBody: + content: + application/json: + schema: + type: object + example: + title: <string> + fetch: + objectTypes: + - name: companies + propertiesToSend: + - <string> + - <string> + - name: tickets + propertiesToSend: + - <string> + - <string> + cardType: EXTERNAL + targetUrl: <string> + serverlessFunction: <string> + display: + properties: + - dataType: EMAIL + label: <string> + name: <string> + options: + - label: <string> + name: <string> + type: SUCCESS + - label: <string> + name: <string> + type: DANGER + - dataType: STRING + label: <string> + name: <string> + options: + - label: <string> + name: <string> + type: INFO + - label: <string> + name: <string> + type: DEFAULT + actions: + baseUrls: + - <string> + - <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: appId + in: path + schema: + type: string + required: true + example: <integer> + - name: cardId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + actions: + baseUrls: + - <string> + - <string> + auditHistory: + - actionType: UPDATE + applicationId: <integer> + authSource: EXTERNAL + changedAt: <long> + initiatingUserId: <integer> + objectTypeId: <integer> + - actionType: DELETE + applicationId: <integer> + authSource: INTERNAL + changedAt: <long> + initiatingUserId: <integer> + objectTypeId: <integer> + display: + properties: + - dataType: LINK + label: <string> + name: <string> + options: + - label: <string> + name: <string> + type: DANGER + - label: <string> + name: <string> + type: INFO + - dataType: DATETIME + label: <string> + name: <string> + options: + - label: <string> + name: <string> + type: DEFAULT + - label: <string> + name: <string> + type: SUCCESS + fetch: + objectTypes: + - name: marketing_events + propertiesToSend: + - <string> + - <string> + - name: marketing_events + propertiesToSend: + - <string> + - <string> + targetUrl: <string> + id: <string> + title: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex__3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "enim1c": [ + "<string>", + "<string>" + ], + "in_6": [ + "<string>", + "<string>" + ], + "elit_9": [ + "<string>", + "<string>" + ], + "consequate": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "enim_6f": [ + "<string>", + "<string>" + ], + "eiusmod7": [ + "<string>", + "<string>" + ] + }, + "links": { + "in_6d": "<string>", + "ut8e5": "<string>", + "aliqua0c": "<string>" + } + } + /crm/v3/extensions/cards-dev/sample-response: + get: + tags: + - CRM Cards API > SampleResponse + summary: Get sample card detail response + description: >- + Returns an example card detail response. This is the payload with + displayed details for a card that will be shown to a user. An app should + send this in response to the data fetch request. + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + totalCount: <integer> + allItemsLinkUrl: <string> + cardLabel: <string> + topLevelActions: + secondary: + - httpMethod: CONNECT + propertyNamesIncluded: + - <string> + - <string> + type: ACTION_HOOK + url: <string> + confirmation: + cancelButtonLabel: <string> + confirmButtonLabel: <string> + prompt: <string> + label: <string> + - httpMethod: POST + propertyNamesIncluded: + - <string> + - <string> + type: ACTION_HOOK + url: <string> + confirmation: + cancelButtonLabel: <string> + confirmButtonLabel: <string> + prompt: <string> + label: <string> + settings: + height: <integer> + propertyNamesIncluded: + - <string> + - <string> + type: IFRAME + url: <string> + width: <integer> + label: <string> + primary: + httpMethod: POST + propertyNamesIncluded: + - <string> + - <string> + type: ACTION_HOOK + url: <string> + confirmation: + cancelButtonLabel: <string> + confirmButtonLabel: <string> + prompt: <string> + label: <string> + sections: + - actions: + - httpMethod: HEAD + propertyNamesIncluded: + - <string> + - <string> + type: ACTION_HOOK + url: <string> + confirmation: + cancelButtonLabel: <string> + confirmButtonLabel: <string> + prompt: <string> + label: <string> + - httpMethod: PATCH + propertyNamesIncluded: + - <string> + - <string> + type: ACTION_HOOK + url: <string> + confirmation: + cancelButtonLabel: <string> + confirmButtonLabel: <string> + prompt: <string> + label: <string> + id: <string> + title: <string> + tokens: + - value: <string> + name: <string> + label: <string> + dataType: EMAIL + - value: <string> + name: <string> + label: <string> + dataType: CURRENCY + linkUrl: <string> + - actions: + - httpMethod: GET + propertyNamesIncluded: + - <string> + - <string> + type: ACTION_HOOK + url: <string> + confirmation: + cancelButtonLabel: <string> + confirmButtonLabel: <string> + prompt: <string> + label: <string> + - httpMethod: PATCH + propertyNamesIncluded: + - <string> + - <string> + type: ACTION_HOOK + url: <string> + confirmation: + cancelButtonLabel: <string> + confirmButtonLabel: <string> + prompt: <string> + label: <string> + id: <string> + title: <string> + tokens: + - value: <string> + name: <string> + label: <string> + dataType: DATE + - value: <string> + name: <string> + label: <string> + dataType: DATETIME + linkUrl: <string> + responseVersion: v1 + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex__3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "enim1c": [ + "<string>", + "<string>" + ], + "in_6": [ + "<string>", + "<string>" + ], + "elit_9": [ + "<string>", + "<string>" + ], + "consequate": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "enim_6f": [ + "<string>", + "<string>" + ], + "eiusmod7": [ + "<string>", + "<string>" + ] + }, + "links": { + "in_6d": "<string>", + "ut8e5": "<string>", + "aliqua0c": "<string>" + } + } + /crm/v3/objects/{objectType}/batch/read: + post: + tags: + - Objects API > Batch + summary: Read a batch of objects by internal ID, or unique property values + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + properties: + - <string> + - <string> + propertiesWithHistory: + - <string> + - <string> + idProperty: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + - name: objectType + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + velit1: <string> + enim_1: <string> + tempor48: <string> + esse_f99: <string> + updatedAt: <dateTime> + propertiesWithHistory: + in81c: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + aute3: <string> + Duis918: <string> + ut_1: <string> + updatedAt: <dateTime> + propertiesWithHistory: + ut5: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + adipisicing_c3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: CANCELED + requestedAt: <dateTime> + links: + qui60: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + elitb: <string> + enimb3: <string> + eiusmod_2: <string> + updatedAt: <dateTime> + propertiesWithHistory: + aliquaa0e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + nostrudff4: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + suntb: <string> + Duisa: <string> + updatedAt: <dateTime> + propertiesWithHistory: + cupidatat_65: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + laborumd6: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + in79a: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + aute9: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: COMPLETE + numErrors: <integer> + errors: + - category: <string> + context: + dolore__: + - <string> + - <string> + est__: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + nostrud5: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + voluptatef0: + - <string> + - <string> + voluptate2: + - <string> + - <string> + links: + quis_6a: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + sit_b: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + sunt_a1: + - <string> + - <string> + do_d11: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + laboris_da4: + - <string> + - <string> + links: + elit33b: <string> + ullamco1b: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + anim_45: <string> + in_f: <string> + dolore_6: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "cupidatat1e5": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "Ut1": [ + "<string>", + "<string>" + ], + "in_e01": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "sint393": [ + "<string>", + "<string>" + ] + }, + "links": { + "anim7a": "<string>", + "in_da": "<string>" + } + } + /crm/v3/objects/{objectType}/batch/archive: + post: + tags: + - Objects API > Batch + summary: Archive a batch of objects by ID + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: objectType + in: path + schema: + type: string + required: true + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "cupidatat1e5": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "Ut1": [ + "<string>", + "<string>" + ], + "in_e01": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "sint393": [ + "<string>", + "<string>" + ] + }, + "links": { + "anim7a": "<string>", + "in_da": "<string>" + } + } + /crm/v3/objects/{objectType}/batch/create: + post: + tags: + - Objects API > Batch + summary: Create a batch of objects + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - associations: + - to: + id: <string> + types: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + properties: + fugiat_ce8: <string> + officia_f: <string> + - associations: + - to: + id: <string> + types: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + properties: + pariaturce: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: objectType + in: path + schema: + type: string + required: true + example: <string> + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + velit1: <string> + enim_1: <string> + tempor48: <string> + esse_f99: <string> + updatedAt: <dateTime> + propertiesWithHistory: + in81c: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + aute3: <string> + Duis918: <string> + ut_1: <string> + updatedAt: <dateTime> + propertiesWithHistory: + ut5: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + adipisicing_c3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: CANCELED + requestedAt: <dateTime> + links: + qui60: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + elitb: <string> + enimb3: <string> + eiusmod_2: <string> + updatedAt: <dateTime> + propertiesWithHistory: + aliquaa0e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + nostrudff4: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + suntb: <string> + Duisa: <string> + updatedAt: <dateTime> + propertiesWithHistory: + cupidatat_65: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + laborumd6: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + in79a: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + aute9: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: COMPLETE + numErrors: <integer> + errors: + - category: <string> + context: + dolore__: + - <string> + - <string> + est__: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + nostrud5: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + voluptatef0: + - <string> + - <string> + voluptate2: + - <string> + - <string> + links: + quis_6a: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + sit_b: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + sunt_a1: + - <string> + - <string> + do_d11: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + laboris_da4: + - <string> + - <string> + links: + elit33b: <string> + ullamco1b: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + anim_45: <string> + in_f: <string> + dolore_6: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "cupidatat1e5": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "Ut1": [ + "<string>", + "<string>" + ], + "in_e01": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "sint393": [ + "<string>", + "<string>" + ] + }, + "links": { + "anim7a": "<string>", + "in_da": "<string>" + } + } + /crm/v3/objects/{objectType}/batch/update: + post: + tags: + - Objects API > Batch + summary: Update a batch of objects by internal ID, or unique property values + requestBody: + content: {} + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: objectType + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + velit1: <string> + enim_1: <string> + tempor48: <string> + esse_f99: <string> + updatedAt: <dateTime> + propertiesWithHistory: + in81c: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + aute3: <string> + Duis918: <string> + ut_1: <string> + updatedAt: <dateTime> + propertiesWithHistory: + ut5: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + adipisicing_c3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: CANCELED + requestedAt: <dateTime> + links: + qui60: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + elitb: <string> + enimb3: <string> + eiusmod_2: <string> + updatedAt: <dateTime> + propertiesWithHistory: + aliquaa0e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + nostrudff4: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + suntb: <string> + Duisa: <string> + updatedAt: <dateTime> + propertiesWithHistory: + cupidatat_65: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + laborumd6: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + in79a: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + aute9: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: COMPLETE + numErrors: <integer> + errors: + - category: <string> + context: + dolore__: + - <string> + - <string> + est__: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + nostrud5: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + voluptatef0: + - <string> + - <string> + voluptate2: + - <string> + - <string> + links: + quis_6a: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + sit_b: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + sunt_a1: + - <string> + - <string> + do_d11: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + laboris_da4: + - <string> + - <string> + links: + elit33b: <string> + ullamco1b: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + anim_45: <string> + in_f: <string> + dolore_6: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "cupidatat1e5": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "Ut1": [ + "<string>", + "<string>" + ], + "in_e01": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "sint393": [ + "<string>", + "<string>" + ] + }, + "links": { + "anim7a": "<string>", + "in_da": "<string>" + } + } + /crm/v3/objects/{objectType}/{objectId}: + get: + tags: + - Objects API > Basic + summary: Read + description: >- + Read an Object identified by `{objectId}`. `{objectId}` refers to the + internal object ID by default, or optionally any unique property value + as specified by the `idProperty` query param. Control what is returned + via the `properties` query param. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: objectType + in: path + schema: + type: string + required: true + example: <string> + - name: objectId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + qui_98: <string> + updatedAt: <dateTime> + propertiesWithHistory: + aute_636: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + aliqua0c: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + magnab: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + quisd46: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "cupidatat1e5": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "Ut1": [ + "<string>", + "<string>" + ], + "in_e01": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "sint393": [ + "<string>", + "<string>" + ] + }, + "links": { + "anim7a": "<string>", + "in_da": "<string>" + } + } + delete: + tags: + - Objects API > Basic + summary: Archive + description: Move an Object identified by `{objectId}` to the recycling bin. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: objectType + in: path + schema: + type: string + required: true + example: <string> + - name: objectId + in: path + schema: + type: string + required: true + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "cupidatat1e5": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "Ut1": [ + "<string>", + "<string>" + ], + "in_e01": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "sint393": [ + "<string>", + "<string>" + ] + }, + "links": { + "anim7a": "<string>", + "in_da": "<string>" + } + } + patch: + tags: + - Objects API > Basic + summary: Update + description: >- + Perform a partial update of an Object identified by `{objectId}`. + `{objectId}` refers to the internal object ID by default, or optionally + any unique property value as specified by the `idProperty` query param. + Provided property values will be overwritten. Read-only and non-existent + properties will be ignored. Properties values can be cleared by passing + an empty string. + requestBody: + content: + application/json: + schema: + type: object + example: + properties: + officia7: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: objectType + in: path + schema: + type: string + required: true + example: <string> + - name: objectId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + deserunt675: <string> + dolor_1ac: <string> + updatedAt: <dateTime> + propertiesWithHistory: + proident_48b: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + Duis_50: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + ex5: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "cupidatat1e5": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "Ut1": [ + "<string>", + "<string>" + ], + "in_e01": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "sint393": [ + "<string>", + "<string>" + ] + }, + "links": { + "anim7a": "<string>", + "in_da": "<string>" + } + } + /crm/v3/objects/{objectType}: + get: + tags: + - Objects API > Basic + summary: List + description: >- + Read a page of objects. Control what is returned via the `properties` + query param. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: limit + in: query + schema: + type: integer + description: The maximum number of results to display per page. + example: '10' + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + - name: objectType + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + esse033: <string> + dolore126: <string> + esse_f7: <string> + et_21: <string> + updatedAt: <dateTime> + propertiesWithHistory: + ut1: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + deserunt3ec: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + - createdAt: <dateTime> + id: <string> + properties: + cupidatatd4: <string> + updatedAt: <dateTime> + propertiesWithHistory: + id__86: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + ea785: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + aute2e: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + dolore7: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + do_50d: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "cupidatat1e5": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "Ut1": [ + "<string>", + "<string>" + ], + "in_e01": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "sint393": [ + "<string>", + "<string>" + ] + }, + "links": { + "anim7a": "<string>", + "in_da": "<string>" + } + } + post: + tags: + - Objects API > Basic + summary: Create + description: >- + Create a CRM object with the given properties and return a copy of the + object, including the ID. Documentation and examples for creating + standard objects is provided. + requestBody: + content: + application/json: + schema: + type: object + example: + associations: + - to: + id: <string> + types: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + properties: + velit_8e: <string> + consequate_: <string> + ut_e: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: objectType + in: path + schema: + type: string + required: true + example: <string> + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + deserunt675: <string> + dolor_1ac: <string> + updatedAt: <dateTime> + propertiesWithHistory: + proident_48b: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + Duis_50: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + ex5: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "cupidatat1e5": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "Ut1": [ + "<string>", + "<string>" + ], + "in_e01": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "sint393": [ + "<string>", + "<string>" + ] + }, + "links": { + "anim7a": "<string>", + "in_da": "<string>" + } + } + /crm/v3/objects/{objectType}/search: + post: + tags: + - Objects API > Search + summary: post-/crm/v3/objects/{object Type}/search do Search + requestBody: + content: + application/json: + schema: + type: object + example: + after: <integer> + filterGroups: + - filters: + - operator: GT + propertyName: <string> + value: <string> + highValue: <string> + values: + - <string> + - <string> + - operator: CONTAINS_TOKEN + propertyName: <string> + value: <string> + highValue: <string> + values: + - <string> + - <string> + - filters: + - operator: NOT_CONTAINS_TOKEN + propertyName: <string> + value: <string> + highValue: <string> + values: + - <string> + - <string> + - operator: EQ + propertyName: <string> + value: <string> + highValue: <string> + values: + - <string> + - <string> + limit: <integer> + properties: + - <string> + - <string> + sorts: + - <string> + - <string> + query: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: objectType + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + sit_2_5: <string> + quis74b: <string> + veniam_8: <string> + updatedAt: <dateTime> + propertiesWithHistory: + ut_ab: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + dolore47: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + eu__9b: <string> + updatedAt: <dateTime> + propertiesWithHistory: + deserunte: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + amet4: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "cupidatat1e5": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "Ut1": [ + "<string>", + "<string>" + ], + "in_e01": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "sint393": [ + "<string>", + "<string>" + ] + }, + "links": { + "anim7a": "<string>", + "in_da": "<string>" + } + } + /crm/v3/objects/deals/batch/update: + post: + tags: + - Deals API > Batch + summary: Update a batch of deals by internal ID, or unique property values + requestBody: + content: {} + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + do_46: <string> + pariatur_e3: <string> + updatedAt: <dateTime> + propertiesWithHistory: + mollit__7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + nulla_e3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + proident_8: <string> + nostrud_52: <string> + updatedAt: <dateTime> + propertiesWithHistory: + aliquip1: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + non_dd: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: COMPLETE + requestedAt: <dateTime> + links: + dolor0fc: <string> + sed_5: <string> + amete78: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + veniam_6: <string> + autee10: <string> + sed32: <string> + updatedAt: <dateTime> + propertiesWithHistory: + consequat_06d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + laborum_096: <string> + eu_4: <string> + updatedAt: <dateTime> + propertiesWithHistory: + dolor__da: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + sunt_d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: COMPLETE + numErrors: <integer> + errors: + - category: <string> + context: + laboris423: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + dolore6: + - <string> + - <string> + pariatur8: + - <string> + - <string> + laboris6a: + - <string> + - <string> + anim_0: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + ipsum_7: + - <string> + - <string> + links: + eiusmodcab: <string> + qui8: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + anim27c: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + ipsum99: + - <string> + - <string> + officia_: + - <string> + - <string> + ad8a6: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + tempor_2ac: + - <string> + - <string> + commodoc8f: + - <string> + - <string> + dof: + - <string> + - <string> + officia_faa: + - <string> + - <string> + dolorefa6: + - <string> + - <string> + links: + ipsum_57: <string> + cupidatat_a: <string> + cupidatat_7_: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + ea_: <string> + exercitation_1_: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ad_cc2": [ + "<string>", + "<string>" + ], + "laboris_3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "tempor_262": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "consequat_c": [ + "<string>", + "<string>" + ] + }, + "links": { + "reprehenderit9": "<string>" + } + } + /crm/v3/objects/deals/batch/archive: + post: + tags: + - Deals API > Batch + summary: Archive a batch of deals by ID + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ad_cc2": [ + "<string>", + "<string>" + ], + "laboris_3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "tempor_262": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "consequat_c": [ + "<string>", + "<string>" + ] + }, + "links": { + "reprehenderit9": "<string>" + } + } + /crm/v3/objects/deals/batch/create: + post: + tags: + - Deals API > Batch + summary: Create a batch of deals + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - associations: + - to: + id: <string> + types: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + properties: + veniam_b0_: <string> + - associations: + - to: + id: <string> + types: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + properties: + cupidatat8_: <string> + voluptate95: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + do_46: <string> + pariatur_e3: <string> + updatedAt: <dateTime> + propertiesWithHistory: + mollit__7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + nulla_e3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + proident_8: <string> + nostrud_52: <string> + updatedAt: <dateTime> + propertiesWithHistory: + aliquip1: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + non_dd: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: COMPLETE + requestedAt: <dateTime> + links: + dolor0fc: <string> + sed_5: <string> + amete78: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + veniam_6: <string> + autee10: <string> + sed32: <string> + updatedAt: <dateTime> + propertiesWithHistory: + consequat_06d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + laborum_096: <string> + eu_4: <string> + updatedAt: <dateTime> + propertiesWithHistory: + dolor__da: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + sunt_d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: COMPLETE + numErrors: <integer> + errors: + - category: <string> + context: + laboris423: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + dolore6: + - <string> + - <string> + pariatur8: + - <string> + - <string> + laboris6a: + - <string> + - <string> + anim_0: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + ipsum_7: + - <string> + - <string> + links: + eiusmodcab: <string> + qui8: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + anim27c: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + ipsum99: + - <string> + - <string> + officia_: + - <string> + - <string> + ad8a6: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + tempor_2ac: + - <string> + - <string> + commodoc8f: + - <string> + - <string> + dof: + - <string> + - <string> + officia_faa: + - <string> + - <string> + dolorefa6: + - <string> + - <string> + links: + ipsum_57: <string> + cupidatat_a: <string> + cupidatat_7_: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + ea_: <string> + exercitation_1_: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ad_cc2": [ + "<string>", + "<string>" + ], + "laboris_3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "tempor_262": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "consequat_c": [ + "<string>", + "<string>" + ] + }, + "links": { + "reprehenderit9": "<string>" + } + } + /crm/v3/objects/deals/batch/read: + post: + tags: + - Deals API > Batch + summary: Read a batch of deals by internal ID, or unique property values + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + properties: + - <string> + - <string> + propertiesWithHistory: + - <string> + - <string> + idProperty: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + do_46: <string> + pariatur_e3: <string> + updatedAt: <dateTime> + propertiesWithHistory: + mollit__7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + nulla_e3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + proident_8: <string> + nostrud_52: <string> + updatedAt: <dateTime> + propertiesWithHistory: + aliquip1: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + non_dd: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: COMPLETE + requestedAt: <dateTime> + links: + dolor0fc: <string> + sed_5: <string> + amete78: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + veniam_6: <string> + autee10: <string> + sed32: <string> + updatedAt: <dateTime> + propertiesWithHistory: + consequat_06d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + laborum_096: <string> + eu_4: <string> + updatedAt: <dateTime> + propertiesWithHistory: + dolor__da: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + sunt_d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: COMPLETE + numErrors: <integer> + errors: + - category: <string> + context: + laboris423: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + dolore6: + - <string> + - <string> + pariatur8: + - <string> + - <string> + laboris6a: + - <string> + - <string> + anim_0: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + ipsum_7: + - <string> + - <string> + links: + eiusmodcab: <string> + qui8: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + anim27c: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + ipsum99: + - <string> + - <string> + officia_: + - <string> + - <string> + ad8a6: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + tempor_2ac: + - <string> + - <string> + commodoc8f: + - <string> + - <string> + dof: + - <string> + - <string> + officia_faa: + - <string> + - <string> + dolorefa6: + - <string> + - <string> + links: + ipsum_57: <string> + cupidatat_a: <string> + cupidatat_7_: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + ea_: <string> + exercitation_1_: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ad_cc2": [ + "<string>", + "<string>" + ], + "laboris_3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "tempor_262": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "consequat_c": [ + "<string>", + "<string>" + ] + }, + "links": { + "reprehenderit9": "<string>" + } + } + /crm/v3/objects/deals: + get: + tags: + - Deals API > Basic + summary: List + description: >- + Read a page of deals. Control what is returned via the `properties` + query param. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: limit + in: query + schema: + type: integer + description: The maximum number of results to display per page. + example: '10' + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + pariatur_c76: <string> + proident_da: <string> + updatedAt: <dateTime> + propertiesWithHistory: + culpa_6: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + Lorem_24f: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + - createdAt: <dateTime> + id: <string> + properties: + temporee: <string> + dolore9: <string> + reprehenderit_39d: <string> + updatedAt: <dateTime> + propertiesWithHistory: + Lorem2aa: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + aliquip_f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + proident1: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + dolor5: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ad_cc2": [ + "<string>", + "<string>" + ], + "laboris_3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "tempor_262": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "consequat_c": [ + "<string>", + "<string>" + ] + }, + "links": { + "reprehenderit9": "<string>" + } + } + post: + tags: + - Deals API > Basic + summary: Create + description: >- + Create a deal with the given properties and return a copy of the object, + including the ID. Documentation and examples for creating standard deals + is provided. + requestBody: + content: + application/json: + schema: + type: object + example: + associations: + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + properties: + Lorem96: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + exercitation78: <string> + updatedAt: <dateTime> + propertiesWithHistory: + noncf: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + pariatureaf: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + qui_3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ad_cc2": [ + "<string>", + "<string>" + ], + "laboris_3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "tempor_262": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "consequat_c": [ + "<string>", + "<string>" + ] + }, + "links": { + "reprehenderit9": "<string>" + } + } + /crm/v3/objects/deals/{dealId}: + get: + tags: + - Deals API > Basic + summary: Read + description: >- + Read an Object identified by `{dealId}`. `{dealId}` refers to the + internal object ID by default, or optionally any unique property value + as specified by the `idProperty` query param. Control what is returned + via the `properties` query param. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: dealId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + minim_f_: <string> + dolorecb: <string> + updatedAt: <dateTime> + propertiesWithHistory: + nostrud_6: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + in_27: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + pariatur59: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + veniam_597: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ad_cc2": [ + "<string>", + "<string>" + ], + "laboris_3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "tempor_262": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "consequat_c": [ + "<string>", + "<string>" + ] + }, + "links": { + "reprehenderit9": "<string>" + } + } + delete: + tags: + - Deals API > Basic + summary: Archive + description: Move an Object identified by `{dealId}` to the recycling bin. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: dealId + in: path + schema: + type: string + required: true + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ad_cc2": [ + "<string>", + "<string>" + ], + "laboris_3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "tempor_262": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "consequat_c": [ + "<string>", + "<string>" + ] + }, + "links": { + "reprehenderit9": "<string>" + } + } + patch: + tags: + - Deals API > Basic + summary: Update + description: >- + Perform a partial update of an Object identified by `{dealId}`. + `{dealId}` refers to the internal object ID by default, or optionally + any unique property value as specified by the `idProperty` query param. + Provided property values will be overwritten. Read-only and non-existent + properties will be ignored. Properties values can be cleared by passing + an empty string. + requestBody: + content: + application/json: + schema: + type: object + example: + properties: + velit4_8: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: dealId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + exercitation78: <string> + updatedAt: <dateTime> + propertiesWithHistory: + noncf: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + pariatureaf: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + qui_3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ad_cc2": [ + "<string>", + "<string>" + ], + "laboris_3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "tempor_262": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "consequat_c": [ + "<string>", + "<string>" + ] + }, + "links": { + "reprehenderit9": "<string>" + } + } + /crm/v3/objects/deals/search: + post: + tags: + - Deals API > Search + summary: post-/crm/v3/objects/deals/search do Search + requestBody: + content: {} + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + sit_a: <string> + enim447: <string> + proident6: <string> + ipsumc: <string> + updatedAt: <dateTime> + propertiesWithHistory: + velit4: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + eu_2: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + commodo_ee: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + nostrud_83c: <string> + updatedAt: <dateTime> + propertiesWithHistory: + tempor_46: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + Duisdc: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ad_cc2": [ + "<string>", + "<string>" + ], + "laboris_3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "tempor_262": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "consequat_c": [ + "<string>", + "<string>" + ] + }, + "links": { + "reprehenderit9": "<string>" + } + } + /crm/v3/objects/deals/merge: + post: + tags: + - Deals API + summary: Merge two deals + requestBody: + content: + application/json: + schema: + type: object + example: + objectIdToMerge: <string> + primaryObjectId: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: '1972-11-28T01:33:41.700Z' + id: in ad Excepteur + properties: + dolore_b4: dolore id dolo + commodob: ut minim + esse62f: exercitation do qui reprehenderit + updatedAt: '1944-12-09T14:31:03.328Z' + archived: true + archivedAt: '1977-08-17T07:07:33.047Z' + propertiesWithHistory: + adipisicing3: + - sourceType: est + timestamp: '2007-08-13T14:18:26.324Z' + value: qui amet esse + sourceId: anim Excepteur ipsum eu cillum + sourceLabel: non + updatedByUserId: -88859589 + - sourceType: in + timestamp: '1997-08-30T05:51:28.429Z' + value: ea in exercitation do + sourceId: mollit proident + sourceLabel: qui ut enim Ut sunt + updatedByUserId: -1010650 + veniam5: + - sourceType: quis minim in + timestamp: '1948-11-26T01:25:14.230Z' + value: eu officia + sourceId: nostrud id mollit + sourceLabel: culpa ut + updatedByUserId: 20123947 + - sourceType: ad enim + timestamp: '1959-10-29T19:30:24.953Z' + value: eiusmod consequat Excepteur commodo + sourceId: deserunt sed Excepteur exercitation + sourceLabel: dolor minim ut in + updatedByUserId: -79663408 + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "labore9e": [ + "<string>", + "<string>" + ] + }, + "links": { + "deserunt_443": "<string>" + }, + "errors": [ + { + "message": "esse magna Excepteur in qui", + "subCategory": "Excepteur ad", + "code": "ut", + "in": "commodo occaecat", + "context": { + "nisi_678": [ + "ea esse anim pariatur", + "consequat" + ], + "officia_8": [ + "fugiat", + "aliqua quis" + ] + } + }, + { + "message": "sunt", + "subCategory": "commodo ullamco occaecat", + "code": "ea anim pariatur qui sed", + "in": "non eu minim", + "context": { + "Utb": [ + "cupidatat consectetur no", + "magna enim aute laborum" + ], + "quis1e8": [ + "nisi e", + "ea cupidatat non" + ] + } + } + ] + } + /crm/v3/objects/deals/batch/upsert: + post: + tags: + - Deals API + summary: Create or update a batch of deals by unique property values + description: >- + Create or update records identified by a unique property value as + specified by the `idProperty` query param. `idProperty` query param + refers to a property whose values are unique for the object. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + properties: + minim_8: <string> + ex_f: <string> + nulla_3: <string> + idProperty: <string> + objectWriteTraceId: <string> + - id: <string> + properties: + ad_f8: <string> + amet_2: <string> + ipsumde: <string> + nostrud_3: <string> + idProperty: <string> + objectWriteTraceId: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + new: <boolean> + properties: + magna_0: <string> + anim1: <string> + laborum_4: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + cupidatat4c: + - sourceType: laborum eiusmod incididunt ipsum in + timestamp: '1947-11-28T10:54:35.425Z' + value: ea + sourceId: consequat anim eu do et + sourceLabel: amet pariatur sunt Ut + updatedByUserId: -2653713 + - sourceType: dolor ad ut consectetur + timestamp: '1966-02-19T13:25:08.936Z' + value: veniam ex + sourceId: in in dolor consequat + sourceLabel: cupidatat anim + updatedByUserId: -79111102 + cillum_d: + - sourceType: ea elit aute adipisici + timestamp: '2017-10-04T04:42:42.076Z' + value: velit reprehend + sourceId: Lorem laboris + sourceLabel: consectetur dolore incididunt + updatedByUserId: 2786154 + - sourceType: in laboris + timestamp: '2018-05-21T16:39:29.364Z' + value: magna eu occaecat velit + sourceId: aliqua ad + sourceLabel: enim tempor + updatedByUserId: -64262524 + - createdAt: <dateTime> + id: <string> + new: <boolean> + properties: + do452: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + non_1f: + - sourceType: in minim voluptate Lorem ullamco + timestamp: '2005-04-04T06:01:57.288Z' + value: Lorem amet + sourceId: quis sint aliquip officia mollit + sourceLabel: anim ut et dolore sint + updatedByUserId: 31027437 + - sourceType: occaecat in laboris + timestamp: '1950-06-11T05:40:58.050Z' + value: in sunt + sourceId: ex deserunt pariatur + sourceLabel: ullamco inc + updatedByUserId: 42065776 + fugiat8: + - sourceType: irure nulla + timestamp: '1965-08-30T20:41:08.635Z' + value: occaecat veniam nulla + sourceId: fugiat deserunt Duis anim + sourceLabel: dolor ea sit + updatedByUserId: -81127223 + - sourceType: minim + timestamp: '1979-06-27T04:44:08.699Z' + value: minim consectetur nisi deserunt occaecat + sourceId: nostrud tempor + sourceLabel: Ut dolor + updatedByUserId: -29780922 + ea832: + - sourceType: non n + timestamp: '2000-08-18T07:36:13.847Z' + value: labore fugiat + sourceId: ut esse fugiat nulla + sourceLabel: ullamco nulla + updatedByUserId: -90457846 + - sourceType: in ipsum amet incididunt + timestamp: '2024-07-06T11:57:33.254Z' + value: reprehenderit in in cul + sourceId: elit Excepteur ad + sourceLabel: sit sed + updatedByUserId: 39228185 + startedAt: <dateTime> + status: PROCESSING + requestedAt: <dateTime> + links: + sed738: <string> + quis7c: <string> + cupidatat0b: <string> + aliquipe17: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + new: <boolean> + properties: + et_8a: <string> + ute2: <string> + est4: <string> + incididuntd8: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + quise: + - sourceType: eu adipisicing ut + timestamp: '1964-04-05T06:11:38.832Z' + value: eu consequat + sourceId: aliqua a + sourceLabel: officia non reprehenderit do + updatedByUserId: 56319008 + - sourceType: fugiat dolor enim + timestamp: '1955-08-23T21:59:43.808Z' + value: consequat officia in + sourceId: culpa + sourceLabel: consequat ullamco + updatedByUserId: -87729386 + eua: + - sourceType: sunt ut + timestamp: '1962-09-24T17:46:02.257Z' + value: anim + sourceId: dolor incididunt Ut + sourceLabel: in occaecat + updatedByUserId: -91314511 + - sourceType: adipisicing tempor + timestamp: '1949-04-28T23:15:26.411Z' + value: voluptate cillum + sourceId: culpa velit aliqua consectetur + sourceLabel: fugiat + updatedByUserId: -65637776 + - createdAt: <dateTime> + id: <string> + new: <boolean> + properties: + officia_4e1: <string> + velit2c3: <string> + sint_9: <string> + velit79: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + cillumd: + - sourceType: minim sed ea + timestamp: '1979-07-15T13:51:35.148Z' + value: dolore + sourceId: aliquip deserunt + sourceLabel: voluptate est ut + updatedByUserId: -46464629 + - sourceType: eli + timestamp: '2001-03-23T18:15:15.726Z' + value: ipsum sint qui ex incididunt + sourceId: sunt laborum + sourceLabel: aliquip nostrud + updatedByUserId: -15732693 + ut_be: + - sourceType: officia commodo + timestamp: '1974-12-16T16:55:38.591Z' + value: nulla cupidatat + sourceId: cillum ex anim ad + sourceLabel: eu fugiat commodo dolor Ut + updatedByUserId: -29601504 + - sourceType: Excepteur sed do reprehenderit + timestamp: '2000-06-03T06:49:58.852Z' + value: id consectetur + sourceId: et + sourceLabel: Ut Duis quis ullamco + updatedByUserId: 73109277 + startedAt: <dateTime> + status: PENDING + numErrors: <integer> + requestedAt: <dateTime> + links: + labore_8d0: <string> + ea_: <string> + errors: + - category: nostrud nisi + context: + et_4: + - ea + - sunt ex fugiat + errors: + - message: fugiat + subCategory: aliquip adipisicing Duis proident + code: est tempor anim + in: irure cupidata + context: + sunt_e: + - consequat dolore + - consectetur dolore + ea_2: + - non Ut ut + - qui anim aute + irure_6: + - anim aliqua + - irure pariatur reprehenderit id + - message: consequat in proident labore + subCategory: voluptate dolor Lorem aute + code: deserunt irure do + in: lab + context: + voluptate99a: + - do + - cillum in + esse_9e: + - qui Lorem in nisi + - pari + veniam3: + - cupidatat est aliquip + - nisi in occaecat + links: + voluptate_8: veniam do id laboris culpa + eiusmod_4: esse dolor culpa ullamco incididunt + message: id + status: ullamco minim + subCategory: {} + id: sunt + - category: esse + context: + culpa8a: + - non labore ullamco amet + - sunt + ex_f1b: + - qui dolore e + - eius + errors: + - message: ut esse aliqua deserunt dolore + subCategory: aliqua laboris aliquip + code: proident sed + in: enim anim + context: + consectetur4: + - dolor in aliquip non + - dolor eiusmod amet quis + - message: et dolore sed + subCategory: consequat nulla + code: in + in: officia qui velit + context: + dolore_8_: + - ut de + - ipsum adipisicing est ex + deseruntb: + - mollit + - consectetur occaecat est proident + links: + officia_0cb: ex Lorem + reprehenderit_b5a: ex irure minim + message: eu ea + status: incididunt cupidatat sunt + subCategory: {} + id: Excepteur velit eu + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "labore9e": [ + "<string>", + "<string>" + ] + }, + "links": { + "deserunt_443": "<string>" + }, + "errors": [ + { + "message": "esse magna Excepteur in qui", + "subCategory": "Excepteur ad", + "code": "ut", + "in": "commodo occaecat", + "context": { + "nisi_678": [ + "ea esse anim pariatur", + "consequat" + ], + "officia_8": [ + "fugiat", + "aliqua quis" + ] + } + }, + { + "message": "sunt", + "subCategory": "commodo ullamco occaecat", + "code": "ea anim pariatur qui sed", + "in": "non eu minim", + "context": { + "Utb": [ + "cupidatat consectetur no", + "magna enim aute laborum" + ], + "quis1e8": [ + "nisi e", + "ea cupidatat non" + ] + } + } + ] + } + /crm/v3/objects/deals/splits/batch/upsert: + post: + tags: + - Deal Splits API > Batch + summary: >- + Create or replace deal splits for deals with the provided IDs. Deal + split percentages for each deal must sum up to 1.0 (100%) and may have + up to 8 decimal places + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <integer> + splits: + - ownerId: <integer> + percentage: <number> + - ownerId: <integer> + percentage: <number> + - id: <integer> + splits: + - ownerId: <integer> + percentage: <number> + - ownerId: <integer> + percentage: <number> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - id: <string> + splits: + - createdAt: <dateTime> + id: <string> + properties: + sint_e0c: <string> + voluptate_e13: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + occaecat66: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + adipisicing_9df: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + voluptate_05: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + fugiatc_c: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + etef: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + pariatur_f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - id: <string> + splits: + - createdAt: <dateTime> + id: <string> + properties: + in_0e9: <string> + eiusmod554: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + fugiat3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + temporb_: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + id0ef: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + incididunte8: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + in_306: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + startedAt: <dateTime> + status: CANCELED + requestedAt: <dateTime> + links: + elit_c01: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - id: <string> + splits: + - createdAt: <dateTime> + id: <string> + properties: + aute_743: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + velit__: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + adipisicing7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + velit_74: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + culpac1_: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + dolore__6: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - id: <string> + splits: + - createdAt: <dateTime> + id: <string> + properties: + minim_6: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + elit3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + irure6fc: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + sint_4: <string> + occaecat_0eb: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + cupidatat_b: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + startedAt: <dateTime> + status: COMPLETE + numErrors: <integer> + requestedAt: <dateTime> + links: + cillum86: <string> + errors: + - category: <string> + context: + sint_ae: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + Lorem_a39: + - <string> + - <string> + mollit_3: + - <string> + - <string> + velit66: + - <string> + - <string> + eudc: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + deserunt_c_: + - <string> + - <string> + adipisicing__cc: + - <string> + - <string> + links: + minim_3: <string> + cupidatataf3: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + - category: <string> + context: + eu_2c: + - <string> + - <string> + eiusmodb6: + - <string> + - <string> + eiusmod_3: + - <string> + - <string> + amet_0ea: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + aliqua8: + - <string> + - <string> + cupidatat_b2: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + consectetur7: + - <string> + - <string> + do_24: + - <string> + - <string> + links: + voluptate_1: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "aliqua3": [ + "<string>", + "<string>" + ] + }, + "links": { + "ut_a3b": "<string>", + "minim_5": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "nulladb6": [ + "<string>", + "<string>" + ], + "sit_6": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "irureb2": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/deals/splits/batch/read: + post: + tags: + - Deal Splits API > Batch + summary: >- + Read a batch of deal split objects by their associated deal object + internal ID + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - id: <string> + splits: + - createdAt: <dateTime> + id: <string> + properties: + sint_e0c: <string> + voluptate_e13: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + occaecat66: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + adipisicing_9df: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + voluptate_05: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + fugiatc_c: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + etef: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + pariatur_f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - id: <string> + splits: + - createdAt: <dateTime> + id: <string> + properties: + in_0e9: <string> + eiusmod554: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + fugiat3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + temporb_: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + id0ef: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + incididunte8: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + in_306: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + startedAt: <dateTime> + status: CANCELED + requestedAt: <dateTime> + links: + elit_c01: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - id: <string> + splits: + - createdAt: <dateTime> + id: <string> + properties: + aute_743: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + velit__: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + adipisicing7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + velit_74: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + culpac1_: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + dolore__6: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - id: <string> + splits: + - createdAt: <dateTime> + id: <string> + properties: + minim_6: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + elit3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + irure6fc: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + sint_4: <string> + occaecat_0eb: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + cupidatat_b: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + startedAt: <dateTime> + status: COMPLETE + numErrors: <integer> + requestedAt: <dateTime> + links: + cillum86: <string> + errors: + - category: <string> + context: + sint_ae: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + Lorem_a39: + - <string> + - <string> + mollit_3: + - <string> + - <string> + velit66: + - <string> + - <string> + eudc: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + deserunt_c_: + - <string> + - <string> + adipisicing__cc: + - <string> + - <string> + links: + minim_3: <string> + cupidatataf3: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + - category: <string> + context: + eu_2c: + - <string> + - <string> + eiusmodb6: + - <string> + - <string> + eiusmod_3: + - <string> + - <string> + amet_0ea: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + aliqua8: + - <string> + - <string> + cupidatat_b2: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + consectetur7: + - <string> + - <string> + do_24: + - <string> + - <string> + links: + voluptate_1: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "aliqua3": [ + "<string>", + "<string>" + ] + }, + "links": { + "ut_a3b": "<string>", + "minim_5": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "nulladb6": [ + "<string>", + "<string>" + ], + "sit_6": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "irureb2": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/discounts/batch/update: + post: + tags: + - Discounts API > Batch + summary: Update a batch of discounts + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + properties: + non_3a: <string> + - id: <string> + properties: + officia1: <string> + reprehenderit__: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + nulla79: <string> + updatedAt: <dateTime> + propertiesWithHistory: + cillum0: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + magna_2: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + qui2: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + in3d5: <string> + culpa4: <string> + updatedAt: <dateTime> + propertiesWithHistory: + dolore17: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + qui_c7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: CANCELED + requestedAt: <dateTime> + links: + elitf3: <string> + exercitationd: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + ut1_: <string> + updatedAt: <dateTime> + propertiesWithHistory: + do_bc: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + aliquip_d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + culpac: <string> + updatedAt: <dateTime> + propertiesWithHistory: + consequatee3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: COMPLETE + numErrors: <integer> + errors: + - category: <string> + context: + fugiat_9: + - <string> + - <string> + elit73b: + - <string> + - <string> + magna_a: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + laborum_c: + - <string> + - <string> + proident_3: + - <string> + - <string> + minim_0: + - <string> + - <string> + sunt_2: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + ipsum3: + - <string> + - <string> + ad_1: + - <string> + - <string> + links: + aliqua_7b9: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + eiusmod13: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + incididunt_9c: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + qui_6: + - <string> + - <string> + links: + nisi_: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + consequat54: <string> + veniam_9: <string> + fugiatb_d: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "aliquip_33": [ + "<string>", + "<string>" + ], + "ea18": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "amet_b": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "velit_5": [ + "<string>", + "<string>" + ], + "enim00": [ + "<string>", + "<string>" + ] + }, + "links": { + "ex_5dc": "<string>", + "aliquip_fc": "<string>" + } + } + /crm/v3/objects/discounts/batch/create: + post: + tags: + - Discounts API > Batch + summary: Create a batch of discounts + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - associations: + - to: + id: <string> + types: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + properties: + cupidatat_7: <string> + - associations: + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + properties: + irure3: <string> + deserunt_: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + nulla79: <string> + updatedAt: <dateTime> + propertiesWithHistory: + cillum0: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + magna_2: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + qui2: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + in3d5: <string> + culpa4: <string> + updatedAt: <dateTime> + propertiesWithHistory: + dolore17: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + qui_c7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: CANCELED + requestedAt: <dateTime> + links: + elitf3: <string> + exercitationd: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + ut1_: <string> + updatedAt: <dateTime> + propertiesWithHistory: + do_bc: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + aliquip_d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + culpac: <string> + updatedAt: <dateTime> + propertiesWithHistory: + consequatee3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: COMPLETE + numErrors: <integer> + errors: + - category: <string> + context: + fugiat_9: + - <string> + - <string> + elit73b: + - <string> + - <string> + magna_a: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + laborum_c: + - <string> + - <string> + proident_3: + - <string> + - <string> + minim_0: + - <string> + - <string> + sunt_2: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + ipsum3: + - <string> + - <string> + ad_1: + - <string> + - <string> + links: + aliqua_7b9: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + eiusmod13: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + incididunt_9c: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + qui_6: + - <string> + - <string> + links: + nisi_: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + consequat54: <string> + veniam_9: <string> + fugiatb_d: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "aliquip_33": [ + "<string>", + "<string>" + ], + "ea18": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "amet_b": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "velit_5": [ + "<string>", + "<string>" + ], + "enim00": [ + "<string>", + "<string>" + ] + }, + "links": { + "ex_5dc": "<string>", + "aliquip_fc": "<string>" + } + } + /crm/v3/objects/discounts/batch/archive: + post: + tags: + - Discounts API > Batch + summary: Archive a batch of discounts by ID + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "aliquip_33": [ + "<string>", + "<string>" + ], + "ea18": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "amet_b": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "velit_5": [ + "<string>", + "<string>" + ], + "enim00": [ + "<string>", + "<string>" + ] + }, + "links": { + "ex_5dc": "<string>", + "aliquip_fc": "<string>" + } + } + /crm/v3/objects/discounts/batch/read: + post: + tags: + - Discounts API > Batch + summary: Read a batch of discounts by internal ID, or unique property values + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + properties: + - <string> + - <string> + propertiesWithHistory: + - <string> + - <string> + idProperty: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + nulla79: <string> + updatedAt: <dateTime> + propertiesWithHistory: + cillum0: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + magna_2: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + qui2: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + in3d5: <string> + culpa4: <string> + updatedAt: <dateTime> + propertiesWithHistory: + dolore17: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + qui_c7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: CANCELED + requestedAt: <dateTime> + links: + elitf3: <string> + exercitationd: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + ut1_: <string> + updatedAt: <dateTime> + propertiesWithHistory: + do_bc: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + aliquip_d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + culpac: <string> + updatedAt: <dateTime> + propertiesWithHistory: + consequatee3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: COMPLETE + numErrors: <integer> + errors: + - category: <string> + context: + fugiat_9: + - <string> + - <string> + elit73b: + - <string> + - <string> + magna_a: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + laborum_c: + - <string> + - <string> + proident_3: + - <string> + - <string> + minim_0: + - <string> + - <string> + sunt_2: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + ipsum3: + - <string> + - <string> + ad_1: + - <string> + - <string> + links: + aliqua_7b9: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + eiusmod13: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + incididunt_9c: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + qui_6: + - <string> + - <string> + links: + nisi_: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + consequat54: <string> + veniam_9: <string> + fugiatb_d: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "aliquip_33": [ + "<string>", + "<string>" + ], + "ea18": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "amet_b": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "velit_5": [ + "<string>", + "<string>" + ], + "enim00": [ + "<string>", + "<string>" + ] + }, + "links": { + "ex_5dc": "<string>", + "aliquip_fc": "<string>" + } + } + /crm/v3/objects/discounts/{discountId}: + get: + tags: + - Discounts API > Basic + summary: Read + description: >- + Read an Object identified by `{discountId}`. `{discountId}` refers to + the internal object ID by default, or optionally any unique property + value as specified by the `idProperty` query param. Control what is + returned via the `properties` query param. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: discountId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + ullamco__92: <string> + minim_db9: <string> + eu_9: <string> + adipisicing8: <string> + updatedAt: <dateTime> + propertiesWithHistory: + magna_7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + mollitcf: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + enim_1: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "aliquip_33": [ + "<string>", + "<string>" + ], + "ea18": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "amet_b": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "velit_5": [ + "<string>", + "<string>" + ], + "enim00": [ + "<string>", + "<string>" + ] + }, + "links": { + "ex_5dc": "<string>", + "aliquip_fc": "<string>" + } + } + delete: + tags: + - Discounts API > Basic + summary: Archive + description: Move an Object identified by `{discountId}` to the recycling bin. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: discountId + in: path + schema: + type: string + required: true + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "aliquip_33": [ + "<string>", + "<string>" + ], + "ea18": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "amet_b": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "velit_5": [ + "<string>", + "<string>" + ], + "enim00": [ + "<string>", + "<string>" + ] + }, + "links": { + "ex_5dc": "<string>", + "aliquip_fc": "<string>" + } + } + patch: + tags: + - Discounts API > Basic + summary: Update + description: >- + Perform a partial update of an Object identified by `{discountId}`. + `{discountId}` refers to the internal object ID by default, or + optionally any unique property value as specified by the `idProperty` + query param. Provided property values will be overwritten. Read-only and + non-existent properties will be ignored. Properties values can be + cleared by passing an empty string. + requestBody: + content: + application/json: + schema: + type: object + example: + properties: + quis03f: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: discountId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + in_5f8: <string> + updatedAt: <dateTime> + propertiesWithHistory: + labore26: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "aliquip_33": [ + "<string>", + "<string>" + ], + "ea18": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "amet_b": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "velit_5": [ + "<string>", + "<string>" + ], + "enim00": [ + "<string>", + "<string>" + ] + }, + "links": { + "ex_5dc": "<string>", + "aliquip_fc": "<string>" + } + } + /crm/v3/objects/discounts: + get: + tags: + - Discounts API > Basic + summary: List + description: >- + Read a page of discounts. Control what is returned via the `properties` + query param. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: limit + in: query + schema: + type: integer + description: The maximum number of results to display per page. + example: '10' + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + ullamco90: <string> + exercitation07: <string> + updatedAt: <dateTime> + propertiesWithHistory: + tempor_e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + eiusmodba: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + dolora8c: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + - createdAt: <dateTime> + id: <string> + properties: + ullamco_f0: <string> + velit_f: <string> + updatedAt: <dateTime> + propertiesWithHistory: + aliqua6: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + aliquip_f9: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + dolore_1: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + labore_a: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + nulla_6: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "aliquip_33": [ + "<string>", + "<string>" + ], + "ea18": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "amet_b": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "velit_5": [ + "<string>", + "<string>" + ], + "enim00": [ + "<string>", + "<string>" + ] + }, + "links": { + "ex_5dc": "<string>", + "aliquip_fc": "<string>" + } + } + post: + tags: + - Discounts API > Basic + summary: Create + description: >- + Create a discount with the given properties and return a copy of the + object, including the ID. Documentation and examples for creating + standard discounts is provided. + requestBody: + content: + application/json: + schema: + type: object + example: + associations: + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + properties: + nostrudcf: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + in_5f8: <string> + updatedAt: <dateTime> + propertiesWithHistory: + labore26: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "aliquip_33": [ + "<string>", + "<string>" + ], + "ea18": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "amet_b": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "velit_5": [ + "<string>", + "<string>" + ], + "enim00": [ + "<string>", + "<string>" + ] + }, + "links": { + "ex_5dc": "<string>", + "aliquip_fc": "<string>" + } + } + /crm/v3/objects/discounts/search: + post: + tags: + - Discounts API > Search + summary: post-/crm/v3/objects/discounts/search + requestBody: + content: + application/json: + schema: + type: object + example: + after: <integer> + filterGroups: + - filters: + - operator: NOT_IN + propertyName: <string> + value: <string> + highValue: <string> + values: + - <string> + - <string> + - operator: NOT_HAS_PROPERTY + propertyName: <string> + value: <string> + highValue: <string> + values: + - <string> + - <string> + - filters: + - operator: HAS_PROPERTY + propertyName: <string> + value: <string> + highValue: <string> + values: + - <string> + - <string> + - operator: LTE + propertyName: <string> + value: <string> + highValue: <string> + values: + - <string> + - <string> + limit: <integer> + properties: + - <string> + - <string> + sorts: + - <string> + - <string> + query: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + dolored3: <string> + updatedAt: <dateTime> + propertiesWithHistory: + fugiat653: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + amet__f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + tempor0c: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + minim_87: <string> + updatedAt: <dateTime> + propertiesWithHistory: + id_e5: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + quisd7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "aliquip_33": [ + "<string>", + "<string>" + ], + "ea18": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "amet_b": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "velit_5": [ + "<string>", + "<string>" + ], + "enim00": [ + "<string>", + "<string>" + ] + }, + "links": { + "ex_5dc": "<string>", + "aliquip_fc": "<string>" + } + } + /crm/v3/exports/export/async/tasks/{taskId}/status: + get: + tags: + - Exports API > Public_Exports + summary: Get the status of the export including the URL to download the file + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: taskId + in: path + schema: + type: string + required: true + example: <long> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + startedAt: <dateTime> + status: CANCELED + result: <string> + numErrors: <integer> + errors: + - category: <string> + context: + proident__c: + - <string> + - <string> + occaecat_94: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + in_8: + - <string> + - <string> + Ut3_d: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + in_3a: + - <string> + - <string> + links: + in_180: <string> + magna_55: <string> + mollit9: <string> + tempor_f5: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + mollit_46: + - <string> + - <string> + in_ba: + - <string> + - <string> + euc2: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + consecteturb6a: + - <string> + - <string> + voluptate_1d5: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + sed_d: + - <string> + - <string> + consectetur_59: + - <string> + - <string> + in5e: + - <string> + - <string> + links: + qui_a: <string> + aute_c: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + cupidatatc: <string> + enimb01: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "sitde": [ + "<string>", + "<string>" + ], + "officia_77": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "esse_0": [ + "<string>", + "<string>" + ], + "magna80": [ + "<string>", + "<string>" + ], + "doloreea4": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "officia7": [ + "<string>", + "<string>" + ], + "voluptatec1": [ + "<string>", + "<string>" + ], + "esse_fd": [ + "<string>", + "<string>" + ] + }, + "links": { + "sunt_e0": "<string>", + "quis_": "<string>" + } + } + /crm/v3/exports/export/async: + post: + tags: + - Exports API > Core + summary: Start an export + description: >- + Begins exporting CRM data for the portal as specified in the request + body + requestBody: + content: + application/json: + schema: + type: object + example: + exportName: <string> + exportType: VIEW + format: CSV + language: ES + objectProperties: + - <string> + - <string> + objectType: <string> + associatedObjectType: <string> + publicCrmSearchRequest: + filters: + - operator: GT + propertyName: <string> + value: <string> + highValue: <string> + values: + - <string> + - <string> + - operator: GTE + propertyName: <string> + value: <string> + highValue: <string> + values: + - <string> + - <string> + query: <string> + sorts: + - <string> + - <string> + exportInternalValuesOptions: + - VALUES + - VALUES + overrideAssociatedObjectsPerDefinitionPerRowLimit: <boolean> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '202': + description: Accepted + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + id: <string> + links: + eiusmoda: <string> + officia_55: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "sitde": [ + "<string>", + "<string>" + ], + "officia_77": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "esse_0": [ + "<string>", + "<string>" + ], + "magna80": [ + "<string>", + "<string>" + ], + "doloreea4": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "officia7": [ + "<string>", + "<string>" + ], + "voluptatec1": [ + "<string>", + "<string>" + ], + "esse_fd": [ + "<string>", + "<string>" + ] + }, + "links": { + "sunt_e0": "<string>", + "quis_": "<string>" + } + } + /crm/v3/objects/feedback_submissions/batch/update: + post: + tags: + - Feedback Submissions API > Batch + summary: >- + Update a batch of feedback submissions by internal ID, or unique + property values + requestBody: + content: {} + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + anim_144: <string> + updatedAt: <dateTime> + propertiesWithHistory: + amet_4: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + eu3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + magna92: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + sit_27e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + incididunta7: <string> + Lorem_df: <string> + laborisf6: <string> + updatedAt: <dateTime> + propertiesWithHistory: + mollit_791: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: COMPLETE + requestedAt: <dateTime> + links: + ullamcofb8: <string> + elitd: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + dolore5: <string> + cupidatat_1ba: <string> + updatedAt: <dateTime> + propertiesWithHistory: + proident_6: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + fugiata5f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + dolore_1bc: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + ea_a: <string> + updatedAt: <dateTime> + propertiesWithHistory: + dolore_389: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PROCESSING + numErrors: <integer> + errors: + - category: <string> + context: + laboruma: + - <string> + - <string> + et5b1: + - <string> + - <string> + culpa56: + - <string> + - <string> + ex35: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + minim_db: + - <string> + - <string> + enima: + - <string> + - <string> + voluptateb3: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + adipisicing55b: + - <string> + - <string> + esseb45: + - <string> + - <string> + links: + adipisicingd03: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + in05: + - <string> + - <string> + magna_c0: + - <string> + - <string> + pariatur_13d: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + nisi__: + - <string> + - <string> + velit_b6a: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + labore_e: + - <string> + - <string> + in3: + - <string> + - <string> + links: + culpa2eb: <string> + ad_52d: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + veniam_53: <string> + veniam_1: <string> + in_9_1: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "laboris_0": [ + "<string>", + "<string>" + ], + "aliqua_0": [ + "<string>", + "<string>" + ], + "cupidatat_7": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "nostrud_95": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "exercitation_3": [ + "<string>", + "<string>" + ], + "deseruntb_": [ + "<string>", + "<string>" + ], + "do_": [ + "<string>", + "<string>" + ] + }, + "links": { + "nulla_6": "<string>", + "veniam_f": "<string>", + "Ut9": "<string>" + } + } + /crm/v3/objects/feedback_submissions/batch/create: + post: + tags: + - Feedback Submissions API > Batch + summary: Create a batch of feedback submissions + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - associations: + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + properties: + amet4: <string> + nostrud37: <string> + - associations: + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + properties: + culpa_2a: <string> + eiusmod_8: <string> + ex5: <string> + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + anim_144: <string> + updatedAt: <dateTime> + propertiesWithHistory: + amet_4: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + eu3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + magna92: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + sit_27e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + incididunta7: <string> + Lorem_df: <string> + laborisf6: <string> + updatedAt: <dateTime> + propertiesWithHistory: + mollit_791: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: COMPLETE + requestedAt: <dateTime> + links: + ullamcofb8: <string> + elitd: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + dolore5: <string> + cupidatat_1ba: <string> + updatedAt: <dateTime> + propertiesWithHistory: + proident_6: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + fugiata5f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + dolore_1bc: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + ea_a: <string> + updatedAt: <dateTime> + propertiesWithHistory: + dolore_389: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PROCESSING + numErrors: <integer> + errors: + - category: <string> + context: + laboruma: + - <string> + - <string> + et5b1: + - <string> + - <string> + culpa56: + - <string> + - <string> + ex35: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + minim_db: + - <string> + - <string> + enima: + - <string> + - <string> + voluptateb3: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + adipisicing55b: + - <string> + - <string> + esseb45: + - <string> + - <string> + links: + adipisicingd03: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + in05: + - <string> + - <string> + magna_c0: + - <string> + - <string> + pariatur_13d: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + nisi__: + - <string> + - <string> + velit_b6a: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + labore_e: + - <string> + - <string> + in3: + - <string> + - <string> + links: + culpa2eb: <string> + ad_52d: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + veniam_53: <string> + veniam_1: <string> + in_9_1: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "laboris_0": [ + "<string>", + "<string>" + ], + "aliqua_0": [ + "<string>", + "<string>" + ], + "cupidatat_7": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "nostrud_95": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "exercitation_3": [ + "<string>", + "<string>" + ], + "deseruntb_": [ + "<string>", + "<string>" + ], + "do_": [ + "<string>", + "<string>" + ] + }, + "links": { + "nulla_6": "<string>", + "veniam_f": "<string>", + "Ut9": "<string>" + } + } + /crm/v3/objects/feedback_submissions/batch/archive: + post: + tags: + - Feedback Submissions API > Batch + summary: Archive a batch of feedback submissions by ID + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "laboris_0": [ + "<string>", + "<string>" + ], + "aliqua_0": [ + "<string>", + "<string>" + ], + "cupidatat_7": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "nostrud_95": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "exercitation_3": [ + "<string>", + "<string>" + ], + "deseruntb_": [ + "<string>", + "<string>" + ], + "do_": [ + "<string>", + "<string>" + ] + }, + "links": { + "nulla_6": "<string>", + "veniam_f": "<string>", + "Ut9": "<string>" + } + } + /crm/v3/objects/feedback_submissions/batch/read: + post: + tags: + - Feedback Submissions API > Batch + summary: >- + Read a batch of feedback submissions by internal ID, or unique property + values + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + properties: + - <string> + - <string> + propertiesWithHistory: + - <string> + - <string> + idProperty: <string> + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + anim_144: <string> + updatedAt: <dateTime> + propertiesWithHistory: + amet_4: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + eu3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + magna92: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + sit_27e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + incididunta7: <string> + Lorem_df: <string> + laborisf6: <string> + updatedAt: <dateTime> + propertiesWithHistory: + mollit_791: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: COMPLETE + requestedAt: <dateTime> + links: + ullamcofb8: <string> + elitd: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + dolore5: <string> + cupidatat_1ba: <string> + updatedAt: <dateTime> + propertiesWithHistory: + proident_6: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + fugiata5f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + dolore_1bc: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + ea_a: <string> + updatedAt: <dateTime> + propertiesWithHistory: + dolore_389: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PROCESSING + numErrors: <integer> + errors: + - category: <string> + context: + laboruma: + - <string> + - <string> + et5b1: + - <string> + - <string> + culpa56: + - <string> + - <string> + ex35: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + minim_db: + - <string> + - <string> + enima: + - <string> + - <string> + voluptateb3: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + adipisicing55b: + - <string> + - <string> + esseb45: + - <string> + - <string> + links: + adipisicingd03: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + in05: + - <string> + - <string> + magna_c0: + - <string> + - <string> + pariatur_13d: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + nisi__: + - <string> + - <string> + velit_b6a: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + labore_e: + - <string> + - <string> + in3: + - <string> + - <string> + links: + culpa2eb: <string> + ad_52d: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + veniam_53: <string> + veniam_1: <string> + in_9_1: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "laboris_0": [ + "<string>", + "<string>" + ], + "aliqua_0": [ + "<string>", + "<string>" + ], + "cupidatat_7": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "nostrud_95": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "exercitation_3": [ + "<string>", + "<string>" + ], + "deseruntb_": [ + "<string>", + "<string>" + ], + "do_": [ + "<string>", + "<string>" + ] + }, + "links": { + "nulla_6": "<string>", + "veniam_f": "<string>", + "Ut9": "<string>" + } + } + /crm/v3/objects/feedback_submissions/{feedbackSubmissionId}: + get: + tags: + - Feedback Submissions API > Basic + summary: Read + description: >- + Read an Object identified by `{feedbackSubmissionId}`. + `{feedbackSubmissionId}` refers to the internal object ID by default, or + optionally any unique property value as specified by the `idProperty` + query param. Control what is returned via the `properties` query param. + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: feedbackSubmissionId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + reprehenderit_9b0: <string> + uta0: <string> + updatedAt: <dateTime> + propertiesWithHistory: + quif0: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + in019: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "laboris_0": [ + "<string>", + "<string>" + ], + "aliqua_0": [ + "<string>", + "<string>" + ], + "cupidatat_7": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "nostrud_95": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "exercitation_3": [ + "<string>", + "<string>" + ], + "deseruntb_": [ + "<string>", + "<string>" + ], + "do_": [ + "<string>", + "<string>" + ] + }, + "links": { + "nulla_6": "<string>", + "veniam_f": "<string>", + "Ut9": "<string>" + } + } + delete: + tags: + - Feedback Submissions API > Basic + summary: Archive + description: >- + Move an Object identified by `{feedbackSubmissionId}` to the recycling + bin. + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: feedbackSubmissionId + in: path + schema: + type: string + required: true + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "laboris_0": [ + "<string>", + "<string>" + ], + "aliqua_0": [ + "<string>", + "<string>" + ], + "cupidatat_7": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "nostrud_95": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "exercitation_3": [ + "<string>", + "<string>" + ], + "deseruntb_": [ + "<string>", + "<string>" + ], + "do_": [ + "<string>", + "<string>" + ] + }, + "links": { + "nulla_6": "<string>", + "veniam_f": "<string>", + "Ut9": "<string>" + } + } + patch: + tags: + - Feedback Submissions API > Basic + summary: Update + description: >- + Perform a partial update of an Object identified by + `{feedbackSubmissionId}`. `{feedbackSubmissionId}` refers to the + internal object ID by default, or optionally any unique property value + as specified by the `idProperty` query param. Provided property values + will be overwritten. Read-only and non-existent properties will be + ignored. Properties values can be cleared by passing an empty string. + requestBody: + content: + application/json: + schema: + type: object + example: + properties: + officia00d: <string> + pariatur_63: <string> + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: feedbackSubmissionId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + Lorem_a5: <string> + reprehenderite46: <string> + ex_235: <string> + eiusmod_bfa: <string> + updatedAt: <dateTime> + propertiesWithHistory: + dolore_f7e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + mollit_0: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "laboris_0": [ + "<string>", + "<string>" + ], + "aliqua_0": [ + "<string>", + "<string>" + ], + "cupidatat_7": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "nostrud_95": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "exercitation_3": [ + "<string>", + "<string>" + ], + "deseruntb_": [ + "<string>", + "<string>" + ], + "do_": [ + "<string>", + "<string>" + ] + }, + "links": { + "nulla_6": "<string>", + "veniam_f": "<string>", + "Ut9": "<string>" + } + } + /crm/v3/objects/feedback_submissions: + get: + tags: + - Feedback Submissions API > Basic + summary: List + description: >- + Read a page of feedback submissions. Control what is returned via the + `properties` query param. + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: limit + in: query + schema: + type: integer + description: The maximum number of results to display per page. + example: '10' + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + deserunt68: <string> + cillum_e: <string> + id_1: <string> + updatedAt: <dateTime> + propertiesWithHistory: + mollit55: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + esse2ba: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + deserunt0d7: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + Excepteur1: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + fugiat_0cc: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + - createdAt: <dateTime> + id: <string> + properties: + ipsum_f23: <string> + updatedAt: <dateTime> + propertiesWithHistory: + do8f6: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + minim_ae: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + veniam6: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "laboris_0": [ + "<string>", + "<string>" + ], + "aliqua_0": [ + "<string>", + "<string>" + ], + "cupidatat_7": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "nostrud_95": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "exercitation_3": [ + "<string>", + "<string>" + ], + "deseruntb_": [ + "<string>", + "<string>" + ], + "do_": [ + "<string>", + "<string>" + ] + }, + "links": { + "nulla_6": "<string>", + "veniam_f": "<string>", + "Ut9": "<string>" + } + } + post: + tags: + - Feedback Submissions API > Basic + summary: Create + description: >- + Create a feedback submission with the given properties and return a copy + of the object, including the ID. Documentation and examples for creating + standard feedback submissions is provided. + requestBody: + content: + application/json: + schema: + type: object + example: + associations: + - to: + id: <string> + types: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + properties: + in_0: <string> + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + Lorem_a5: <string> + reprehenderite46: <string> + ex_235: <string> + eiusmod_bfa: <string> + updatedAt: <dateTime> + propertiesWithHistory: + dolore_f7e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + mollit_0: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "laboris_0": [ + "<string>", + "<string>" + ], + "aliqua_0": [ + "<string>", + "<string>" + ], + "cupidatat_7": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "nostrud_95": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "exercitation_3": [ + "<string>", + "<string>" + ], + "deseruntb_": [ + "<string>", + "<string>" + ], + "do_": [ + "<string>", + "<string>" + ] + }, + "links": { + "nulla_6": "<string>", + "veniam_f": "<string>", + "Ut9": "<string>" + } + } + /crm/v3/objects/feedback_submissions/search: + post: + tags: + - Feedback Submissions API > Search + summary: post-/crm/v3/objects/feedback submissions/search do Search + requestBody: + content: {} + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + aliquipa7: <string> + updatedAt: <dateTime> + propertiesWithHistory: + Ut_4c_: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + in_a: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + dolore_71: <string> + updatedAt: <dateTime> + propertiesWithHistory: + incididunt_93: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + amet_d52: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "laboris_0": [ + "<string>", + "<string>" + ], + "aliqua_0": [ + "<string>", + "<string>" + ], + "cupidatat_7": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "nostrud_95": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "exercitation_3": [ + "<string>", + "<string>" + ], + "deseruntb_": [ + "<string>", + "<string>" + ], + "do_": [ + "<string>", + "<string>" + ] + }, + "links": { + "nulla_6": "<string>", + "veniam_f": "<string>", + "Ut9": "<string>" + } + } + /crm/v3/objects/fees/batch/create: + post: + tags: + - Fees API > Batch + summary: Create a batch of fees + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - associations: + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + properties: + Duis_e: <string> + aliquip_d: <string> + - associations: + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + properties: + eu_7: <string> + sed_8: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + utf: <string> + elit_68: <string> + uta: <string> + updatedAt: <dateTime> + propertiesWithHistory: + deserunt_f04: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + ide7_: <string> + updatedAt: <dateTime> + propertiesWithHistory: + dolor_f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + cillum_1: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PROCESSING + requestedAt: <dateTime> + links: + officia6: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + nostrudab: <string> + deserunt0c6: <string> + sunt_c05: <string> + updatedAt: <dateTime> + propertiesWithHistory: + eiusmod_f4_: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + aliqua_6: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + nulla_e7: <string> + esse1: <string> + updatedAt: <dateTime> + propertiesWithHistory: + exercitationd: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + sed_f7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PROCESSING + numErrors: <integer> + errors: + - category: <string> + context: + aliqua_3ce: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + anim_689: + - <string> + - <string> + amet_4: + - <string> + - <string> + dolore_929: + - <string> + - <string> + cillumcc: + - <string> + - <string> + ea_08: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + nisi22e: + - <string> + - <string> + links: + incididunte48: <string> + nulla2b0: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + enim_3: + - <string> + - <string> + id9: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + mollit1: + - <string> + - <string> + nisi53c: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + mollit6cf: + - <string> + - <string> + aute9e4: + - <string> + - <string> + links: + ea__4_: <string> + deserunt1e: <string> + mollita: <string> + cillum_1f: <string> + laboris2: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + aliquip_c: <string> + nisi_0d: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ea_37": [ + "<string>", + "<string>" + ], + "amet_22": [ + "<string>", + "<string>" + ], + "incididunt8": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "eiusmod_80": [ + "<string>", + "<string>" + ], + "nonf": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "laborumd0": [ + "<string>", + "<string>" + ] + }, + "links": { + "laboris_8": "<string>", + "do8_": "<string>" + } + } + /crm/v3/objects/fees/batch/update: + post: + tags: + - Fees API > Batch + summary: Update a batch of fees + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + properties: + occaecat50: <string> + velita: <string> + eiusmod93: <string> + - id: <string> + properties: + idc: <string> + exercitation7bc: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + utf: <string> + elit_68: <string> + uta: <string> + updatedAt: <dateTime> + propertiesWithHistory: + deserunt_f04: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + ide7_: <string> + updatedAt: <dateTime> + propertiesWithHistory: + dolor_f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + cillum_1: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PROCESSING + requestedAt: <dateTime> + links: + officia6: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + nostrudab: <string> + deserunt0c6: <string> + sunt_c05: <string> + updatedAt: <dateTime> + propertiesWithHistory: + eiusmod_f4_: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + aliqua_6: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + nulla_e7: <string> + esse1: <string> + updatedAt: <dateTime> + propertiesWithHistory: + exercitationd: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + sed_f7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PROCESSING + numErrors: <integer> + errors: + - category: <string> + context: + aliqua_3ce: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + anim_689: + - <string> + - <string> + amet_4: + - <string> + - <string> + dolore_929: + - <string> + - <string> + cillumcc: + - <string> + - <string> + ea_08: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + nisi22e: + - <string> + - <string> + links: + incididunte48: <string> + nulla2b0: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + enim_3: + - <string> + - <string> + id9: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + mollit1: + - <string> + - <string> + nisi53c: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + mollit6cf: + - <string> + - <string> + aute9e4: + - <string> + - <string> + links: + ea__4_: <string> + deserunt1e: <string> + mollita: <string> + cillum_1f: <string> + laboris2: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + aliquip_c: <string> + nisi_0d: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ea_37": [ + "<string>", + "<string>" + ], + "amet_22": [ + "<string>", + "<string>" + ], + "incididunt8": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "eiusmod_80": [ + "<string>", + "<string>" + ], + "nonf": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "laborumd0": [ + "<string>", + "<string>" + ] + }, + "links": { + "laboris_8": "<string>", + "do8_": "<string>" + } + } + /crm/v3/objects/fees/batch/archive: + post: + tags: + - Fees API > Batch + summary: Archive a batch of fees by ID + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ea_37": [ + "<string>", + "<string>" + ], + "amet_22": [ + "<string>", + "<string>" + ], + "incididunt8": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "eiusmod_80": [ + "<string>", + "<string>" + ], + "nonf": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "laborumd0": [ + "<string>", + "<string>" + ] + }, + "links": { + "laboris_8": "<string>", + "do8_": "<string>" + } + } + /crm/v3/objects/fees/batch/read: + post: + tags: + - Fees API > Batch + summary: Read a batch of fees by internal ID, or unique property values + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + properties: + - <string> + - <string> + propertiesWithHistory: + - <string> + - <string> + idProperty: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + utf: <string> + elit_68: <string> + uta: <string> + updatedAt: <dateTime> + propertiesWithHistory: + deserunt_f04: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + ide7_: <string> + updatedAt: <dateTime> + propertiesWithHistory: + dolor_f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + cillum_1: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PROCESSING + requestedAt: <dateTime> + links: + officia6: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + nostrudab: <string> + deserunt0c6: <string> + sunt_c05: <string> + updatedAt: <dateTime> + propertiesWithHistory: + eiusmod_f4_: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + aliqua_6: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + nulla_e7: <string> + esse1: <string> + updatedAt: <dateTime> + propertiesWithHistory: + exercitationd: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + sed_f7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PROCESSING + numErrors: <integer> + errors: + - category: <string> + context: + aliqua_3ce: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + anim_689: + - <string> + - <string> + amet_4: + - <string> + - <string> + dolore_929: + - <string> + - <string> + cillumcc: + - <string> + - <string> + ea_08: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + nisi22e: + - <string> + - <string> + links: + incididunte48: <string> + nulla2b0: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + enim_3: + - <string> + - <string> + id9: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + mollit1: + - <string> + - <string> + nisi53c: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + mollit6cf: + - <string> + - <string> + aute9e4: + - <string> + - <string> + links: + ea__4_: <string> + deserunt1e: <string> + mollita: <string> + cillum_1f: <string> + laboris2: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + aliquip_c: <string> + nisi_0d: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ea_37": [ + "<string>", + "<string>" + ], + "amet_22": [ + "<string>", + "<string>" + ], + "incididunt8": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "eiusmod_80": [ + "<string>", + "<string>" + ], + "nonf": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "laborumd0": [ + "<string>", + "<string>" + ] + }, + "links": { + "laboris_8": "<string>", + "do8_": "<string>" + } + } + /crm/v3/objects/fees/{feeId}: + get: + tags: + - Fees API > Basic + summary: Read + description: >- + Read an Object identified by `{feeId}`. `{feeId}` refers to the internal + object ID by default, or optionally any unique property value as + specified by the `idProperty` query param. Control what is returned via + the `properties` query param. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: feeId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + anim51: <string> + quis60: <string> + updatedAt: <dateTime> + propertiesWithHistory: + sint_907: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + adipisicing687: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + Excepteur9: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + reprehenderit02: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + proident_a24: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + Duis_c: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + aliqua_41: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ea_37": [ + "<string>", + "<string>" + ], + "amet_22": [ + "<string>", + "<string>" + ], + "incididunt8": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "eiusmod_80": [ + "<string>", + "<string>" + ], + "nonf": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "laborumd0": [ + "<string>", + "<string>" + ] + }, + "links": { + "laboris_8": "<string>", + "do8_": "<string>" + } + } + delete: + tags: + - Fees API > Basic + summary: Archive + description: Move an Object identified by `{feeId}` to the recycling bin. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: feeId + in: path + schema: + type: string + required: true + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ea_37": [ + "<string>", + "<string>" + ], + "amet_22": [ + "<string>", + "<string>" + ], + "incididunt8": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "eiusmod_80": [ + "<string>", + "<string>" + ], + "nonf": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "laborumd0": [ + "<string>", + "<string>" + ] + }, + "links": { + "laboris_8": "<string>", + "do8_": "<string>" + } + } + patch: + tags: + - Fees API > Basic + summary: Update + description: >- + Perform a partial update of an Object identified by `{feeId}`. `{feeId}` + refers to the internal object ID by default, or optionally any unique + property value as specified by the `idProperty` query param. Provided + property values will be overwritten. Read-only and non-existent + properties will be ignored. Properties values can be cleared by passing + an empty string. + requestBody: + content: + application/json: + schema: + type: object + example: + properties: + exercitation2: <string> + officiaa9: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: feeId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + qui8b0: <string> + ind: <string> + laboris__de: <string> + updatedAt: <dateTime> + propertiesWithHistory: + ullamco_a: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + irure__: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ea_37": [ + "<string>", + "<string>" + ], + "amet_22": [ + "<string>", + "<string>" + ], + "incididunt8": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "eiusmod_80": [ + "<string>", + "<string>" + ], + "nonf": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "laborumd0": [ + "<string>", + "<string>" + ] + }, + "links": { + "laboris_8": "<string>", + "do8_": "<string>" + } + } + /crm/v3/objects/fees: + get: + tags: + - Fees API > Basic + summary: List + description: >- + Read a page of fees. Control what is returned via the `properties` query + param. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: limit + in: query + schema: + type: integer + description: The maximum number of results to display per page. + example: '10' + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + proident5: <string> + updatedAt: <dateTime> + propertiesWithHistory: + proidentd0: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + incididunt_99: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + adipisicing_a_: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + - createdAt: <dateTime> + id: <string> + properties: + quis_: <string> + updatedAt: <dateTime> + propertiesWithHistory: + euc: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + ullamco1: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + incididunt1: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + elitbcc: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + commodo2: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ea_37": [ + "<string>", + "<string>" + ], + "amet_22": [ + "<string>", + "<string>" + ], + "incididunt8": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "eiusmod_80": [ + "<string>", + "<string>" + ], + "nonf": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "laborumd0": [ + "<string>", + "<string>" + ] + }, + "links": { + "laboris_8": "<string>", + "do8_": "<string>" + } + } + post: + tags: + - Fees API > Basic + summary: Create + description: >- + Create a fee with the given properties and return a copy of the object, + including the ID. Documentation and examples for creating standard fees + is provided. + requestBody: + content: + application/json: + schema: + type: object + example: + associations: + - to: + id: <string> + types: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + properties: + veniamb: <string> + voluptate_4: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + qui8b0: <string> + ind: <string> + laboris__de: <string> + updatedAt: <dateTime> + propertiesWithHistory: + ullamco_a: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + irure__: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ea_37": [ + "<string>", + "<string>" + ], + "amet_22": [ + "<string>", + "<string>" + ], + "incididunt8": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "eiusmod_80": [ + "<string>", + "<string>" + ], + "nonf": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "laborumd0": [ + "<string>", + "<string>" + ] + }, + "links": { + "laboris_8": "<string>", + "do8_": "<string>" + } + } + /crm/v3/objects/fees/merge: + post: + tags: + - Fees API > Public_Object + summary: Merge two fees with same type + requestBody: + content: + application/json: + schema: + type: object + example: + objectIdToMerge: <string> + primaryObjectId: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + qui8b0: <string> + ind: <string> + laboris__de: <string> + updatedAt: <dateTime> + propertiesWithHistory: + ullamco_a: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + irure__: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ea_37": [ + "<string>", + "<string>" + ], + "amet_22": [ + "<string>", + "<string>" + ], + "incididunt8": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "eiusmod_80": [ + "<string>", + "<string>" + ], + "nonf": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "laborumd0": [ + "<string>", + "<string>" + ] + }, + "links": { + "laboris_8": "<string>", + "do8_": "<string>" + } + } + /crm/v3/objects/fees/gdpr-delete: + post: + tags: + - Fees API > GDPR + summary: GDPR DELETE + description: >- + Permanently delete a contact and all associated content to follow GDPR. + Use optional property 'idProperty' set to 'email' to identify contact by + email address. If email address is not found, the email address will be + added to a blocklist and prevent it from being used in the future. + requestBody: + content: + application/json: + schema: + type: object + example: + objectId: <string> + idProperty: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ea_37": [ + "<string>", + "<string>" + ], + "amet_22": [ + "<string>", + "<string>" + ], + "incididunt8": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "eiusmod_80": [ + "<string>", + "<string>" + ], + "nonf": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "laborumd0": [ + "<string>", + "<string>" + ] + }, + "links": { + "laboris_8": "<string>", + "do8_": "<string>" + } + } + /crm/v3/objects/fees/search: + post: + tags: + - Fees API > Search + summary: post-/crm/v3/objects/fees/search + requestBody: + content: + application/json: + schema: + type: object + example: + after: <integer> + filterGroups: + - filters: + - operator: IN + propertyName: <string> + value: <string> + highValue: <string> + values: + - <string> + - <string> + - operator: IN + propertyName: <string> + value: <string> + highValue: <string> + values: + - <string> + - <string> + - filters: + - operator: LT + propertyName: <string> + value: <string> + highValue: <string> + values: + - <string> + - <string> + - operator: NEQ + propertyName: <string> + value: <string> + highValue: <string> + values: + - <string> + - <string> + limit: <integer> + properties: + - <string> + - <string> + sorts: + - <string> + - <string> + query: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + amet0: <string> + updatedAt: <dateTime> + propertiesWithHistory: + occaecat_748: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + fugiat_54: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + ut6: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + sunt_8: <string> + dolor_46: <string> + ea_cd: <string> + updatedAt: <dateTime> + propertiesWithHistory: + do__01: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + ex_e3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + occaecat_7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + veniam_c: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ea_37": [ + "<string>", + "<string>" + ], + "amet_22": [ + "<string>", + "<string>" + ], + "incididunt8": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "eiusmod_80": [ + "<string>", + "<string>" + ], + "nonf": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "laborumd0": [ + "<string>", + "<string>" + ] + }, + "links": { + "laboris_8": "<string>", + "do8_": "<string>" + } + } + /crm/v3/objects/goal_targets/batch/read: + post: + tags: + - Goals API > Batch + summary: Read a batch of goal targets by internal ID, or unique property values + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + properties: + - <string> + - <string> + propertiesWithHistory: + - <string> + - <string> + idProperty: <string> + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + sed_3: <string> + updatedAt: <dateTime> + propertiesWithHistory: + nulla_b: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + amet7ac: <string> + updatedAt: <dateTime> + propertiesWithHistory: + nisi2: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + et82: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PROCESSING + requestedAt: <dateTime> + links: + mollita7_: <string> + id_3ac: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + aliquip_a: <string> + dolor_45: <string> + updatedAt: <dateTime> + propertiesWithHistory: + exercitation_9: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + utb9b: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + exf3: <string> + updatedAt: <dateTime> + propertiesWithHistory: + magna_4d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + sint_79: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PROCESSING + numErrors: <integer> + errors: + - category: <string> + context: + anim_9: + - <string> + - <string> + est5: + - <string> + - <string> + eu_877: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + magnab_: + - <string> + - <string> + velit97_: + - <string> + - <string> + consecteturb_4: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + Duis25e: + - <string> + - <string> + links: + consequat6c2: <string> + in964: <string> + magna_8: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + deseruntd8: + - <string> + - <string> + doloreed3: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + pariatur_61: + - <string> + - <string> + laboris_5a: + - <string> + - <string> + officia_cc: + - <string> + - <string> + deserunt_f0: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + elit_c6: + - <string> + - <string> + dolor_e: + - <string> + - <string> + Lorem_e1: + - <string> + - <string> + links: + doa: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + enim633: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "officia__5": [ + "<string>", + "<string>" + ], + "veniam32f": [ + "<string>", + "<string>" + ], + "aute_54": [ + "<string>", + "<string>" + ], + "sed_485": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "labore__11": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "Lorem986": [ + "<string>", + "<string>" + ], + "ut_ca": [ + "<string>", + "<string>" + ], + "dolore_3c": [ + "<string>", + "<string>" + ], + "Lorem_94a": [ + "<string>", + "<string>" + ] + }, + "links": { + "quisb": "<string>", + "veniam_25": "<string>", + "esse_bb": "<string>" + } + } + /crm/v3/objects/goal_targets/{goalTargetId}: + get: + tags: + - Goals API > Basic + summary: Read + description: >- + Read an Object identified by `{goalTargetId}`. `{goalTargetId}` refers + to the internal object ID by default, or optionally any unique property + value as specified by the `idProperty` query param. Control what is + returned via the `properties` query param. + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: goalTargetId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + Duis2: <string> + updatedAt: <dateTime> + propertiesWithHistory: + exercitation72d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + culpa_60: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + Lorem_6: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + minim__2: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "officia__5": [ + "<string>", + "<string>" + ], + "veniam32f": [ + "<string>", + "<string>" + ], + "aute_54": [ + "<string>", + "<string>" + ], + "sed_485": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "labore__11": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "Lorem986": [ + "<string>", + "<string>" + ], + "ut_ca": [ + "<string>", + "<string>" + ], + "dolore_3c": [ + "<string>", + "<string>" + ], + "Lorem_94a": [ + "<string>", + "<string>" + ] + }, + "links": { + "quisb": "<string>", + "veniam_25": "<string>", + "esse_bb": "<string>" + } + } + /crm/v3/objects/goal_targets: + get: + tags: + - Goals API > Basic + summary: List + description: >- + Read a page of goal targets. Control what is returned via the + `properties` query param. + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: limit + in: query + schema: + type: integer + description: The maximum number of results to display per page. + example: '10' + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + mollit3b: <string> + updatedAt: <dateTime> + propertiesWithHistory: + in4e2: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + mollit534: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + - createdAt: <dateTime> + id: <string> + properties: + officiada: <string> + consequat6a_: <string> + updatedAt: <dateTime> + propertiesWithHistory: + ad_c92: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + nostrud48f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + esse_51: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + quis_fa: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + aliquip_0: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "officia__5": [ + "<string>", + "<string>" + ], + "veniam32f": [ + "<string>", + "<string>" + ], + "aute_54": [ + "<string>", + "<string>" + ], + "sed_485": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "labore__11": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "Lorem986": [ + "<string>", + "<string>" + ], + "ut_ca": [ + "<string>", + "<string>" + ], + "dolore_3c": [ + "<string>", + "<string>" + ], + "Lorem_94a": [ + "<string>", + "<string>" + ] + }, + "links": { + "quisb": "<string>", + "veniam_25": "<string>", + "esse_bb": "<string>" + } + } + /crm/v3/objects/goal_targets/search: + post: + tags: + - Goals API > Search + summary: post-/crm/v3/objects/goal targets/search do Search + requestBody: + content: {} + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + enim_7: <string> + laborum__d_: <string> + euf: <string> + updatedAt: <dateTime> + propertiesWithHistory: + sint21: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + et_ad7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + reprehenderit_2: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + incididunt_1d: <string> + updatedAt: <dateTime> + propertiesWithHistory: + dolor4df: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + exercitation_9: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + ad08a: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "officia__5": [ + "<string>", + "<string>" + ], + "veniam32f": [ + "<string>", + "<string>" + ], + "aute_54": [ + "<string>", + "<string>" + ], + "sed_485": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "labore__11": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "Lorem986": [ + "<string>", + "<string>" + ], + "ut_ca": [ + "<string>", + "<string>" + ], + "dolore_3c": [ + "<string>", + "<string>" + ], + "Lorem_94a": [ + "<string>", + "<string>" + ] + }, + "links": { + "quisb": "<string>", + "veniam_25": "<string>", + "esse_bb": "<string>" + } + } + /crm/v3/imports/{importId}: + get: + tags: + - Imports API > Core + summary: Get the information on any import + description: A complete summary of an import record, including any updates. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: importId + in: path + schema: + type: string + required: true + example: <long> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + metadata: + counters: + elit5_8: <integer> + officia_5: <integer> + fugiat_1: <integer> + fileIds: + - <string> + - <string> + objectLists: + - listId: <string> + objectType: <string> + - listId: <string> + objectType: <string> + optOutImport: <boolean> + state: CANCELED + updatedAt: <dateTime> + importTemplate: + templateId: <integer> + templateType: admin_defined + importRequestJson: {} + importSource: MOBILE_IOS + importName: <string> + mappedObjectTypeIds: + - <string> + - <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "in636": [ + "<string>", + "<string>" + ], + "ad_177": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "Lorem_57c": [ + "<string>", + "<string>" + ], + "consequatc5": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "et_e": [ + "<string>", + "<string>" + ], + "dolor_423": [ + "<string>", + "<string>" + ], + "voluptate4": [ + "<string>", + "<string>" + ] + }, + "links": { + "eu072": "<string>", + "esse38": "<string>" + } + } + /crm/v3/imports/{importId}/cancel: + post: + tags: + - Imports API > Core + summary: Cancel an active import + description: This allows a developer to cancel an active import. + requestBody: + content: {} + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: importId + in: path + schema: + type: string + required: true + example: <long> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + startedAt: <dateTime> + status: COMPLETE + requestedAt: <dateTime> + links: + veniam___e: <string> + Excepteur_0: <string> + Duis9: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "in636": [ + "<string>", + "<string>" + ], + "ad_177": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "Lorem_57c": [ + "<string>", + "<string>" + ], + "consequatc5": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "et_e": [ + "<string>", + "<string>" + ], + "dolor_423": [ + "<string>", + "<string>" + ], + "voluptate4": [ + "<string>", + "<string>" + ] + }, + "links": { + "eu072": "<string>", + "esse38": "<string>" + } + } + /crm/v3/imports/: + get: + tags: + - Imports API > Core + summary: Get active imports + description: Returns a paged list of active imports for this account. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: before + in: query + schema: + type: string + example: <string> + - name: limit + in: query + schema: + type: string + description: The maximum number of results to display per page. + example: <integer> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + metadata: + counters: + adipisicing_72f: <integer> + cupidatat_70: <integer> + fileIds: + - <string> + - <string> + objectLists: + - listId: <string> + objectType: <string> + - listId: <string> + objectType: <string> + optOutImport: <boolean> + state: CANCELED + updatedAt: <dateTime> + importTemplate: + templateId: <integer> + templateType: user_file + importRequestJson: {} + importSource: MOBILE_IOS + importName: <string> + mappedObjectTypeIds: + - <string> + - <string> + - createdAt: <dateTime> + id: <string> + metadata: + counters: + veniamcc: <integer> + fileIds: + - <string> + - <string> + objectLists: + - listId: <string> + objectType: <string> + - listId: <string> + objectType: <string> + optOutImport: <boolean> + state: DEFERRED + updatedAt: <dateTime> + importTemplate: + templateId: <integer> + templateType: previous_import + importRequestJson: {} + importSource: MOBILE_ANDROID + importName: <string> + mappedObjectTypeIds: + - <string> + - <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "in636": [ + "<string>", + "<string>" + ], + "ad_177": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "Lorem_57c": [ + "<string>", + "<string>" + ], + "consequatc5": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "et_e": [ + "<string>", + "<string>" + ], + "dolor_423": [ + "<string>", + "<string>" + ], + "voluptate4": [ + "<string>", + "<string>" + ] + }, + "links": { + "eu072": "<string>", + "esse38": "<string>" + } + } + post: + tags: + - Imports API > Core + summary: Start a new import + description: >- + Begins importing data from the specified file resources. This uploads + the corresponding file and uses the import request object to convert + rows in the files to objects. + requestBody: + content: + multipart/form-data: + schema: + type: object + properties: + files: + type: string + description: A list of files containing the data to import + example: <string> + importRequest: + type: string + description: >- + JSON formatted metadata about the import. This includes a + name for the import and the column mappings for each file. + See the overview tab for more on the required format. + example: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: multipart/form-data + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + metadata: + counters: + elit5_8: <integer> + officia_5: <integer> + fugiat_1: <integer> + fileIds: + - <string> + - <string> + objectLists: + - listId: <string> + objectType: <string> + - listId: <string> + objectType: <string> + optOutImport: <boolean> + state: CANCELED + updatedAt: <dateTime> + importTemplate: + templateId: <integer> + templateType: admin_defined + importRequestJson: {} + importSource: MOBILE_IOS + importName: <string> + mappedObjectTypeIds: + - <string> + - <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "in636": [ + "<string>", + "<string>" + ], + "ad_177": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "Lorem_57c": [ + "<string>", + "<string>" + ], + "consequatc5": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "et_e": [ + "<string>", + "<string>" + ], + "dolor_423": [ + "<string>", + "<string>" + ], + "voluptate4": [ + "<string>", + "<string>" + ] + }, + "links": { + "eu072": "<string>", + "esse38": "<string>" + } + } + /crm/v3/imports/{importId}/errors: + get: + tags: + - Imports API > Public_Imports + summary: get-/crm/v3/imports/{import Id}/errors get Errors + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: limit + in: query + schema: + type: string + description: The maximum number of results to display per page. + example: <integer> + - name: includeErrorMessage + in: query + schema: + type: string + description: Set to True to receive a message explaining the error. + example: <boolean> + - name: includeRowData + in: query + schema: + type: string + description: Set to True to receive the data values for the errored row. + example: <boolean> + - name: importId + in: path + schema: + type: string + required: true + example: <long> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <integer> + errorType: MISSING_EVENT_DEFINITION + id: <string> + sourceData: + fileId: <integer> + lineNumber: <integer> + rowData: + - <string> + - <string> + pageName: <string> + containsEncryptedProperties: <boolean> + objectType: MARKETING_EVENT + invalidValue: <string> + extraContext: <string> + objectTypeId: <string> + knownColumnNumber: <integer> + - createdAt: <integer> + errorType: CREATE_ONLY_IMPORT + id: <string> + sourceData: + fileId: <integer> + lineNumber: <integer> + rowData: + - <string> + - <string> + pageName: <string> + containsEncryptedProperties: <boolean> + objectType: PUBLISHING_TASK + invalidValue: <string> + extraContext: <string> + objectTypeId: <string> + knownColumnNumber: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "in636": [ + "<string>", + "<string>" + ], + "ad_177": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "Lorem_57c": [ + "<string>", + "<string>" + ], + "consequatc5": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "et_e": [ + "<string>", + "<string>" + ], + "dolor_423": [ + "<string>", + "<string>" + ], + "voluptate4": [ + "<string>", + "<string>" + ] + }, + "links": { + "eu072": "<string>", + "esse38": "<string>" + } + } + /crm/v3/objects/leads/batch/read: + post: + tags: + - Leads API > Batch + summary: Read a batch of leads by internal ID, or unique property values + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + properties: + - <string> + - <string> + propertiesWithHistory: + - <string> + - <string> + idProperty: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + voluptate_9af: <string> + et_3: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + exercitation01: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + aute_be5: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + Ute: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + esse_ac6: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + sint_31: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + startedAt: <dateTime> + status: COMPLETE + requestedAt: <dateTime> + links: + dolore40: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + ex_5_: <string> + eu_7b: <string> + adipisicing__8: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + Duis_a8c: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + dolorb: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + aute_2f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + in_c: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + startedAt: <dateTime> + status: PROCESSING + numErrors: <integer> + requestedAt: <dateTime> + links: + et71: <string> + deserunt_4b: <string> + errors: + - category: <string> + context: + sint_e_: + - <string> + - <string> + idc47: + - <string> + - <string> + laborec2a: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + cillum_ca: + - <string> + - <string> + incididuntc1f: + - <string> + - <string> + eiusmode6: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + voluptate4a: + - <string> + - <string> + links: + dolor_fdb: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + - category: <string> + context: + irure_fc: + - <string> + - <string> + amet_: + - <string> + - <string> + consectetur_7: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + pariature26: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + enim4: + - <string> + - <string> + nisi_9: + - <string> + - <string> + links: + pariatur4: <string> + culpa_fc: <string> + amet_99a: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ut_d": [ + "<string>", + "<string>" + ], + "elit_5": [ + "<string>", + "<string>" + ] + }, + "links": { + "Ut4": "<string>", + "mollit23": "<string>", + "cupidatatf43": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "commodo0": [ + "<string>", + "<string>" + ], + "adipisicing_9e": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "sunt_": [ + "<string>", + "<string>" + ], + "aliquip_0": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/leads/batch/archive: + post: + tags: + - Leads API > Batch + summary: Archive a batch of leads by ID + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ut_d": [ + "<string>", + "<string>" + ], + "elit_5": [ + "<string>", + "<string>" + ] + }, + "links": { + "Ut4": "<string>", + "mollit23": "<string>", + "cupidatatf43": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "commodo0": [ + "<string>", + "<string>" + ], + "adipisicing_9e": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "sunt_": [ + "<string>", + "<string>" + ], + "aliquip_0": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/leads/batch/create: + post: + tags: + - Leads API > Batch + summary: Create a batch of leads + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - associations: + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + properties: + officia_6: <string> + - associations: + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + properties: + deserunt_1: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + voluptate_9af: <string> + et_3: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + exercitation01: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + aute_be5: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + Ute: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + esse_ac6: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + sint_31: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + startedAt: <dateTime> + status: COMPLETE + requestedAt: <dateTime> + links: + dolore40: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + ex_5_: <string> + eu_7b: <string> + adipisicing__8: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + Duis_a8c: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + dolorb: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + aute_2f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + in_c: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + startedAt: <dateTime> + status: PROCESSING + numErrors: <integer> + requestedAt: <dateTime> + links: + et71: <string> + deserunt_4b: <string> + errors: + - category: <string> + context: + sint_e_: + - <string> + - <string> + idc47: + - <string> + - <string> + laborec2a: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + cillum_ca: + - <string> + - <string> + incididuntc1f: + - <string> + - <string> + eiusmode6: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + voluptate4a: + - <string> + - <string> + links: + dolor_fdb: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + - category: <string> + context: + irure_fc: + - <string> + - <string> + amet_: + - <string> + - <string> + consectetur_7: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + pariature26: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + enim4: + - <string> + - <string> + nisi_9: + - <string> + - <string> + links: + pariatur4: <string> + culpa_fc: <string> + amet_99a: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ut_d": [ + "<string>", + "<string>" + ], + "elit_5": [ + "<string>", + "<string>" + ] + }, + "links": { + "Ut4": "<string>", + "mollit23": "<string>", + "cupidatatf43": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "commodo0": [ + "<string>", + "<string>" + ], + "adipisicing_9e": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "sunt_": [ + "<string>", + "<string>" + ], + "aliquip_0": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/leads/batch/update: + post: + tags: + - Leads API > Batch + summary: Update a batch of leads + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + properties: + id__a: <string> + eu3: <string> + dolor417: <string> + idProperty: <string> + - id: <string> + properties: + Excepteur_3e: <string> + idProperty: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + voluptate_9af: <string> + et_3: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + exercitation01: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + aute_be5: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + Ute: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + esse_ac6: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + sint_31: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + startedAt: <dateTime> + status: COMPLETE + requestedAt: <dateTime> + links: + dolore40: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + ex_5_: <string> + eu_7b: <string> + adipisicing__8: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + Duis_a8c: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + dolorb: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + aute_2f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + in_c: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + startedAt: <dateTime> + status: PROCESSING + numErrors: <integer> + requestedAt: <dateTime> + links: + et71: <string> + deserunt_4b: <string> + errors: + - category: <string> + context: + sint_e_: + - <string> + - <string> + idc47: + - <string> + - <string> + laborec2a: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + cillum_ca: + - <string> + - <string> + incididuntc1f: + - <string> + - <string> + eiusmode6: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + voluptate4a: + - <string> + - <string> + links: + dolor_fdb: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + - category: <string> + context: + irure_fc: + - <string> + - <string> + amet_: + - <string> + - <string> + consectetur_7: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + pariature26: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + enim4: + - <string> + - <string> + nisi_9: + - <string> + - <string> + links: + pariatur4: <string> + culpa_fc: <string> + amet_99a: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ut_d": [ + "<string>", + "<string>" + ], + "elit_5": [ + "<string>", + "<string>" + ] + }, + "links": { + "Ut4": "<string>", + "mollit23": "<string>", + "cupidatatf43": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "commodo0": [ + "<string>", + "<string>" + ], + "adipisicing_9e": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "sunt_": [ + "<string>", + "<string>" + ], + "aliquip_0": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/leads/{leadsId}: + get: + tags: + - Leads API > Basic + summary: Read + description: >- + Read an Object identified by `{leadsId}`. `{leadsId}` refers to the + internal object ID by default, or optionally any unique property value + as specified by the `idProperty` query param. Control what is returned + via the `properties` query param. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: leadsId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + laborum_b25: <string> + ea_46b: <string> + updatedAt: <dateTime> + associations: + est1f2: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + sunte83: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + cupidatata1: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + culpa_3be: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + ute1: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ut_d": [ + "<string>", + "<string>" + ], + "elit_5": [ + "<string>", + "<string>" + ] + }, + "links": { + "Ut4": "<string>", + "mollit23": "<string>", + "cupidatatf43": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "commodo0": [ + "<string>", + "<string>" + ], + "adipisicing_9e": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "sunt_": [ + "<string>", + "<string>" + ], + "aliquip_0": [ + "<string>", + "<string>" + ] + } + } + ] + } + delete: + tags: + - Leads API > Basic + summary: Archive + description: Move an Object identified by `{leadsId}` to the recycling bin. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: leadsId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ut_d": [ + "<string>", + "<string>" + ], + "elit_5": [ + "<string>", + "<string>" + ] + }, + "links": { + "Ut4": "<string>", + "mollit23": "<string>", + "cupidatatf43": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "commodo0": [ + "<string>", + "<string>" + ], + "adipisicing_9e": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "sunt_": [ + "<string>", + "<string>" + ], + "aliquip_0": [ + "<string>", + "<string>" + ] + } + } + ] + } + patch: + tags: + - Leads API > Basic + summary: Update + description: >- + Perform a partial update of an Object identified by `{leadsId}`. + `{leadsId}` refers to the internal object ID by default, or optionally + any unique property value as specified by the `idProperty` query param. + Provided property values will be overwritten. Read-only and non-existent + properties will be ignored. Properties values can be cleared by passing + an empty string. + requestBody: + content: + application/json: + schema: + type: object + example: + properties: + sint_eb: <string> + voluptateb21: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: leadsId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + eac1: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + dolore_f7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ut_d": [ + "<string>", + "<string>" + ], + "elit_5": [ + "<string>", + "<string>" + ] + }, + "links": { + "Ut4": "<string>", + "mollit23": "<string>", + "cupidatatf43": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "commodo0": [ + "<string>", + "<string>" + ], + "adipisicing_9e": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "sunt_": [ + "<string>", + "<string>" + ], + "aliquip_0": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/leads: + get: + tags: + - Leads API > Basic + summary: List + description: >- + Read a page of leads. Control what is returned via the `properties` + query param. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: limit + in: query + schema: + type: integer + description: The maximum number of results to display per page. + example: '10' + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + laboris263: <string> + et_7a: <string> + laboris__: <string> + updatedAt: <dateTime> + associations: + laborum_30: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + voluptate_a: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + anim98: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + eu_17: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + aliqua_e8: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + velit_4d8: <string> + sunt__: <string> + updatedAt: <dateTime> + associations: + do3f: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + nostrud_0b: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + aute_dc0: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ut_d": [ + "<string>", + "<string>" + ], + "elit_5": [ + "<string>", + "<string>" + ] + }, + "links": { + "Ut4": "<string>", + "mollit23": "<string>", + "cupidatatf43": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "commodo0": [ + "<string>", + "<string>" + ], + "adipisicing_9e": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "sunt_": [ + "<string>", + "<string>" + ], + "aliquip_0": [ + "<string>", + "<string>" + ] + } + } + ] + } + post: + tags: + - Leads API > Basic + summary: Create + description: >- + Create a lead with the given properties and return a copy of the object, + including the ID. Documentation and examples for creating standard leads + is provided. + requestBody: + content: + application/json: + schema: + type: object + example: + associations: + - to: + id: <string> + types: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + properties: + reprehenderit_65f: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + eac1: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + dolore_f7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ut_d": [ + "<string>", + "<string>" + ], + "elit_5": [ + "<string>", + "<string>" + ] + }, + "links": { + "Ut4": "<string>", + "mollit23": "<string>", + "cupidatatf43": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "commodo0": [ + "<string>", + "<string>" + ], + "adipisicing_9e": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "sunt_": [ + "<string>", + "<string>" + ], + "aliquip_0": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/leads/search: + post: + tags: + - Leads API > Search + summary: post-/crm/v3/objects/leads/search + requestBody: + content: + application/json: + schema: + type: object + example: + after: <string> + filterGroups: + - filters: + - operator: LTE + propertyName: <string> + highValue: <string> + values: + - <string> + - <string> + value: <string> + - operator: BETWEEN + propertyName: <string> + highValue: <string> + values: + - <string> + - <string> + value: <string> + - filters: + - operator: GTE + propertyName: <string> + highValue: <string> + values: + - <string> + - <string> + value: <string> + - operator: NOT_IN + propertyName: <string> + highValue: <string> + values: + - <string> + - <string> + value: <string> + limit: <integer> + properties: + - <string> + - <string> + sorts: + - <string> + - <string> + query: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + culpa_df: <string> + tempor_30: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + exercitationaa: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + Ut7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + do_dd1: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + proidentc10: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + culpa_b: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + id_d9: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ut_d": [ + "<string>", + "<string>" + ], + "elit_5": [ + "<string>", + "<string>" + ] + }, + "links": { + "Ut4": "<string>", + "mollit23": "<string>", + "cupidatatf43": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "commodo0": [ + "<string>", + "<string>" + ], + "adipisicing_9e": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "sunt_": [ + "<string>", + "<string>" + ], + "aliquip_0": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/line_items/batch/create: + post: + tags: + - Line Items API > Batch + summary: Create a batch of line items + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - associations: + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + properties: + quisd: <string> + - associations: + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + properties: + tempor_d: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + est_9: <string> + updatedAt: <dateTime> + propertiesWithHistory: + ullamco7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + occaecat5: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + dolor_d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + exc: <string> + laborum4: <string> + in_86f: <string> + updatedAt: <dateTime> + propertiesWithHistory: + cupidatat_c: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PROCESSING + requestedAt: <dateTime> + links: + dolore_3: <string> + quis2: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + exb: <string> + updatedAt: <dateTime> + propertiesWithHistory: + aliqua_6: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + in_8fa: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + minim2be: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + eiusmod0f: <string> + proident_6: <string> + updatedAt: <dateTime> + propertiesWithHistory: + incididunt_6: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + dolore_8: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + ade3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PENDING + numErrors: <integer> + errors: + - category: <string> + context: + veniamd15: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + Excepteur_1: + - <string> + - <string> + Duis_a52: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + enim5d8: + - <string> + - <string> + Duis_e8: + - <string> + - <string> + links: + sint_cb0: <string> + irure_3: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + cupidatat6: + - <string> + - <string> + nostrud_83e: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + amet_7ba: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + esse98: + - <string> + - <string> + exercitation_7f5: + - <string> + - <string> + et_2_8: + - <string> + - <string> + links: + id170: <string> + in_96: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + non117: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "in_dd": [ + "<string>", + "<string>" + ], + "occaecat_810": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "reprehenderit_94d": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "nostrud_2": [ + "<string>", + "<string>" + ], + "sint_2b": [ + "<string>", + "<string>" + ] + }, + "links": { + "proident530": "<string>", + "occaecat_6": "<string>", + "ex_16": "<string>" + } + } + /crm/v3/objects/line_items/batch/update: + post: + tags: + - Line Items API > Batch + summary: Update a batch of line items by internal ID, or unique property values + requestBody: + content: {} + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + est_9: <string> + updatedAt: <dateTime> + propertiesWithHistory: + ullamco7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + occaecat5: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + dolor_d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + exc: <string> + laborum4: <string> + in_86f: <string> + updatedAt: <dateTime> + propertiesWithHistory: + cupidatat_c: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PROCESSING + requestedAt: <dateTime> + links: + dolore_3: <string> + quis2: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + exb: <string> + updatedAt: <dateTime> + propertiesWithHistory: + aliqua_6: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + in_8fa: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + minim2be: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + eiusmod0f: <string> + proident_6: <string> + updatedAt: <dateTime> + propertiesWithHistory: + incididunt_6: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + dolore_8: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + ade3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PENDING + numErrors: <integer> + errors: + - category: <string> + context: + veniamd15: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + Excepteur_1: + - <string> + - <string> + Duis_a52: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + enim5d8: + - <string> + - <string> + Duis_e8: + - <string> + - <string> + links: + sint_cb0: <string> + irure_3: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + cupidatat6: + - <string> + - <string> + nostrud_83e: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + amet_7ba: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + esse98: + - <string> + - <string> + exercitation_7f5: + - <string> + - <string> + et_2_8: + - <string> + - <string> + links: + id170: <string> + in_96: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + non117: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "in_dd": [ + "<string>", + "<string>" + ], + "occaecat_810": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "reprehenderit_94d": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "nostrud_2": [ + "<string>", + "<string>" + ], + "sint_2b": [ + "<string>", + "<string>" + ] + }, + "links": { + "proident530": "<string>", + "occaecat_6": "<string>", + "ex_16": "<string>" + } + } + /crm/v3/objects/line_items/batch/archive: + post: + tags: + - Line Items API > Batch + summary: Archive a batch of line items by ID + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "in_dd": [ + "<string>", + "<string>" + ], + "occaecat_810": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "reprehenderit_94d": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "nostrud_2": [ + "<string>", + "<string>" + ], + "sint_2b": [ + "<string>", + "<string>" + ] + }, + "links": { + "proident530": "<string>", + "occaecat_6": "<string>", + "ex_16": "<string>" + } + } + /crm/v3/objects/line_items/batch/read: + post: + tags: + - Line Items API > Batch + summary: Read a batch of line items by internal ID, or unique property values + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + properties: + - <string> + - <string> + propertiesWithHistory: + - <string> + - <string> + idProperty: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + est_9: <string> + updatedAt: <dateTime> + propertiesWithHistory: + ullamco7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + occaecat5: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + dolor_d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + exc: <string> + laborum4: <string> + in_86f: <string> + updatedAt: <dateTime> + propertiesWithHistory: + cupidatat_c: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PROCESSING + requestedAt: <dateTime> + links: + dolore_3: <string> + quis2: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + exb: <string> + updatedAt: <dateTime> + propertiesWithHistory: + aliqua_6: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + in_8fa: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + minim2be: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + eiusmod0f: <string> + proident_6: <string> + updatedAt: <dateTime> + propertiesWithHistory: + incididunt_6: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + dolore_8: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + ade3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PENDING + numErrors: <integer> + errors: + - category: <string> + context: + veniamd15: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + Excepteur_1: + - <string> + - <string> + Duis_a52: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + enim5d8: + - <string> + - <string> + Duis_e8: + - <string> + - <string> + links: + sint_cb0: <string> + irure_3: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + cupidatat6: + - <string> + - <string> + nostrud_83e: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + amet_7ba: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + esse98: + - <string> + - <string> + exercitation_7f5: + - <string> + - <string> + et_2_8: + - <string> + - <string> + links: + id170: <string> + in_96: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + non117: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "in_dd": [ + "<string>", + "<string>" + ], + "occaecat_810": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "reprehenderit_94d": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "nostrud_2": [ + "<string>", + "<string>" + ], + "sint_2b": [ + "<string>", + "<string>" + ] + }, + "links": { + "proident530": "<string>", + "occaecat_6": "<string>", + "ex_16": "<string>" + } + } + /crm/v3/objects/line_items: + get: + tags: + - Line Items API > Basic + summary: List + description: >- + Read a page of line items. Control what is returned via the `properties` + query param. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: limit + in: query + schema: + type: integer + description: The maximum number of results to display per page. + example: '10' + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + cupidatat_d6: <string> + et_6: <string> + updatedAt: <dateTime> + propertiesWithHistory: + nostrud_8: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + ea_a6: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + suntdb8: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + - createdAt: <dateTime> + id: <string> + properties: + est8b: <string> + updatedAt: <dateTime> + propertiesWithHistory: + exercitation_83: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + ad9: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + est729: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "in_dd": [ + "<string>", + "<string>" + ], + "occaecat_810": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "reprehenderit_94d": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "nostrud_2": [ + "<string>", + "<string>" + ], + "sint_2b": [ + "<string>", + "<string>" + ] + }, + "links": { + "proident530": "<string>", + "occaecat_6": "<string>", + "ex_16": "<string>" + } + } + post: + tags: + - Line Items API > Basic + summary: Create + description: >- + Create a line item with the given properties and return a copy of the + object, including the ID. Documentation and examples for creating + standard line items is provided. + requestBody: + content: + application/json: + schema: + type: object + example: + associations: + - to: + id: <string> + types: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + properties: + labore_9f7: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + velitd: <string> + updatedAt: <dateTime> + propertiesWithHistory: + ea5: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + est3b7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "in_dd": [ + "<string>", + "<string>" + ], + "occaecat_810": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "reprehenderit_94d": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "nostrud_2": [ + "<string>", + "<string>" + ], + "sint_2b": [ + "<string>", + "<string>" + ] + }, + "links": { + "proident530": "<string>", + "occaecat_6": "<string>", + "ex_16": "<string>" + } + } + /crm/v3/objects/line_items/{lineItemId}: + get: + tags: + - Line Items API > Basic + summary: Read + description: >- + Read an Object identified by `{lineItemId}`. `{lineItemId}` refers to + the internal object ID by default, or optionally any unique property + value as specified by the `idProperty` query param. Control what is + returned via the `properties` query param. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: lineItemId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + ipsum594: <string> + esta8: <string> + deserunta: <string> + minim27: <string> + incididunt_3c: <string> + updatedAt: <dateTime> + propertiesWithHistory: + idda_: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + pariatur_1: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + laboris_1: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + veniam_cd: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + aute_e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + non_: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + nostrud8: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "in_dd": [ + "<string>", + "<string>" + ], + "occaecat_810": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "reprehenderit_94d": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "nostrud_2": [ + "<string>", + "<string>" + ], + "sint_2b": [ + "<string>", + "<string>" + ] + }, + "links": { + "proident530": "<string>", + "occaecat_6": "<string>", + "ex_16": "<string>" + } + } + delete: + tags: + - Line Items API > Basic + summary: Archive + description: Move an Object identified by `{lineItemId}` to the recycling bin. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: lineItemId + in: path + schema: + type: string + required: true + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "in_dd": [ + "<string>", + "<string>" + ], + "occaecat_810": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "reprehenderit_94d": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "nostrud_2": [ + "<string>", + "<string>" + ], + "sint_2b": [ + "<string>", + "<string>" + ] + }, + "links": { + "proident530": "<string>", + "occaecat_6": "<string>", + "ex_16": "<string>" + } + } + patch: + tags: + - Line Items API > Basic + summary: Update + description: >- + Perform a partial update of an Object identified by `{lineItemId}`. + `{lineItemId}` refers to the internal object ID by default, or + optionally any unique property value as specified by the `idProperty` + query param. Provided property values will be overwritten. Read-only and + non-existent properties will be ignored. Properties values can be + cleared by passing an empty string. + requestBody: + content: + application/json: + schema: + type: object + example: + properties: + voluptate_7: <string> + adipisicing_f_: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: lineItemId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + velitd: <string> + updatedAt: <dateTime> + propertiesWithHistory: + ea5: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + est3b7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "in_dd": [ + "<string>", + "<string>" + ], + "occaecat_810": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "reprehenderit_94d": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "nostrud_2": [ + "<string>", + "<string>" + ], + "sint_2b": [ + "<string>", + "<string>" + ] + }, + "links": { + "proident530": "<string>", + "occaecat_6": "<string>", + "ex_16": "<string>" + } + } + /crm/v3/objects/line_items/search: + post: + tags: + - Line Items API > Search + summary: post-/crm/v3/objects/line items/search do Search + requestBody: + content: {} + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + dolor_9c: <string> + velit7a3: <string> + dolore_95: <string> + updatedAt: <dateTime> + propertiesWithHistory: + laboris5: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + tempor_e8: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + commodo_9f3: <string> + incididunt__8b: <string> + quid7: <string> + sed_ce: <string> + updatedAt: <dateTime> + propertiesWithHistory: + pariatur4: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "in_dd": [ + "<string>", + "<string>" + ], + "occaecat_810": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "reprehenderit_94d": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "nostrud_2": [ + "<string>", + "<string>" + ], + "sint_2b": [ + "<string>", + "<string>" + ] + }, + "links": { + "proident530": "<string>", + "occaecat_6": "<string>", + "ex_16": "<string>" + } + } + /crm/v3/lists/{listId}/memberships/add-and-remove: + put: + tags: + - Lists API > Memberships + summary: Add and/or Remove Records from a List + description: >- + Add and/or remove records that have already been created in the system + to and/or from a list. + + + This endpoint only works for lists that have a `processingType` of + `MANUAL` or `SNAPSHOT`. + requestBody: + content: + application/json: + schema: + type: object + example: + recordIdsToAdd: + - <long> + - <long> + recordIdsToRemove: + - <long> + - <long> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: listId + in: path + schema: + type: string + required: true + example: <integer> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + recordIdsMissing: + - <long> + - <long> + recordIdsRemoved: + - <long> + - <long> + recordsIdsAdded: + - <long> + - <long> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "aliqua_ee": [ + "<string>", + "<string>" + ], + "eu_45": [ + "<string>", + "<string>" + ], + "proident_8": [ + "<string>", + "<string>" + ] + }, + "links": { + "ipsum_d": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "elit__3a": [ + "<string>", + "<string>" + ], + "reprehenderitbb4": [ + "<string>", + "<string>" + ], + "ipsumc": [ + "<string>", + "<string>" + ], + "eu__3a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "cupidatate6": [ + "<string>", + "<string>" + ], + "veniam_4": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/lists/{listId}/memberships/add: + put: + tags: + - Lists API > Memberships + summary: Add Records to a List + description: >- + Add the records provided to the list. Records that do not exist or that + are already members of the list are ignored. + + + This endpoint only works for lists that have a `processingType` of + `MANUAL` or `SNAPSHOT`. + requestBody: + content: + application/json: + schema: + type: object + example: + - <long> + - <long> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: listId + in: path + schema: + type: string + required: true + example: <integer> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + recordIdsMissing: + - <long> + - <long> + recordIdsRemoved: + - <long> + - <long> + recordsIdsAdded: + - <long> + - <long> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "aliqua_ee": [ + "<string>", + "<string>" + ], + "eu_45": [ + "<string>", + "<string>" + ], + "proident_8": [ + "<string>", + "<string>" + ] + }, + "links": { + "ipsum_d": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "elit__3a": [ + "<string>", + "<string>" + ], + "reprehenderitbb4": [ + "<string>", + "<string>" + ], + "ipsumc": [ + "<string>", + "<string>" + ], + "eu__3a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "cupidatate6": [ + "<string>", + "<string>" + ], + "veniam_4": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/lists/{listId}/memberships/add-from/{sourceListId}: + put: + tags: + - Lists API > Memberships + summary: Add All Records from a Source List to a Destination List + description: >- + Add all of the records from a *source list* (specified by the + `sourceListId`) to a *destination list* (specified by the `listId`). + Records that are already members of the *destination list* will be + ignored. The *destination* and *source list* IDs must be different. The + *destination* and *source lists* must contain records of the same type + (e.g. contacts, companies, etc.). + + + This endpoint only works for *destination lists* that have a + `processingType` of `MANUAL` or `SNAPSHOT`. The *source list* can have + any `processingType`. + requestBody: + content: {} + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: listId + in: path + schema: + type: string + required: true + example: <integer> + - name: sourceListId + in: path + schema: + type: string + required: true + example: <integer> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "aliqua_ee": [ + "<string>", + "<string>" + ], + "eu_45": [ + "<string>", + "<string>" + ], + "proident_8": [ + "<string>", + "<string>" + ] + }, + "links": { + "ipsum_d": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "elit__3a": [ + "<string>", + "<string>" + ], + "reprehenderitbb4": [ + "<string>", + "<string>" + ], + "ipsumc": [ + "<string>", + "<string>" + ], + "eu__3a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "cupidatate6": [ + "<string>", + "<string>" + ], + "veniam_4": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/lists/{listId}/memberships: + get: + tags: + - Lists API > Memberships + summary: Fetch List Memberships Ordered by ID + description: >- + Fetch the memberships of a list in order sorted by the `recordId` of the + records in the list. + + + The `recordId`s are sorted in *ascending* order if an `after` offset or + no offset is provided. If only a `before` offset is provided, then the + records are sorted in *descending* order. + + + The `after` offset parameter will take precedence over the `before` + offset in a case where both are provided. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: after + in: query + schema: + type: string + description: >- + The paging offset token for the page that comes `after` the + previously requested records. + + + If provided, then the records in the response will be the records + following the offset, sorted in *ascending* order. Takes precedence + over the `before` offset. + example: <string> + - name: before + in: query + schema: + type: string + description: >- + The paging offset token for the page that comes `before` the + previously requested records. + + + If provided, then the records in the response will be the records + preceding the offset, sorted in *descending* order. + example: <string> + - name: limit + in: query + schema: + type: integer + description: >- + The number of records to return in the response. The maximum `limit` + is 250. + example: '100' + - name: listId + in: path + schema: + type: string + required: true + example: <integer> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - membershipTimestamp: <dateTime> + recordId: <string> + - membershipTimestamp: <dateTime> + recordId: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "aliqua_ee": [ + "<string>", + "<string>" + ], + "eu_45": [ + "<string>", + "<string>" + ], + "proident_8": [ + "<string>", + "<string>" + ] + }, + "links": { + "ipsum_d": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "elit__3a": [ + "<string>", + "<string>" + ], + "reprehenderitbb4": [ + "<string>", + "<string>" + ], + "ipsumc": [ + "<string>", + "<string>" + ], + "eu__3a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "cupidatate6": [ + "<string>", + "<string>" + ], + "veniam_4": [ + "<string>", + "<string>" + ] + } + } + ] + } + delete: + tags: + - Lists API > Memberships + summary: Delete All Records from a List + description: >- + Remove **all** of the records from a list. ***Note:*** *The list is not + deleted.* + + + This endpoint only works for lists that have a `processingType` of + `MANUAL` or `SNAPSHOT`. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: listId + in: path + schema: + type: string + required: true + example: <integer> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "aliqua_ee": [ + "<string>", + "<string>" + ], + "eu_45": [ + "<string>", + "<string>" + ], + "proident_8": [ + "<string>", + "<string>" + ] + }, + "links": { + "ipsum_d": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "elit__3a": [ + "<string>", + "<string>" + ], + "reprehenderitbb4": [ + "<string>", + "<string>" + ], + "ipsumc": [ + "<string>", + "<string>" + ], + "eu__3a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "cupidatate6": [ + "<string>", + "<string>" + ], + "veniam_4": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/lists/{listId}/memberships/remove: + put: + tags: + - Lists API > Memberships + summary: Remove Records from a List + description: >- + Remove the records provided from the list. Records that do not exist or + that are not members of the list are ignored. + + + This endpoint only works for lists that have a `processingType` of + `MANUAL` or `SNAPSHOT`. + requestBody: + content: + application/json: + schema: + type: object + example: + - <long> + - <long> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: listId + in: path + schema: + type: string + required: true + example: <integer> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + recordIdsMissing: + - <long> + - <long> + recordIdsRemoved: + - <long> + - <long> + recordsIdsAdded: + - <long> + - <long> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "aliqua_ee": [ + "<string>", + "<string>" + ], + "eu_45": [ + "<string>", + "<string>" + ], + "proident_8": [ + "<string>", + "<string>" + ] + }, + "links": { + "ipsum_d": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "elit__3a": [ + "<string>", + "<string>" + ], + "reprehenderitbb4": [ + "<string>", + "<string>" + ], + "ipsumc": [ + "<string>", + "<string>" + ], + "eu__3a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "cupidatate6": [ + "<string>", + "<string>" + ], + "veniam_4": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/lists/search: + post: + tags: + - Lists API > Lists + summary: Search Lists + description: >- + Search lists by list name or page through all lists by providing an + empty `query` value. + requestBody: + content: + application/json: + schema: + type: object + example: + additionalProperties: + - <string> + - <string> + offset: <integer> + query: <string> + count: <integer> + listIds: + - <string> + - <string> + processingTypes: + - <string> + - <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + hasMore: <boolean> + lists: + - additionalProperties: + occaecat_093: <string> + listId: <integer> + listVersion: <integer> + name: <string> + objectTypeId: <string> + processingStatus: <string> + processingType: <string> + updatedById: <integer> + filtersUpdatedAt: <dateTime> + createdAt: <dateTime> + deletedAt: <dateTime> + createdById: <integer> + updatedAt: <dateTime> + - additionalProperties: + officia4: <string> + listId: <integer> + listVersion: <integer> + name: <string> + objectTypeId: <string> + processingStatus: <string> + processingType: <string> + updatedById: <integer> + filtersUpdatedAt: <dateTime> + createdAt: <dateTime> + deletedAt: <dateTime> + createdById: <integer> + updatedAt: <dateTime> + offset: <integer> + total: <integer> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "aliqua_ee": [ + "<string>", + "<string>" + ], + "eu_45": [ + "<string>", + "<string>" + ], + "proident_8": [ + "<string>", + "<string>" + ] + }, + "links": { + "ipsum_d": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "elit__3a": [ + "<string>", + "<string>" + ], + "reprehenderitbb4": [ + "<string>", + "<string>" + ], + "ipsumc": [ + "<string>", + "<string>" + ], + "eu__3a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "cupidatate6": [ + "<string>", + "<string>" + ], + "veniam_4": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/lists/{listId}/update-list-name: + put: + tags: + - Lists API + summary: Update List Name + description: >- + Update the name of a list. The name must be globally unique relative to + all other public lists in the portal. + requestBody: + content: {} + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: listName + in: query + schema: + type: string + description: The name to update the list to. + example: <string> + - name: includeFilters + in: query + schema: + type: boolean + description: >- + A flag indicating whether or not the response object list definition + should include a filter branch definition. By default, object list + definitions will not have their filter branch definitions included + in the response. + example: 'false' + - name: listId + in: path + schema: + type: string + required: true + example: <integer> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + text/plain: + schema: + type: string + example: |- + { + "updatedList": { + "listId": "<integer>", + "listVersion": "<integer>", + "name": "<string>", + "objectTypeId": "<string>", + "processingStatus": "<string>", + "processingType": "<string>", + "createdAt": "<dateTime>", + "updatedAt": "<dateTime>", + "filtersUpdatedAt": "<dateTime>", + "deletedAt": "<dateTime>", + "createdById": "<integer>", + "updatedById": "<integer>", + "filterBranch": { + "filterBranchOperator": "<string>", + "filterBranchType": "OR", + "filterBranches": [ + { + "value": "<Circular reference to #/components/schemas/PublicOrFilterBranch detected>" + }, + { + "value": "<Circular reference to #/components/schemas/PublicOrFilterBranch detected>" + } + ], + "filters": [ + { + "filterType": "PROPERTY", + "operation": { + "includeObjectsWithNoValueSet": "<boolean>", + "operationType": "BOOL", + "operator": "<string>", + "value": "<boolean>" + }, + "property": "<string>" + }, + { + "filterType": "PROPERTY", + "operation": { + "includeObjectsWithNoValueSet": "<boolean>", + "operationType": "BOOL", + "operator": "<string>", + "value": "<boolean>" + }, + "property": "<string>" + } + ] + } + } + } + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "fugiat6": [ + "<string>", + "<string>" + ], + "aute_61_": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "id_7": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "Duisba": [ + "<string>", + "<string>" + ] + }, + "links": { + "reprehenderitc4b": "<string>" + } + } + /crm/v3/lists/{listId}: + get: + tags: + - Lists API + summary: Fetch List by ID + description: Fetch a single list by **ILS list ID**. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: includeFilters + in: query + schema: + type: boolean + description: >- + A flag indicating whether or not the response object list definition + should include a filter branch definition. By default, object list + definitions will not have their filter branch definitions included + in the response. + example: 'false' + - name: listId + in: path + schema: + type: string + required: true + example: <integer> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + text/plain: + schema: + type: string + example: |- + { + "list": { + "listId": "<integer>", + "listVersion": "<integer>", + "name": "<string>", + "objectTypeId": "<string>", + "processingStatus": "<string>", + "processingType": "<string>", + "createdAt": "<dateTime>", + "updatedAt": "<dateTime>", + "filtersUpdatedAt": "<dateTime>", + "deletedAt": "<dateTime>", + "createdById": "<integer>", + "updatedById": "<integer>", + "filterBranch": { + "filterBranchOperator": "<string>", + "filterBranchType": "OR", + "filterBranches": [ + { + "value": "<Circular reference to #/components/schemas/PublicOrFilterBranch detected>" + }, + { + "value": "<Circular reference to #/components/schemas/PublicOrFilterBranch detected>" + } + ], + "filters": [ + { + "filterType": "PROPERTY", + "operation": { + "includeObjectsWithNoValueSet": "<boolean>", + "operationType": "BOOL", + "operator": "<string>", + "value": "<boolean>" + }, + "property": "<string>" + }, + { + "filterType": "PROPERTY", + "operation": { + "includeObjectsWithNoValueSet": "<boolean>", + "operationType": "BOOL", + "operator": "<string>", + "value": "<boolean>" + }, + "property": "<string>" + } + ] + } + } + } + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "fugiat6": [ + "<string>", + "<string>" + ], + "aute_61_": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "id_7": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "Duisba": [ + "<string>", + "<string>" + ] + }, + "links": { + "reprehenderitc4b": "<string>" + } + } + delete: + tags: + - Lists API + summary: Delete a List + description: >- + Delete a list by **ILS list ID**. Lists deleted through this endpoint + can be restored up to 90-days following the delete. After 90-days, the + list is purged and can no longer be restored. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: listId + in: path + schema: + type: string + required: true + example: <integer> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "fugiat6": [ + "<string>", + "<string>" + ], + "aute_61_": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "id_7": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "Duisba": [ + "<string>", + "<string>" + ] + }, + "links": { + "reprehenderitc4b": "<string>" + } + } + /crm/v3/lists/{listId}/update-list-filters: + put: + tags: + - Lists API + summary: Update List Filter Definition + description: >- + Update the filter branch definition of a `DYNAMIC` list. Once updated, + the list memberships will be re-evaluated and updated to match the new + definition. + requestBody: + content: + application/json: + schema: + type: object + example: + filterBranch: + filterBranchOperator: <string> + filterBranchType: OR + filterBranches: + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + filters: + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: enrollObjectsInWorkflows + in: query + schema: + type: boolean + description: >- + A flag indicating whether or not the memberships added to the list + as a result of the filter change should be enrolled in workflows + that are relevant to this list. + example: 'false' + - name: listId + in: path + schema: + type: string + required: true + example: <integer> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + text/plain: + schema: + type: string + example: |- + { + "updatedList": { + "listId": "<integer>", + "listVersion": "<integer>", + "name": "<string>", + "objectTypeId": "<string>", + "processingStatus": "<string>", + "processingType": "<string>", + "createdAt": "<dateTime>", + "updatedAt": "<dateTime>", + "filtersUpdatedAt": "<dateTime>", + "deletedAt": "<dateTime>", + "createdById": "<integer>", + "updatedById": "<integer>", + "filterBranch": { + "filterBranchOperator": "<string>", + "filterBranchType": "OR", + "filterBranches": [ + { + "value": "<Circular reference to #/components/schemas/PublicOrFilterBranch detected>" + }, + { + "value": "<Circular reference to #/components/schemas/PublicOrFilterBranch detected>" + } + ], + "filters": [ + { + "filterType": "PROPERTY", + "operation": { + "includeObjectsWithNoValueSet": "<boolean>", + "operationType": "BOOL", + "operator": "<string>", + "value": "<boolean>" + }, + "property": "<string>" + }, + { + "filterType": "PROPERTY", + "operation": { + "includeObjectsWithNoValueSet": "<boolean>", + "operationType": "BOOL", + "operator": "<string>", + "value": "<boolean>" + }, + "property": "<string>" + } + ] + } + } + } + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "fugiat6": [ + "<string>", + "<string>" + ], + "aute_61_": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "id_7": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "Duisba": [ + "<string>", + "<string>" + ] + }, + "links": { + "reprehenderitc4b": "<string>" + } + } + /crm/v3/lists/object-type-id/{objectTypeId}/name/{listName}: + get: + tags: + - Lists API + summary: Fetch List by Name + description: Fetch a single list by list name and object type. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: includeFilters + in: query + schema: + type: boolean + description: >- + A flag indicating whether or not the response object list definition + should include a filter branch definition. By default, object list + definitions will not have their filter branch definitions included + in the response. + example: 'false' + - name: objectTypeId + in: path + schema: + type: string + required: true + example: <string> + - name: listName + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + text/plain: + schema: + type: string + example: |- + { + "list": { + "listId": "<integer>", + "listVersion": "<integer>", + "name": "<string>", + "objectTypeId": "<string>", + "processingStatus": "<string>", + "processingType": "<string>", + "createdAt": "<dateTime>", + "updatedAt": "<dateTime>", + "filtersUpdatedAt": "<dateTime>", + "deletedAt": "<dateTime>", + "createdById": "<integer>", + "updatedById": "<integer>", + "filterBranch": { + "filterBranchOperator": "<string>", + "filterBranchType": "OR", + "filterBranches": [ + { + "value": "<Circular reference to #/components/schemas/PublicOrFilterBranch detected>" + }, + { + "value": "<Circular reference to #/components/schemas/PublicOrFilterBranch detected>" + } + ], + "filters": [ + { + "filterType": "PROPERTY", + "operation": { + "includeObjectsWithNoValueSet": "<boolean>", + "operationType": "BOOL", + "operator": "<string>", + "value": "<boolean>" + }, + "property": "<string>" + }, + { + "filterType": "PROPERTY", + "operation": { + "includeObjectsWithNoValueSet": "<boolean>", + "operationType": "BOOL", + "operator": "<string>", + "value": "<boolean>" + }, + "property": "<string>" + } + ] + } + } + } + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "fugiat6": [ + "<string>", + "<string>" + ], + "aute_61_": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "id_7": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "Duisba": [ + "<string>", + "<string>" + ] + }, + "links": { + "reprehenderitc4b": "<string>" + } + } + /crm/v3/lists/: + get: + tags: + - Lists API + summary: Fetch Multiple Lists + description: >- + Fetch multiple lists in a single request by **ILS list ID**. The + response will include the definitions of all lists that exist for the + `listIds` provided. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: listIds + in: query + schema: + type: string + description: The **ILS IDs** of the lists to fetch. + example: <integer> + - name: listIds + in: query + schema: + type: string + description: The **ILS IDs** of the lists to fetch. + example: <integer> + - name: includeFilters + in: query + schema: + type: boolean + description: >- + A flag indicating whether or not the response object list + definitions should include a filter branch definition. By default, + object list definitions will not have their filter branch + definitions included in the response. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + text/plain: + schema: + type: string + example: |- + { + "lists": [ + { + "listId": "<integer>", + "listVersion": "<integer>", + "name": "<string>", + "objectTypeId": "<string>", + "processingStatus": "<string>", + "processingType": "<string>", + "createdAt": "<dateTime>", + "updatedAt": "<dateTime>", + "filtersUpdatedAt": "<dateTime>", + "deletedAt": "<dateTime>", + "createdById": "<integer>", + "updatedById": "<integer>", + "filterBranch": { + "filterBranchOperator": "<string>", + "filterBranchType": "OR", + "filterBranches": [ + { + "value": "<Circular reference to #/components/schemas/PublicOrFilterBranch detected>" + }, + { + "value": "<Circular reference to #/components/schemas/PublicOrFilterBranch detected>" + } + ], + "filters": [ + { + "filterType": "PROPERTY", + "operation": { + "includeObjectsWithNoValueSet": "<boolean>", + "operationType": "BOOL", + "operator": "<string>", + "value": "<boolean>" + }, + "property": "<string>" + }, + { + "filterType": "PROPERTY", + "operation": { + "includeObjectsWithNoValueSet": "<boolean>", + "operationType": "BOOL", + "operator": "<string>", + "value": "<boolean>" + }, + "property": "<string>" + } + ] + } + }, + { + "listId": "<integer>", + "listVersion": "<integer>", + "name": "<string>", + "objectTypeId": "<string>", + "processingStatus": "<string>", + "processingType": "<string>", + "createdAt": "<dateTime>", + "updatedAt": "<dateTime>", + "filtersUpdatedAt": "<dateTime>", + "deletedAt": "<dateTime>", + "createdById": "<integer>", + "updatedById": "<integer>", + "filterBranch": { + "filterBranchOperator": "<string>", + "filterBranchType": "OR", + "filterBranches": [ + { + "value": "<Circular reference to #/components/schemas/PublicOrFilterBranch detected>" + }, + { + "value": "<Circular reference to #/components/schemas/PublicOrFilterBranch detected>" + } + ], + "filters": [ + { + "filterType": "PROPERTY", + "operation": { + "includeObjectsWithNoValueSet": "<boolean>", + "operationType": "BOOL", + "operator": "<string>", + "value": "<boolean>" + }, + "property": "<string>" + }, + { + "filterType": "PROPERTY", + "operation": { + "includeObjectsWithNoValueSet": "<boolean>", + "operationType": "BOOL", + "operator": "<string>", + "value": "<boolean>" + }, + "property": "<string>" + } + ] + } + } + ] + } + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "fugiat6": [ + "<string>", + "<string>" + ], + "aute_61_": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "id_7": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "Duisba": [ + "<string>", + "<string>" + ] + }, + "links": { + "reprehenderitc4b": "<string>" + } + } + post: + tags: + - Lists API + summary: Create List + description: Create a new list with the provided object list definition. + requestBody: + content: + application/json: + schema: + type: object + example: + name: <string> + objectTypeId: <string> + processingType: <string> + filterBranch: + filterBranchOperator: <string> + filterBranchType: OR + filterBranches: + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + - value: >- + <Circular reference to + #/components/schemas/PublicOrFilterBranch detected> + filters: + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + - filterType: PROPERTY + operation: + includeObjectsWithNoValueSet: <boolean> + operationType: BOOL + operator: <string> + value: <boolean> + property: <string> + listFolderId: <integer> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + text/plain: + schema: + type: string + example: |- + { + "list": { + "listId": "<integer>", + "listVersion": "<integer>", + "name": "<string>", + "objectTypeId": "<string>", + "processingStatus": "<string>", + "processingType": "<string>", + "createdAt": "<dateTime>", + "updatedAt": "<dateTime>", + "filtersUpdatedAt": "<dateTime>", + "deletedAt": "<dateTime>", + "createdById": "<integer>", + "updatedById": "<integer>", + "filterBranch": { + "filterBranchOperator": "<string>", + "filterBranchType": "OR", + "filterBranches": [ + { + "value": "<Circular reference to #/components/schemas/PublicOrFilterBranch detected>" + }, + { + "value": "<Circular reference to #/components/schemas/PublicOrFilterBranch detected>" + } + ], + "filters": [ + { + "filterType": "PROPERTY", + "operation": { + "includeObjectsWithNoValueSet": "<boolean>", + "operationType": "BOOL", + "operator": "<string>", + "value": "<boolean>" + }, + "property": "<string>" + }, + { + "filterType": "PROPERTY", + "operation": { + "includeObjectsWithNoValueSet": "<boolean>", + "operationType": "BOOL", + "operator": "<string>", + "value": "<boolean>" + }, + "property": "<string>" + } + ] + } + } + } + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "fugiat6": [ + "<string>", + "<string>" + ], + "aute_61_": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "id_7": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "Duisba": [ + "<string>", + "<string>" + ] + }, + "links": { + "reprehenderitc4b": "<string>" + } + } + /crm/v3/lists/{listId}/restore: + put: + tags: + - Lists API + summary: Restore a List + description: >- + Restore a previously deleted list by **ILS list ID**. Deleted lists are + eligible to be restored up-to 90-days after the list has been deleted. + requestBody: + content: {} + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: listId + in: path + schema: + type: string + required: true + example: <integer> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "fugiat6": [ + "<string>", + "<string>" + ], + "aute_61_": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "id_7": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "Duisba": [ + "<string>", + "<string>" + ] + }, + "links": { + "reprehenderitc4b": "<string>" + } + } + /crm/v3/lists/folders/move-list: + put: + tags: + - Lists API + summary: Moves a list to a given folder + description: Given a list and a folder, the list will be moved to that folder. + requestBody: + content: + application/json: + schema: + type: object + example: + listId: <string> + newFolderId: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "irure_8c3": [ + "<string>", + "<string>" + ], + "do5": [ + "<string>", + "<string>" + ] + }, + "links": { + "ea5cf": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "proident_1": [ + "<string>", + "<string>" + ], + "anim__": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "mollit_543": [ + "<string>", + "<string>" + ], + "veniam20f": [ + "<string>", + "<string>" + ], + "Ut88_": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/lists/folders/{folderId}/move/{newParentFolderId}: + put: + tags: + - Lists API + summary: Moves a folder + description: >- + This moves the folder from its current location to a new location. It + updates the parent of this folder to the new Id given. + requestBody: + content: {} + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: folderId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + - name: newParentFolderId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + folder: + childLists: + - <integer> + - <integer> + childNodes: + - value: >- + <Circular reference to + #/components/schemas/PublicListFolder detected> + - value: >- + <Circular reference to + #/components/schemas/PublicListFolder detected> + id: <integer> + parentFolderId: <integer> + createdAt: <dateTime> + name: <string> + updatedContentsAt: <dateTime> + userId: <integer> + updatedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "irure_8c3": [ + "<string>", + "<string>" + ], + "do5": [ + "<string>", + "<string>" + ] + }, + "links": { + "ea5cf": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "proident_1": [ + "<string>", + "<string>" + ], + "anim__": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "mollit_543": [ + "<string>", + "<string>" + ], + "veniam20f": [ + "<string>", + "<string>" + ], + "Ut88_": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/lists/folders/{folderId}/rename: + put: + tags: + - Lists API + summary: Rename a folder + description: Renames the given folderId with a new name. + requestBody: + content: {} + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: newFolderName + in: query + schema: + type: string + example: <string> + - name: folderId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + folder: + childLists: + - <integer> + - <integer> + childNodes: + - value: >- + <Circular reference to + #/components/schemas/PublicListFolder detected> + - value: >- + <Circular reference to + #/components/schemas/PublicListFolder detected> + id: <integer> + parentFolderId: <integer> + createdAt: <dateTime> + name: <string> + updatedContentsAt: <dateTime> + userId: <integer> + updatedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "irure_8c3": [ + "<string>", + "<string>" + ], + "do5": [ + "<string>", + "<string>" + ] + }, + "links": { + "ea5cf": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "proident_1": [ + "<string>", + "<string>" + ], + "anim__": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "mollit_543": [ + "<string>", + "<string>" + ], + "veniam20f": [ + "<string>", + "<string>" + ], + "Ut88_": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/lists/records/{objectTypeId}/{recordId}/memberships: + get: + tags: + - Lists API + summary: Get lists record is member of + description: For given record provide lists this record is member of. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: objectTypeId + in: path + schema: + type: string + required: true + description: (Required) Object type id of the record + example: <string> + - name: recordId + in: path + schema: + type: string + required: true + description: (Required) Id of the record + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - firstAddedTimestamp: <dateTime> + lastAddedTimestamp: <dateTime> + listId: <string> + listVersion: <integer> + - firstAddedTimestamp: <dateTime> + lastAddedTimestamp: <dateTime> + listId: <string> + listVersion: <integer> + total: <long> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "irure_8c3": [ + "<string>", + "<string>" + ], + "do5": [ + "<string>", + "<string>" + ] + }, + "links": { + "ea5cf": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "proident_1": [ + "<string>", + "<string>" + ], + "anim__": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "mollit_543": [ + "<string>", + "<string>" + ], + "veniam20f": [ + "<string>", + "<string>" + ], + "Ut88_": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/lists/folders: + get: + tags: + - Lists API + summary: Retrieves a folder. + description: >- + Retrieves a folder and recursively includes all folders via the + childNodes attribute. The child lists field will be empty in all child + nodes. Only the folder retrieved will include the child lists in that + folder. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: folderId + in: query + schema: + type: integer + description: The Id of the folder to retrieve. + example: '0' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + folder: + childLists: + - <integer> + - <integer> + childNodes: + - value: >- + <Circular reference to + #/components/schemas/PublicListFolder detected> + - value: >- + <Circular reference to + #/components/schemas/PublicListFolder detected> + id: <integer> + parentFolderId: <integer> + createdAt: <dateTime> + name: <string> + updatedContentsAt: <dateTime> + userId: <integer> + updatedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "irure_8c3": [ + "<string>", + "<string>" + ], + "do5": [ + "<string>", + "<string>" + ] + }, + "links": { + "ea5cf": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "proident_1": [ + "<string>", + "<string>" + ], + "anim__": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "mollit_543": [ + "<string>", + "<string>" + ], + "veniam20f": [ + "<string>", + "<string>" + ], + "Ut88_": [ + "<string>", + "<string>" + ] + } + } + ] + } + post: + tags: + - Lists API + summary: Creates a folder + description: Creates a folder with the given information. + requestBody: + content: + application/json: + schema: + type: object + example: + name: <string> + parentFolderId: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + folder: + childLists: + - <integer> + - <integer> + childNodes: + - value: >- + <Circular reference to + #/components/schemas/PublicListFolder detected> + - value: >- + <Circular reference to + #/components/schemas/PublicListFolder detected> + id: <integer> + parentFolderId: <integer> + createdAt: <dateTime> + name: <string> + updatedContentsAt: <dateTime> + userId: <integer> + updatedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "irure_8c3": [ + "<string>", + "<string>" + ], + "do5": [ + "<string>", + "<string>" + ] + }, + "links": { + "ea5cf": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "proident_1": [ + "<string>", + "<string>" + ], + "anim__": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "mollit_543": [ + "<string>", + "<string>" + ], + "veniam20f": [ + "<string>", + "<string>" + ], + "Ut88_": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/lists/folders/{folderId}: + delete: + tags: + - Lists API + summary: Deletes a folder + description: Deletes the folder with the given Id. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: folderId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "irure_8c3": [ + "<string>", + "<string>" + ], + "do5": [ + "<string>", + "<string>" + ] + }, + "links": { + "ea5cf": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "proident_1": [ + "<string>", + "<string>" + ], + "anim__": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "mollit_543": [ + "<string>", + "<string>" + ], + "veniam20f": [ + "<string>", + "<string>" + ], + "Ut88_": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/lists/idmapping: + get: + tags: + - Lists API + summary: Translate Legacy List Id to Modern List Id + description: >- + This API allows translation of legacy list id to list id. This is a + temporary API allowed for mapping old id's to new id's and will expire + on May 30th, 2025. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: legacyListId + in: query + schema: + type: string + description: The legacy list id from lists v1 API. + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + legacyListId: <string> + listId: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "irure_bcc": [ + "<string>", + "<string>" + ] + }, + "links": { + "ut70": "<string>", + "mollit9f9": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "Excepteur73": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "incididunt_b33": [ + "<string>", + "<string>" + ] + } + } + ] + } + post: + tags: + - Lists API + summary: Translate Legacy List Id to Modern List Id in Batch + description: >- + This API allows translation of a batch of legacy list id's to list id's. + This allows for a maximum of 10,000 id's. This is a temporary API + allowed for mapping old id's to new id's and will expire on May 30th, + 2025. + requestBody: + content: + application/json: + schema: + type: object + example: + - <string> + - <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + legacyListIdsToIdsMapping: + - legacyListId: <string> + listId: <string> + - legacyListId: <string> + listId: <string> + missingLegacyListIds: + - <string> + - <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "irure_bcc": [ + "<string>", + "<string>" + ] + }, + "links": { + "ut70": "<string>", + "mollit9f9": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "Excepteur73": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "incididunt_b33": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/lists/{listId}/memberships/join-order: + get: + tags: + - Lists API + summary: Fetch List Memberships Ordered by Added to List Date + description: >- + Fetch the memberships of a list in order sorted by the time the records + were added to the list. + + + The `recordId`s are sorted in *ascending* order if an `after` offset or + no offset is provided. If only a `before` offset is provided, then the + records are sorted in *descending* order. + + + The `after` offset parameter will take precedence over the `before` + offset in a case where both are provided. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: after + in: query + schema: + type: string + description: >- + The paging offset token for the page that comes `after` the + previously requested records. + + + If provided, then the records in the response will be the records + following the offset, sorted in *ascending* order. Takes precedence + over the `before` offset. + example: <string> + - name: before + in: query + schema: + type: string + description: >- + The paging offset token for the page that comes `before` the + previously requested records. + + + If provided, then the records in the response will be the records + preceding the offset, sorted in *descending* order. + example: <string> + - name: limit + in: query + schema: + type: integer + description: >- + The number of records to return in the response. The maximum `limit` + is 250. + example: '100' + - name: listId + in: path + schema: + type: string + required: true + description: (Required) The **ILS ID** of the list. + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - membershipTimestamp: '1986-06-27T13:53:02.296Z' + recordId: id + - membershipTimestamp: '1975-03-30T07:45:42.608Z' + recordId: laboris est + total: -30382537 + paging: + next: + after: Duis quis sint enim laborum + link: labore magn + prev: + before: anim cupidatat id minim + link: pariatur commodo dolor dolor + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "irure_bcc": [ + "<string>", + "<string>" + ] + }, + "links": { + "ut70": "<string>", + "mollit9f9": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "Excepteur73": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "incididunt_b33": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/{objectType}/batch/upsert: + post: + tags: + - Objects API + summary: Create or update a batch of objects by unique property values + description: >- + Create or update records identified by a unique property value as + specified by the `idProperty` query param. `idProperty` query param + refers to a property whose values are unique for the object. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + properties: + ipsumeb9: <string> + idProperty: <string> + objectWriteTraceId: <string> + - id: <string> + properties: + culpa_97: <string> + idProperty: <string> + objectWriteTraceId: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: objectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + new: <boolean> + properties: + velit31: <string> + nostrud_74: <string> + laboruma63: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + est__: + - sourceType: commodo consequat dolore + timestamp: '1953-10-25T15:07:10.519Z' + value: veniam consequat l + sourceId: in magna eiusmod + sourceLabel: non dolore elit adipisicing + updatedByUserId: 12584655 + - sourceType: irure voluptate minim + timestamp: '2009-12-24T18:11:50.397Z' + value: enim ut minim dolor + sourceId: et + sourceLabel: consequat labore + updatedByUserId: 28035756 + Excepteurfe: + - sourceType: reprehenderit voluptate + timestamp: '2004-04-28T19:55:04.919Z' + value: commodo cillum ea nisi + sourceId: 'enim tempor ' + sourceLabel: laborum proident officia + updatedByUserId: -67427473 + - sourceType: sed velit ullamco + timestamp: '2019-04-19T21:27:04.331Z' + value: eiusmod aute voluptate + sourceId: a + sourceLabel: fugiat deserunt + updatedByUserId: 45520265 + exercitation_9a: + - sourceType: laboris nisi + timestamp: '1972-01-12T00:22:46.329Z' + value: voluptate cillum et + sourceId: ad sit ex id anim + sourceLabel: tempor qui dolor officia + updatedByUserId: 70108597 + - sourceType: Duis ipsu + timestamp: '1953-03-27T07:25:54.987Z' + value: culpa dolor laboris sed + sourceId: elit con + sourceLabel: ipsum commodo + updatedByUserId: -81263114 + nisid0: + - sourceType: ci + timestamp: '2014-09-10T10:09:54.296Z' + value: enim exercitation + sourceId: dolore consequat anim cillum + sourceLabel: ipsum + updatedByUserId: -23318793 + - sourceType: quis sint qui + timestamp: '1957-07-03T19:08:34.869Z' + value: cupidatat adipisicing voluptate minim + sourceId: fugiat laboris mollit nulla + sourceLabel: irure amet laborum veniam + updatedByUserId: -11333559 + - createdAt: <dateTime> + id: <string> + new: <boolean> + properties: + anim_93: <string> + deserunt6: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + id51c: + - sourceType: deserunt adipisicing aliquip + timestamp: '1960-12-30T15:39:25.452Z' + value: proident occaecat in + sourceId: adipisicing et + sourceLabel: consequ + updatedByUserId: 5694659 + - sourceType: do eu + timestamp: '2017-02-19T06:54:20.376Z' + value: id ut elit + sourceId: sed amet pr + sourceLabel: deserunt eiusmo + updatedByUserId: -90217067 + anim_: + - sourceType: labore nostrud aliquip officia + timestamp: '2022-02-16T08:48:10.753Z' + value: nisi aliqua aliquip + sourceId: est laborum dolore ut + sourceLabel: exercitation do nisi + updatedByUserId: -58294533 + - sourceType: ex est + timestamp: '1968-01-18T03:43:02.327Z' + value: ex anim + sourceId: ipsum quis in + sourceLabel: elit cillum incididunt consectetur est + updatedByUserId: -20616516 + startedAt: <dateTime> + status: COMPLETE + requestedAt: <dateTime> + links: + cillum_b: <string> + dolor307: <string> + Loremf14: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + new: <boolean> + properties: + mollit_b07: <string> + et_f: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + exercitation_d6: + - sourceType: ut velit irure + timestamp: '2018-10-09T16:27:07.271Z' + value: ipsum veniam Ut est + sourceId: id + sourceLabel: et + updatedByUserId: -22546386 + - sourceType: eu proident laboris + timestamp: '1980-08-10T13:41:28.613Z' + value: consequat mag + sourceId: non occaecat + sourceLabel: 'irure ad ' + updatedByUserId: 90303142 + - createdAt: <dateTime> + id: <string> + new: <boolean> + properties: + dolore_0_8: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + in3: + - sourceType: non eiusmod magna labore sed + timestamp: '1990-10-22T14:26:50.649Z' + value: occaecat + sourceId: eiusmod consectetur dolore dolor + sourceLabel: consequat do irure id commodo + updatedByUserId: -61574136 + - sourceType: ut + timestamp: '2008-03-26T07:58:27.221Z' + value: amet aliqua dolore Ut + sourceId: ut + sourceLabel: qui deserunt + updatedByUserId: 20864799 + startedAt: <dateTime> + status: COMPLETE + numErrors: <integer> + requestedAt: <dateTime> + links: + sintc: <string> + errors: + - category: magna anim Duis fugiat + context: + enime0: + - nisi non + - tempor id minim in magna + mollit1: + - ad dolor proident + - est in ut + errors: + - message: reprehenderit + subCategory: qui in culpa + code: Lorem enim non eiusmod + in: quis do + context: + irureed: + - sint dolor anim + - magna fugiat mollit reprehenderit + in_f21: + - eli + - voluptate dolore + occaecata: + - adipisicing fugiat + - sed + - message: dolor sed labore + subCategory: nostrud Ut + code: proiden + in: in aute deserunt consequat d + context: + ullamcoba: + - do pariatur non ullamco mollit + - esse minim laborum + labore_a9: + - 'dolor ipsum consectetur ' + - ipsum nisi + links: + Ut_95: sint + message: nisi Ut in dolor qui + status: non labore + subCategory: {} + id: pariatur tempor voluptate consequat + - category: ex tempor officia ut sunt + context: + ullamcoc0: + - minim ex Ut + - aliqua sit + do_31: + - nostrud elit + - laboris nisi enim do + cupidatata4_: + - occaecat Ut consectetur amet + - Ut nulla dolor fug + sunt__: + - deserunt + - officia cillum dolore pariatur + adf3: + - id Duis + - Ut et mollit + errors: + - message: do labore consequat pariatur sit + subCategory: amet reprehenderit eu Ut + code: laboris tempor anim ullamco laborum + in: irure ex laboris pariatur + context: + eu_a5: + - veniam velit elit laboris + - eu sunt dolor + - message: mollit sit nostrud + subCategory: id Ut eiusmod anim officia + code: cupidatat id + in: cupi + context: + aute_39: + - nisi sit + - et magna + tempor_f: + - sed magna in cillum sit + - anim enim + links: + pariatur_4: enim id quis veniam + message: aliqua consequat eiusmod + status: eu ut exercitation + subCategory: {} + id: aliqua eu + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "autef0": [ + "<string>", + "<string>" + ], + "adipisicing1": [ + "<string>", + "<string>" + ] + }, + "links": { + "eiusmod_2": "<string>" + }, + "errors": [ + { + "message": "cupidatat adipisicing irure", + "subCategory": "sed reprehenderit do aliquip nisi", + "code": "adipisicing sed ea consectetur", + "in": "esse id non et laboris", + "context": { + "dolore_bc": [ + "officia ipsum cillum Excepteur", + "aute Ut" + ], + "fugiata4": [ + "pariatur in occaecat culpa et", + "id laboris ut incididunt" + ], + "culpa5": [ + "labore aliquip nisi reprehenderit", + "esse " + ], + "qui90b": [ + "ut", + "exercitation aliquip nulla reprehenderit" + ], + "veniam4b6": [ + "nisi veniam", + "aliquip dolore incididunt sit irure" + ] + } + }, + { + "message": "occaecat fugiat in Ut in", + "subCategory": "mollit non do", + "code": "Lor", + "in": "commodo ad eiusmod amet", + "context": { + "aute01e": [ + "dolor sint", + "laboris" + ], + "eu_2b": [ + "sunt nulla dolore", + "ad commodo deserunt Ut" + ] + } + } + ] + } + /crm/v3/objects/orders/batch/read: + post: + tags: + - Orders API > Batch + summary: Read a batch of orders by internal ID, or unique property values + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + properties: + - <string> + - <string> + propertiesWithHistory: + - <string> + - <string> + idProperty: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + commodoe: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + Ut_3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + ipsum_f9_: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + ut9: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + sint0bd: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + startedAt: <dateTime> + status: PROCESSING + requestedAt: <dateTime> + links: + non_5e8: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + laborum_66: <string> + do_9: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + laborum_10: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + aliquip__: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + fugiata8: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + cillum_772: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + pariature88: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + fugiat_9: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + startedAt: <dateTime> + status: PROCESSING + numErrors: <integer> + requestedAt: <dateTime> + links: + dolore0: <string> + errors: + - category: <string> + context: + eu__2e: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + utaa3: + - <string> + - <string> + incididunt48: + - <string> + - <string> + dolor__5_: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + sunt_3a0: + - <string> + - <string> + links: + cupidatat__9c: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + - category: <string> + context: + cupidatat_02: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + sedd: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + estbbb: + - <string> + - <string> + fugiat_a: + - <string> + - <string> + links: + anim_c03: <string> + velit_da: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "tempor684": [ + "<string>", + "<string>" + ] + }, + "links": { + "irureef3": "<string>", + "temporb4": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "Duis9": [ + "<string>", + "<string>" + ], + "minim_5f3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "adba": [ + "<string>", + "<string>" + ], + "adipisicing_": [ + "<string>", + "<string>" + ], + "veniam_855": [ + "<string>", + "<string>" + ], + "qui975": [ + "<string>", + "<string>" + ], + "cupidatat_207": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/orders/batch/archive: + post: + tags: + - Orders API > Batch + summary: Archive a batch of orders by ID + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "tempor684": [ + "<string>", + "<string>" + ] + }, + "links": { + "irureef3": "<string>", + "temporb4": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "Duis9": [ + "<string>", + "<string>" + ], + "minim_5f3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "adba": [ + "<string>", + "<string>" + ], + "adipisicing_": [ + "<string>", + "<string>" + ], + "veniam_855": [ + "<string>", + "<string>" + ], + "qui975": [ + "<string>", + "<string>" + ], + "cupidatat_207": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/orders/batch/create: + post: + tags: + - Orders API > Batch + summary: Create a batch of orders + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - associations: + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + properties: + enima7d: <string> + enim_62: <string> + - associations: + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + properties: + dolore_18a: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + commodoe: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + Ut_3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + ipsum_f9_: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + ut9: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + sint0bd: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + startedAt: <dateTime> + status: PROCESSING + requestedAt: <dateTime> + links: + non_5e8: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + laborum_66: <string> + do_9: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + laborum_10: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + aliquip__: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + fugiata8: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + cillum_772: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + pariature88: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + fugiat_9: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + startedAt: <dateTime> + status: PROCESSING + numErrors: <integer> + requestedAt: <dateTime> + links: + dolore0: <string> + errors: + - category: <string> + context: + eu__2e: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + utaa3: + - <string> + - <string> + incididunt48: + - <string> + - <string> + dolor__5_: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + sunt_3a0: + - <string> + - <string> + links: + cupidatat__9c: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + - category: <string> + context: + cupidatat_02: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + sedd: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + estbbb: + - <string> + - <string> + fugiat_a: + - <string> + - <string> + links: + anim_c03: <string> + velit_da: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "tempor684": [ + "<string>", + "<string>" + ] + }, + "links": { + "irureef3": "<string>", + "temporb4": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "Duis9": [ + "<string>", + "<string>" + ], + "minim_5f3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "adba": [ + "<string>", + "<string>" + ], + "adipisicing_": [ + "<string>", + "<string>" + ], + "veniam_855": [ + "<string>", + "<string>" + ], + "qui975": [ + "<string>", + "<string>" + ], + "cupidatat_207": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/orders/batch/update: + post: + tags: + - Orders API > Batch + summary: Update a batch of orders + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + properties: + id_5: <string> + idProperty: <string> + - id: <string> + properties: + enim9b: <string> + idProperty: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + commodoe: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + Ut_3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + ipsum_f9_: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + ut9: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + sint0bd: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + startedAt: <dateTime> + status: PROCESSING + requestedAt: <dateTime> + links: + non_5e8: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + laborum_66: <string> + do_9: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + laborum_10: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + aliquip__: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + fugiata8: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + cillum_772: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + pariature88: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + fugiat_9: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + startedAt: <dateTime> + status: PROCESSING + numErrors: <integer> + requestedAt: <dateTime> + links: + dolore0: <string> + errors: + - category: <string> + context: + eu__2e: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + utaa3: + - <string> + - <string> + incididunt48: + - <string> + - <string> + dolor__5_: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + sunt_3a0: + - <string> + - <string> + links: + cupidatat__9c: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + - category: <string> + context: + cupidatat_02: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + sedd: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + estbbb: + - <string> + - <string> + fugiat_a: + - <string> + - <string> + links: + anim_c03: <string> + velit_da: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "tempor684": [ + "<string>", + "<string>" + ] + }, + "links": { + "irureef3": "<string>", + "temporb4": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "Duis9": [ + "<string>", + "<string>" + ], + "minim_5f3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "adba": [ + "<string>", + "<string>" + ], + "adipisicing_": [ + "<string>", + "<string>" + ], + "veniam_855": [ + "<string>", + "<string>" + ], + "qui975": [ + "<string>", + "<string>" + ], + "cupidatat_207": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/orders/{orderId}: + get: + tags: + - Orders API > Basic + summary: Read + description: >- + Read an Object identified by `{orderId}`. `{orderId}` refers to the + internal object ID by default, or optionally any unique property value + as specified by the `idProperty` query param. Control what is returned + via the `properties` query param. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: orderId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + et887: <string> + laboris_76: <string> + updatedAt: <dateTime> + associations: + cillum16: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + in87: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + proidenta1: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + ipsum5: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + commodoa: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "tempor684": [ + "<string>", + "<string>" + ] + }, + "links": { + "irureef3": "<string>", + "temporb4": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "Duis9": [ + "<string>", + "<string>" + ], + "minim_5f3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "adba": [ + "<string>", + "<string>" + ], + "adipisicing_": [ + "<string>", + "<string>" + ], + "veniam_855": [ + "<string>", + "<string>" + ], + "qui975": [ + "<string>", + "<string>" + ], + "cupidatat_207": [ + "<string>", + "<string>" + ] + } + } + ] + } + delete: + tags: + - Orders API > Basic + summary: Archive + description: Move an Object identified by `{orderId}` to the recycling bin. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: orderId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "tempor684": [ + "<string>", + "<string>" + ] + }, + "links": { + "irureef3": "<string>", + "temporb4": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "Duis9": [ + "<string>", + "<string>" + ], + "minim_5f3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "adba": [ + "<string>", + "<string>" + ], + "adipisicing_": [ + "<string>", + "<string>" + ], + "veniam_855": [ + "<string>", + "<string>" + ], + "qui975": [ + "<string>", + "<string>" + ], + "cupidatat_207": [ + "<string>", + "<string>" + ] + } + } + ] + } + patch: + tags: + - Orders API > Basic + summary: Update + description: >- + Perform a partial update of an Object identified by `{orderId}`. + `{orderId}` refers to the internal object ID by default, or optionally + any unique property value as specified by the `idProperty` query param. + Provided property values will be overwritten. Read-only and non-existent + properties will be ignored. Properties values can be cleared by passing + an empty string. + requestBody: + content: + application/json: + schema: + type: object + example: + properties: + eiusmod_13a: <string> + enim_36_: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: orderId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + utf_e: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + commodo2c: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "tempor684": [ + "<string>", + "<string>" + ] + }, + "links": { + "irureef3": "<string>", + "temporb4": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "Duis9": [ + "<string>", + "<string>" + ], + "minim_5f3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "adba": [ + "<string>", + "<string>" + ], + "adipisicing_": [ + "<string>", + "<string>" + ], + "veniam_855": [ + "<string>", + "<string>" + ], + "qui975": [ + "<string>", + "<string>" + ], + "cupidatat_207": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/orders: + get: + tags: + - Orders API > Basic + summary: List + description: >- + Read a page of orders. Control what is returned via the `properties` + query param. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: limit + in: query + schema: + type: integer + description: The maximum number of results to display per page. + example: '10' + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + in_a: <string> + updatedAt: <dateTime> + associations: + magna3d: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + ipsum7f: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + eaa: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + dod: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + qui_e: <string> + elit_1b7: <string> + updatedAt: <dateTime> + associations: + quis_4: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + nisi479: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + Duis_36a: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + mollit_6: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "tempor684": [ + "<string>", + "<string>" + ] + }, + "links": { + "irureef3": "<string>", + "temporb4": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "Duis9": [ + "<string>", + "<string>" + ], + "minim_5f3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "adba": [ + "<string>", + "<string>" + ], + "adipisicing_": [ + "<string>", + "<string>" + ], + "veniam_855": [ + "<string>", + "<string>" + ], + "qui975": [ + "<string>", + "<string>" + ], + "cupidatat_207": [ + "<string>", + "<string>" + ] + } + } + ] + } + post: + tags: + - Orders API > Basic + summary: Create + description: >- + Create a order with the given properties and return a copy of the + object, including the ID. Documentation and examples for creating + standard orders is provided. + requestBody: + content: + application/json: + schema: + type: object + example: + associations: + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + properties: + quis4: <string> + sunt__91: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + utf_e: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + commodo2c: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "tempor684": [ + "<string>", + "<string>" + ] + }, + "links": { + "irureef3": "<string>", + "temporb4": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "Duis9": [ + "<string>", + "<string>" + ], + "minim_5f3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "adba": [ + "<string>", + "<string>" + ], + "adipisicing_": [ + "<string>", + "<string>" + ], + "veniam_855": [ + "<string>", + "<string>" + ], + "qui975": [ + "<string>", + "<string>" + ], + "cupidatat_207": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/orders/search: + post: + tags: + - Orders API > Search + summary: post-/crm/v3/objects/orders/search + requestBody: + content: + application/json: + schema: + type: object + example: + after: <string> + filterGroups: + - filters: + - operator: NOT_CONTAINS_TOKEN + propertyName: <string> + highValue: <string> + values: + - <string> + - <string> + value: <string> + - operator: NEQ + propertyName: <string> + highValue: <string> + values: + - <string> + - <string> + value: <string> + - filters: + - operator: NOT_HAS_PROPERTY + propertyName: <string> + highValue: <string> + values: + - <string> + - <string> + value: <string> + - operator: NEQ + propertyName: <string> + highValue: <string> + values: + - <string> + - <string> + value: <string> + limit: <integer> + properties: + - <string> + - <string> + sorts: + - <string> + - <string> + query: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + nostrud_b1: <string> + dolore_bef: <string> + fugiatf5f: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + sunt_44: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + esse81d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + et8d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + irured_4: <string> + est__: <string> + temporc21: <string> + suntb8: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + quic_b: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "tempor684": [ + "<string>", + "<string>" + ] + }, + "links": { + "irureef3": "<string>", + "temporb4": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "Duis9": [ + "<string>", + "<string>" + ], + "minim_5f3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "adba": [ + "<string>", + "<string>" + ], + "adipisicing_": [ + "<string>", + "<string>" + ], + "veniam_855": [ + "<string>", + "<string>" + ], + "qui975": [ + "<string>", + "<string>" + ], + "cupidatat_207": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/owners/: + get: + tags: + - Owners API > Owners + summary: Get a page of owners + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: email + in: query + schema: + type: string + description: Filter by email address (optional) + example: <string> + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: limit + in: query + schema: + type: integer + description: The maximum number of results to display per page. + example: '100' + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - archived: <boolean> + createdAt: <dateTime> + id: <string> + updatedAt: <dateTime> + email: <string> + firstName: <string> + lastName: <string> + userId: <integer> + teams: + - id: <string> + name: <string> + primary: <boolean> + - id: <string> + name: <string> + primary: <boolean> + type: QUEUE + - archived: <boolean> + createdAt: <dateTime> + id: <string> + updatedAt: <dateTime> + email: <string> + firstName: <string> + lastName: <string> + userId: <integer> + teams: + - id: <string> + name: <string> + primary: <boolean> + - id: <string> + name: <string> + primary: <boolean> + type: QUEUE + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ipsum_8": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ut_b": [ + "<string>", + "<string>" + ], + "suntc1a": [ + "<string>", + "<string>" + ], + "eiusmod_84b": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "voluptatee3": [ + "<string>", + "<string>" + ], + "culpa4": [ + "<string>", + "<string>" + ] + }, + "links": { + "pariatur_e84": "<string>" + } + } + /crm/v3/owners/{ownerId}: + get: + tags: + - Owners API > Owners + summary: Read an owner by given `id` or `userId` + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: idProperty + in: query + schema: + type: string + example: id + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + - name: ownerId + in: path + schema: + type: string + required: true + example: <integer> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + archived: <boolean> + createdAt: <dateTime> + id: <string> + updatedAt: <dateTime> + email: <string> + firstName: <string> + lastName: <string> + userId: <integer> + teams: + - id: <string> + name: <string> + primary: <boolean> + - id: <string> + name: <string> + primary: <boolean> + type: PERSON + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ipsum_8": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ut_b": [ + "<string>", + "<string>" + ], + "suntc1a": [ + "<string>", + "<string>" + ], + "eiusmod_84b": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "voluptatee3": [ + "<string>", + "<string>" + ], + "culpa4": [ + "<string>", + "<string>" + ] + }, + "links": { + "pariatur_e84": "<string>" + } + } + /crm/v3/objects/payments/batch/read: + post: + tags: + - Payments API > Batch + summary: Read a batch of payments by internal ID, or unique property values + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + properties: + - <string> + - <string> + propertiesWithHistory: + - <string> + - <string> + idProperty: <string> + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + occaecatdfa: <string> + ut2: <string> + in5: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + voluptate_5: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + in6: <string> + labore_8c: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + eaf: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + in_0a: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + startedAt: <dateTime> + status: PENDING + requestedAt: <dateTime> + links: + commodo_fb2: <string> + consequat4a: <string> + ut_2d: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + laborumbee: <string> + cillum65: <string> + in9: <string> + aute46: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + officia3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + esse_9f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + dolore9: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + pariatur5c9: <string> + eu_: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + cupidatat_06: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + startedAt: <dateTime> + status: COMPLETE + numErrors: <integer> + requestedAt: <dateTime> + links: + ut_5e: <string> + ad_7: <string> + errors: + - category: <string> + context: + in8a5: + - <string> + - <string> + reprehenderit_3b: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + elit_4d0: + - <string> + - <string> + eu9c: + - <string> + - <string> + in_e: + - <string> + - <string> + in_4_b: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + exercitation6: + - <string> + - <string> + elit_6: + - <string> + - <string> + links: + do4: <string> + sit2: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + - category: <string> + context: + occaecat_61: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + nostrud64a: + - <string> + - <string> + quis_6: + - <string> + - <string> + fugiat_8: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + occaecat_83a: + - <string> + - <string> + links: + consecteturc: <string> + in_e: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "tempor_bc": [ + "<string>", + "<string>" + ], + "ex628": [ + "<string>", + "<string>" + ], + "enim_79d": [ + "<string>", + "<string>" + ], + "Excepteur_daf": [ + "<string>", + "<string>" + ] + }, + "links": { + "id9": "<string>", + "consectetur95": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "incididunt3a1": [ + "<string>", + "<string>" + ], + "id_2": [ + "<string>", + "<string>" + ], + "et88": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "amet_c95": [ + "<string>", + "<string>" + ], + "sed0d": [ + "<string>", + "<string>" + ], + "Lorem_3": [ + "<string>", + "<string>" + ], + "eu6": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/payments/{paymentsId}: + get: + tags: + - Payments API > Basic + summary: Read + description: >- + Read an Object identified by `{paymentsId}`. `{paymentsId}` refers to + the internal object ID by default, or optionally any unique property + value as specified by the `idProperty` query param. Control what is + returned via the `properties` query param. + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: paymentsId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + enim9eb: <string> + labore4: <string> + updatedAt: <dateTime> + associations: + commodo2: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + amet_be4: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + elit_05: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + ametd: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "tempor_bc": [ + "<string>", + "<string>" + ], + "ex628": [ + "<string>", + "<string>" + ], + "enim_79d": [ + "<string>", + "<string>" + ], + "Excepteur_daf": [ + "<string>", + "<string>" + ] + }, + "links": { + "id9": "<string>", + "consectetur95": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "incididunt3a1": [ + "<string>", + "<string>" + ], + "id_2": [ + "<string>", + "<string>" + ], + "et88": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "amet_c95": [ + "<string>", + "<string>" + ], + "sed0d": [ + "<string>", + "<string>" + ], + "Lorem_3": [ + "<string>", + "<string>" + ], + "eu6": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/payments: + get: + tags: + - Payments API > Basic + summary: List + description: >- + Read a page of payments. Control what is returned via the `properties` + query param. + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: limit + in: query + schema: + type: integer + description: The maximum number of results to display per page. + example: '10' + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + officia21_: <string> + updatedAt: <dateTime> + associations: + consequat03_: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + sunta42: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + exdbf: <string> + updatedAt: <dateTime> + associations: + cillum_d: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + veniam_ff3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + mollite6e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + in68: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "tempor_bc": [ + "<string>", + "<string>" + ], + "ex628": [ + "<string>", + "<string>" + ], + "enim_79d": [ + "<string>", + "<string>" + ], + "Excepteur_daf": [ + "<string>", + "<string>" + ] + }, + "links": { + "id9": "<string>", + "consectetur95": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "incididunt3a1": [ + "<string>", + "<string>" + ], + "id_2": [ + "<string>", + "<string>" + ], + "et88": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "amet_c95": [ + "<string>", + "<string>" + ], + "sed0d": [ + "<string>", + "<string>" + ], + "Lorem_3": [ + "<string>", + "<string>" + ], + "eu6": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/payments/search: + post: + tags: + - Payments API > Search + summary: post-/crm/v3/objects/payments/search + requestBody: + content: + application/json: + schema: + type: object + example: + after: <string> + filterGroups: + - filters: + - operator: EQ + propertyName: <string> + highValue: <string> + values: + - <string> + - <string> + value: <string> + - operator: GTE + propertyName: <string> + highValue: <string> + values: + - <string> + - <string> + value: <string> + - filters: + - operator: NEQ + propertyName: <string> + highValue: <string> + values: + - <string> + - <string> + value: <string> + - operator: HAS_PROPERTY + propertyName: <string> + highValue: <string> + values: + - <string> + - <string> + value: <string> + limit: <integer> + properties: + - <string> + - <string> + sorts: + - <string> + - <string> + query: <string> + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + veniam5bd: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + consequat_8: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + consecteturba4: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + est_7a: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + aliquad15: <string> + in_3a: <string> + nostrud_b: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + suntaaa: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "tempor_bc": [ + "<string>", + "<string>" + ], + "ex628": [ + "<string>", + "<string>" + ], + "enim_79d": [ + "<string>", + "<string>" + ], + "Excepteur_daf": [ + "<string>", + "<string>" + ] + }, + "links": { + "id9": "<string>", + "consectetur95": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "incididunt3a1": [ + "<string>", + "<string>" + ], + "id_2": [ + "<string>", + "<string>" + ], + "et88": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "amet_c95": [ + "<string>", + "<string>" + ], + "sed0d": [ + "<string>", + "<string>" + ], + "Lorem_3": [ + "<string>", + "<string>" + ], + "eu6": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/pipelines/{objectType}/{pipelineId}: + get: + tags: + - Pipelines API > Pipelines + summary: Return a pipeline by ID + description: Return a single pipeline object identified by its unique `{pipelineId}`. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: objectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + - name: pipelineId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + archived: <boolean> + createdAt: <dateTime> + displayOrder: <integer> + id: <string> + label: <string> + stages: + - archived: <boolean> + createdAt: <dateTime> + displayOrder: <integer> + id: <string> + label: <string> + metadata: + Loremb3_: <string> + Duisf4: <string> + updatedAt: <dateTime> + archivedAt: <dateTime> + writePermissions: INTERNAL_ONLY + - archived: <boolean> + createdAt: <dateTime> + displayOrder: <integer> + id: <string> + label: <string> + metadata: + ea__63: <string> + updatedAt: <dateTime> + archivedAt: <dateTime> + writePermissions: INTERNAL_ONLY + updatedAt: <dateTime> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "in62": [ + "<string>", + "<string>" + ], + "aliquip_f6": [ + "<string>", + "<string>" + ], + "in00": [ + "<string>", + "<string>" + ] + }, + "links": { + "laborea": "<string>", + "aliquip756": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "laborum_0b8": [ + "<string>", + "<string>" + ], + "dolorff5": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "ut_e7": [ + "<string>", + "<string>" + ], + "id_6e": [ + "<string>", + "<string>" + ], + "adipisicingcee": [ + "<string>", + "<string>" + ] + } + } + ] + } + put: + tags: + - Pipelines API > Pipelines + summary: Replace a pipeline + description: >- + Replace all the properties of an existing pipeline with the values + provided. This will overwrite any existing pipeline stages. The updated + pipeline will be returned in the response. + requestBody: + content: + application/json: + schema: + type: object + example: + displayOrder: <integer> + label: <string> + stages: + - displayOrder: <integer> + label: <string> + metadata: + sint_0b: <string> + ea12: <string> + - displayOrder: <integer> + label: <string> + metadata: + nulla3: <string> + Lorem_0fd: <string> + laboris8: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: validateReferencesBeforeDelete + in: query + schema: + type: boolean + example: 'false' + - name: validateDealStageUsagesBeforeDelete + in: query + schema: + type: boolean + example: 'false' + - name: objectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + - name: pipelineId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + archived: <boolean> + createdAt: <dateTime> + displayOrder: <integer> + id: <string> + label: <string> + stages: + - archived: <boolean> + createdAt: <dateTime> + displayOrder: <integer> + id: <string> + label: <string> + metadata: + Loremb3_: <string> + Duisf4: <string> + updatedAt: <dateTime> + archivedAt: <dateTime> + writePermissions: INTERNAL_ONLY + - archived: <boolean> + createdAt: <dateTime> + displayOrder: <integer> + id: <string> + label: <string> + metadata: + ea__63: <string> + updatedAt: <dateTime> + archivedAt: <dateTime> + writePermissions: INTERNAL_ONLY + updatedAt: <dateTime> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "in62": [ + "<string>", + "<string>" + ], + "aliquip_f6": [ + "<string>", + "<string>" + ], + "in00": [ + "<string>", + "<string>" + ] + }, + "links": { + "laborea": "<string>", + "aliquip756": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "laborum_0b8": [ + "<string>", + "<string>" + ], + "dolorff5": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "ut_e7": [ + "<string>", + "<string>" + ], + "id_6e": [ + "<string>", + "<string>" + ], + "adipisicingcee": [ + "<string>", + "<string>" + ] + } + } + ] + } + delete: + tags: + - Pipelines API > Pipelines + summary: Delete a pipeline + description: Delete the pipeline identified by `{pipelineId}`. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: validateReferencesBeforeDelete + in: query + schema: + type: boolean + example: 'false' + - name: validateDealStageUsagesBeforeDelete + in: query + schema: + type: boolean + example: 'false' + - name: objectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + - name: pipelineId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "in62": [ + "<string>", + "<string>" + ], + "aliquip_f6": [ + "<string>", + "<string>" + ], + "in00": [ + "<string>", + "<string>" + ] + }, + "links": { + "laborea": "<string>", + "aliquip756": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "laborum_0b8": [ + "<string>", + "<string>" + ], + "dolorff5": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "ut_e7": [ + "<string>", + "<string>" + ], + "id_6e": [ + "<string>", + "<string>" + ], + "adipisicingcee": [ + "<string>", + "<string>" + ] + } + } + ] + } + patch: + tags: + - Pipelines API > Pipelines + summary: Update a pipeline + description: >- + Perform a partial update of the pipeline identified by `{pipelineId}`. + The updated pipeline will be returned in the response. + requestBody: + content: + application/json: + schema: + type: object + example: + archived: <boolean> + displayOrder: <integer> + label: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: validateReferencesBeforeDelete + in: query + schema: + type: boolean + example: 'false' + - name: validateDealStageUsagesBeforeDelete + in: query + schema: + type: boolean + example: 'false' + - name: objectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + - name: pipelineId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + archived: <boolean> + createdAt: <dateTime> + displayOrder: <integer> + id: <string> + label: <string> + stages: + - archived: <boolean> + createdAt: <dateTime> + displayOrder: <integer> + id: <string> + label: <string> + metadata: + Loremb3_: <string> + Duisf4: <string> + updatedAt: <dateTime> + archivedAt: <dateTime> + writePermissions: INTERNAL_ONLY + - archived: <boolean> + createdAt: <dateTime> + displayOrder: <integer> + id: <string> + label: <string> + metadata: + ea__63: <string> + updatedAt: <dateTime> + archivedAt: <dateTime> + writePermissions: INTERNAL_ONLY + updatedAt: <dateTime> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "in62": [ + "<string>", + "<string>" + ], + "aliquip_f6": [ + "<string>", + "<string>" + ], + "in00": [ + "<string>", + "<string>" + ] + }, + "links": { + "laborea": "<string>", + "aliquip756": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "laborum_0b8": [ + "<string>", + "<string>" + ], + "dolorff5": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "ut_e7": [ + "<string>", + "<string>" + ], + "id_6e": [ + "<string>", + "<string>" + ], + "adipisicingcee": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/pipelines/{objectType}: + get: + tags: + - Pipelines API > Pipelines + summary: Retrieve all pipelines + description: Return all pipelines for the object type specified by `{objectType}`. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: objectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - archived: <boolean> + createdAt: <dateTime> + displayOrder: <integer> + id: <string> + label: <string> + stages: + - archived: <boolean> + createdAt: <dateTime> + displayOrder: <integer> + id: <string> + label: <string> + metadata: + sunt_c7a: <string> + aute0a: <string> + ipsumc9: <string> + updatedAt: <dateTime> + archivedAt: <dateTime> + writePermissions: READ_ONLY + - archived: <boolean> + createdAt: <dateTime> + displayOrder: <integer> + id: <string> + label: <string> + metadata: + laboris5: <string> + updatedAt: <dateTime> + archivedAt: <dateTime> + writePermissions: READ_ONLY + updatedAt: <dateTime> + archivedAt: <dateTime> + - archived: <boolean> + createdAt: <dateTime> + displayOrder: <integer> + id: <string> + label: <string> + stages: + - archived: <boolean> + createdAt: <dateTime> + displayOrder: <integer> + id: <string> + label: <string> + metadata: + aliqua_8: <string> + updatedAt: <dateTime> + archivedAt: <dateTime> + writePermissions: CRM_PERMISSIONS_ENFORCEMENT + - archived: <boolean> + createdAt: <dateTime> + displayOrder: <integer> + id: <string> + label: <string> + metadata: + qui41: <string> + nisi_a: <string> + updatedAt: <dateTime> + archivedAt: <dateTime> + writePermissions: CRM_PERMISSIONS_ENFORCEMENT + updatedAt: <dateTime> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "in62": [ + "<string>", + "<string>" + ], + "aliquip_f6": [ + "<string>", + "<string>" + ], + "in00": [ + "<string>", + "<string>" + ] + }, + "links": { + "laborea": "<string>", + "aliquip756": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "laborum_0b8": [ + "<string>", + "<string>" + ], + "dolorff5": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "ut_e7": [ + "<string>", + "<string>" + ], + "id_6e": [ + "<string>", + "<string>" + ], + "adipisicingcee": [ + "<string>", + "<string>" + ] + } + } + ] + } + post: + tags: + - Pipelines API > Pipelines + summary: Create a pipeline + description: >- + Create a new pipeline with the provided property values. The entire + pipeline object, including its unique ID, will be returned in the + response. + requestBody: + content: + application/json: + schema: + type: object + example: + displayOrder: <integer> + label: <string> + stages: + - displayOrder: <integer> + label: <string> + metadata: + sint_0b: <string> + ea12: <string> + - displayOrder: <integer> + label: <string> + metadata: + nulla3: <string> + Lorem_0fd: <string> + laboris8: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: objectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + archived: <boolean> + createdAt: <dateTime> + displayOrder: <integer> + id: <string> + label: <string> + stages: + - archived: <boolean> + createdAt: <dateTime> + displayOrder: <integer> + id: <string> + label: <string> + metadata: + Loremb3_: <string> + Duisf4: <string> + updatedAt: <dateTime> + archivedAt: <dateTime> + writePermissions: INTERNAL_ONLY + - archived: <boolean> + createdAt: <dateTime> + displayOrder: <integer> + id: <string> + label: <string> + metadata: + ea__63: <string> + updatedAt: <dateTime> + archivedAt: <dateTime> + writePermissions: INTERNAL_ONLY + updatedAt: <dateTime> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "in62": [ + "<string>", + "<string>" + ], + "aliquip_f6": [ + "<string>", + "<string>" + ], + "in00": [ + "<string>", + "<string>" + ] + }, + "links": { + "laborea": "<string>", + "aliquip756": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "laborum_0b8": [ + "<string>", + "<string>" + ], + "dolorff5": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "ut_e7": [ + "<string>", + "<string>" + ], + "id_6e": [ + "<string>", + "<string>" + ], + "adipisicingcee": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/pipelines/{objectType}/{pipelineId}/audit: + get: + tags: + - Pipelines API > Pipeline Audits + summary: Return an audit of all changes to the pipeline + description: >- + Return a reverse chronological list of all mutations that have occurred + on the pipeline identified by `{pipelineId}`. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: objectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + - name: pipelineId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - action: <string> + identifier: <string> + portalId: <integer> + rawObject: {} + fromUserId: <integer> + message: <string> + timestamp: <dateTime> + - action: <string> + identifier: <string> + portalId: <integer> + rawObject: {} + fromUserId: <integer> + message: <string> + timestamp: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "in62": [ + "<string>", + "<string>" + ], + "aliquip_f6": [ + "<string>", + "<string>" + ], + "in00": [ + "<string>", + "<string>" + ] + }, + "links": { + "laborea": "<string>", + "aliquip756": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "laborum_0b8": [ + "<string>", + "<string>" + ], + "dolorff5": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "ut_e7": [ + "<string>", + "<string>" + ], + "id_6e": [ + "<string>", + "<string>" + ], + "adipisicingcee": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/pipelines/{objectType}/{pipelineId}/stages: + get: + tags: + - Pipelines API > Pipeline Stages + summary: Return all stages of a pipeline + description: >- + Return all the stages associated with the pipeline identified by + `{pipelineId}`. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: objectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + - name: pipelineId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - archived: <boolean> + createdAt: <dateTime> + displayOrder: <integer> + id: <string> + label: <string> + metadata: + pariaturc8: <string> + Lorem__3: <string> + updatedAt: <dateTime> + archivedAt: <dateTime> + writePermissions: CRM_PERMISSIONS_ENFORCEMENT + - archived: <boolean> + createdAt: <dateTime> + displayOrder: <integer> + id: <string> + label: <string> + metadata: + autea0f: <string> + fugiat_7a: <string> + updatedAt: <dateTime> + archivedAt: <dateTime> + writePermissions: READ_ONLY + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "in62": [ + "<string>", + "<string>" + ], + "aliquip_f6": [ + "<string>", + "<string>" + ], + "in00": [ + "<string>", + "<string>" + ] + }, + "links": { + "laborea": "<string>", + "aliquip756": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "laborum_0b8": [ + "<string>", + "<string>" + ], + "dolorff5": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "ut_e7": [ + "<string>", + "<string>" + ], + "id_6e": [ + "<string>", + "<string>" + ], + "adipisicingcee": [ + "<string>", + "<string>" + ] + } + } + ] + } + post: + tags: + - Pipelines API > Pipeline Stages + summary: Create a pipeline stage + description: >- + Create a new stage associated with the pipeline identified by + `{pipelineId}`. The entire stage object, including its unique ID, will + be returned in the response. + requestBody: + content: + application/json: + schema: + type: object + example: + displayOrder: <integer> + label: <string> + metadata: + cupidatat7f2: <string> + esse4_6: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: objectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + - name: pipelineId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + archived: <boolean> + createdAt: <dateTime> + displayOrder: <integer> + id: <string> + label: <string> + metadata: + mollit9f: <string> + updatedAt: <dateTime> + archivedAt: <dateTime> + writePermissions: READ_ONLY + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "in62": [ + "<string>", + "<string>" + ], + "aliquip_f6": [ + "<string>", + "<string>" + ], + "in00": [ + "<string>", + "<string>" + ] + }, + "links": { + "laborea": "<string>", + "aliquip756": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "laborum_0b8": [ + "<string>", + "<string>" + ], + "dolorff5": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "ut_e7": [ + "<string>", + "<string>" + ], + "id_6e": [ + "<string>", + "<string>" + ], + "adipisicingcee": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId}: + get: + tags: + - Pipelines API > Pipeline Stages + summary: Return a pipeline stage by ID + description: >- + Return the stage identified by `{stageId}` associated with the pipeline + identified by `{pipelineId}`. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: objectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + - name: pipelineId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + - name: stageId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + archived: <boolean> + createdAt: <dateTime> + displayOrder: <integer> + id: <string> + label: <string> + metadata: + mollit9f: <string> + updatedAt: <dateTime> + archivedAt: <dateTime> + writePermissions: READ_ONLY + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "in62": [ + "<string>", + "<string>" + ], + "aliquip_f6": [ + "<string>", + "<string>" + ], + "in00": [ + "<string>", + "<string>" + ] + }, + "links": { + "laborea": "<string>", + "aliquip756": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "laborum_0b8": [ + "<string>", + "<string>" + ], + "dolorff5": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "ut_e7": [ + "<string>", + "<string>" + ], + "id_6e": [ + "<string>", + "<string>" + ], + "adipisicingcee": [ + "<string>", + "<string>" + ] + } + } + ] + } + put: + tags: + - Pipelines API > Pipeline Stages + summary: Replace a pipeline stage + description: >- + Replace all the properties of an existing pipeline stage with the values + provided. The updated stage will be returned in the response. + requestBody: + content: + application/json: + schema: + type: object + example: + displayOrder: <integer> + label: <string> + metadata: + cupidatat7f2: <string> + esse4_6: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: objectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + - name: pipelineId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + - name: stageId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + archived: <boolean> + createdAt: <dateTime> + displayOrder: <integer> + id: <string> + label: <string> + metadata: + mollit9f: <string> + updatedAt: <dateTime> + archivedAt: <dateTime> + writePermissions: READ_ONLY + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "in62": [ + "<string>", + "<string>" + ], + "aliquip_f6": [ + "<string>", + "<string>" + ], + "in00": [ + "<string>", + "<string>" + ] + }, + "links": { + "laborea": "<string>", + "aliquip756": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "laborum_0b8": [ + "<string>", + "<string>" + ], + "dolorff5": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "ut_e7": [ + "<string>", + "<string>" + ], + "id_6e": [ + "<string>", + "<string>" + ], + "adipisicingcee": [ + "<string>", + "<string>" + ] + } + } + ] + } + delete: + tags: + - Pipelines API > Pipeline Stages + summary: Delete a pipeline stage + description: >- + Delete the pipeline stage identified by `{stageId}` associated with the + pipeline identified by `{pipelineId}`. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: objectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + - name: pipelineId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + - name: stageId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "in62": [ + "<string>", + "<string>" + ], + "aliquip_f6": [ + "<string>", + "<string>" + ], + "in00": [ + "<string>", + "<string>" + ] + }, + "links": { + "laborea": "<string>", + "aliquip756": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "laborum_0b8": [ + "<string>", + "<string>" + ], + "dolorff5": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "ut_e7": [ + "<string>", + "<string>" + ], + "id_6e": [ + "<string>", + "<string>" + ], + "adipisicingcee": [ + "<string>", + "<string>" + ] + } + } + ] + } + patch: + tags: + - Pipelines API > Pipeline Stages + summary: Update a pipeline stage + description: >- + Perform a partial update of the pipeline stage identified by `{stageId}` + associated with the pipeline identified by `{pipelineId}`. Any + properties not included in this update will keep their existing values. + The updated stage will be returned in the response. + requestBody: + content: + application/json: + schema: + type: object + example: + metadata: + ullamco7: <string> + eiusmodc1: <string> + Duis5: <string> + archived: <boolean> + displayOrder: <integer> + label: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: objectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + - name: pipelineId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + - name: stageId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + archived: <boolean> + createdAt: <dateTime> + displayOrder: <integer> + id: <string> + label: <string> + metadata: + mollit9f: <string> + updatedAt: <dateTime> + archivedAt: <dateTime> + writePermissions: READ_ONLY + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "in62": [ + "<string>", + "<string>" + ], + "aliquip_f6": [ + "<string>", + "<string>" + ], + "in00": [ + "<string>", + "<string>" + ] + }, + "links": { + "laborea": "<string>", + "aliquip756": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "laborum_0b8": [ + "<string>", + "<string>" + ], + "dolorff5": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "ut_e7": [ + "<string>", + "<string>" + ], + "id_6e": [ + "<string>", + "<string>" + ], + "adipisicingcee": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId}/audit: + get: + tags: + - Pipelines API + summary: Return an audit of all changes to the pipeline stage + description: >- + Return a reverse chronological list of all mutations that have occurred + on the pipeline stage identified by `{stageId}`. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: objectType + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + - name: pipelineId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: \A + - name: stageId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - action: sunt eiusmod ipsum sed + identifier: sit culpa voluptate + portalId: -67693291 + rawObject: {} + fromUserId: 81978954 + message: eiusmod pariatu + timestamp: '1992-05-23T04:37:35.967Z' + - action: amet dolore sunt laborum nisi + identifier: in amet sint Ut labore + portalId: 96814393 + rawObject: {} + fromUserId: -30236487 + message: magna ex + timestamp: '2016-07-21T15:14:29.846Z' + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "nostrud7c6": [ + "<string>", + "<string>" + ] + }, + "links": { + "nisi_7d3": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "ipsum6_": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "Excepteur_90": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/products/batch/archive: + post: + tags: + - Products API > Batch + summary: Archive a batch of products by ID + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "mollit_": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "enim_3": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "in8": [ + "<string>", + "<string>" + ], + "velit2a": [ + "<string>", + "<string>" + ], + "est6a": [ + "<string>", + "<string>" + ], + "idd3f": [ + "<string>", + "<string>" + ] + }, + "links": { + "in4": "<string>" + } + } + /crm/v3/objects/products/batch/read: + post: + tags: + - Products API > Batch + summary: Read a batch of products by internal ID, or unique property values + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + properties: + - <string> + - <string> + propertiesWithHistory: + - <string> + - <string> + idProperty: <string> + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + enimb3b: <string> + updatedAt: <dateTime> + propertiesWithHistory: + magna__0e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + ipsum_68f: <string> + dolore03: <string> + updatedAt: <dateTime> + propertiesWithHistory: + voluptate__1b: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: CANCELED + requestedAt: <dateTime> + links: + do_b: <string> + doaba: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + elit_898: <string> + updatedAt: <dateTime> + propertiesWithHistory: + commodo_7c: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + amet_5c3: <string> + consequat_e1_: <string> + updatedAt: <dateTime> + propertiesWithHistory: + ullamcod: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: COMPLETE + numErrors: <integer> + errors: + - category: <string> + context: + fugiat3de: + - <string> + - <string> + deserunt_3: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + incididuntc: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + enim_b: + - <string> + - <string> + sunt_f5_: + - <string> + - <string> + links: + incididunt70: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + reprehenderit_aa: + - <string> + - <string> + incididunt_6: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + dolor5c: + - <string> + - <string> + dolore2: + - <string> + - <string> + laborum_5: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + laborum17: + - <string> + - <string> + consectetur_a32: + - <string> + - <string> + links: + sunt_4c1: <string> + incididunt7: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + qui35: <string> + fugiat_7: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "mollit_": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "enim_3": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "in8": [ + "<string>", + "<string>" + ], + "velit2a": [ + "<string>", + "<string>" + ], + "est6a": [ + "<string>", + "<string>" + ], + "idd3f": [ + "<string>", + "<string>" + ] + }, + "links": { + "in4": "<string>" + } + } + /crm/v3/objects/products/batch/create: + post: + tags: + - Products API > Batch + summary: Create a batch of products + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - associations: + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + properties: + incididunt6: <string> + dolore54e: <string> + - associations: + - to: + id: <string> + types: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + properties: + Ut_3: <string> + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + enimb3b: <string> + updatedAt: <dateTime> + propertiesWithHistory: + magna__0e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + ipsum_68f: <string> + dolore03: <string> + updatedAt: <dateTime> + propertiesWithHistory: + voluptate__1b: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: CANCELED + requestedAt: <dateTime> + links: + do_b: <string> + doaba: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + elit_898: <string> + updatedAt: <dateTime> + propertiesWithHistory: + commodo_7c: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + amet_5c3: <string> + consequat_e1_: <string> + updatedAt: <dateTime> + propertiesWithHistory: + ullamcod: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: COMPLETE + numErrors: <integer> + errors: + - category: <string> + context: + fugiat3de: + - <string> + - <string> + deserunt_3: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + incididuntc: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + enim_b: + - <string> + - <string> + sunt_f5_: + - <string> + - <string> + links: + incididunt70: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + reprehenderit_aa: + - <string> + - <string> + incididunt_6: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + dolor5c: + - <string> + - <string> + dolore2: + - <string> + - <string> + laborum_5: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + laborum17: + - <string> + - <string> + consectetur_a32: + - <string> + - <string> + links: + sunt_4c1: <string> + incididunt7: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + qui35: <string> + fugiat_7: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "mollit_": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "enim_3": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "in8": [ + "<string>", + "<string>" + ], + "velit2a": [ + "<string>", + "<string>" + ], + "est6a": [ + "<string>", + "<string>" + ], + "idd3f": [ + "<string>", + "<string>" + ] + }, + "links": { + "in4": "<string>" + } + } + /crm/v3/objects/products/batch/update: + post: + tags: + - Products API > Batch + summary: Update a batch of products by internal ID, or unique property values + requestBody: + content: {} + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + enimb3b: <string> + updatedAt: <dateTime> + propertiesWithHistory: + magna__0e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + ipsum_68f: <string> + dolore03: <string> + updatedAt: <dateTime> + propertiesWithHistory: + voluptate__1b: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: CANCELED + requestedAt: <dateTime> + links: + do_b: <string> + doaba: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + elit_898: <string> + updatedAt: <dateTime> + propertiesWithHistory: + commodo_7c: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + amet_5c3: <string> + consequat_e1_: <string> + updatedAt: <dateTime> + propertiesWithHistory: + ullamcod: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: COMPLETE + numErrors: <integer> + errors: + - category: <string> + context: + fugiat3de: + - <string> + - <string> + deserunt_3: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + incididuntc: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + enim_b: + - <string> + - <string> + sunt_f5_: + - <string> + - <string> + links: + incididunt70: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + reprehenderit_aa: + - <string> + - <string> + incididunt_6: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + dolor5c: + - <string> + - <string> + dolore2: + - <string> + - <string> + laborum_5: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + laborum17: + - <string> + - <string> + consectetur_a32: + - <string> + - <string> + links: + sunt_4c1: <string> + incididunt7: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + qui35: <string> + fugiat_7: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "mollit_": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "enim_3": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "in8": [ + "<string>", + "<string>" + ], + "velit2a": [ + "<string>", + "<string>" + ], + "est6a": [ + "<string>", + "<string>" + ], + "idd3f": [ + "<string>", + "<string>" + ] + }, + "links": { + "in4": "<string>" + } + } + /crm/v3/objects/products: + get: + tags: + - Products API > Basic + summary: List + description: >- + Read a page of products. Control what is returned via the `properties` + query param. + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: limit + in: query + schema: + type: integer + description: The maximum number of results to display per page. + example: '10' + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + Duis_c5: <string> + cupidatat9e: <string> + updatedAt: <dateTime> + propertiesWithHistory: + dolor_dc7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + ut_c: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + este: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + - createdAt: <dateTime> + id: <string> + properties: + consectetur_89a: <string> + updatedAt: <dateTime> + propertiesWithHistory: + laborisa1: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + commodo985: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + minim_e: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + laboris_72: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + cillum_9: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "mollit_": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "enim_3": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "in8": [ + "<string>", + "<string>" + ], + "velit2a": [ + "<string>", + "<string>" + ], + "est6a": [ + "<string>", + "<string>" + ], + "idd3f": [ + "<string>", + "<string>" + ] + }, + "links": { + "in4": "<string>" + } + } + post: + tags: + - Products API > Basic + summary: Create + description: >- + Create a product with the given properties and return a copy of the + object, including the ID. Documentation and examples for creating + standard products is provided. + requestBody: + content: + application/json: + schema: + type: object + example: + associations: + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + properties: + Ut4c: <string> + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + et_40: <string> + updatedAt: <dateTime> + propertiesWithHistory: + sed25: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "mollit_": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "enim_3": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "in8": [ + "<string>", + "<string>" + ], + "velit2a": [ + "<string>", + "<string>" + ], + "est6a": [ + "<string>", + "<string>" + ], + "idd3f": [ + "<string>", + "<string>" + ] + }, + "links": { + "in4": "<string>" + } + } + /crm/v3/objects/products/{productId}: + get: + tags: + - Products API > Basic + summary: Read + description: >- + Read an Object identified by `{productId}`. `{productId}` refers to the + internal object ID by default, or optionally any unique property value + as specified by the `idProperty` query param. Control what is returned + via the `properties` query param. + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: productId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + tempor_941: <string> + consequat_5d: <string> + updatedAt: <dateTime> + propertiesWithHistory: + Ut_e68: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + labore_b: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + sunt_b98: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + dolore8: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "mollit_": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "enim_3": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "in8": [ + "<string>", + "<string>" + ], + "velit2a": [ + "<string>", + "<string>" + ], + "est6a": [ + "<string>", + "<string>" + ], + "idd3f": [ + "<string>", + "<string>" + ] + }, + "links": { + "in4": "<string>" + } + } + delete: + tags: + - Products API > Basic + summary: Archive + description: Move an Object identified by `{productId}` to the recycling bin. + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: productId + in: path + schema: + type: string + required: true + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "mollit_": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "enim_3": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "in8": [ + "<string>", + "<string>" + ], + "velit2a": [ + "<string>", + "<string>" + ], + "est6a": [ + "<string>", + "<string>" + ], + "idd3f": [ + "<string>", + "<string>" + ] + }, + "links": { + "in4": "<string>" + } + } + patch: + tags: + - Products API > Basic + summary: Update + description: >- + Perform a partial update of an Object identified by `{productId}`. + `{productId}` refers to the internal object ID by default, or optionally + any unique property value as specified by the `idProperty` query param. + Provided property values will be overwritten. Read-only and non-existent + properties will be ignored. Properties values can be cleared by passing + an empty string. + requestBody: + content: + application/json: + schema: + type: object + example: + properties: + tempor_d9: <string> + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: productId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + et_40: <string> + updatedAt: <dateTime> + propertiesWithHistory: + sed25: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "mollit_": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "enim_3": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "in8": [ + "<string>", + "<string>" + ], + "velit2a": [ + "<string>", + "<string>" + ], + "est6a": [ + "<string>", + "<string>" + ], + "idd3f": [ + "<string>", + "<string>" + ] + }, + "links": { + "in4": "<string>" + } + } + /crm/v3/objects/products/search: + post: + tags: + - Products API > Search + summary: post-/crm/v3/objects/products/search do Search + requestBody: + content: {} + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + aliquad2: <string> + updatedAt: <dateTime> + propertiesWithHistory: + dolore8d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + nisid3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + eu_f: <string> + updatedAt: <dateTime> + propertiesWithHistory: + ipsumf9d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "mollit_": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "enim_3": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "in8": [ + "<string>", + "<string>" + ], + "velit2a": [ + "<string>", + "<string>" + ], + "est6a": [ + "<string>", + "<string>" + ], + "idd3f": [ + "<string>", + "<string>" + ] + }, + "links": { + "in4": "<string>" + } + } + /crm/v3/objects/quotes/batch/archive: + post: + tags: + - Quotes API > Batch + summary: Archive a batch of quotes by ID + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "labore_81": [ + "<string>", + "<string>" + ], + "cillum187": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "sunt719": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "Lorem7e": [ + "<string>", + "<string>" + ], + "Lorem3d": [ + "<string>", + "<string>" + ] + }, + "links": { + "ea6": "<string>", + "cupidatat_66": "<string>" + } + } + /crm/v3/objects/quotes/batch/update: + post: + tags: + - Quotes API > Batch + summary: Update a batch of quotes by internal ID, or unique property values + requestBody: + content: {} + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + qui_8: <string> + ullamco_ac9: <string> + updatedAt: <dateTime> + propertiesWithHistory: + dolor4a0: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + nulla_11: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + dofbf: <string> + updatedAt: <dateTime> + propertiesWithHistory: + quis_5e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + doloree: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + dolor_e2: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + consecteturd_: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PENDING + requestedAt: <dateTime> + links: + esseb90: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + quif30: <string> + updatedAt: <dateTime> + propertiesWithHistory: + pariatur_64_: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + occaecat48: <string> + occaecat_6: <string> + consequat_b: <string> + updatedAt: <dateTime> + propertiesWithHistory: + commodo_f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PROCESSING + numErrors: <integer> + errors: + - category: <string> + context: + fugiate65: + - <string> + - <string> + proident_fe: + - <string> + - <string> + est___: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + dolor_f9: + - <string> + - <string> + tempor_26a: + - <string> + - <string> + irurec_f: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + amet_7: + - <string> + - <string> + officia_373: + - <string> + - <string> + tempor_d: + - <string> + - <string> + reprehenderit_2: + - <string> + - <string> + links: + ullamco5: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + dolore_cab: + - <string> + - <string> + et5: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + Lorem_a01: + - <string> + - <string> + exercitation1: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + quis_4: + - <string> + - <string> + exercitationdc: + - <string> + - <string> + links: + officia_fe3: <string> + dolor_47: <string> + est5c: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + Ut19: <string> + sunt07: <string> + ut035: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "labore_81": [ + "<string>", + "<string>" + ], + "cillum187": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "sunt719": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "Lorem7e": [ + "<string>", + "<string>" + ], + "Lorem3d": [ + "<string>", + "<string>" + ] + }, + "links": { + "ea6": "<string>", + "cupidatat_66": "<string>" + } + } + /crm/v3/objects/quotes/batch/create: + post: + tags: + - Quotes API > Batch + summary: Create a batch of quotes + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - associations: + - to: + id: <string> + types: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + properties: + fugiat_b8: <string> + dolor_331: <string> + - associations: + - to: + id: <string> + types: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + properties: + ut__4: <string> + quic: <string> + eiusmod670: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + qui_8: <string> + ullamco_ac9: <string> + updatedAt: <dateTime> + propertiesWithHistory: + dolor4a0: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + nulla_11: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + dofbf: <string> + updatedAt: <dateTime> + propertiesWithHistory: + quis_5e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + doloree: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + dolor_e2: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + consecteturd_: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PENDING + requestedAt: <dateTime> + links: + esseb90: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + quif30: <string> + updatedAt: <dateTime> + propertiesWithHistory: + pariatur_64_: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + occaecat48: <string> + occaecat_6: <string> + consequat_b: <string> + updatedAt: <dateTime> + propertiesWithHistory: + commodo_f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PROCESSING + numErrors: <integer> + errors: + - category: <string> + context: + fugiate65: + - <string> + - <string> + proident_fe: + - <string> + - <string> + est___: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + dolor_f9: + - <string> + - <string> + tempor_26a: + - <string> + - <string> + irurec_f: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + amet_7: + - <string> + - <string> + officia_373: + - <string> + - <string> + tempor_d: + - <string> + - <string> + reprehenderit_2: + - <string> + - <string> + links: + ullamco5: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + dolore_cab: + - <string> + - <string> + et5: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + Lorem_a01: + - <string> + - <string> + exercitation1: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + quis_4: + - <string> + - <string> + exercitationdc: + - <string> + - <string> + links: + officia_fe3: <string> + dolor_47: <string> + est5c: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + Ut19: <string> + sunt07: <string> + ut035: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "labore_81": [ + "<string>", + "<string>" + ], + "cillum187": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "sunt719": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "Lorem7e": [ + "<string>", + "<string>" + ], + "Lorem3d": [ + "<string>", + "<string>" + ] + }, + "links": { + "ea6": "<string>", + "cupidatat_66": "<string>" + } + } + /crm/v3/objects/quotes/batch/read: + post: + tags: + - Quotes API > Batch + summary: Read a batch of quotes by internal ID, or unique property values + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + properties: + - <string> + - <string> + propertiesWithHistory: + - <string> + - <string> + idProperty: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + qui_8: <string> + ullamco_ac9: <string> + updatedAt: <dateTime> + propertiesWithHistory: + dolor4a0: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + nulla_11: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + dofbf: <string> + updatedAt: <dateTime> + propertiesWithHistory: + quis_5e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + doloree: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + dolor_e2: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + consecteturd_: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PENDING + requestedAt: <dateTime> + links: + esseb90: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + quif30: <string> + updatedAt: <dateTime> + propertiesWithHistory: + pariatur_64_: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + occaecat48: <string> + occaecat_6: <string> + consequat_b: <string> + updatedAt: <dateTime> + propertiesWithHistory: + commodo_f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PROCESSING + numErrors: <integer> + errors: + - category: <string> + context: + fugiate65: + - <string> + - <string> + proident_fe: + - <string> + - <string> + est___: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + dolor_f9: + - <string> + - <string> + tempor_26a: + - <string> + - <string> + irurec_f: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + amet_7: + - <string> + - <string> + officia_373: + - <string> + - <string> + tempor_d: + - <string> + - <string> + reprehenderit_2: + - <string> + - <string> + links: + ullamco5: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + dolore_cab: + - <string> + - <string> + et5: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + Lorem_a01: + - <string> + - <string> + exercitation1: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + quis_4: + - <string> + - <string> + exercitationdc: + - <string> + - <string> + links: + officia_fe3: <string> + dolor_47: <string> + est5c: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + Ut19: <string> + sunt07: <string> + ut035: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "labore_81": [ + "<string>", + "<string>" + ], + "cillum187": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "sunt719": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "Lorem7e": [ + "<string>", + "<string>" + ], + "Lorem3d": [ + "<string>", + "<string>" + ] + }, + "links": { + "ea6": "<string>", + "cupidatat_66": "<string>" + } + } + /crm/v3/objects/quotes: + get: + tags: + - Quotes API > Basic + summary: List + description: >- + Read a page of quotes. Control what is returned via the `properties` + query param. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: limit + in: query + schema: + type: integer + description: The maximum number of results to display per page. + example: '10' + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + sed_edb: <string> + dolor0d6: <string> + esse_8: <string> + updatedAt: <dateTime> + propertiesWithHistory: + qui72: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + quis_65: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + in_a: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + - createdAt: <dateTime> + id: <string> + properties: + fugiat_f1: <string> + exercitation_4f4: <string> + updatedAt: <dateTime> + propertiesWithHistory: + et_eb7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + adipisicing_5c: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + ex_1: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + aliqua_7a: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "labore_81": [ + "<string>", + "<string>" + ], + "cillum187": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "sunt719": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "Lorem7e": [ + "<string>", + "<string>" + ], + "Lorem3d": [ + "<string>", + "<string>" + ] + }, + "links": { + "ea6": "<string>", + "cupidatat_66": "<string>" + } + } + post: + tags: + - Quotes API > Basic + summary: Create + description: >- + Create a quote with the given properties and return a copy of the + object, including the ID. Documentation and examples for creating + standard quotes is provided. + requestBody: + content: + application/json: + schema: + type: object + example: + associations: + - to: + id: <string> + types: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + properties: + elit_26: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + sed_6: <string> + updatedAt: <dateTime> + propertiesWithHistory: + culpa0: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "labore_81": [ + "<string>", + "<string>" + ], + "cillum187": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "sunt719": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "Lorem7e": [ + "<string>", + "<string>" + ], + "Lorem3d": [ + "<string>", + "<string>" + ] + }, + "links": { + "ea6": "<string>", + "cupidatat_66": "<string>" + } + } + /crm/v3/objects/quotes/{quoteId}: + get: + tags: + - Quotes API > Basic + summary: Read + description: >- + Read an Object identified by `{quoteId}`. `{quoteId}` refers to the + internal object ID by default, or optionally any unique property value + as specified by the `idProperty` query param. Control what is returned + via the `properties` query param. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: quoteId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + ipsumbc: <string> + Duis826: <string> + ut71_: <string> + quis_ca: <string> + updatedAt: <dateTime> + propertiesWithHistory: + in_b: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + occaecat_32: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + cupidatat_f1: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "labore_81": [ + "<string>", + "<string>" + ], + "cillum187": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "sunt719": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "Lorem7e": [ + "<string>", + "<string>" + ], + "Lorem3d": [ + "<string>", + "<string>" + ] + }, + "links": { + "ea6": "<string>", + "cupidatat_66": "<string>" + } + } + delete: + tags: + - Quotes API > Basic + summary: Archive + description: Move an Object identified by `{quoteId}` to the recycling bin. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: quoteId + in: path + schema: + type: string + required: true + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "labore_81": [ + "<string>", + "<string>" + ], + "cillum187": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "sunt719": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "Lorem7e": [ + "<string>", + "<string>" + ], + "Lorem3d": [ + "<string>", + "<string>" + ] + }, + "links": { + "ea6": "<string>", + "cupidatat_66": "<string>" + } + } + patch: + tags: + - Quotes API > Basic + summary: Update + description: >- + Perform a partial update of an Object identified by `{quoteId}`. + `{quoteId}` refers to the internal object ID by default, or optionally + any unique property value as specified by the `idProperty` query param. + Provided property values will be overwritten. Read-only and non-existent + properties will be ignored. Properties values can be cleared by passing + an empty string. + requestBody: + content: + application/json: + schema: + type: object + example: + properties: + consequat_82: <string> + sit1c: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: quoteId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + sed_6: <string> + updatedAt: <dateTime> + propertiesWithHistory: + culpa0: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "labore_81": [ + "<string>", + "<string>" + ], + "cillum187": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "sunt719": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "Lorem7e": [ + "<string>", + "<string>" + ], + "Lorem3d": [ + "<string>", + "<string>" + ] + }, + "links": { + "ea6": "<string>", + "cupidatat_66": "<string>" + } + } + /crm/v3/objects/quotes/search: + post: + tags: + - Quotes API > Search + summary: post-/crm/v3/objects/quotes/search do Search + requestBody: + content: {} + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + veniamf: <string> + exercitation__: <string> + nulla8: <string> + updatedAt: <dateTime> + propertiesWithHistory: + deserunt40: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + ut_3e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + reprehenderitd: <string> + dolored31: <string> + updatedAt: <dateTime> + propertiesWithHistory: + ad_f_: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + in1d5: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + estb47: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "labore_81": [ + "<string>", + "<string>" + ], + "cillum187": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "sunt719": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "Lorem7e": [ + "<string>", + "<string>" + ], + "Lorem3d": [ + "<string>", + "<string>" + ] + }, + "links": { + "ea6": "<string>", + "cupidatat_66": "<string>" + } + } + /crm/v3/objects/quotes/batch/upsert: + post: + tags: + - Quotes API + summary: Create or update a batch of quotes by unique property values + description: >- + Create or update records identified by a unique property value as + specified by the `idProperty` query param. `idProperty` query param + refers to a property whose values are unique for the object. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + properties: + aliqua_1: <string> + dolore_82: <string> + Excepteur_b57: <string> + idProperty: <string> + objectWriteTraceId: <string> + - id: <string> + properties: + ex896: <string> + dolore_c87: <string> + labore147: <string> + dodf: <string> + idProperty: <string> + objectWriteTraceId: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + new: <boolean> + properties: + exercitation1: <string> + Duis4e2: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + nostrud7: + - sourceType: quis est + timestamp: '2024-05-05T17:55:40.068Z' + value: in Ut sit adipisicin + sourceId: tempor deserunt aliquip do + sourceLabel: incididunt adipisicing ea + updatedByUserId: -20499884 + - sourceType: veniam est dolore officia + timestamp: '1992-02-23T10:43:26.166Z' + value: i + sourceId: Duis + sourceLabel: irure proident eiusmod laborum ullamco + updatedByUserId: -90436829 + - createdAt: <dateTime> + id: <string> + new: <boolean> + properties: + commodof3d: <string> + tempore3: <string> + elit89: <string> + laborisd3: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + adipisicing9: + - sourceType: adipisicing cupidatat occaecat t + timestamp: '2011-03-01T08:10:52.193Z' + value: aliquip ullamco et sit + sourceId: consectetur voluptate amet in + sourceLabel: laboris labore est do + updatedByUserId: -9808692 + - sourceType: culpa mollit dolor qui in + timestamp: '1988-04-25T09:21:43.640Z' + value: nisi culpa + sourceId: labor + sourceLabel: ut dolore officia + updatedByUserId: -83391681 + startedAt: <dateTime> + status: COMPLETE + requestedAt: <dateTime> + links: + commodo_0: <string> + occaecat_908: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + new: <boolean> + properties: + anim_1: <string> + fugiat2c: <string> + consectetur_: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + mollit_5: + - sourceType: sunt est + timestamp: '1981-04-14T07:22:37.262Z' + value: et proident + sourceId: deserunt ipsum laborum + sourceLabel: dolor + updatedByUserId: 10103051 + - sourceType: incididunt exercitation Lorem cupidatat + timestamp: '1946-02-03T23:56:14.637Z' + value: irure consequat exercitation amet + sourceId: consequat culpa magna adipisicing + sourceLabel: proident adipisicing est laborum + updatedByUserId: -43616841 + sit__: + - sourceType: eu esse Duis irure ut + timestamp: '2025-01-18T18:05:45.020Z' + value: e + sourceId: aliquip adipisicing + sourceLabel: amet velit in nulla + updatedByUserId: 95093309 + - sourceType: Ut magna officia Lorem qui + timestamp: '1980-12-21T12:06:45.177Z' + value: dolor magna pariatur in + sourceId: consectetur elit commodo + sourceLabel: dolor ut + updatedByUserId: -13406419 + estb23: + - sourceType: aliqua veniam enim Duis + timestamp: '1995-06-18T00:44:50.179Z' + value: incididunt dolore elit + sourceId: consectetur et proi + sourceLabel: enim irure + updatedByUserId: 19451437 + - sourceType: anim nulla sed nisi do + timestamp: '1959-09-28T22:02:44.382Z' + value: ut in no + sourceId: ex magna + sourceLabel: sit aliquip dolor + updatedByUserId: -39527383 + - createdAt: <dateTime> + id: <string> + new: <boolean> + properties: + ut_5f: <string> + sint1: <string> + ea_891: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + sit_1: + - sourceType: ullamco aliquip culpa + timestamp: '1949-08-17T02:37:03.104Z' + value: et qui ipsum ut + sourceId: labore non sed + sourceLabel: id do sint dolore + updatedByUserId: -41825680 + - sourceType: commodo adipi + timestamp: '1946-04-03T13:31:06.433Z' + value: nisi do culpa mollit + sourceId: et sint + sourceLabel: et officia Excepteur exercitation sunt + updatedByUserId: -57548525 + startedAt: <dateTime> + status: PROCESSING + numErrors: <integer> + requestedAt: <dateTime> + links: + in5: <string> + inbc: <string> + Duis_: <string> + errors: + - category: et deserunt + context: + commodod9: + - minim + - anim in + in__e: + - laborum commodo consectet + - est id elit veniam + errors: + - message: pariatur consequat esse + subCategory: occaecat laborum deserunt minim + code: enim amet proident + in: minim aute enim culpa + context: + commodoa: + - sint sit eu + - ex a + ut_d: + - commodo enim + - tempor occaecat + consequat7c1: + - magna anim + - nisi + do9: + - in pariatur + - nulla occaecat labore non enim + - message: velit + subCategory: consequat incididunt minim + code: et Ut + in: ipsum minim in + context: + proident_33: + - amet in qui laboris + - do fugiat officia proident + non_: + - in cons + - incididunt des + links: + ipsum_e7d: nulla + in4cc: voluptate commodo irure + message: sit veniam nulla + status: dolor pariatur + subCategory: {} + id: occaecat + - category: cupidatat + context: + esse2a: + - elit consectetur + - ad sint eu nostrud + commodo5d: + - cupidatat aliqu + - esse aute + errors: + - message: reprehenderit id Exce + subCategory: ipsum do est enim + code: 'eu ' + in: Duis mollit ut + context: + adipisicing_a: + - magna quis esse + - in proident Duis + exercitation455: + - ut in laboris magna + - in ipsum laboris dolore + - message: labore consequat fugiat qui commodo + subCategory: in deserunt amet Lorem + code: incididunt aliquip elit adipisicing + in: exercitation + context: + nostrudcb: + - labore adipisicing + - fugiat est id Lorem + occaecat_a: + - voluptate + - irure + sunt_d9f: + - tempor laboris + - nostrud deserunt + minim21b: + - laborum labore pariatur aliquip occaecat + - E + links: + in7_: voluptate ad nostrud + message: dolor eu aute + status: exercitation culpa + subCategory: {} + id: cillum Excepteur + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "officia_fd9": [ + "<string>", + "<string>" + ], + "sit469": [ + "<string>", + "<string>" + ], + "veniam_23": [ + "<string>", + "<string>" + ] + }, + "links": { + "eu_9e": "<string>", + "veniamf": "<string>" + }, + "errors": [ + { + "message": "irure", + "subCategory": "esse", + "code": "deserunt", + "in": "temp", + "context": { + "laborum_b": [ + "consequat", + "esse incididunt pariatur ea laborum" + ], + "cupidatat2": [ + "dolor sit", + "id et" + ] + } + }, + { + "message": "Excepteur aliqua", + "subCategory": "dolore dolore", + "code": "exercitation mollit nisi", + "in": "qui ex ut id", + "context": { + "Lorem_b34": [ + "id", + "in Ut cillum fugiat dolore" + ] + } + } + ] + } + /crm/v3/objects/taxes/batch/update: + post: + tags: + - Taxes API > Batch + summary: Update a batch of taxes + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + properties: + inc16: <string> + nostrud8f: <string> + laboris02: <string> + - id: <string> + properties: + nulla_ab: <string> + pariaturc: <string> + aliqua_: <string> + estca: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + magna_3c: <string> + non_93f: <string> + dolor_d8: <string> + updatedAt: <dateTime> + propertiesWithHistory: + amet9: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + temporbb: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + suntee8: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + amet39: <string> + updatedAt: <dateTime> + propertiesWithHistory: + in_a28: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PROCESSING + requestedAt: <dateTime> + links: + sed_7: <string> + est3: <string> + cupidatat1f: <string> + in8b4: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + dolored: <string> + sunt_901: <string> + updatedAt: <dateTime> + propertiesWithHistory: + esse0f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + commodo9: <string> + updatedAt: <dateTime> + propertiesWithHistory: + consequatd: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + nonb77: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PENDING + numErrors: <integer> + errors: + - category: <string> + context: + nostrud_2f: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + occaecat69: + - <string> + - <string> + adipisicing2: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + voluptated: + - <string> + - <string> + ad_e7: + - <string> + - <string> + links: + dolor9e2: <string> + in0: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + dolore0: + - <string> + - <string> + nulla_3ff: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + adipisicing_f: + - <string> + - <string> + pariatur_c: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + commodo3: + - <string> + - <string> + et7: + - <string> + - <string> + links: + sint__41: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + do_ff: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex_36": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "sint819": [ + "<string>", + "<string>" + ], + "in_f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "cupidatat_b": [ + "<string>", + "<string>" + ] + }, + "links": { + "dolore_b": "<string>", + "in_3": "<string>", + "aliquip01": "<string>" + } + } + /crm/v3/objects/taxes/batch/create: + post: + tags: + - Taxes API > Batch + summary: Create a batch of taxes + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - associations: + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + properties: + cillum_f9b: <string> + - associations: + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + properties: + ad_032: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + magna_3c: <string> + non_93f: <string> + dolor_d8: <string> + updatedAt: <dateTime> + propertiesWithHistory: + amet9: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + temporbb: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + suntee8: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + amet39: <string> + updatedAt: <dateTime> + propertiesWithHistory: + in_a28: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PROCESSING + requestedAt: <dateTime> + links: + sed_7: <string> + est3: <string> + cupidatat1f: <string> + in8b4: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + dolored: <string> + sunt_901: <string> + updatedAt: <dateTime> + propertiesWithHistory: + esse0f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + commodo9: <string> + updatedAt: <dateTime> + propertiesWithHistory: + consequatd: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + nonb77: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PENDING + numErrors: <integer> + errors: + - category: <string> + context: + nostrud_2f: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + occaecat69: + - <string> + - <string> + adipisicing2: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + voluptated: + - <string> + - <string> + ad_e7: + - <string> + - <string> + links: + dolor9e2: <string> + in0: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + dolore0: + - <string> + - <string> + nulla_3ff: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + adipisicing_f: + - <string> + - <string> + pariatur_c: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + commodo3: + - <string> + - <string> + et7: + - <string> + - <string> + links: + sint__41: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + do_ff: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex_36": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "sint819": [ + "<string>", + "<string>" + ], + "in_f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "cupidatat_b": [ + "<string>", + "<string>" + ] + }, + "links": { + "dolore_b": "<string>", + "in_3": "<string>", + "aliquip01": "<string>" + } + } + /crm/v3/objects/taxes/batch/read: + post: + tags: + - Taxes API > Batch + summary: Read a batch of taxes by internal ID, or unique property values + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + properties: + - <string> + - <string> + propertiesWithHistory: + - <string> + - <string> + idProperty: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + magna_3c: <string> + non_93f: <string> + dolor_d8: <string> + updatedAt: <dateTime> + propertiesWithHistory: + amet9: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + temporbb: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + suntee8: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + amet39: <string> + updatedAt: <dateTime> + propertiesWithHistory: + in_a28: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PROCESSING + requestedAt: <dateTime> + links: + sed_7: <string> + est3: <string> + cupidatat1f: <string> + in8b4: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + dolored: <string> + sunt_901: <string> + updatedAt: <dateTime> + propertiesWithHistory: + esse0f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + commodo9: <string> + updatedAt: <dateTime> + propertiesWithHistory: + consequatd: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + nonb77: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PENDING + numErrors: <integer> + errors: + - category: <string> + context: + nostrud_2f: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + occaecat69: + - <string> + - <string> + adipisicing2: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + voluptated: + - <string> + - <string> + ad_e7: + - <string> + - <string> + links: + dolor9e2: <string> + in0: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + dolore0: + - <string> + - <string> + nulla_3ff: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + adipisicing_f: + - <string> + - <string> + pariatur_c: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + commodo3: + - <string> + - <string> + et7: + - <string> + - <string> + links: + sint__41: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + do_ff: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex_36": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "sint819": [ + "<string>", + "<string>" + ], + "in_f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "cupidatat_b": [ + "<string>", + "<string>" + ] + }, + "links": { + "dolore_b": "<string>", + "in_3": "<string>", + "aliquip01": "<string>" + } + } + /crm/v3/objects/taxes/batch/archive: + post: + tags: + - Taxes API > Batch + summary: Archive a batch of taxes by ID + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex_36": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "sint819": [ + "<string>", + "<string>" + ], + "in_f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "cupidatat_b": [ + "<string>", + "<string>" + ] + }, + "links": { + "dolore_b": "<string>", + "in_3": "<string>", + "aliquip01": "<string>" + } + } + /crm/v3/objects/taxes: + get: + tags: + - Taxes API > Basic + summary: List + description: >- + Read a page of taxes. Control what is returned via the `properties` + query param. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: limit + in: query + schema: + type: integer + description: The maximum number of results to display per page. + example: '10' + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + sedc5e: <string> + nisib: <string> + quisa2: <string> + updatedAt: <dateTime> + propertiesWithHistory: + dolor_9: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + mollit_2f: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + adipisicing_69: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + - createdAt: <dateTime> + id: <string> + properties: + amet_8: <string> + updatedAt: <dateTime> + propertiesWithHistory: + esse9a: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + pariatur_3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + proident_e: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + exercitation_a6: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + do2: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + minime: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex_36": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "sint819": [ + "<string>", + "<string>" + ], + "in_f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "cupidatat_b": [ + "<string>", + "<string>" + ] + }, + "links": { + "dolore_b": "<string>", + "in_3": "<string>", + "aliquip01": "<string>" + } + } + post: + tags: + - Taxes API > Basic + summary: Create + description: >- + Create a tax with the given properties and return a copy of the object, + including the ID. Documentation and examples for creating standard taxes + is provided. + requestBody: + content: + application/json: + schema: + type: object + example: + associations: + - to: + id: <string> + types: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + properties: + pariatur_12: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + sed_0b: <string> + nulla_6bd: <string> + updatedAt: <dateTime> + propertiesWithHistory: + in20: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + veniamc5: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex_36": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "sint819": [ + "<string>", + "<string>" + ], + "in_f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "cupidatat_b": [ + "<string>", + "<string>" + ] + }, + "links": { + "dolore_b": "<string>", + "in_3": "<string>", + "aliquip01": "<string>" + } + } + /crm/v3/objects/taxes/{taxId}: + get: + tags: + - Taxes API > Basic + summary: Read + description: >- + Read an Object identified by `{taxId}`. `{taxId}` refers to the internal + object ID by default, or optionally any unique property value as + specified by the `idProperty` query param. Control what is returned via + the `properties` query param. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: taxId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + dolor_5: <string> + updatedAt: <dateTime> + propertiesWithHistory: + sit47: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + in_e0: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + commodo_d: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + dolore0f6: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex_36": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "sint819": [ + "<string>", + "<string>" + ], + "in_f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "cupidatat_b": [ + "<string>", + "<string>" + ] + }, + "links": { + "dolore_b": "<string>", + "in_3": "<string>", + "aliquip01": "<string>" + } + } + delete: + tags: + - Taxes API > Basic + summary: Archive + description: Move an Object identified by `{taxId}` to the recycling bin. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: taxId + in: path + schema: + type: string + required: true + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex_36": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "sint819": [ + "<string>", + "<string>" + ], + "in_f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "cupidatat_b": [ + "<string>", + "<string>" + ] + }, + "links": { + "dolore_b": "<string>", + "in_3": "<string>", + "aliquip01": "<string>" + } + } + patch: + tags: + - Taxes API > Basic + summary: Update + description: >- + Perform a partial update of an Object identified by `{taxId}`. `{taxId}` + refers to the internal object ID by default, or optionally any unique + property value as specified by the `idProperty` query param. Provided + property values will be overwritten. Read-only and non-existent + properties will be ignored. Properties values can be cleared by passing + an empty string. + requestBody: + content: + application/json: + schema: + type: object + example: + properties: + elit_4: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: taxId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + sed_0b: <string> + nulla_6bd: <string> + updatedAt: <dateTime> + propertiesWithHistory: + in20: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + veniamc5: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex_36": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "sint819": [ + "<string>", + "<string>" + ], + "in_f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "cupidatat_b": [ + "<string>", + "<string>" + ] + }, + "links": { + "dolore_b": "<string>", + "in_3": "<string>", + "aliquip01": "<string>" + } + } + /crm/v3/objects/taxes/merge: + post: + tags: + - Taxes API > Public_Object + summary: Merge two taxes with same type + requestBody: + content: + application/json: + schema: + type: object + example: + objectIdToMerge: <string> + primaryObjectId: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + sed_0b: <string> + nulla_6bd: <string> + updatedAt: <dateTime> + propertiesWithHistory: + in20: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + veniamc5: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex_36": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "sint819": [ + "<string>", + "<string>" + ], + "in_f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "cupidatat_b": [ + "<string>", + "<string>" + ] + }, + "links": { + "dolore_b": "<string>", + "in_3": "<string>", + "aliquip01": "<string>" + } + } + /crm/v3/objects/taxes/gdpr-delete: + post: + tags: + - Taxes API > GDPR + summary: GDPR DELETE + description: >- + Permanently delete a contact and all associated content to follow GDPR. + Use optional property 'idProperty' set to 'email' to identify contact by + email address. If email address is not found, the email address will be + added to a blocklist and prevent it from being used in the future. + requestBody: + content: + application/json: + schema: + type: object + example: + objectId: <string> + idProperty: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex_36": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "sint819": [ + "<string>", + "<string>" + ], + "in_f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "cupidatat_b": [ + "<string>", + "<string>" + ] + }, + "links": { + "dolore_b": "<string>", + "in_3": "<string>", + "aliquip01": "<string>" + } + } + /crm/v3/objects/taxes/search: + post: + tags: + - Taxes API > Search + summary: post-/crm/v3/objects/taxes/search + requestBody: + content: + application/json: + schema: + type: object + example: + after: <integer> + filterGroups: + - filters: + - operator: NOT_HAS_PROPERTY + propertyName: <string> + value: <string> + highValue: <string> + values: + - <string> + - <string> + - operator: EQ + propertyName: <string> + value: <string> + highValue: <string> + values: + - <string> + - <string> + - filters: + - operator: NOT_CONTAINS_TOKEN + propertyName: <string> + value: <string> + highValue: <string> + values: + - <string> + - <string> + - operator: NOT_CONTAINS_TOKEN + propertyName: <string> + value: <string> + highValue: <string> + values: + - <string> + - <string> + limit: <integer> + properties: + - <string> + - <string> + sorts: + - <string> + - <string> + query: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + aute9ec: <string> + updatedAt: <dateTime> + propertiesWithHistory: + officia_a2: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + proident_9: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + ad6: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + qui6: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + incididunt_14b: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + ex47: <string> + fugiatf45: <string> + updatedAt: <dateTime> + propertiesWithHistory: + cupidatat_dee: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + eu8e0: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + exercitation_e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ex_36": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "sint819": [ + "<string>", + "<string>" + ], + "in_f": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "cupidatat_b": [ + "<string>", + "<string>" + ] + }, + "links": { + "dolore_b": "<string>", + "in_3": "<string>", + "aliquip01": "<string>" + } + } + /crm/v3/objects/tickets/batch/archive: + post: + tags: + - Tickets API > Batch + summary: Archive a batch of tickets by ID + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "enim9d3": [ + "<string>", + "<string>" + ], + "dolor7b": [ + "<string>", + "<string>" + ], + "magnab75": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "officia2": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "qui_037": [ + "<string>", + "<string>" + ], + "nostrud_41": [ + "<string>", + "<string>" + ] + }, + "links": { + "cillum_d7": "<string>", + "amet0": "<string>" + } + } + /crm/v3/objects/tickets/batch/read: + post: + tags: + - Tickets API > Batch + summary: Read a batch of tickets by internal ID, or unique property values + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + properties: + - <string> + - <string> + propertiesWithHistory: + - <string> + - <string> + idProperty: <string> + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + velit_f5c: <string> + Duis0: <string> + updatedAt: <dateTime> + propertiesWithHistory: + pariatur6d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + commodo_d9: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + sit_a: <string> + in54: <string> + updatedAt: <dateTime> + propertiesWithHistory: + aliquip_4d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + sitb2: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + eiusmod08a: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + dolor7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PROCESSING + requestedAt: <dateTime> + links: + et_e: <string> + consectetur_46c: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + reprehenderit3fb: <string> + Lorem9f: <string> + updatedAt: <dateTime> + propertiesWithHistory: + voluptate_41_: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + ute: <string> + updatedAt: <dateTime> + propertiesWithHistory: + fugiat_73: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + consequat412: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PENDING + numErrors: <integer> + errors: + - category: <string> + context: + incididunt_f_d: + - <string> + - <string> + inf79: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + veniamaf1: + - <string> + - <string> + dolorf9c: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + in_915: + - <string> + - <string> + tempor_9_: + - <string> + - <string> + links: + deserunt_aff: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + laboris9: + - <string> + - <string> + exc: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + pariatura4: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + auteba7: + - <string> + - <string> + links: + dolor5f9: <string> + culpa_00: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + minim_e: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "enim9d3": [ + "<string>", + "<string>" + ], + "dolor7b": [ + "<string>", + "<string>" + ], + "magnab75": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "officia2": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "qui_037": [ + "<string>", + "<string>" + ], + "nostrud_41": [ + "<string>", + "<string>" + ] + }, + "links": { + "cillum_d7": "<string>", + "amet0": "<string>" + } + } + /crm/v3/objects/tickets/batch/create: + post: + tags: + - Tickets API > Batch + summary: Create a batch of tickets + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - associations: + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + properties: + esse_ed4: <string> + incididunt_aac: <string> + - associations: + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + properties: + anim0a: <string> + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + velit_f5c: <string> + Duis0: <string> + updatedAt: <dateTime> + propertiesWithHistory: + pariatur6d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + commodo_d9: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + sit_a: <string> + in54: <string> + updatedAt: <dateTime> + propertiesWithHistory: + aliquip_4d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + sitb2: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + eiusmod08a: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + dolor7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PROCESSING + requestedAt: <dateTime> + links: + et_e: <string> + consectetur_46c: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + reprehenderit3fb: <string> + Lorem9f: <string> + updatedAt: <dateTime> + propertiesWithHistory: + voluptate_41_: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + ute: <string> + updatedAt: <dateTime> + propertiesWithHistory: + fugiat_73: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + consequat412: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PENDING + numErrors: <integer> + errors: + - category: <string> + context: + incididunt_f_d: + - <string> + - <string> + inf79: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + veniamaf1: + - <string> + - <string> + dolorf9c: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + in_915: + - <string> + - <string> + tempor_9_: + - <string> + - <string> + links: + deserunt_aff: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + laboris9: + - <string> + - <string> + exc: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + pariatura4: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + auteba7: + - <string> + - <string> + links: + dolor5f9: <string> + culpa_00: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + minim_e: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "enim9d3": [ + "<string>", + "<string>" + ], + "dolor7b": [ + "<string>", + "<string>" + ], + "magnab75": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "officia2": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "qui_037": [ + "<string>", + "<string>" + ], + "nostrud_41": [ + "<string>", + "<string>" + ] + }, + "links": { + "cillum_d7": "<string>", + "amet0": "<string>" + } + } + /crm/v3/objects/tickets/batch/update: + post: + tags: + - Tickets API > Batch + summary: Update a batch of tickets by internal ID, or unique property values + requestBody: + content: {} + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + velit_f5c: <string> + Duis0: <string> + updatedAt: <dateTime> + propertiesWithHistory: + pariatur6d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + commodo_d9: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + sit_a: <string> + in54: <string> + updatedAt: <dateTime> + propertiesWithHistory: + aliquip_4d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + sitb2: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + eiusmod08a: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + dolor7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PROCESSING + requestedAt: <dateTime> + links: + et_e: <string> + consectetur_46c: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + reprehenderit3fb: <string> + Lorem9f: <string> + updatedAt: <dateTime> + propertiesWithHistory: + voluptate_41_: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + ute: <string> + updatedAt: <dateTime> + propertiesWithHistory: + fugiat_73: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + consequat412: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PENDING + numErrors: <integer> + errors: + - category: <string> + context: + incididunt_f_d: + - <string> + - <string> + inf79: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + veniamaf1: + - <string> + - <string> + dolorf9c: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + in_915: + - <string> + - <string> + tempor_9_: + - <string> + - <string> + links: + deserunt_aff: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + laboris9: + - <string> + - <string> + exc: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + pariatura4: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + auteba7: + - <string> + - <string> + links: + dolor5f9: <string> + culpa_00: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + minim_e: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "enim9d3": [ + "<string>", + "<string>" + ], + "dolor7b": [ + "<string>", + "<string>" + ], + "magnab75": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "officia2": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "qui_037": [ + "<string>", + "<string>" + ], + "nostrud_41": [ + "<string>", + "<string>" + ] + }, + "links": { + "cillum_d7": "<string>", + "amet0": "<string>" + } + } + /crm/v3/objects/tickets/{ticketId}: + get: + tags: + - Tickets API > Basic + summary: Read + description: >- + Read an Object identified by `{ticketId}`. `{ticketId}` refers to the + internal object ID by default, or optionally any unique property value + as specified by the `idProperty` query param. Control what is returned + via the `properties` query param. + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: ticketId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + do32a: <string> + tempor_0: <string> + updatedAt: <dateTime> + propertiesWithHistory: + tempor__0: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + elit27: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + labore5: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "enim9d3": [ + "<string>", + "<string>" + ], + "dolor7b": [ + "<string>", + "<string>" + ], + "magnab75": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "officia2": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "qui_037": [ + "<string>", + "<string>" + ], + "nostrud_41": [ + "<string>", + "<string>" + ] + }, + "links": { + "cillum_d7": "<string>", + "amet0": "<string>" + } + } + delete: + tags: + - Tickets API > Basic + summary: Archive + description: Move an Object identified by `{ticketId}` to the recycling bin. + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: ticketId + in: path + schema: + type: string + required: true + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "enim9d3": [ + "<string>", + "<string>" + ], + "dolor7b": [ + "<string>", + "<string>" + ], + "magnab75": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "officia2": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "qui_037": [ + "<string>", + "<string>" + ], + "nostrud_41": [ + "<string>", + "<string>" + ] + }, + "links": { + "cillum_d7": "<string>", + "amet0": "<string>" + } + } + patch: + tags: + - Tickets API > Basic + summary: Update + description: >- + Perform a partial update of an Object identified by `{ticketId}`. + `{ticketId}` refers to the internal object ID by default, or optionally + any unique property value as specified by the `idProperty` query param. + Provided property values will be overwritten. Read-only and non-existent + properties will be ignored. Properties values can be cleared by passing + an empty string. + requestBody: + content: + application/json: + schema: + type: object + example: + properties: + id580: <string> + sed_4: <string> + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: ticketId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + voluptate_361: <string> + laborumbf: <string> + velita: <string> + updatedAt: <dateTime> + propertiesWithHistory: + dolore3f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + aliqua_6be: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + laboris4d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "enim9d3": [ + "<string>", + "<string>" + ], + "dolor7b": [ + "<string>", + "<string>" + ], + "magnab75": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "officia2": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "qui_037": [ + "<string>", + "<string>" + ], + "nostrud_41": [ + "<string>", + "<string>" + ] + }, + "links": { + "cillum_d7": "<string>", + "amet0": "<string>" + } + } + /crm/v3/objects/tickets: + get: + tags: + - Tickets API > Basic + summary: List + description: >- + Read a page of tickets. Control what is returned via the `properties` + query param. + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: limit + in: query + schema: + type: integer + description: The maximum number of results to display per page. + example: '10' + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + ut_9a: <string> + updatedAt: <dateTime> + propertiesWithHistory: + voluptate_a: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + ina66: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + - createdAt: <dateTime> + id: <string> + properties: + ad__ae: <string> + culpa_d: <string> + updatedAt: <dateTime> + propertiesWithHistory: + amet_acb: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + ipsumfd7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + consequat_843: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + utdb_: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + incididunt7: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "enim9d3": [ + "<string>", + "<string>" + ], + "dolor7b": [ + "<string>", + "<string>" + ], + "magnab75": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "officia2": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "qui_037": [ + "<string>", + "<string>" + ], + "nostrud_41": [ + "<string>", + "<string>" + ] + }, + "links": { + "cillum_d7": "<string>", + "amet0": "<string>" + } + } + post: + tags: + - Tickets API > Basic + summary: Create + description: >- + Create a ticket with the given properties and return a copy of the + object, including the ID. Documentation and examples for creating + standard tickets is provided. + requestBody: + content: + application/json: + schema: + type: object + example: + associations: + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + properties: + Duis5a: <string> + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + voluptate_361: <string> + laborumbf: <string> + velita: <string> + updatedAt: <dateTime> + propertiesWithHistory: + dolore3f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + aliqua_6be: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + laboris4d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "enim9d3": [ + "<string>", + "<string>" + ], + "dolor7b": [ + "<string>", + "<string>" + ], + "magnab75": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "officia2": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "qui_037": [ + "<string>", + "<string>" + ], + "nostrud_41": [ + "<string>", + "<string>" + ] + }, + "links": { + "cillum_d7": "<string>", + "amet0": "<string>" + } + } + /crm/v3/objects/tickets/merge: + post: + tags: + - Tickets API > Public_Object + summary: Merge two tickets with same type + requestBody: + content: + application/json: + schema: + type: object + example: + objectIdToMerge: <string> + primaryObjectId: <string> + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + voluptate_361: <string> + laborumbf: <string> + velita: <string> + updatedAt: <dateTime> + propertiesWithHistory: + dolore3f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + aliqua_6be: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + laboris4d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "enim9d3": [ + "<string>", + "<string>" + ], + "dolor7b": [ + "<string>", + "<string>" + ], + "magnab75": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "officia2": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "qui_037": [ + "<string>", + "<string>" + ], + "nostrud_41": [ + "<string>", + "<string>" + ] + }, + "links": { + "cillum_d7": "<string>", + "amet0": "<string>" + } + } + /crm/v3/objects/tickets/search: + post: + tags: + - Tickets API > Search + summary: post-/crm/v3/objects/tickets/search do Search + requestBody: + content: {} + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + elit1: <string> + consectetur_796: <string> + updatedAt: <dateTime> + propertiesWithHistory: + dolor_7bc: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + occaecated1: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + do_b3e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + proident608: <string> + ea_f_: <string> + updatedAt: <dateTime> + propertiesWithHistory: + mollit_c: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + aute_045: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "enim9d3": [ + "<string>", + "<string>" + ], + "dolor7b": [ + "<string>", + "<string>" + ], + "magnab75": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "officia2": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "qui_037": [ + "<string>", + "<string>" + ], + "nostrud_41": [ + "<string>", + "<string>" + ] + }, + "links": { + "cillum_d7": "<string>", + "amet0": "<string>" + } + } + /crm/v3/objects/tickets/batch/upsert: + post: + tags: + - Tickets API + summary: Create or update a batch of tickets by unique property values + description: >- + Create or update records identified by a unique property value as + specified by the `idProperty` query param. `idProperty` query param + refers to a property whose values are unique for the object. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + properties: + veniam75: <string> + cupidatat1: <string> + idProperty: <string> + objectWriteTraceId: <string> + - id: <string> + properties: + adipisicingbd: <string> + consectetur8: <string> + idProperty: <string> + objectWriteTraceId: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + new: <boolean> + properties: + aliqua_32: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + officia_547: + - sourceType: Excepteur deserunt velit occaecat + timestamp: '1955-09-25T21:32:09.681Z' + value: sint Duis laborum mollit + sourceId: 'sit magna ' + sourceLabel: minim dolore nulla do aliqua + updatedByUserId: -66874440 + - sourceType: est + timestamp: '1960-11-03T02:30:12.974Z' + value: aliqua culpa + sourceId: Ut + sourceLabel: culpa ex magna + updatedByUserId: -86526752 + magna_76b: + - sourceType: dolore anim laborum dolor + timestamp: '2008-08-19T16:18:30.158Z' + value: laborum dolore officia + sourceId: id minim enim + sourceLabel: eu do sunt veniam nostrud + updatedByUserId: 49381208 + - sourceType: ullamco in veniam + timestamp: '1948-07-31T02:47:42.641Z' + value: anim + sourceId: culpa officia cillum dolore + sourceLabel: sunt sint + updatedByUserId: 93902332 + labore_0f: + - sourceType: U + timestamp: '2011-09-13T23:58:45.450Z' + value: labore minim sint dolore + sourceId: in cillum Lorem amet Duis + sourceLabel: do irure amet laboris + updatedByUserId: 95180574 + - sourceType: do commodo sunt nulla + timestamp: '1999-02-03T07:51:58.601Z' + value: enim ut eu reprehenderit deserunt + sourceId: esse id + sourceLabel: enim cupidatat + updatedByUserId: -14195302 + dolore948: + - sourceType: adipisicing + timestamp: '1951-05-27T06:42:51.106Z' + value: id amet dolore + sourceId: ut sint ullamco + sourceLabel: do nisi + updatedByUserId: 60557479 + - sourceType: voluptate minim Ut + timestamp: '1982-07-05T03:17:43.098Z' + value: volupta + sourceId: laboris in eni + sourceLabel: irure dolor adipisicing + updatedByUserId: -84243178 + - createdAt: <dateTime> + id: <string> + new: <boolean> + properties: + velit_362: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + do__: + - sourceType: adipisicing incididunt + timestamp: '1984-12-31T22:00:52.589Z' + value: anim Duis adipisicing pariatur + sourceId: ullamco minim dolor laborum + sourceLabel: est Duis tempor + updatedByUserId: 76677089 + - sourceType: enim + timestamp: '2024-04-10T21:25:57.425Z' + value: aliqua dolore anim cupidatat + sourceId: sint + sourceLabel: veniam + updatedByUserId: -1851743 + pariatur_0da: + - sourceType: exercitation nisi quis Lorem laboris + timestamp: '1968-03-26T23:40:03.129Z' + value: eiusmod labore + sourceId: ut labore aute in + sourceLabel: ad quis elit et dolore + updatedByUserId: -23026338 + - sourceType: aliquip et + timestamp: '1999-06-10T18:07:36.392Z' + value: sunt reprehenderit ut + sourceId: enim magna ipsum Ut + sourceLabel: voluptate laboris + updatedByUserId: 7568665 + startedAt: <dateTime> + status: CANCELED + requestedAt: <dateTime> + links: + qui3bf: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + new: <boolean> + properties: + aliquip58d: <string> + labore_2f: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + reprehenderitd5: + - sourceType: anim dolor culpa + timestamp: '1974-06-23T03:19:52.899Z' + value: sunt in ut + sourceId: Duis officia cupidatat + sourceLabel: labore consequat ipsum tempor + updatedByUserId: 82824736 + - sourceType: eu + timestamp: '1992-11-07T23:59:08.145Z' + value: elit dolore ullamco sit id + sourceId: id esse officia eu + sourceLabel: et tempor + updatedByUserId: 63158788 + id_a_: + - sourceType: exercitation esse cillum + timestamp: '2003-06-29T16:40:41.763Z' + value: eiusmod + sourceId: in est qui aute mo + sourceLabel: dolor in dolore minim ex + updatedByUserId: -73378798 + - sourceType: dolor aute mollit + timestamp: '2011-04-04T08:56:51.662Z' + value: Lorem non irure + sourceId: sit elit aliquip + sourceLabel: id anim + updatedByUserId: 77407888 + nostrud8_c: + - sourceType: et tempor + timestamp: '1983-09-27T08:47:13.866Z' + value: dolor sint est dolore + sourceId: et do ipsum + sourceLabel: est Excepteur consequat + updatedByUserId: 50197521 + - sourceType: non cillum ea + timestamp: '1974-06-16T07:54:07.645Z' + value: dolor ut ad eu magna + sourceId: cupidatat anim consequat sit + sourceLabel: Lorem ullamco in commodo do + updatedByUserId: -83762001 + - createdAt: <dateTime> + id: <string> + new: <boolean> + properties: + nisi3: <string> + labored_5: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + proident_c: + - sourceType: Lorem + timestamp: '1976-04-19T02:54:57.714Z' + value: aliqua Excepteur non in dolore + sourceId: dolore veniam + sourceLabel: dolore Duis aute ea + updatedByUserId: 86886607 + - sourceType: ut veniam + timestamp: '1977-01-01T09:54:30.372Z' + value: occaecat anim + sourceId: nisi ipsum dolore minim + sourceLabel: cillum + updatedByUserId: 66996702 + minim0: + - sourceType: deserunt cillum dolore veniam + timestamp: '2016-05-22T14:27:45.058Z' + value: et consequat aliqua magna + sourceId: occaecat officia + sourceLabel: qui + updatedByUserId: 55649469 + - sourceType: officia reprehenderit qui + timestamp: '2022-08-21T21:59:20.013Z' + value: dolor reprehenderit + sourceId: aliquip eiusm + sourceLabel: Lorem + updatedByUserId: 94016213 + startedAt: <dateTime> + status: COMPLETE + numErrors: <integer> + requestedAt: <dateTime> + links: + voluptateb48: <string> + laborisd72: <string> + errors: + - category: ut aliqua + context: + pariatur_fb9: + - labore adipisicing elit dolor + - dolore nisi in sit reprehenderit + anim_33: + - ea ex do nisi tem + - veniam qui + consectetur_623: + - exercitation voluptate i + - ex Duis mollit quis sint + errors: + - message: dolore et incididunt oc + subCategory: Excepteur amet reprehenderit labore dolor + code: aute id + in: Excepteur id amet + context: + adipisicingd2: + - esse repreh + - dolor non Lorem + - message: minim et dolor + subCategory: dolore adipisicing + code: Lorem magna Ut elit + in: exercitation + context: + nisidc: + - exercitation cillum + - anim nulla + tempor_93: + - amet in proident + - minim Duis laborum + links: + irure_8f5: et aliqua de + magna_9: i + message: consectetu + status: dolor + subCategory: {} + id: veniam ea minim + - category: magna sed fugiat nulla + context: + magna_: + - amet + - elit velit + pariatur__e_: + - do eiusmod non + - consequat dolore fugiat + culpa8_: + - nostrud dolore cillum + - 'sunt dolore non ' + errors: + - message: ut laborum + subCategory: et officia non + code: occaecat + in: Lorem aute + context: + sed_80: + - nisi magna culpa + - pariatur Lorem + elitea: + - eiusmod aute in + - ex ut + - message: in + subCategory: officia qui + code: ea pariatur ex + in: elit sit exercitation + context: + voluptatea2: + - dolore ad + - exercitation culpa reprehenderit eu + sed_6: + - laborum commodo + - occaecat dolore Lorem + amet20: + - cillum aute conse + - consectetur nisi cillum + links: + consequatce9: amet deserunt consectetur magna + dolor_d7: culpa fugiat ullamco + sed_ec: al + message: consectetur + status: non Ut proident aliqua + subCategory: {} + id: in do laborum adipis + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "reprehenderit1": [ + "<string>", + "<string>" + ], + "aute_bf": [ + "<string>", + "<string>" + ] + }, + "links": { + "irure_511": "<string>", + "in_9": "<string>" + }, + "errors": [ + { + "message": "exercitation", + "subCategory": "Excepteur sint veniam", + "code": "dolore elit", + "in": "consectetur in", + "context": { + "fugiat5": [ + "labore", + "dolor aliquip pariatur laborum" + ], + "dolor_30d": [ + "ut non cupidatat Lorem", + "nisi Lorem labore mollit fugiat" + ] + } + }, + { + "message": "sint", + "subCategory": "cillum velit cupidatat", + "code": "do sint", + "in": "est cupidatat eu culpa", + "context": { + "dolor_67": [ + "voluptate cupidatat deserunt do", + "culpa" + ], + "in_2e": [ + "culpa", + "ad aliqua in" + ] + } + } + ] + } + /crm/v3/limits/associations/labels: + get: + tags: + - Limits Tracking API > Limits + summary: Read association label limits + description: Returns limits and usage for custom association labels + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: fromObjectTypeId + in: query + schema: + type: string + example: <string> + - name: toObjectTypeId + in: query + schema: + type: string + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - allLabels: + - <string> + - <string> + fromObjectType: + objectTypeId: <string> + pluralLabel: <string> + singularLabel: <string> + limit: <integer> + percentage: <number> + toObjectType: + objectTypeId: <string> + pluralLabel: <string> + singularLabel: <string> + usage: <integer> + - allLabels: + - <string> + - <string> + fromObjectType: + objectTypeId: <string> + pluralLabel: <string> + singularLabel: <string> + limit: <integer> + percentage: <number> + toObjectType: + objectTypeId: <string> + pluralLabel: <string> + singularLabel: <string> + usage: <integer> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "aute_b5": [ + "<string>", + "<string>" + ], + "sunt__44": [ + "<string>", + "<string>" + ], + "do_6": [ + "<string>", + "<string>" + ] + }, + "links": { + "exercitation__75": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "magna2b0": [ + "<string>", + "<string>" + ], + "consectetur5": [ + "<string>", + "<string>" + ], + "sitd4_": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "elit_7a7": [ + "<string>", + "<string>" + ], + "quis33": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/limits/associations/records/{fromObjectTypeId}/{toObjectTypeId}: + get: + tags: + - Limits Tracking API > Limits + summary: Read record association limits between two objects + description: Returns records approaching or at association limits between two objects + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: fromObjectTypeId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + - name: toObjectTypeId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + atLimitFromRecordSamples: + - label: <string> + objectId: <integer> + - label: <string> + objectId: <integer> + limit: <long> + nearLimitFromRecordSamples: + - label: <string> + objectId: <integer> + percentage: <number> + usage: <integer> + - label: <string> + objectId: <integer> + percentage: <number> + usage: <integer> + totalRecordsAtLimit: <integer> + totalRecordsNearLimit: <integer> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "aute_b5": [ + "<string>", + "<string>" + ], + "sunt__44": [ + "<string>", + "<string>" + ], + "do_6": [ + "<string>", + "<string>" + ] + }, + "links": { + "exercitation__75": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "magna2b0": [ + "<string>", + "<string>" + ], + "consectetur5": [ + "<string>", + "<string>" + ], + "sitd4_": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "elit_7a7": [ + "<string>", + "<string>" + ], + "quis33": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/limits/associations/records/{fromObjectTypeId}/to: + get: + tags: + - Limits Tracking API > Limits + summary: Read record association limits from an object + description: >- + Returns objects for which the from object has records approaching or at + association limits + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: fromObjectTypeId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - hasRecordsAtLimit: <boolean> + hasRecordsNearLimit: <boolean> + objectTypeId: <string> + pluralLabel: <string> + singularLabel: <string> + - hasRecordsAtLimit: <boolean> + hasRecordsNearLimit: <boolean> + objectTypeId: <string> + pluralLabel: <string> + singularLabel: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "aute_b5": [ + "<string>", + "<string>" + ], + "sunt__44": [ + "<string>", + "<string>" + ], + "do_6": [ + "<string>", + "<string>" + ] + }, + "links": { + "exercitation__75": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "magna2b0": [ + "<string>", + "<string>" + ], + "consectetur5": [ + "<string>", + "<string>" + ], + "sitd4_": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "elit_7a7": [ + "<string>", + "<string>" + ], + "quis33": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/limits/custom-object-types: + get: + tags: + - Limits Tracking API > Limits + summary: Read custom object limits + description: Returns limits and usage for custom object schemas + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + limit: <long> + percentage: <number> + usage: <long> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "aute_b5": [ + "<string>", + "<string>" + ], + "sunt__44": [ + "<string>", + "<string>" + ], + "do_6": [ + "<string>", + "<string>" + ] + }, + "links": { + "exercitation__75": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "magna2b0": [ + "<string>", + "<string>" + ], + "consectetur5": [ + "<string>", + "<string>" + ], + "sitd4_": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "elit_7a7": [ + "<string>", + "<string>" + ], + "quis33": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/limits/custom-properties: + get: + tags: + - Limits Tracking API > Limits + summary: Read custom property limits + description: Returns limits and usage per object for custom properties + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + byObjectType: + - limit: <integer> + objectTypeId: <string> + percentage: <number> + pluralLabel: <string> + singularLabel: <string> + usage: <integer> + - limit: <integer> + objectTypeId: <string> + percentage: <number> + pluralLabel: <string> + singularLabel: <string> + usage: <integer> + overallLimit: <long> + overallPercentage: <number> + overallUsage: <long> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "aute_b5": [ + "<string>", + "<string>" + ], + "sunt__44": [ + "<string>", + "<string>" + ], + "do_6": [ + "<string>", + "<string>" + ] + }, + "links": { + "exercitation__75": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "magna2b0": [ + "<string>", + "<string>" + ], + "consectetur5": [ + "<string>", + "<string>" + ], + "sitd4_": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "elit_7a7": [ + "<string>", + "<string>" + ], + "quis33": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/limits/associations/records/from: + get: + tags: + - Limits Tracking API > Limits + summary: Read record association limits + description: Returns objects with records approaching or at association limits + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - hasRecordsAtLimit: <boolean> + hasRecordsNearLimit: <boolean> + objectTypeId: <string> + pluralLabel: <string> + singularLabel: <string> + - hasRecordsAtLimit: <boolean> + hasRecordsNearLimit: <boolean> + objectTypeId: <string> + pluralLabel: <string> + singularLabel: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "aute_b5": [ + "<string>", + "<string>" + ], + "sunt__44": [ + "<string>", + "<string>" + ], + "do_6": [ + "<string>", + "<string>" + ] + }, + "links": { + "exercitation__75": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "magna2b0": [ + "<string>", + "<string>" + ], + "consectetur5": [ + "<string>", + "<string>" + ], + "sitd4_": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "elit_7a7": [ + "<string>", + "<string>" + ], + "quis33": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/limits/records: + get: + tags: + - Limits Tracking API > Limits + summary: Read record limits + description: Returns limits and usage per object for records + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + customObjectTypes: + byObjectType: + - objectTypeId: <string> + pluralLabel: <string> + singularLabel: <string> + usage: <integer> + - objectTypeId: <string> + pluralLabel: <string> + singularLabel: <string> + usage: <integer> + overallLimit: <integer> + overallPercentage: <number> + overallUsage: <integer> + hubspotDefinedObjectTypes: + - limit: <integer> + objectTypeId: <string> + percentage: <number> + pluralLabel: <string> + singularLabel: <string> + usage: <integer> + - limit: <integer> + objectTypeId: <string> + percentage: <number> + pluralLabel: <string> + singularLabel: <string> + usage: <integer> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "aute_b5": [ + "<string>", + "<string>" + ], + "sunt__44": [ + "<string>", + "<string>" + ], + "do_6": [ + "<string>", + "<string>" + ] + }, + "links": { + "exercitation__75": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "magna2b0": [ + "<string>", + "<string>" + ], + "consectetur5": [ + "<string>", + "<string>" + ], + "sitd4_": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "elit_7a7": [ + "<string>", + "<string>" + ], + "quis33": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/limits/pipelines: + get: + tags: + - Limits Tracking API > Limits + summary: Read pipeline limits + description: Returns limits and usage per object for pipelines + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + customObjectTypes: + byObjectType: + - objectTypeId: <string> + pluralLabel: <string> + singularLabel: <string> + usage: <integer> + - objectTypeId: <string> + pluralLabel: <string> + singularLabel: <string> + usage: <integer> + overallLimit: <integer> + overallPercentage: <number> + overallUsage: <integer> + hubspotDefinedObjectTypes: + - limit: <integer> + objectTypeId: <string> + percentage: <number> + pluralLabel: <string> + singularLabel: <string> + usage: <integer> + - limit: <integer> + objectTypeId: <string> + percentage: <number> + pluralLabel: <string> + singularLabel: <string> + usage: <integer> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "aute_b5": [ + "<string>", + "<string>" + ], + "sunt__44": [ + "<string>", + "<string>" + ], + "do_6": [ + "<string>", + "<string>" + ] + }, + "links": { + "exercitation__75": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "magna2b0": [ + "<string>", + "<string>" + ], + "consectetur5": [ + "<string>", + "<string>" + ], + "sitd4_": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "elit_7a7": [ + "<string>", + "<string>" + ], + "quis33": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/limits/calculated-properties: + get: + tags: + - Limits Tracking API > Limits + summary: Read calculation property limits + description: Returns overall limit and per object usage for calculated properties + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + byObjectType: + - objectTypeId: <string> + pluralLabel: <string> + singularLabel: <string> + usage: <integer> + - objectTypeId: <string> + pluralLabel: <string> + singularLabel: <string> + usage: <integer> + overallLimit: <long> + overallPercentage: <number> + overallUsage: <long> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "aute_b5": [ + "<string>", + "<string>" + ], + "sunt__44": [ + "<string>", + "<string>" + ], + "do_6": [ + "<string>", + "<string>" + ] + }, + "links": { + "exercitation__75": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "magna2b0": [ + "<string>", + "<string>" + ], + "consectetur5": [ + "<string>", + "<string>" + ], + "sitd4_": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "elit_7a7": [ + "<string>", + "<string>" + ], + "quis33": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/invoices/batch/read: + post: + tags: + - Invoices API > Batch + summary: Read a batch of invoices by internal ID, or unique property values + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + properties: + - <string> + - <string> + propertiesWithHistory: + - <string> + - <string> + idProperty: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + ut7ad: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + ada2_: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + voluptate_1: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + proident04: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + Ut_d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + Ut_6: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + sit698: <string> + laboris0: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + magna4e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + startedAt: <dateTime> + status: COMPLETE + requestedAt: <dateTime> + links: + culpa_8: <string> + ea69: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + magna_2: <string> + dolor_15: <string> + ipsum_4: <string> + aute_8: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + dolor_4ef: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + in_ae6: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + dof: <string> + ut_3b: <string> + nisi_b7: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + deserunt_76: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + cillum__1e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + startedAt: <dateTime> + status: PROCESSING + numErrors: <integer> + requestedAt: <dateTime> + links: + do_07: <string> + cupidatatcc: <string> + adipisicing_36: <string> + laboris3c7: <string> + errors: + - category: <string> + context: + Duis5: + - <string> + - <string> + sed_3b: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + irure4: + - <string> + - <string> + adipisicing__a: + - <string> + - <string> + anim_6_4: + - <string> + - <string> + ipsum_a: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + suntb: + - <string> + - <string> + links: + occaecate49: <string> + exercitation_: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + - category: <string> + context: + dolor77: + - <string> + - <string> + veniam__: + - <string> + - <string> + ut_38: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + qui_c_: + - <string> + - <string> + reprehenderit_b: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + anim_42: + - <string> + - <string> + sint_d6: + - <string> + - <string> + links: + quis3: <string> + deserunt08e: <string> + idae6: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "veniam_b": [ + "<string>", + "<string>" + ], + "idf2": [ + "<string>", + "<string>" + ] + }, + "links": { + "cillum_d": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "nulla0": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "ut4d": [ + "<string>", + "<string>" + ], + "Lorem_f": [ + "<string>", + "<string>" + ], + "aliquac3": [ + "<string>", + "<string>" + ], + "enim95": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/invoices/{invoiceId}: + get: + tags: + - Invoices API > Basic + summary: Read + description: >- + Read an Object identified by `{invoiceId}`. `{invoiceId}` refers to the + internal object ID by default, or optionally any unique property value + as specified by the `idProperty` query param. Control what is returned + via the `properties` query param. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: invoiceId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + aute_504: <string> + amet65: <string> + updatedAt: <dateTime> + associations: + mollit7_: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + commodo_f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "veniam_b": [ + "<string>", + "<string>" + ], + "idf2": [ + "<string>", + "<string>" + ] + }, + "links": { + "cillum_d": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "nulla0": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "ut4d": [ + "<string>", + "<string>" + ], + "Lorem_f": [ + "<string>", + "<string>" + ], + "aliquac3": [ + "<string>", + "<string>" + ], + "enim95": [ + "<string>", + "<string>" + ] + } + } + ] + } + delete: + tags: + - Invoices API + summary: Archive + description: Move an Object identified by `{invoiceId}` to the recycling bin. + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: invoiceId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "enim_bff": [ + "<string>", + "<string>" + ], + "enim_da": [ + "<string>", + "<string>" + ] + }, + "links": { + "animf03": "<string>", + "labore33": "<string>" + }, + "errors": [ + { + "message": "culpa cillum", + "subCategory": "esse", + "code": "commodo ut cillum esse ut", + "in": "qui mollit minim", + "context": { + "doloref": [ + "sunt anim irure mollit", + "do ea" + ], + "labore_af6": [ + "proident", + "enim eiusmod magna adipisicing" + ] + } + }, + { + "message": "eu mollit id", + "subCategory": "reprehenderit minim labore exercitation", + "code": "in cupidatat", + "in": "elit eiusmod officia do adipisicing", + "context": { + "dolore_1": [ + "proident minim c", + "et" + ] + } + } + ] + } + patch: + tags: + - Invoices API + summary: Update + description: >- + Perform a partial update of an Object identified by `{invoiceId}`. + `{invoiceId}` refers to the internal object ID by default, or optionally + any unique property value as specified by the `idProperty` query param. + Provided property values will be overwritten. Read-only and non-existent + properties will be ignored. Properties values can be cleared by passing + an empty string. + requestBody: + content: + application/json: + schema: + type: object + example: + properties: + Ut26: <string> + objectWriteTraceId: <string> + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: invoiceId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: '1984-10-01T04:45:27.537Z' + id: ex nostrud + properties: + mollit70: amet labore nulla aliquip + sedc3a: laborum + doloree05: cupidatat sit dolore dolore eu + Ut_86: aliqua + updatedAt: '1957-08-13T03:09:43.927Z' + archived: true + archivedAt: '2000-05-23T17:59:13.228Z' + propertiesWithHistory: + reprehenderitd: + - sourceType: reprehenderit + timestamp: '1989-06-16T22:00:03.340Z' + value: officia eu labore + sourceId: 'occaecat mollit veniam exercitation ' + sourceLabel: dolore Lorem sit ipsum culpa + updatedByUserId: -83540352 + - sourceType: fugiat + timestamp: '1970-08-17T09:45:50.563Z' + value: in minim dolore + sourceId: culpa + sourceLabel: proident in + updatedByUserId: -20394806 + do72: + - sourceType: ut reprehenderit amet eu + timestamp: '1969-11-22T13:53:12.836Z' + value: mollit reprehenderit ex + sourceId: consectetur + sourceLabel: ipsum a + updatedByUserId: -22832863 + - sourceType: labore + timestamp: '1957-12-25T12:34:04.252Z' + value: nulla aute enim labore + sourceId: velit dolor culpa sed enim + sourceLabel: sit in Lorem + updatedByUserId: -267773 + in60: + - sourceType: in + timestamp: '2011-01-09T21:09:10.987Z' + value: nisi laboris + sourceId: mollit aute Ut + sourceLabel: ad cillum exercitation sint mollit + updatedByUserId: 18206430 + - sourceType: pariatur irure non et + timestamp: '1967-08-15T03:02:34.588Z' + value: tempor aute ea + sourceId: enim aliqua in + sourceLabel: in Duis nisi + updatedByUserId: 49658634 + et_d: + - sourceType: sed + timestamp: '1992-07-27T10:42:10.852Z' + value: aliquip venia + sourceId: dolor Lorem + sourceLabel: voluptate fugiat Duis commod + updatedByUserId: 37734724 + - sourceType: quis est + timestamp: '1986-08-29T16:31:48.324Z' + value: dolore ullamco minim velit + sourceId: ullamco aliquip officia + sourceLabel: velit dolor sunt exercitation + updatedByUserId: 33081443 + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "enim_bff": [ + "<string>", + "<string>" + ], + "enim_da": [ + "<string>", + "<string>" + ] + }, + "links": { + "animf03": "<string>", + "labore33": "<string>" + }, + "errors": [ + { + "message": "culpa cillum", + "subCategory": "esse", + "code": "commodo ut cillum esse ut", + "in": "qui mollit minim", + "context": { + "doloref": [ + "sunt anim irure mollit", + "do ea" + ], + "labore_af6": [ + "proident", + "enim eiusmod magna adipisicing" + ] + } + }, + { + "message": "eu mollit id", + "subCategory": "reprehenderit minim labore exercitation", + "code": "in cupidatat", + "in": "elit eiusmod officia do adipisicing", + "context": { + "dolore_1": [ + "proident minim c", + "et" + ] + } + } + ] + } + /crm/v3/objects/invoices: + get: + tags: + - Invoices API > Basic + summary: List + description: >- + Read a page of invoices. Control what is returned via the `properties` + query param. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: limit + in: query + schema: + type: integer + description: The maximum number of results to display per page. + example: '10' + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + culpa_2: <string> + ea39: <string> + updatedAt: <dateTime> + associations: + irure57: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + in_44e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + nisi_c8: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + Duise00: <string> + fugiat_7a: <string> + ut69: <string> + updatedAt: <dateTime> + associations: + Lorem_7: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + minim3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "veniam_b": [ + "<string>", + "<string>" + ], + "idf2": [ + "<string>", + "<string>" + ] + }, + "links": { + "cillum_d": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "nulla0": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "ut4d": [ + "<string>", + "<string>" + ], + "Lorem_f": [ + "<string>", + "<string>" + ], + "aliquac3": [ + "<string>", + "<string>" + ], + "enim95": [ + "<string>", + "<string>" + ] + } + } + ] + } + post: + tags: + - Invoices API + summary: Create + description: >- + Create a invoice with the given properties and return a copy of the + object, including the ID. Documentation and examples for creating + standard invoices is provided. + requestBody: + content: + application/json: + schema: + type: object + example: + associations: + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + properties: + sed_e8b: <string> + cillum977: <string> + objectWriteTraceId: <string> + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: '1984-10-01T04:45:27.537Z' + id: ex nostrud + properties: + mollit70: amet labore nulla aliquip + sedc3a: laborum + doloree05: cupidatat sit dolore dolore eu + Ut_86: aliqua + updatedAt: '1957-08-13T03:09:43.927Z' + archived: true + archivedAt: '2000-05-23T17:59:13.228Z' + propertiesWithHistory: + reprehenderitd: + - sourceType: reprehenderit + timestamp: '1989-06-16T22:00:03.340Z' + value: officia eu labore + sourceId: 'occaecat mollit veniam exercitation ' + sourceLabel: dolore Lorem sit ipsum culpa + updatedByUserId: -83540352 + - sourceType: fugiat + timestamp: '1970-08-17T09:45:50.563Z' + value: in minim dolore + sourceId: culpa + sourceLabel: proident in + updatedByUserId: -20394806 + do72: + - sourceType: ut reprehenderit amet eu + timestamp: '1969-11-22T13:53:12.836Z' + value: mollit reprehenderit ex + sourceId: consectetur + sourceLabel: ipsum a + updatedByUserId: -22832863 + - sourceType: labore + timestamp: '1957-12-25T12:34:04.252Z' + value: nulla aute enim labore + sourceId: velit dolor culpa sed enim + sourceLabel: sit in Lorem + updatedByUserId: -267773 + in60: + - sourceType: in + timestamp: '2011-01-09T21:09:10.987Z' + value: nisi laboris + sourceId: mollit aute Ut + sourceLabel: ad cillum exercitation sint mollit + updatedByUserId: 18206430 + - sourceType: pariatur irure non et + timestamp: '1967-08-15T03:02:34.588Z' + value: tempor aute ea + sourceId: enim aliqua in + sourceLabel: in Duis nisi + updatedByUserId: 49658634 + et_d: + - sourceType: sed + timestamp: '1992-07-27T10:42:10.852Z' + value: aliquip venia + sourceId: dolor Lorem + sourceLabel: voluptate fugiat Duis commod + updatedByUserId: 37734724 + - sourceType: quis est + timestamp: '1986-08-29T16:31:48.324Z' + value: dolore ullamco minim velit + sourceId: ullamco aliquip officia + sourceLabel: velit dolor sunt exercitation + updatedByUserId: 33081443 + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "enim_bff": [ + "<string>", + "<string>" + ], + "enim_da": [ + "<string>", + "<string>" + ] + }, + "links": { + "animf03": "<string>", + "labore33": "<string>" + }, + "errors": [ + { + "message": "culpa cillum", + "subCategory": "esse", + "code": "commodo ut cillum esse ut", + "in": "qui mollit minim", + "context": { + "doloref": [ + "sunt anim irure mollit", + "do ea" + ], + "labore_af6": [ + "proident", + "enim eiusmod magna adipisicing" + ] + } + }, + { + "message": "eu mollit id", + "subCategory": "reprehenderit minim labore exercitation", + "code": "in cupidatat", + "in": "elit eiusmod officia do adipisicing", + "context": { + "dolore_1": [ + "proident minim c", + "et" + ] + } + } + ] + } + /crm/v3/objects/invoices/search: + post: + tags: + - Invoices API > Search + summary: Search for invoices + requestBody: + content: {} + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + in_388: <string> + aute166: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + reprehenderit7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + cupidatat244: <string> + aute_f: <string> + consequat_f: <string> + ipsumb9: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + consectetur_2: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + ut_69f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "veniam_b": [ + "<string>", + "<string>" + ], + "idf2": [ + "<string>", + "<string>" + ] + }, + "links": { + "cillum_d": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "nulla0": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "ut4d": [ + "<string>", + "<string>" + ], + "Lorem_f": [ + "<string>", + "<string>" + ], + "aliquac3": [ + "<string>", + "<string>" + ], + "enim95": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/invoices/batch/archive: + post: + tags: + - Invoices API + summary: Archive a batch of invoices by ID + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: fugiat consequat + - id: sit officia occaecat + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "enim_bff": [ + "<string>", + "<string>" + ], + "enim_da": [ + "<string>", + "<string>" + ] + }, + "links": { + "animf03": "<string>", + "labore33": "<string>" + }, + "errors": [ + { + "message": "culpa cillum", + "subCategory": "esse", + "code": "commodo ut cillum esse ut", + "in": "qui mollit minim", + "context": { + "doloref": [ + "sunt anim irure mollit", + "do ea" + ], + "labore_af6": [ + "proident", + "enim eiusmod magna adipisicing" + ] + } + }, + { + "message": "eu mollit id", + "subCategory": "reprehenderit minim labore exercitation", + "code": "in cupidatat", + "in": "elit eiusmod officia do adipisicing", + "context": { + "dolore_1": [ + "proident minim c", + "et" + ] + } + } + ] + } + /crm/v3/objects/invoices/batch/create: + post: + tags: + - Invoices API + summary: Create a batch of invoices + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - associations: + - to: + id: <string> + types: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + properties: + consectetur_155: <string> + velit5: <string> + objectWriteTraceId: <string> + - associations: + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + properties: + eu_026: <string> + objectWriteTraceId: <string> + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: '2021-08-03T05:01:14.022Z' + results: + - createdAt: '1957-03-22T21:42:04.988Z' + id: enim irure es + properties: + dolorec0: cupidatat sunt aute + updatedAt: '2009-11-27T07:17:59.350Z' + archived: true + archivedAt: '1982-06-05T13:40:36.717Z' + propertiesWithHistory: + animba: + - sourceType: id cillum magna qui + timestamp: '1948-03-07T00:51:27.382Z' + value: aliquip occaecat et ut + sourceId: in laboris enim laborum labore + sourceLabel: cupidatat esse eiusmod dolor consequat + updatedByUserId: -79005761 + - sourceType: ea + timestamp: '1963-07-17T15:08:33.388Z' + value: laborum ea elit cillum + sourceId: aliquip + sourceLabel: eiusmod + updatedByUserId: 96178446 + Excepteur_77: + - sourceType: exercitation occaecat cupidatat amet + timestamp: '1947-02-09T07:24:31.852Z' + value: dolore minim cillum sed + sourceId: est reprehenderit sunt nulla + sourceLabel: 'enim ' + updatedByUserId: -99715049 + - sourceType: ex tempor dolor + timestamp: '1999-11-08T21:33:40.678Z' + value: adipisicing nisi cillum + sourceId: amet ex Excepteur ea + sourceLabel: cillum ad + updatedByUserId: 5087880 + - createdAt: '1983-08-30T02:58:35.031Z' + id: fugiat mollit + properties: + cupidatat_7: aliquip laborum eiusmod nostrud + ut_687: reprehenderit + updatedAt: '1946-09-12T11:06:46.798Z' + archived: false + archivedAt: '1962-10-18T10:29:34.153Z' + propertiesWithHistory: + irure_67_: + - sourceType: nulla veniam amet quis + timestamp: '1978-08-25T04:12:10.077Z' + value: ut ex + sourceId: id + sourceLabel: aute fugiat + updatedByUserId: -14858253 + - sourceType: nisi + timestamp: '1979-05-31T09:40:21.283Z' + value: anim occaecat veniam + sourceId: voluptate in sunt ea laborum + sourceLabel: amet cupidatat + updatedByUserId: 59978911 + anim_3: + - sourceType: in + timestamp: '1961-06-01T00:41:17.768Z' + value: pariatur cupidatat officia voluptate + sourceId: dolore ea Lorem proident paria + sourceLabel: sint nostrud et + updatedByUserId: 22750256 + - sourceType: i + timestamp: '2000-11-05T22:09:25.335Z' + value: sit reprehenderit sunt veniam + sourceId: laboris mollit + sourceLabel: aliqu + updatedByUserId: -22942412 + startedAt: '1992-02-09T20:13:38.978Z' + status: COMPLETE + requestedAt: '2013-02-07T17:17:26.108Z' + links: + ut585: anim qui nisi et + amet_58: ex velit voluptate officia + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: '1951-08-22T19:40:38.040Z' + results: + - createdAt: '1997-10-30T06:22:43.502Z' + id: ad reprehenderit fugiat ex incididunt + properties: + Ut_773: sit anim + updatedAt: '1973-03-07T10:36:52.818Z' + archived: true + archivedAt: '1962-04-29T05:00:49.945Z' + propertiesWithHistory: + laborum2be: + - sourceType: ad aliquip reprehenderit + timestamp: '1956-03-04T18:28:16.472Z' + value: proident consequat cillum dolore fugiat + sourceId: aliquip enim exercit + sourceLabel: aliquip do + updatedByUserId: 21485577 + - sourceType: Excepteur et + timestamp: '1972-02-23T01:06:12.281Z' + value: dolor laboris + sourceId: officia ut Ut + sourceLabel: consectetur velit in voluptate + updatedByUserId: -41753454 + - createdAt: '2013-04-09T11:48:27.520Z' + id: culpa + properties: + deserunt_22c: Duis amet + updatedAt: '1974-12-25T11:53:12.433Z' + archived: false + archivedAt: '2018-06-18T14:03:43.201Z' + propertiesWithHistory: + cupidatatdb: + - sourceType: nisi nostrud + timestamp: '2016-01-16T21:19:23.675Z' + value: incididunt fugiat consectetur + sourceId: est incididunt + sourceLabel: magn + updatedByUserId: -23948258 + - sourceType: amet nulla + timestamp: '2018-10-18T12:02:10.986Z' + value: ut in esse dolore reprehenderit + sourceId: in dolore + sourceLabel: et nulla + updatedByUserId: 61337088 + startedAt: '2019-08-07T10:15:18.008Z' + status: COMPLETE + numErrors: 85092741 + requestedAt: '2020-06-06T21:43:04.842Z' + links: + Excepteur8: velit esse + errors: + - category: eiusmod proident c + context: + exercitation4c4: + - magna Duis veniam paria + - Excepteur et sit minim + Ut5: + - ut aliquip anim + - fugiat nostrud + errors: + - message: et ullamco in + subCategory: in sint + code: enim ut veniam Ut + in: incididunt ipsum commodo veniam quis + context: + irure_30: + - fugiat laborum laboris + - incididunt + ine56: + - ea consequat enim + - dolore elit ir + - message: dolor + subCategory: commodo cillum aliqui + code: in magna ut quis + in: dolore occaecat Lorem sunt + context: + nostrudc2: + - culpa voluptate + - in + links: + occaecat8a: sit deserunt + message: deserunt nisi do fugiat + status: magna + subCategory: {} + id: minim dolor + - category: Duis eu amet dolor + context: + sunt28: + - Ut sit ex ali + - sunt laborum labore + enim_46: + - magna + - cupidatat + errors: + - message: consect + subCategory: id non + code: est aliquip ex velit aute + in: Lorem + context: + esse_1: + - v + - dolor occaecat Lorem consectetur ut + - message: Lorem + subCategory: exercitation laborum + code: esse qui laboris + in: ad do ullamco officia + context: + aliquip52e: + - sed magna + - dolor fugiat + ad89: + - nisi + - non deserunt Excepteur incididunt + consequat_0a: + - veniam quis est + - ea eiusmod + links: + consecteturfb: eu sunt + message: nostrud aute tempor + status: voluptate laboris + subCategory: {} + id: ea e + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "enim_bff": [ + "<string>", + "<string>" + ], + "enim_da": [ + "<string>", + "<string>" + ] + }, + "links": { + "animf03": "<string>", + "labore33": "<string>" + }, + "errors": [ + { + "message": "culpa cillum", + "subCategory": "esse", + "code": "commodo ut cillum esse ut", + "in": "qui mollit minim", + "context": { + "doloref": [ + "sunt anim irure mollit", + "do ea" + ], + "labore_af6": [ + "proident", + "enim eiusmod magna adipisicing" + ] + } + }, + { + "message": "eu mollit id", + "subCategory": "reprehenderit minim labore exercitation", + "code": "in cupidatat", + "in": "elit eiusmod officia do adipisicing", + "context": { + "dolore_1": [ + "proident minim c", + "et" + ] + } + } + ] + } + /crm/v3/objects/invoices/batch/update: + post: + tags: + - Invoices API + summary: Update a batch of invoices + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + properties: + cillum_863: <string> + occaecat_2: <string> + incididuntcb2: <string> + iruref: <string> + idProperty: <string> + objectWriteTraceId: <string> + - id: <string> + properties: + nostrud01: <string> + idProperty: <string> + objectWriteTraceId: <string> + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: '2021-08-03T05:01:14.022Z' + results: + - createdAt: '1957-03-22T21:42:04.988Z' + id: enim irure es + properties: + dolorec0: cupidatat sunt aute + updatedAt: '2009-11-27T07:17:59.350Z' + archived: true + archivedAt: '1982-06-05T13:40:36.717Z' + propertiesWithHistory: + animba: + - sourceType: id cillum magna qui + timestamp: '1948-03-07T00:51:27.382Z' + value: aliquip occaecat et ut + sourceId: in laboris enim laborum labore + sourceLabel: cupidatat esse eiusmod dolor consequat + updatedByUserId: -79005761 + - sourceType: ea + timestamp: '1963-07-17T15:08:33.388Z' + value: laborum ea elit cillum + sourceId: aliquip + sourceLabel: eiusmod + updatedByUserId: 96178446 + Excepteur_77: + - sourceType: exercitation occaecat cupidatat amet + timestamp: '1947-02-09T07:24:31.852Z' + value: dolore minim cillum sed + sourceId: est reprehenderit sunt nulla + sourceLabel: 'enim ' + updatedByUserId: -99715049 + - sourceType: ex tempor dolor + timestamp: '1999-11-08T21:33:40.678Z' + value: adipisicing nisi cillum + sourceId: amet ex Excepteur ea + sourceLabel: cillum ad + updatedByUserId: 5087880 + - createdAt: '1983-08-30T02:58:35.031Z' + id: fugiat mollit + properties: + cupidatat_7: aliquip laborum eiusmod nostrud + ut_687: reprehenderit + updatedAt: '1946-09-12T11:06:46.798Z' + archived: false + archivedAt: '1962-10-18T10:29:34.153Z' + propertiesWithHistory: + irure_67_: + - sourceType: nulla veniam amet quis + timestamp: '1978-08-25T04:12:10.077Z' + value: ut ex + sourceId: id + sourceLabel: aute fugiat + updatedByUserId: -14858253 + - sourceType: nisi + timestamp: '1979-05-31T09:40:21.283Z' + value: anim occaecat veniam + sourceId: voluptate in sunt ea laborum + sourceLabel: amet cupidatat + updatedByUserId: 59978911 + anim_3: + - sourceType: in + timestamp: '1961-06-01T00:41:17.768Z' + value: pariatur cupidatat officia voluptate + sourceId: dolore ea Lorem proident paria + sourceLabel: sint nostrud et + updatedByUserId: 22750256 + - sourceType: i + timestamp: '2000-11-05T22:09:25.335Z' + value: sit reprehenderit sunt veniam + sourceId: laboris mollit + sourceLabel: aliqu + updatedByUserId: -22942412 + startedAt: '1992-02-09T20:13:38.978Z' + status: COMPLETE + requestedAt: '2013-02-07T17:17:26.108Z' + links: + ut585: anim qui nisi et + amet_58: ex velit voluptate officia + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: '1951-08-22T19:40:38.040Z' + results: + - createdAt: '1997-10-30T06:22:43.502Z' + id: ad reprehenderit fugiat ex incididunt + properties: + Ut_773: sit anim + updatedAt: '1973-03-07T10:36:52.818Z' + archived: true + archivedAt: '1962-04-29T05:00:49.945Z' + propertiesWithHistory: + laborum2be: + - sourceType: ad aliquip reprehenderit + timestamp: '1956-03-04T18:28:16.472Z' + value: proident consequat cillum dolore fugiat + sourceId: aliquip enim exercit + sourceLabel: aliquip do + updatedByUserId: 21485577 + - sourceType: Excepteur et + timestamp: '1972-02-23T01:06:12.281Z' + value: dolor laboris + sourceId: officia ut Ut + sourceLabel: consectetur velit in voluptate + updatedByUserId: -41753454 + - createdAt: '2013-04-09T11:48:27.520Z' + id: culpa + properties: + deserunt_22c: Duis amet + updatedAt: '1974-12-25T11:53:12.433Z' + archived: false + archivedAt: '2018-06-18T14:03:43.201Z' + propertiesWithHistory: + cupidatatdb: + - sourceType: nisi nostrud + timestamp: '2016-01-16T21:19:23.675Z' + value: incididunt fugiat consectetur + sourceId: est incididunt + sourceLabel: magn + updatedByUserId: -23948258 + - sourceType: amet nulla + timestamp: '2018-10-18T12:02:10.986Z' + value: ut in esse dolore reprehenderit + sourceId: in dolore + sourceLabel: et nulla + updatedByUserId: 61337088 + startedAt: '2019-08-07T10:15:18.008Z' + status: COMPLETE + numErrors: 85092741 + requestedAt: '2020-06-06T21:43:04.842Z' + links: + Excepteur8: velit esse + errors: + - category: eiusmod proident c + context: + exercitation4c4: + - magna Duis veniam paria + - Excepteur et sit minim + Ut5: + - ut aliquip anim + - fugiat nostrud + errors: + - message: et ullamco in + subCategory: in sint + code: enim ut veniam Ut + in: incididunt ipsum commodo veniam quis + context: + irure_30: + - fugiat laborum laboris + - incididunt + ine56: + - ea consequat enim + - dolore elit ir + - message: dolor + subCategory: commodo cillum aliqui + code: in magna ut quis + in: dolore occaecat Lorem sunt + context: + nostrudc2: + - culpa voluptate + - in + links: + occaecat8a: sit deserunt + message: deserunt nisi do fugiat + status: magna + subCategory: {} + id: minim dolor + - category: Duis eu amet dolor + context: + sunt28: + - Ut sit ex ali + - sunt laborum labore + enim_46: + - magna + - cupidatat + errors: + - message: consect + subCategory: id non + code: est aliquip ex velit aute + in: Lorem + context: + esse_1: + - v + - dolor occaecat Lorem consectetur ut + - message: Lorem + subCategory: exercitation laborum + code: esse qui laboris + in: ad do ullamco officia + context: + aliquip52e: + - sed magna + - dolor fugiat + ad89: + - nisi + - non deserunt Excepteur incididunt + consequat_0a: + - veniam quis est + - ea eiusmod + links: + consecteturfb: eu sunt + message: nostrud aute tempor + status: voluptate laboris + subCategory: {} + id: ea e + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "enim_bff": [ + "<string>", + "<string>" + ], + "enim_da": [ + "<string>", + "<string>" + ] + }, + "links": { + "animf03": "<string>", + "labore33": "<string>" + }, + "errors": [ + { + "message": "culpa cillum", + "subCategory": "esse", + "code": "commodo ut cillum esse ut", + "in": "qui mollit minim", + "context": { + "doloref": [ + "sunt anim irure mollit", + "do ea" + ], + "labore_af6": [ + "proident", + "enim eiusmod magna adipisicing" + ] + } + }, + { + "message": "eu mollit id", + "subCategory": "reprehenderit minim labore exercitation", + "code": "in cupidatat", + "in": "elit eiusmod officia do adipisicing", + "context": { + "dolore_1": [ + "proident minim c", + "et" + ] + } + } + ] + } + /crm/v3/objects/invoices/batch/upsert: + post: + tags: + - Invoices API + summary: Create or update a batch of invoices by unique property values + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + properties: + quis_2: <string> + ut_59: <string> + idProperty: <string> + objectWriteTraceId: <string> + - id: <string> + properties: + cillum_2_c: <string> + ut_99c: <string> + idProperty: <string> + objectWriteTraceId: <string> + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + new: <boolean> + properties: + fugiatb98: <string> + eae: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + sed216: + - sourceType: Excepteur + timestamp: '1954-07-13T06:37:50.732Z' + value: tempor mollit aliquip + sourceId: ad sunt ipsum exercitation do + sourceLabel: Excepteur + updatedByUserId: -72734141 + - sourceType: aliqui + timestamp: '2003-10-02T03:18:41.131Z' + value: officia labore incididunt au + sourceId: minim consectetur + sourceLabel: pariatur anim + updatedByUserId: 90728803 + non_0: + - sourceType: sint dolore do quis + timestamp: '2015-08-18T14:06:21.655Z' + value: dolore amet ad + sourceId: veniam nulla amet elit ea + sourceLabel: adipisicing ipsum reprehenderit velit Ut + updatedByUserId: 94429617 + - sourceType: Duis + timestamp: '1948-12-01T23:23:06.631Z' + value: sint magna + sourceId: pariatur sint labori + sourceLabel: nulla dolore in incididunt + updatedByUserId: 28233548 + - createdAt: <dateTime> + id: <string> + new: <boolean> + properties: + ullamco55: <string> + aliquip_7: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + aliquip_5ed: + - sourceType: aliquip + timestamp: '1996-01-12T20:15:36.075Z' + value: laborum in eu + sourceId: amet id + sourceLabel: eu anim incididunt + updatedByUserId: 40934998 + - sourceType: elit fugiat + timestamp: '1975-01-20T15:40:22.551Z' + value: irure + sourceId: ullamco in + sourceLabel: et cupidatat laboris + updatedByUserId: -29422852 + startedAt: <dateTime> + status: PENDING + requestedAt: <dateTime> + links: + et0f0: <string> + temporf: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + new: <boolean> + properties: + sunt_03: <string> + pariatur_8: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + laborumf3: + - sourceType: dolor aute minim amet + timestamp: '2007-01-25T13:22:29.497Z' + value: et sit magna est + sourceId: dolore pariatur deserunt consectetur dolor + sourceLabel: esse Lorem sint + updatedByUserId: 2348882 + - sourceType: fugiat id quis exercitation sit + timestamp: '1994-10-11T13:39:09.797Z' + value: ad dolor aute labore + sourceId: enim adipis + sourceLabel: sed + updatedByUserId: -87361043 + magna_b: + - sourceType: proident dolore sint con + timestamp: '1985-07-12T10:27:11.964Z' + value: do + sourceId: Lorem deserunt do + sourceLabel: elit labore ipsum + updatedByUserId: 36786918 + - sourceType: adipisicing ea ad qui + timestamp: '1999-12-04T08:50:50.556Z' + value: occaecat aliquip eu ea + sourceId: Excepteur + sourceLabel: incididunt sint Duis et + updatedByUserId: -81996355 + est_: + - sourceType: anim in nostrud + timestamp: '1995-04-03T04:09:40.488Z' + value: 'incididunt ' + sourceId: veniam irure dolore + sourceLabel: cupidatat dolor + updatedByUserId: -28748906 + - sourceType: in est qui + timestamp: '1967-10-29T07:55:09.465Z' + value: aliquip dolor + sourceId: in nulla ea dolore + sourceLabel: eiusmod dolor consequat mollit + updatedByUserId: -32378810 + - createdAt: <dateTime> + id: <string> + new: <boolean> + properties: + nisic2: <string> + Excepteur7: <string> + eiusmodad1: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + eu96: + - sourceType: aliquip dolor dolor + timestamp: '1960-07-05T00:25:03.521Z' + value: officia Duis + sourceId: tempo + sourceLabel: ea do + updatedByUserId: -10168096 + - sourceType: velit + timestamp: '1994-07-28T13:40:09.580Z' + value: minim + sourceId: pariatur dolore sunt mollit + sourceLabel: dolore anim + updatedByUserId: 9146734 + etd35: + - sourceType: adipisicing quis i + timestamp: '1987-05-25T13:49:08.481Z' + value: proident Ut occaecat tempor ut + sourceId: exercitation dolor ipsum officia + sourceLabel: elit sint + updatedByUserId: -52328997 + - sourceType: eiusmod + timestamp: '2000-11-05T08:30:20.292Z' + value: ad aliquip dolore + sourceId: consequat deserunt ad + sourceLabel: in minim esse exercitation sit + updatedByUserId: 24837037 + startedAt: <dateTime> + status: PROCESSING + numErrors: <integer> + requestedAt: <dateTime> + links: + consequat591: <string> + nulla4: <string> + errors: + - category: dolore + context: + deseruntd48: + - nulla ex exercitation + - velit sit + errors: + - message: labore Lorem in aute + subCategory: ut ad non + code: cupidatat ut + in: sunt commodo a + context: + aliqua_a64: + - ex tempor commodo reprehenderit ipsum + - qui eiusmod tempor + - message: eu in + subCategory: commodo + code: laboris incididunt Lorem magna Excepteur + in: labore + context: + reprehenderit_07: + - aute do + - magna Ut + links: + magna_afc: eiusmod consectetur + message: ex esse + status: Duis in sit + subCategory: {} + id: voluptate elit u + - category: ipsum sit in enim + context: + dolor4: + - eni + - anim dolore adipisicing + officia_f: + - sed in ad ipsum + - elit exercitation cupidatat id + minim367: + - officia voluptate laborum fugiat + - fugiat cupidatat esse + errors: + - message: eiusmod dolor dolore + subCategory: velit non aliqua + code: cillum ullamco + in: ut + context: + sit1: + - sed dolor quis amet + - minim in + - message: cillum ad elit + subCategory: elit consectetur + code: labore enim i + in: eiusmod sint ipsum + context: + ea5: + - sunt aute ut + - Excepteur incididunt pariatur eiusmod + links: + laborum_2: ad + officia_: elit anim + message: labore occaecat + status: ipsum anim et in + subCategory: {} + id: nostrud in fugiat deserunt + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "enim_bff": [ + "<string>", + "<string>" + ], + "enim_da": [ + "<string>", + "<string>" + ] + }, + "links": { + "animf03": "<string>", + "labore33": "<string>" + }, + "errors": [ + { + "message": "culpa cillum", + "subCategory": "esse", + "code": "commodo ut cillum esse ut", + "in": "qui mollit minim", + "context": { + "doloref": [ + "sunt anim irure mollit", + "do ea" + ], + "labore_af6": [ + "proident", + "enim eiusmod magna adipisicing" + ] + } + }, + { + "message": "eu mollit id", + "subCategory": "reprehenderit minim labore exercitation", + "code": "in cupidatat", + "in": "elit eiusmod officia do adipisicing", + "context": { + "dolore_1": [ + "proident minim c", + "et" + ] + } + } + ] + } diff --git a/server/node-service/src/plugins/hubspot/specsV4/Conversations API Collections.json b/server/node-service/src/plugins/hubspot/specsV4/Conversations API Collections.json new file mode 100644 index 000000000..a68ded8b5 --- /dev/null +++ b/server/node-service/src/plugins/hubspot/specsV4/Conversations API Collections.json @@ -0,0 +1,4516 @@ +openapi: 3.0.0 +info: + title: Conversations API Collections + description: >- + The conversations APIs enable you to manage and interact with the + conversations inbox, channels, and messages. For example, you can use these + APIs to: + + + - Get and sort conversations inboxes, channels, threads, and messages. + + - Update thread statuses. + + - Delete and restore threads. + + - Send outbound messages via existing conversations channels. + + - Send an internal comment to an agent. + + - Retrieve conversation data to create advanced reports and analytics in + external tools. + + + You could also use these APIs to integrate existing channels with other apps + such as + [Slack](https://knowledge.hubspot.com/integrations/how-do-i-use-the-slack-integration) + or Microsoft Teams to send replies or receive notifications. + + + To get started with the conversations APIs, make sure you have [set up a + HubSpot developer account](https://developers.hubspot.com/get-started) and + [created an app](https://developers.hubspot.com/docs/api/creating-an-app). + You will need a developer account ID and app ID to get access to these APIs. + + + **Fork the collections using Run in Postman:** + + + [<img src="https://run.pstmn.io/button.svg" alt="Run In + Postman">](https://app.getpostman.com/run-collection/26126890-cc463f6b-d702-4d75-b31b-938134ed0abe?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D26126890-cc463f6b-d702-4d75-b31b-938134ed0abe%26entityType%3Dcollection%26workspaceId%3Dd7645f33-539d-49c6-9e0c-efa6faae355d) + version: 1.0.0 +servers: + - url: http://{{baseurl}} +components: + securitySchemes: + oauth2Auth: + type: http + scheme: oauth2 + apikeyAuth: + type: http + scheme: apikey +tags: + - name: Conversations Inbox & Messages API + description: "**Please note:**\_this API is currently in beta and is subject to change based on testing and feedback. By using these endpoints you agree to adhere to HubSpot's\_[Developer Terms](https://legal.hubspot.com/hubspot-developer-terms)\_and[Developer Beta Terms](https://legal.hubspot.com/developerbetaterms?). You also acknowledge and understand the risk associated with testing an unstable API.\n\nThe conversations APIs enable you to manage and interact with the conversations inbox, channels, and messages. For example, you can use these APIs to:\n\n- Get and sort conversations inboxes, channels, threads, and messages.\n \n- Update thread statuses.\n \n- Delete and restore threads.\n \n- Send outbound messages via existing conversations channels.\n \n- Send an internal comment to an agent.\_\n \n- Retrieve conversation data to create advanced reports and analytics in external tools.\n \n\nYou could also use these APIs to integrate existing channels with other apps such as\_[Slack](https://knowledge.hubspot.com/integrations/how-do-i-use-the-slack-integration)\_or Microsoft Teams to send replies or receive notifications.\_\n\nTo get started with the conversations APIs, make sure you have\_[set up a HubSpot developer account](https://developers.hubspot.com/get-started)\_and\_[created an app](https://developers.hubspot.com/docs/api/creating-an-app). You will need a developer account ID and app ID to get access to these APIs.\_\n\n**Please note:**\_with these APIs, you\_cannot\_add net new channels, such as a WhatsApp channel, to the inbox. You also cannot start a new thread in an existing channel or connect a 3rd party chat provider to the inbox.\_\n\nTo view all available endpoints and their requirements, click the\_Endpoints\_tab at the top of this article.\n\nWebhooks for conversations are also supported and can be used in tandem with the conversations API. You can use webhooks to\_subscribe to events about conversations, including thread creation, thread status and assignment changes, and new messages on threads.\_Learn more about using\_[webhooks](https://developers.hubspot.com/docs/api/webhooks).\_\n\n**Please note:**\_to make a\_`GET`\_request to any endpoints, or\_`POST`\_batch read request to the get actors endpoint, you must have\_`conversations.read`\_access.\_All other endpoints require\_`conversations.write`\_access." + - name: Conversations Inbox & Messages API > Conversations + - name: Conversations Visitor Identification API + description: "Use the Visitor Identification API to identify visitors to your site that were authenticated using your own external authentication system.\_An identification token returned from this API can be used to pass information about your already-authenticated visitor to the chat widget, so that it treats the visitor as a known contact. Agents in the inbox can then have confidence about who they are talking to, and visitors can access previous thread history across devices. For example:\n\n**Please note:**\n\n- The Visitor Identification API is for telling HubSpot who the visitor is. You should not rely on this to authenticate users in your platform.\n \n- Access to the Visitor Identification API requires a\__Professional_\_or\__Enterprise_\_level subscription. If the account does not have a qualifying subscription, you will receive a\_`403`\_error response from the API." + - name: Custom Channels API + description: "**Please note**: This API is currently in beta and is subject to change based on testing and feedback. By using these endpoints you agree to adhere to HubSpot's\_[Developer Terms](https://legal.hubspot.com/hubspot-developer-terms)&\_[Developer Beta Terms](https://legal.hubspot.com/developerbetaterms?). You also acknowledge and understand the risk associated with testing an unstable API.\n\n- [Overview](https://developers.hubspot.com/docs/guides/api/conversations/create-custom-channels#tab-1)\n \n- [Endpoints](https://developers.hubspot.com/docs/guides/api/conversations/create-custom-channels#tab-2)\n \n\nIf you have a\_Sales Hub\_Enterprise\_or\_Service Hub\_Enterprise\_account, you can create custom channels to build a bridge between an external message service and HubSpot's\_[inbox](https://knowledge.hubspot.com/inbox/set-up-the-conversations-inbox)\_or\_[help desk](https://knowledge.hubspot.com/help-desk/overview-of-the-help-desk-workspace)\_features. You can then publish your custom channel app in the HubSpot App Marketplace for other HubSpot admins to install and use in their own accounts. \n \n[For more information please refer to the API documentation.](https://developers.hubspot.com/docs/guides/api/conversations/create-custom-channels)" + - name: Custom Channels API > External_Channels + - name: Custom Channels API > External_Messages + - name: Custom Channels API > External_Channel_Accounts +paths: + /conversations/v3/conversations/inboxes: + get: + tags: + - Conversations Inbox & Messages API > Conversations + summary: Get conversations inboxes. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: limit + in: query + schema: + type: string + description: The maximum number of results to display per page. + example: <integer> + - name: sort + in: query + schema: + type: string + example: <string> + - name: sort + in: query + schema: + type: string + example: <string> + - name: defaultPageLength + in: query + schema: + type: string + example: <integer> + - name: archived + in: query + schema: + type: string + example: <boolean> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - id: <string> + name: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + archived: <boolean> + type: <string> + - id: <string> + name: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + archived: <boolean> + type: <string> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "eab": [ + "<string>", + "<string>" + ], + "consectetur_29f": [ + "<string>", + "<string>" + ], + "culpa_bd6": [ + "<string>", + "<string>" + ], + "dolore5cd": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "pariatur_57": [ + "<string>", + "<string>" + ], + "consequat_a": [ + "<string>", + "<string>" + ], + "voluptate08b": [ + "<string>", + "<string>" + ], + "idde": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "anim_a": [ + "<string>", + "<string>" + ] + }, + "links": { + "tempor_0": "<string>", + "ea__93": "<string>" + } + } + /conversations/v3/conversations/threads/{threadId}: + get: + tags: + - Conversations Inbox & Messages API > Conversations + summary: Get a single thread. + description: Returns a single thread. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: string + description: >- + Whether to return only results that have been archived. Default is + false. + example: <boolean> + - name: property + in: query + schema: + type: string + example: <string> + - name: association + in: query + schema: + type: string + description: >- + You can specify an association type here of `TICKET`. If this is set + the response will included a thread associations object and + associated ticket id if present. If there are no associations to a + ticket with this conversation, then the thread associations object + will not be present on the response. + example: TICKET + - name: threadId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + associatedContactId: <string> + createdAt: <dateTime> + id: <string> + inboxId: <string> + spam: <boolean> + status: CLOSED + closedAt: <dateTime> + latestMessageTimestamp: <dateTime> + latestMessageSentTimestamp: <dateTime> + latestMessageReceivedTimestamp: <dateTime> + assignedTo: <string> + archived: <boolean> + originalChannelAccountId: <string> + originalChannelId: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "eab": [ + "<string>", + "<string>" + ], + "consectetur_29f": [ + "<string>", + "<string>" + ], + "culpa_bd6": [ + "<string>", + "<string>" + ], + "dolore5cd": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "pariatur_57": [ + "<string>", + "<string>" + ], + "consequat_a": [ + "<string>", + "<string>" + ], + "voluptate08b": [ + "<string>", + "<string>" + ], + "idde": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "anim_a": [ + "<string>", + "<string>" + ] + }, + "links": { + "tempor_0": "<string>", + "ea__93": "<string>" + } + } + delete: + tags: + - Conversations Inbox & Messages API > Conversations + summary: Archives a thread. + description: >- + Archives a single thread. The thread will be permanently deleted 30 days + after placed in an archived state. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: threadId + in: path + schema: + type: string + required: true + example: <long> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "eab": [ + "<string>", + "<string>" + ], + "consectetur_29f": [ + "<string>", + "<string>" + ], + "culpa_bd6": [ + "<string>", + "<string>" + ], + "dolore5cd": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "pariatur_57": [ + "<string>", + "<string>" + ], + "consequat_a": [ + "<string>", + "<string>" + ], + "voluptate08b": [ + "<string>", + "<string>" + ], + "idde": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "anim_a": [ + "<string>", + "<string>" + ] + }, + "links": { + "tempor_0": "<string>", + "ea__93": "<string>" + } + } + patch: + tags: + - Conversations Inbox & Messages API > Conversations + summary: Update a thread. + description: >- + Updates a single thread. Either a thread's status can be updated, or the + thread can be restored. + requestBody: + content: + application/json: + schema: + type: object + example: + status: CLOSED + archived: <boolean> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: string + description: >- + Whether the thread to update is archived. Default is false. A + thread's status property can not be updated if the thread is + archived. + example: <boolean> + - name: threadId + in: path + schema: + type: string + required: true + example: <long> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + associatedContactId: <string> + createdAt: <dateTime> + id: <string> + inboxId: <string> + spam: <boolean> + status: CLOSED + closedAt: <dateTime> + latestMessageTimestamp: <dateTime> + latestMessageSentTimestamp: <dateTime> + latestMessageReceivedTimestamp: <dateTime> + assignedTo: <string> + archived: <boolean> + originalChannelAccountId: <string> + originalChannelId: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "eab": [ + "<string>", + "<string>" + ], + "consectetur_29f": [ + "<string>", + "<string>" + ], + "culpa_bd6": [ + "<string>", + "<string>" + ], + "dolore5cd": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "pariatur_57": [ + "<string>", + "<string>" + ], + "consequat_a": [ + "<string>", + "<string>" + ], + "voluptate08b": [ + "<string>", + "<string>" + ], + "idde": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "anim_a": [ + "<string>", + "<string>" + ] + }, + "links": { + "tempor_0": "<string>", + "ea__93": "<string>" + } + } + /conversations/v3/conversations/threads/{threadId}/messages/{messageId}/original-content: + get: + tags: + - Conversations Inbox & Messages API > Conversations + summary: Get the original content of a single message. + description: >- + Returns the complete original text and rich text bodies of a message. + This will be different from the text and rich text in the message itself + if the message's `truncationStatus` is anything other than + `NOT_TRUNCATED`. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: property + in: query + schema: + type: string + example: <string> + - name: threadId + in: path + schema: + type: string + required: true + example: <long> + - name: messageId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + text: <string> + richText: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "eab": [ + "<string>", + "<string>" + ], + "consectetur_29f": [ + "<string>", + "<string>" + ], + "culpa_bd6": [ + "<string>", + "<string>" + ], + "dolore5cd": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "pariatur_57": [ + "<string>", + "<string>" + ], + "consequat_a": [ + "<string>", + "<string>" + ], + "voluptate08b": [ + "<string>", + "<string>" + ], + "idde": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "anim_a": [ + "<string>", + "<string>" + ] + }, + "links": { + "tempor_0": "<string>", + "ea__93": "<string>" + } + } + /conversations/v3/conversations/threads/{threadId}/messages: + get: + tags: + - Conversations Inbox & Messages API > Conversations + summary: Get message history for a thread. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: limit + in: query + schema: + type: string + description: The maximum number of results to display per page. + example: <integer> + - name: sort + in: query + schema: + type: string + description: >- + Sort direction. Valid options are `createdAt` (ascending), and + `-createdAt` (descending, default) + example: <string> + - name: sort + in: query + schema: + type: string + description: >- + Sort direction. Valid options are `createdAt` (ascending), and + `-createdAt` (descending, default) + example: <string> + - name: archived + in: query + schema: + type: string + description: Whether to return only results that have been archived. + example: <boolean> + - name: property + in: query + schema: + type: string + example: <string> + - name: threadId + in: path + schema: + type: string + required: true + example: <long> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - value: >- + <Circular reference to + #/components/schemas/PublicConversationsMessage detected> + - value: >- + <Circular reference to + #/components/schemas/PublicConversationsMessage detected> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "eab": [ + "<string>", + "<string>" + ], + "consectetur_29f": [ + "<string>", + "<string>" + ], + "culpa_bd6": [ + "<string>", + "<string>" + ], + "dolore5cd": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "pariatur_57": [ + "<string>", + "<string>" + ], + "consequat_a": [ + "<string>", + "<string>" + ], + "voluptate08b": [ + "<string>", + "<string>" + ], + "idde": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "anim_a": [ + "<string>", + "<string>" + ] + }, + "links": { + "tempor_0": "<string>", + "ea__93": "<string>" + } + } + post: + tags: + - Conversations Inbox & Messages API > Conversations + summary: Send a message to a thread. + description: Send a new message on a thread at the current timestamp. + requestBody: + content: + application/json: + schema: + type: object + example: + attachments: [] + channelAccountId: <string> + channelId: <string> + recipients: + - deliveryIdentifiers: + - type: <string> + value: <string> + - type: <string> + value: <string> + actorId: <string> + name: <string> + recipientField: <string> + deliveryIdentifier: + type: <string> + value: <string> + - deliveryIdentifiers: + - type: <string> + value: <string> + - type: <string> + value: <string> + actorId: <string> + name: <string> + recipientField: <string> + deliveryIdentifier: + type: <string> + value: <string> + senderActorId: <string> + text: <string> + type: MESSAGE + richText: <string> + subject: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: threadId + in: path + schema: + type: string + required: true + example: <long> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: null + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + value: >- + <Circular reference to + #/components/schemas/PublicConversationsMessage detected> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "eab": [ + "<string>", + "<string>" + ], + "consectetur_29f": [ + "<string>", + "<string>" + ], + "culpa_bd6": [ + "<string>", + "<string>" + ], + "dolore5cd": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "pariatur_57": [ + "<string>", + "<string>" + ], + "consequat_a": [ + "<string>", + "<string>" + ], + "voluptate08b": [ + "<string>", + "<string>" + ], + "idde": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "anim_a": [ + "<string>", + "<string>" + ] + }, + "links": { + "tempor_0": "<string>", + "ea__93": "<string>" + } + } + /conversations/v3/conversations/actors/batch/read: + post: + tags: + - Conversations Inbox & Messages API > Conversations + summary: Get actors + description: Resolve `ActorId`s to the underlying actors/participants. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - <string> + - <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: property + in: query + schema: + type: string + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - id: <string> + type: AGENT + name: <string> + email: <string> + avatar: <string> + - id: <string> + type: AGENT + name: <string> + email: <string> + avatar: <string> + startedAt: <dateTime> + status: CANCELED + requestedAt: <dateTime> + links: + nisi5: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - id: <string> + type: AGENT + name: <string> + email: <string> + avatar: <string> + - id: <string> + type: AGENT + name: <string> + email: <string> + avatar: <string> + startedAt: <dateTime> + status: COMPLETE + numErrors: <integer> + errors: + - category: <string> + context: + minim_bc: + - <string> + - <string> + laborisc: + - <string> + - <string> + magna_9: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + eta: + - <string> + - <string> + esseaf3: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + magna6f: + - <string> + - <string> + voluptateef_: + - <string> + - <string> + eiusmod7: + - <string> + - <string> + quis1c: + - <string> + - <string> + links: + id3cf: <string> + laborum_ea5: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + occaecat7c: + - <string> + - <string> + dolorb94: + - <string> + - <string> + consequat__6_: + - <string> + - <string> + sed_977: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + laborum3fa: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + Excepteura5: + - <string> + - <string> + dolore_0: + - <string> + - <string> + links: + aute_31c: <string> + aliqua_3_e: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + eu_9e: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "eab": [ + "<string>", + "<string>" + ], + "consectetur_29f": [ + "<string>", + "<string>" + ], + "culpa_bd6": [ + "<string>", + "<string>" + ], + "dolore5cd": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "pariatur_57": [ + "<string>", + "<string>" + ], + "consequat_a": [ + "<string>", + "<string>" + ], + "voluptate08b": [ + "<string>", + "<string>" + ], + "idde": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "anim_a": [ + "<string>", + "<string>" + ] + }, + "links": { + "tempor_0": "<string>", + "ea__93": "<string>" + } + } + /conversations/v3/conversations/channel-accounts: + get: + tags: + - Conversations Inbox & Messages API > Conversations + summary: Get channel accounts. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: channelId + in: query + schema: + type: string + description: Limits results to channel accounts within a particular channel. + example: <integer> + - name: channelId + in: query + schema: + type: string + description: Limits results to channel accounts within a particular channel. + example: <integer> + - name: inboxId + in: query + schema: + type: string + description: Limits results to channel accounts within a particular inbox. + example: <integer> + - name: inboxId + in: query + schema: + type: string + description: Limits results to channel accounts within a particular inbox. + example: <integer> + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: limit + in: query + schema: + type: string + description: The maximum number of results to display per page. + example: <integer> + - name: sort + in: query + schema: + type: string + example: <string> + - name: sort + in: query + schema: + type: string + example: <string> + - name: defaultPageLength + in: query + schema: + type: string + example: <integer> + - name: archived + in: query + schema: + type: string + example: <boolean> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - id: <string> + channelId: <string> + name: <string> + inboxId: <string> + active: <boolean> + authorized: <boolean> + createdAt: <dateTime> + deliveryIdentifier: + type: <string> + value: <string> + archived: <boolean> + - id: <string> + channelId: <string> + name: <string> + inboxId: <string> + active: <boolean> + authorized: <boolean> + createdAt: <dateTime> + deliveryIdentifier: + type: <string> + value: <string> + archived: <boolean> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "eab": [ + "<string>", + "<string>" + ], + "consectetur_29f": [ + "<string>", + "<string>" + ], + "culpa_bd6": [ + "<string>", + "<string>" + ], + "dolore5cd": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "pariatur_57": [ + "<string>", + "<string>" + ], + "consequat_a": [ + "<string>", + "<string>" + ], + "voluptate08b": [ + "<string>", + "<string>" + ], + "idde": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "anim_a": [ + "<string>", + "<string>" + ] + }, + "links": { + "tempor_0": "<string>", + "ea__93": "<string>" + } + } + /conversations/v3/conversations/channels/{channelId}: + get: + tags: + - Conversations Inbox & Messages API > Conversations + summary: Get a single channel. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: channelId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + id: <string> + name: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "eab": [ + "<string>", + "<string>" + ], + "consectetur_29f": [ + "<string>", + "<string>" + ], + "culpa_bd6": [ + "<string>", + "<string>" + ], + "dolore5cd": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "pariatur_57": [ + "<string>", + "<string>" + ], + "consequat_a": [ + "<string>", + "<string>" + ], + "voluptate08b": [ + "<string>", + "<string>" + ], + "idde": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "anim_a": [ + "<string>", + "<string>" + ] + }, + "links": { + "tempor_0": "<string>", + "ea__93": "<string>" + } + } + /conversations/v3/conversations/threads/{threadId}/messages/{messageId}: + get: + tags: + - Conversations Inbox & Messages API > Conversations + summary: Get a single message. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: property + in: query + schema: + type: string + example: <string> + - name: threadId + in: path + schema: + type: string + required: true + example: <long> + - name: messageId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + value: >- + <Circular reference to + #/components/schemas/PublicConversationsMessage detected> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "eab": [ + "<string>", + "<string>" + ], + "consectetur_29f": [ + "<string>", + "<string>" + ], + "culpa_bd6": [ + "<string>", + "<string>" + ], + "dolore5cd": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "pariatur_57": [ + "<string>", + "<string>" + ], + "consequat_a": [ + "<string>", + "<string>" + ], + "voluptate08b": [ + "<string>", + "<string>" + ], + "idde": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "anim_a": [ + "<string>", + "<string>" + ] + }, + "links": { + "tempor_0": "<string>", + "ea__93": "<string>" + } + } + /conversations/v3/conversations/channels: + get: + tags: + - Conversations Inbox & Messages API > Conversations + summary: Get channels. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: limit + in: query + schema: + type: string + description: The maximum number of results to display per page. + example: <integer> + - name: sort + in: query + schema: + type: string + example: <string> + - name: sort + in: query + schema: + type: string + example: <string> + - name: defaultPageLength + in: query + schema: + type: string + example: <integer> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - id: <string> + name: <string> + - id: <string> + name: <string> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "eab": [ + "<string>", + "<string>" + ], + "consectetur_29f": [ + "<string>", + "<string>" + ], + "culpa_bd6": [ + "<string>", + "<string>" + ], + "dolore5cd": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "pariatur_57": [ + "<string>", + "<string>" + ], + "consequat_a": [ + "<string>", + "<string>" + ], + "voluptate08b": [ + "<string>", + "<string>" + ], + "idde": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "anim_a": [ + "<string>", + "<string>" + ] + }, + "links": { + "tempor_0": "<string>", + "ea__93": "<string>" + } + } + /conversations/v3/conversations/actors/{actorId}: + get: + tags: + - Conversations Inbox & Messages API > Conversations + summary: Get a single actor. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: property + in: query + schema: + type: string + example: <string> + - name: actorId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + id: <string> + type: AGENT + name: <string> + email: <string> + avatar: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "eab": [ + "<string>", + "<string>" + ], + "consectetur_29f": [ + "<string>", + "<string>" + ], + "culpa_bd6": [ + "<string>", + "<string>" + ], + "dolore5cd": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "pariatur_57": [ + "<string>", + "<string>" + ], + "consequat_a": [ + "<string>", + "<string>" + ], + "voluptate08b": [ + "<string>", + "<string>" + ], + "idde": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "anim_a": [ + "<string>", + "<string>" + ] + }, + "links": { + "tempor_0": "<string>", + "ea__93": "<string>" + } + } + /conversations/v3/conversations/threads: + get: + tags: + - Conversations Inbox & Messages API > Conversations + summary: Get threads. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: limit + in: query + schema: + type: string + description: The maximum number of results to display per page. + example: <integer> + - name: sort + in: query + schema: + type: string + description: >- + Set the sort order of the response. Valid options are `id` (default) + and `latestMessageTimestamp` (which requires the + `latestMessageTimestampAfter` field to also be set). If you’re + filtering threads by `associatedContactId` , you can sort in + descending order by prepending - to the sort option (e.g., `-id` or + `-latestMessageTimestampAfter` ). Otherwise, results are always + returned in ascending order. + example: <string> + - name: sort + in: query + schema: + type: string + description: >- + Set the sort order of the response. Valid options are `id` (default) + and `latestMessageTimestamp` (which requires the + `latestMessageTimestampAfter` field to also be set). If you’re + filtering threads by `associatedContactId` , you can sort in + descending order by prepending - to the sort option (e.g., `-id` or + `-latestMessageTimestampAfter` ). Otherwise, results are always + returned in ascending order. + example: <string> + - name: inboxId + in: query + schema: + type: string + description: >- + The ID of the conversations inbox you can optionally include to + retrieve the associated messages for. This parameter cannot be used + in conjunction with the `associatedContactId` property. + example: <integer> + - name: inboxId + in: query + schema: + type: string + description: >- + The ID of the conversations inbox you can optionally include to + retrieve the associated messages for. This parameter cannot be used + in conjunction with the `associatedContactId` property. + example: <integer> + - name: associatedContactId + in: query + schema: + type: string + description: >- + The ID of a contact you can optionally include to retrieve a + filtered list of conversations for. This parameter cannot be used in + conjunction with the `inboxId` property. + example: <long> + - name: threadStatus + in: query + schema: + type: string + description: >- + The status of the associated conversations to filter by (either + `OPEN` or `CLOSED`). This property must be provided if you’re + including the `associatedContactId` query parameter. + example: <string> + - name: latestMessageTimestampAfter + in: query + schema: + type: string + description: >- + The minimum `latestMessageTimestamp`. This is required only when + sorting by `latestMessageTimestamp`. + example: <dateTime> + - name: archived + in: query + schema: + type: string + description: Whether to return only results that have been archived. + example: <boolean> + - name: property + in: query + schema: + type: string + example: <string> + - name: association + in: query + schema: + type: string + description: >- + You can specify an association type here of `TICKET`. If this is set + the response will included a thread associations object and + associated ticket id if present. If there are no associations to a + ticket with this conversation, then the thread associations object + will not be present on the response. + example: TICKET + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - associatedContactId: <string> + createdAt: <dateTime> + id: <string> + inboxId: <string> + spam: <boolean> + status: OPEN + closedAt: <dateTime> + latestMessageTimestamp: <dateTime> + latestMessageSentTimestamp: <dateTime> + latestMessageReceivedTimestamp: <dateTime> + assignedTo: <string> + archived: <boolean> + originalChannelAccountId: <string> + originalChannelId: <string> + - associatedContactId: <string> + createdAt: <dateTime> + id: <string> + inboxId: <string> + spam: <boolean> + status: CLOSED + closedAt: <dateTime> + latestMessageTimestamp: <dateTime> + latestMessageSentTimestamp: <dateTime> + latestMessageReceivedTimestamp: <dateTime> + assignedTo: <string> + archived: <boolean> + originalChannelAccountId: <string> + originalChannelId: <string> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "eab": [ + "<string>", + "<string>" + ], + "consectetur_29f": [ + "<string>", + "<string>" + ], + "culpa_bd6": [ + "<string>", + "<string>" + ], + "dolore5cd": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "pariatur_57": [ + "<string>", + "<string>" + ], + "consequat_a": [ + "<string>", + "<string>" + ], + "voluptate08b": [ + "<string>", + "<string>" + ], + "idde": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "anim_a": [ + "<string>", + "<string>" + ] + }, + "links": { + "tempor_0": "<string>", + "ea__93": "<string>" + } + } + /conversations/v3/conversations/channel-accounts/{channelAccountId}: + get: + tags: + - Conversations Inbox & Messages API > Conversations + summary: Get a single channel account. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: boolean + example: 'false' + - name: channelAccountId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + id: <string> + channelId: <string> + name: <string> + inboxId: <string> + active: <boolean> + authorized: <boolean> + createdAt: <dateTime> + deliveryIdentifier: + type: <string> + value: <string> + archived: <boolean> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "eab": [ + "<string>", + "<string>" + ], + "consectetur_29f": [ + "<string>", + "<string>" + ], + "culpa_bd6": [ + "<string>", + "<string>" + ], + "dolore5cd": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "pariatur_57": [ + "<string>", + "<string>" + ], + "consequat_a": [ + "<string>", + "<string>" + ], + "voluptate08b": [ + "<string>", + "<string>" + ], + "idde": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "anim_a": [ + "<string>", + "<string>" + ] + }, + "links": { + "tempor_0": "<string>", + "ea__93": "<string>" + } + } + /conversations/v3/conversations/inboxes/{inboxId}: + get: + tags: + - Conversations Inbox & Messages API > Conversations + summary: Get a single conversations inbox. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: boolean + example: 'false' + - name: inboxId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + id: <string> + name: <string> + createdAt: <dateTime> + updatedAt: <dateTime> + archived: <boolean> + type: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "eab": [ + "<string>", + "<string>" + ], + "consectetur_29f": [ + "<string>", + "<string>" + ], + "culpa_bd6": [ + "<string>", + "<string>" + ], + "dolore5cd": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "pariatur_57": [ + "<string>", + "<string>" + ], + "consequat_a": [ + "<string>", + "<string>" + ], + "voluptate08b": [ + "<string>", + "<string>" + ], + "idde": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "anim_a": [ + "<string>", + "<string>" + ] + }, + "links": { + "tempor_0": "<string>", + "ea__93": "<string>" + } + } + /conversations/v3/visitor-identification/tokens/create: + post: + tags: + - Conversations Visitor Identification API + summary: Generate a token + description: >- + Generates a new visitor identification token. This token will be unique + every time this endpoint is called, even if called with the same email + address. This token is temporary and will expire after 12 hours + requestBody: + content: + application/json: + schema: + type: object + example: + email: <string> + firstName: <string> + lastName: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + token: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "uta1": [ + "<string>", + "<string>" + ], + "ad_59": [ + "<string>", + "<string>" + ] + }, + "links": { + "irure_01d": "<string>", + "id_65": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "amet_e": [ + "<string>", + "<string>" + ], + "et_33e": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "proident_0": [ + "<string>", + "<string>" + ] + } + } + ] + } + /conversations/v3/custom-channels/{channelId}: + get: + tags: + - Custom Channels API > External_Channels + summary: Get a custom channel + description: >- + Retrieve the details about a custom channel. This API allows you to see + a custom channel's current capabilties and other configuration metadata + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: channelId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <integer> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + capabilities: + est_3c4: {} + et07: {} + createdAt: <dateTime> + id: <string> + name: <string> + channelAccountConnectionRedirectUrl: <string> + webhookUrl: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "nostrud84": [ + "<string>", + "<string>" + ], + "eiusmod84": [ + "<string>", + "<string>" + ] + }, + "links": { + "laborea3": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "voluptate_c6c": [ + "<string>", + "<string>" + ], + "do_8b": [ + "<string>", + "<string>" + ], + "culpaf": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "laboris_66": [ + "<string>", + "<string>" + ], + "exercitation_ef2": [ + "<string>", + "<string>" + ] + } + } + ] + } + patch: + tags: + - Custom Channels API > External_Channels + summary: Update a custom channel + description: >- + This endpoint can be used to update a channel's capabilities. You can + also use it to update the channel's webhookUri and its + channelAccountConnectionRedirectUrl. + requestBody: + content: + application/json: + schema: + type: object + example: + capabilities: + nostrud_0_3: {} + laboreb: {} + channelAccountConnectionRedirectUrl: {} + webhookUrl: {} + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: channelId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <integer> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + capabilities: + est_3c4: {} + et07: {} + createdAt: <dateTime> + id: <string> + name: <string> + channelAccountConnectionRedirectUrl: <string> + webhookUrl: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "nostrud84": [ + "<string>", + "<string>" + ], + "eiusmod84": [ + "<string>", + "<string>" + ] + }, + "links": { + "laborea3": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "voluptate_c6c": [ + "<string>", + "<string>" + ], + "do_8b": [ + "<string>", + "<string>" + ], + "culpaf": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "laboris_66": [ + "<string>", + "<string>" + ], + "exercitation_ef2": [ + "<string>", + "<string>" + ] + } + } + ] + } + delete: + tags: + - Custom Channels API + summary: Archive a custom channel + description: Use this API to archive a registered custom channel + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: channelId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <integer> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "magna_062": [ + "<string>", + "<string>" + ], + "cillum821": [ + "<string>", + "<string>" + ] + }, + "links": { + "sintce": "<string>", + "in_38": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "minim7": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "dolor_8": [ + "<string>", + "<string>" + ] + } + } + ] + } + /conversations/v3/custom-channels/: + get: + tags: + - Custom Channels API > External_Channels + summary: Get all channels for app + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: limit + in: query + schema: + type: string + description: The maximum number of results to display per page. + example: <integer> + - name: sort + in: query + schema: + type: string + example: <string> + - name: sort + in: query + schema: + type: string + example: <string> + - name: defaultPageLength + in: query + schema: + type: string + example: <integer> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - capabilities: + officia_f9: {} + ea_b08: {} + createdAt: <dateTime> + id: <string> + name: <string> + channelAccountConnectionRedirectUrl: <string> + webhookUrl: <string> + - capabilities: + esse_e63: {} + createdAt: <dateTime> + id: <string> + name: <string> + channelAccountConnectionRedirectUrl: <string> + webhookUrl: <string> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "nostrud84": [ + "<string>", + "<string>" + ], + "eiusmod84": [ + "<string>", + "<string>" + ] + }, + "links": { + "laborea3": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "voluptate_c6c": [ + "<string>", + "<string>" + ], + "do_8b": [ + "<string>", + "<string>" + ], + "culpaf": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "laboris_66": [ + "<string>", + "<string>" + ], + "exercitation_ef2": [ + "<string>", + "<string>" + ] + } + } + ] + } + post: + tags: + - Custom Channels API > External_Channels + summary: Create a custom channel + description: >- + Register a new channel along with its capabilities and the webhook url + that will be used to receive messages published over the channel + requestBody: + content: + application/json: + schema: + type: object + example: + capabilities: + eaa: {} + dolor_f7e: {} + autee99: {} + name: <string> + channelAccountConnectionRedirectUrl: <string> + webhookUrl: <string> + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + capabilities: + est_3c4: {} + et07: {} + createdAt: <dateTime> + id: <string> + name: <string> + channelAccountConnectionRedirectUrl: <string> + webhookUrl: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "nostrud84": [ + "<string>", + "<string>" + ], + "eiusmod84": [ + "<string>", + "<string>" + ] + }, + "links": { + "laborea3": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "voluptate_c6c": [ + "<string>", + "<string>" + ], + "do_8b": [ + "<string>", + "<string>" + ], + "culpaf": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "laboris_66": [ + "<string>", + "<string>" + ], + "exercitation_ef2": [ + "<string>", + "<string>" + ] + } + } + ] + } + /conversations/v3/custom-channels/{channelId}/messages/{messageId}: + get: + tags: + - Custom Channels API > External_Messages + summary: Get a message + description: >- + Get the PublicConversationsMessage that represents a message sent over a + custom channel + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: channelId + in: path + schema: + type: string + required: true + description: (Required) The channel the message was sent over + example: <integer> + - name: messageId + in: path + schema: + type: string + required: true + description: (Required) The id of the message + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + archived: <boolean> + attachments: + - fileId: <string> + fileUsageType: <string> + type: FILE + name: <string> + url: <string> + - fileId: <string> + fileUsageType: <string> + type: FILE + name: <string> + url: <string> + channelAccountId: <string> + channelId: <string> + client: + clientType: HUBSPOT + integrationAppId: <integer> + conversationsThreadId: <string> + createdAt: <dateTime> + createdBy: <string> + direction: INCOMING + id: <string> + recipients: + - deliveryIdentifier: + type: <string> + value: <string> + actorId: <string> + name: <string> + recipientField: <string> + - deliveryIdentifier: + type: <string> + value: <string> + actorId: <string> + name: <string> + recipientField: <string> + senders: + - actorId: <string> + name: <string> + senderField: <string> + deliveryIdentifier: + type: <string> + value: <string> + - actorId: <string> + name: <string> + senderField: <string> + deliveryIdentifier: + type: <string> + value: <string> + text: <string> + truncationStatus: NOT_TRUNCATED + type: MESSAGE + subject: <string> + richText: <string> + inReplyToId: <string> + updatedAt: <dateTime> + status: + statusType: FAILED + failureDetails: + errorMessageTokens: + pariaturaf4: <string> + essed24: <string> + errorMessage: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "nostrud84": [ + "<string>", + "<string>" + ], + "eiusmod84": [ + "<string>", + "<string>" + ] + }, + "links": { + "laborea3": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "voluptate_c6c": [ + "<string>", + "<string>" + ], + "do_8b": [ + "<string>", + "<string>" + ], + "culpaf": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "laboris_66": [ + "<string>", + "<string>" + ], + "exercitation_ef2": [ + "<string>", + "<string>" + ] + } + } + ] + } + patch: + tags: + - Custom Channels API > External_Messages + summary: 'Update message ' + description: >- + Use this API to update a message's status to indicate if it was + successfully sent, failed to send, or was read + requestBody: + content: + application/json: + schema: + type: object + example: + status: + statusType: FAILED + timestamp: <dateTime> + failureDetails: + errorMessageTokens: + laboris_c76: <string> + ex_4_7: <string> + incididunt5: <string> + type: CHANNEL_SPECIFIC_FAILURE_DETAILS + channelSpecificErrorEnum: <string> + statusType: READ + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: channelId + in: path + schema: + type: string + required: true + description: (Required) The channel the message was sent over + example: <integer> + - name: messageId + in: path + schema: + type: string + required: true + description: (Required) The id of the message + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + archived: <boolean> + attachments: + - fileId: <string> + fileUsageType: <string> + type: FILE + name: <string> + url: <string> + - fileId: <string> + fileUsageType: <string> + type: FILE + name: <string> + url: <string> + channelAccountId: <string> + channelId: <string> + client: + clientType: HUBSPOT + integrationAppId: <integer> + conversationsThreadId: <string> + createdAt: <dateTime> + createdBy: <string> + direction: INCOMING + id: <string> + recipients: + - deliveryIdentifier: + type: <string> + value: <string> + actorId: <string> + name: <string> + recipientField: <string> + - deliveryIdentifier: + type: <string> + value: <string> + actorId: <string> + name: <string> + recipientField: <string> + senders: + - actorId: <string> + name: <string> + senderField: <string> + deliveryIdentifier: + type: <string> + value: <string> + - actorId: <string> + name: <string> + senderField: <string> + deliveryIdentifier: + type: <string> + value: <string> + text: <string> + truncationStatus: NOT_TRUNCATED + type: MESSAGE + subject: <string> + richText: <string> + inReplyToId: <string> + updatedAt: <dateTime> + status: + statusType: FAILED + failureDetails: + errorMessageTokens: + pariaturaf4: <string> + essed24: <string> + errorMessage: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "nostrud84": [ + "<string>", + "<string>" + ], + "eiusmod84": [ + "<string>", + "<string>" + ] + }, + "links": { + "laborea3": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "voluptate_c6c": [ + "<string>", + "<string>" + ], + "do_8b": [ + "<string>", + "<string>" + ], + "culpaf": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "laboris_66": [ + "<string>", + "<string>" + ], + "exercitation_ef2": [ + "<string>", + "<string>" + ] + } + } + ] + } + /conversations/v3/custom-channels/{channelId}/messages: + post: + tags: + - Custom Channels API > External_Messages + summary: Publish a message + description: Publish a message over your custom channel + requestBody: + content: + application/json: + schema: + type: object + example: + attachments: + - fileId: <string> + type: FILE + fileUsageType: <string> + - fileId: <string> + type: FILE + fileUsageType: <string> + channelAccountId: <string> + messageDirection: OUTGOING + recipients: + - deliveryIdentifier: + type: <string> + value: <string> + name: <string> + - deliveryIdentifier: + type: <string> + value: <string> + name: <string> + senders: + - deliveryIdentifier: + type: <string> + value: <string> + name: <string> + - deliveryIdentifier: + type: <string> + value: <string> + name: <string> + text: <string> + timestamp: <dateTime> + integrationThreadId: <string> + integrationIdempotencyId: <string> + richText: <string> + inReplyToId: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: channelId + in: path + schema: + type: string + required: true + description: (Required) The channel the message will be sent over + example: <integer> + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + archived: <boolean> + attachments: + - fileId: <string> + fileUsageType: <string> + type: FILE + name: <string> + url: <string> + - fileId: <string> + fileUsageType: <string> + type: FILE + name: <string> + url: <string> + channelAccountId: <string> + channelId: <string> + client: + clientType: HUBSPOT + integrationAppId: <integer> + conversationsThreadId: <string> + createdAt: <dateTime> + createdBy: <string> + direction: INCOMING + id: <string> + recipients: + - deliveryIdentifier: + type: <string> + value: <string> + actorId: <string> + name: <string> + recipientField: <string> + - deliveryIdentifier: + type: <string> + value: <string> + actorId: <string> + name: <string> + recipientField: <string> + senders: + - actorId: <string> + name: <string> + senderField: <string> + deliveryIdentifier: + type: <string> + value: <string> + - actorId: <string> + name: <string> + senderField: <string> + deliveryIdentifier: + type: <string> + value: <string> + text: <string> + truncationStatus: NOT_TRUNCATED + type: MESSAGE + subject: <string> + richText: <string> + inReplyToId: <string> + updatedAt: <dateTime> + status: + statusType: FAILED + failureDetails: + errorMessageTokens: + pariaturaf4: <string> + essed24: <string> + errorMessage: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "nostrud84": [ + "<string>", + "<string>" + ], + "eiusmod84": [ + "<string>", + "<string>" + ] + }, + "links": { + "laborea3": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "voluptate_c6c": [ + "<string>", + "<string>" + ], + "do_8b": [ + "<string>", + "<string>" + ], + "culpaf": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "laboris_66": [ + "<string>", + "<string>" + ], + "exercitation_ef2": [ + "<string>", + "<string>" + ] + } + } + ] + } + /conversations/v3/custom-channels/{channelId}/channel-accounts: + get: + tags: + - Custom Channels API > External_Channel_Accounts + summary: Query channel accounts + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: deliveryIdentifierType + in: query + schema: + type: string + example: <string> + - name: deliveryIdentifierType + in: query + schema: + type: string + example: <string> + - name: deliveryIdentifierValue + in: query + schema: + type: string + example: <string> + - name: deliveryIdentifierValue + in: query + schema: + type: string + example: <string> + - name: after + in: query + schema: + type: string + example: <string> + - name: limit + in: query + schema: + type: string + example: <integer> + - name: sort + in: query + schema: + type: string + example: <string> + - name: sort + in: query + schema: + type: string + example: <string> + - name: defaultPageLength + in: query + schema: + type: string + example: <integer> + - name: archived + in: query + schema: + type: string + example: <boolean> + - name: channelId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <integer> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - active: <boolean> + archived: <boolean> + authorized: <boolean> + channelId: <string> + createdAt: <dateTime> + id: <string> + inboxId: <string> + name: <string> + archivedAt: <dateTime> + deliveryIdentifier: + type: <string> + value: <string> + - active: <boolean> + archived: <boolean> + authorized: <boolean> + channelId: <string> + createdAt: <dateTime> + id: <string> + inboxId: <string> + name: <string> + archivedAt: <dateTime> + deliveryIdentifier: + type: <string> + value: <string> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "nostrud84": [ + "<string>", + "<string>" + ], + "eiusmod84": [ + "<string>", + "<string>" + ] + }, + "links": { + "laborea3": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "voluptate_c6c": [ + "<string>", + "<string>" + ], + "do_8b": [ + "<string>", + "<string>" + ], + "culpaf": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "laboris_66": [ + "<string>", + "<string>" + ], + "exercitation_ef2": [ + "<string>", + "<string>" + ] + } + } + ] + } + post: + tags: + - Custom Channels API > External_Channel_Accounts + summary: Create a channel account + description: >- + This API allows you to create one or more accounts that all talk over a + single channel but using different delivery identifiers. + requestBody: + content: + application/json: + schema: + type: object + example: + authorized: <boolean> + inboxId: <string> + name: <string> + deliveryIdentifier: + type: <string> + value: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: channelId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <integer> + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + active: <boolean> + archived: <boolean> + authorized: <boolean> + channelId: <string> + createdAt: <dateTime> + id: <string> + inboxId: <string> + name: <string> + archivedAt: <dateTime> + deliveryIdentifier: + type: <string> + value: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "nostrud84": [ + "<string>", + "<string>" + ], + "eiusmod84": [ + "<string>", + "<string>" + ] + }, + "links": { + "laborea3": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "voluptate_c6c": [ + "<string>", + "<string>" + ], + "do_8b": [ + "<string>", + "<string>" + ], + "culpaf": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "laboris_66": [ + "<string>", + "<string>" + ], + "exercitation_ef2": [ + "<string>", + "<string>" + ] + } + } + ] + } + /conversations/v3/custom-channels/{channelId}/channel-accounts/{channelAccountId}: + get: + tags: + - Custom Channels API > External_Channel_Accounts + summary: Get a channel account by id + description: >- + Retrieve a PublicChannelAccount that contains all the metadata about + your channel account. This includes information like its channel, + associated inbox id, and delivery identifier information. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: boolean + example: 'false' + - name: channelId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <integer> + - name: channelAccountId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <long> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + active: <boolean> + archived: <boolean> + authorized: <boolean> + channelId: <string> + createdAt: <dateTime> + id: <string> + inboxId: <string> + name: <string> + archivedAt: <dateTime> + deliveryIdentifier: + type: <string> + value: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "nostrud84": [ + "<string>", + "<string>" + ], + "eiusmod84": [ + "<string>", + "<string>" + ] + }, + "links": { + "laborea3": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "voluptate_c6c": [ + "<string>", + "<string>" + ], + "do_8b": [ + "<string>", + "<string>" + ], + "culpaf": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "laboris_66": [ + "<string>", + "<string>" + ], + "exercitation_ef2": [ + "<string>", + "<string>" + ] + } + } + ] + } + patch: + tags: + - Custom Channels API > External_Channel_Accounts + summary: Update a channel account + description: >- + This API is used to update the name of the channel account and it's + isAuthorized status. Setting to isAuthorized flag to False disables the + channel account. + requestBody: + content: + application/json: + schema: + type: object + example: + authorized: <boolean> + name: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: channelId + in: path + schema: + type: string + required: true + description: (Required) The channel to update + example: <integer> + - name: channelAccountId + in: path + schema: + type: string + required: true + description: (Required) The channel account to update + example: <long> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + active: <boolean> + archived: <boolean> + authorized: <boolean> + channelId: <string> + createdAt: <dateTime> + id: <string> + inboxId: <string> + name: <string> + archivedAt: <dateTime> + deliveryIdentifier: + type: <string> + value: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "nostrud84": [ + "<string>", + "<string>" + ], + "eiusmod84": [ + "<string>", + "<string>" + ] + }, + "links": { + "laborea3": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "voluptate_c6c": [ + "<string>", + "<string>" + ], + "do_8b": [ + "<string>", + "<string>" + ], + "culpaf": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "laboris_66": [ + "<string>", + "<string>" + ], + "exercitation_ef2": [ + "<string>", + "<string>" + ] + } + } + ] + } + /conversations/v3/custom-channels/{channelId}/channel-account-staging-tokens/{accountToken}: + patch: + tags: + - Custom Channels API + summary: Update a channel account staging token + description: >- + This API is used for integrators creating public apps. Use this API to + update a channel account staging token's account name and delivery + identifier. This information will be applied to the channel account + created from this staging token. + requestBody: + content: + application/json: + schema: + type: object + example: + accountName: <string> + deliveryIdentifier: + type: <string> + value: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: channelId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <integer> + - name: accountToken + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + accountToken: <string> + createdAt: <dateTime> + genericChannelId: <integer> + inboxId: <integer> + userId: <integer> + accountName: <string> + deliveryIdentifier: + type: <string> + value: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "nostrud84": [ + "<string>", + "<string>" + ], + "eiusmod84": [ + "<string>", + "<string>" + ] + }, + "links": { + "laborea3": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "voluptate_c6c": [ + "<string>", + "<string>" + ], + "do_8b": [ + "<string>", + "<string>" + ], + "culpaf": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "laboris_66": [ + "<string>", + "<string>" + ], + "exercitation_ef2": [ + "<string>", + "<string>" + ] + } + } + ] + } diff --git a/server/node-service/src/plugins/hubspot/specsV4/Engagements API Collections.json b/server/node-service/src/plugins/hubspot/specsV4/Engagements API Collections.json new file mode 100644 index 000000000..4a733f7bf --- /dev/null +++ b/server/node-service/src/plugins/hubspot/specsV4/Engagements API Collections.json @@ -0,0 +1,16946 @@ +openapi: 3.0.0 +info: + title: Engagements API Collections + description: >- + **Calls API:** Use the calls engagement API to log and manage calls on CRM + records and on the [calls index + page](https://knowledge.hubspot.com/crm-setup/create-customize-and-manage-your-saved-views). + You can log calls either [in + HubSpot](https://knowledge.hubspot.com/contacts/manually-log-a-call-email-or-meeting-on-a-record) + or through the calls API. Below, learn the basic methods of managing calls + through the API. To view all available endpoints and their requirements, + click the Endpoints tab at the top of this article. + + **Email API:** Use the email engagement API to log and manage emails on CRM + records. You can log email activities either [in + HubSpot](https://knowledge.hubspot.com/contacts/manually-log-a-call-email-or-meeting-on-a-record) + or through the emails API. + + + Below, learn the basic methods of managing emails through the API. To view + all available endpoints and their requirements, click the Endpoints tab at + the top of this article. + + **Meetings API:** Use the meetings engagement API to log and manage meetings + on CRM records. You can log meeting activities either [in + HubSpot](https://knowledge.hubspot.com/contacts/manually-log-a-call-email-or-meeting-on-a-record) + or through the meetings API. You can retrieve, update, or delete meeting + engagements that are manually logged on a record, scheduled using the + [meetings tool](https://knowledge.hubspot.com/meetings-tool/use-meetings), + or [scheduled using the Google Calendar or Office 365 calendar + integration](https://knowledge.hubspot.com/integrations/schedule-a-meeting-with-a-contact-in-a-record). + + **Notes API:** You can log notes on CRM records to add information to the + record timeline or associate an attachment with a record. For example, if + you need to keep track of an offline conversation you had with a contact, + you can add a note to their contact record with details and documents + related to the conversation. Other users in the account will then be able to + view and reference that note. + + + You can manage notes either [in + HubSpot](https://knowledge.hubspot.com/contacts/manually-log-a-call-email-or-meeting-on-a-record) + or through the notes API. + + **Postal Mail API:** Use the postal mail engagement API to log and manage + postal mail on CRM records. You can log the mail you've sent or received [in + HubSpot](https://knowledge.hubspot.com/contacts/manually-log-a-call-email-or-meeting-on-a-record) + or through the postal mail API. You can also retrieve, update, or delete + existing postal mail engagements. + + **Tasks API:** Use the tasks API to create and manage tasks. You can create + tasks [in + HubSpot](https://knowledge.hubspot.com/contacts/manually-log-a-call-email-or-meeting-on-a-record) + or via the tasks API. + + **Communications API:** You can log external communications via WhatsApp, + LinkedIn, or SMS messages on CRM records to add information about the + message to the record timeline. + + + **Fork the collections using Run in Postman:** + + + [<img src="https://run.pstmn.io/button.svg" alt="Run In + Postman">](https://app.getpostman.com/run-collection/26126890-393a8ae3-f0b7-4554-9343-4b2360e63e45?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D26126890-393a8ae3-f0b7-4554-9343-4b2360e63e45%26entityType%3Dcollection%26workspaceId%3Dd7645f33-539d-49c6-9e0c-efa6faae355d) + version: 1.0.0 +servers: + - url: http://{{baseurl}} +components: + securitySchemes: + oauth2Auth: + type: http + scheme: oauth2 +tags: + - name: Calls API + description: "Use the calls engagement API to log and manage calls on CRM records and on the\_[calls index page](https://knowledge.hubspot.com/crm-setup/create-customize-and-manage-your-saved-views). You can log calls either\_[in HubSpot](https://knowledge.hubspot.com/contacts/manually-log-a-call-email-or-meeting-on-a-record)\_or through the calls API. Below, learn the basic methods of managing calls through the API. To view all available endpoints and their requirements, click the\_Endpoints\_tab at the top of this article.\n\n## Create a call engagement\n\nTo create a call engagement, make a\_`POST`\_request to\_`/crm/v3/objects/calls`.\n\nIn the request body, add call details in a\_properties\_object. You can also add an\_associations\_object to associate your new call with an existing record (e.g.,contacts, companies).\n\n### Properties\n\nBelow is a list of HubSpot default calling properties that you can include in the properties object. You can also create custom properties using the\_[properties API](https://developers.hubspot.com/beta-docs/guides/api/crm/properties).\_\n\nUse this table to describe parameters / fields\n\n| FIELD | DESCRIPTION |\n| --- | --- |\n| `hs_timestamp` | Required. This field marks\_the call's time of creation and determines where the call sits on the record timeline. You can use either a Unix timestamp in milliseconds or UTC format. |\n| `hs_call_body` | The description of the call, including any notes that you want to add. |\n| `hs_call_callee_object_id` | The ID of the HubSpot record associated with the call. This will be the recipient of the call for\_`OUTBOUND`\_calls, or the dialer of the call for\_`INBOUND`\_calls. |\n| `hs_call_callee_object_type_id` | The ID of the object to which the call's associated record belongs (e.g., specifies if the record is a contact or company). This will be the object of the recipient for\_`OUTBOUND`\_calls, or the object of the dialer for\_`INBOUND`\_calls. |\n| `hs_call_direction` | The direction of the call from the perspective of the HubSpot user. If the user is the call recipient, the direction should be set to\_`INBOUND`. If the user initiated the call, the direction should be set to\_`OUTBOUND`. |\n| `hs_call_disposition` | The outcome of the call. To set the call disposition, you need to use the internal GUID value. If your account has set up\_[custom call outcomes](https://knowledge.hubspot.com/calling/create-custom-call-and-meeting-outcomes), you can find their disposition GUIDs using\_[this API](https://legacydocs.hubspot.com/docs/methods/engagements/get-call-dispositions). The default HubSpot outcome labels and their internal values are:<br><br>- Busy:\_`9d9162e7-6cf3-4944-bf63-4dff82258764`<br> <br>- Connected:\_`f240bbac-87c9-4f6e-bf70-924b57d47db7`<br> <br>- Left live message:\_`a4c4c377-d246-4b32-a13b-75a56a4cd0ff`<br> <br>- Left voicemail:\_`b2cf5968-551e-4856-9783-52b3da59a7d0`<br> <br>- No answer:\_`73a0d17f-1163-4015-bdd5-ec830791da20`<br> <br>- Wrong number:\_`17b47fee-58de-441e-a44c-c6300d46f273` |\n| `hs_call_duration` | The duration of the call in milliseconds. |\n| `hs_call_from_number` | The phone number that the call was made from. |\n| `hs_call_recording_url` | The URL that stores the call recording. URLS to .mp3 or .wav files can be played back on CRM records. Only HTTPS,\_ secure URLs will be accepted. |\n| `hs_call_status` | The status of the call. The statuses are\_`BUSY`,\_`CALLING_CRM_USER`,\_`CANCELED`,\_`COMPLETED`,\_`CONNECTING`,\_`FAILED`,\_`IN_PROGRESS`,\_`NO_ANSWER`,\_`QUEUED`, and\_`RINGING`. |\n| `hs_call_title` | The title of the call. |\n| `hs_call_source` | The source of the call. This is not required, but it is required to leverage the\_[recording and transcriptions pipeline](https://developers.hubspot.com/docs/api/crm/extensions/recordings-and-transcriptions#log-a-call-with-your-app-s-endpoint-using-the-engagements-api). If the property is set, it must be set to\_`INTEGRATIONS_PLATFORM`. |\n| `hs_call_to_number` | The phone number that received the call. |\n| `hubspot_owner_id` | The\_[ID of the owner](https://developers.hubspot.com/docs/api/crm/owners)\_associated with the call. This field determines the user listed as the call creator on the record timeline. |\n| `hs_activity_type` | The type of call. The options are based on the\_[call types set in your HubSpot account.](https://knowledge.hubspot.com/meetings-tool/how-do-i-create-and-use-call-and-meeting-types) |\n| `hs_attachment_ids` | The IDs of the call's attachments. Multiple attachment IDs are separated by a semi-colon. |" + - name: Calls API > Batch + - name: Calls API > Basic + - name: Calls API > Public_Object + - name: Calls API > GDPR + - name: Calls API > Search + - name: Email API + description: "Use the email engagement API to log and manage emails on CRM records. You can log email activities either\_[in HubSpot](https://knowledge.hubspot.com/contacts/manually-log-a-call-email-or-meeting-on-a-record)\_or through the emails API.\_\n\nBelow, learn the basic methods of managing emails through the API. To view all available endpoints and their requirements, click the\_Endpoints\_tab at the top of this article.\n\n## Create an email\n\nTo create an email engagement, make a\_`POST`\_request to\_`/crm/v3/objects/emails`.\n\nIn the request body, add email details in a\_properties\_object. You can also add an\_associations\_object to associate your new email with an existing record (e.g., contacts, companies).\n\n### Properties\n\nIn the properties object, you can include the following fields:\n\nUse this table to describe parameters / fields\n\n| FIELD | DESCRIPTION |\n| --- | --- |\n| `hs_timestamp` | Required. This field marks\_the email's time of creation and determines where the email sits on the record timeline. You can use either a Unix timestamp in milliseconds or UTC format. |\n| `hubspot_owner_id` | The\_[ID of the owner](https://developers.hubspot.com/docs/api/crm/owners)\_associated with the email. This field determines the user listed as the email creator on the record timeline. |\n| `hs_email_direction` | The direction the email was sent in. Possible values include:<br><br>`EMAIL`: the email was sent from the CRM or sent and logged to the CRM with the\_[BCC address.](https://knowledge.hubspot.com/settings/log-email-in-your-crm-with-the-bcc-or-forwarding-address)<br><br>`INCOMING_EMAIL`: the email was a reply to a logged outgoing email.\_`FORWARDED_EMAIL`: the email was\_[forwarded to the CRM.](https://knowledge.hubspot.com/settings/log-email-in-your-crm-with-the-bcc-or-forwarding-address) |\n| `hs_email_html` | The body of an email if it is sent from a CRM record. |\n| `hs_email_status` | The send status of the email. The value can be\_`BOUNCED`,\_`FAILED`,\_`SCHEDULED`,\_`SENDING`, or\_`SENT`. |\n| `hs_email_subject` | The subject line of the logged email. |\n| `hs_email_text` | The body of the email. |\n| `hs_attachment_ids` | The IDs of the email's attachments. Multiple attachment IDs are separated by a semi-colon. |\n| `hs_email_headers` | The email's headers. The value for this property will automatically populate certain read only email properties. Learn how to\_[set email headers.](https://developers.hubspot.com/docs/api/crm/email#set-email-headers) |" + - name: Email API > Batch + - name: Email API > Basic + - name: Email API > Public_Object + - name: Email API > GDPR + - name: Email API > Search + - name: Meetings API + description: "Use the meetings engagement API to log and manage meetings on CRM records. You can log meeting activities either\_[in HubSpot](https://knowledge.hubspot.com/contacts/manually-log-a-call-email-or-meeting-on-a-record)\_or through the meetings API. You can retrieve, update, or delete meeting engagements that are manually logged on a record, scheduled using the\_[meetings tool](https://knowledge.hubspot.com/meetings-tool/use-meetings), or\_[scheduled using the Google Calendar or Office 365 calendar integration](https://knowledge.hubspot.com/integrations/schedule-a-meeting-with-a-contact-in-a-record).\n\nBelow, learn the basic methods of managing meetings through the API. To view all available endpoints and their requirements, click the\_Endpoints\_tab at the top of this article.\n\n## Create a meeting\n\nTo create a meeting engagement, make a\_`POST`\_request to\_`/crm/v3/objects/meetings`.\n\nIn the request body, add meeting details in a\_properties\_object. You can also add an\_associations\_object to associate your new meeting with an existing record (e.g., contacts, companies).\n\n### Properties\n\nIn the properties object, you can include the following fields:\n\nUse this table to describe parameters / fields\n\n| FIELD | DESCRIPTION |\n| --- | --- |\n| `hs_timestamp` | Required. This field marks\_the date and time that the meeting occurred. You can use either a Unix timestamp in milliseconds or UTC format.<br><br>(BETA) When the property value\_is missing, the value will\_ default to\_`hs_meeting_start_time.` |\n| `hs_meeting_title` | The title of the meeting. |\n| `hubspot_owner_id` | The\_[ID of the owner](https://developers.hubspot.com/docs/api/crm/owners)\_associated with the meeting. This field determines the user listed as the meeting creator on the record timeline. |\n| `hs_meeting_body` | The meeting description. |\n| `hs_internal_meeting_notes` | The internal notes you take for your team during a meeting that are not included in the attendee meeting description. |\n| `hs_meeting_external_URL` | The external URL for the calendar event. For example, this could be a Google calendar link or a Microsoft Outlook calendar link. |\n| `hs_meeting_location` | Where the meeting takes place. The value\_could be a physical address, a conference room, a videoconference link, or a phone number. This appears on the calendar invite on the attendee's calendar. |\n| `hs_meeting_start_time` | The date and time when the meeting starts. The value for this property should match the value for\_`hs_timestamp`. |\n| `hs_meeting_end_time` | The date and time when the meeting ends. |\n| `hs_meeting_outcome` | The outcome of the meeting. The outcome values are scheduled, completed, rescheduled, no show, and canceled. |\n| `hs_activity_type` | The type of meeting. The options are based on the\_[meeting types set in your HubSpot account.](https://knowledge.hubspot.com/meetings-tool/how-do-i-create-and-use-call-and-meeting-types) |\n| `hs_attachment_ids` | The IDs of the meeting's attachments. Multiple attachment IDs are separated by a semi-colon. |" + - name: Meetings API > Batch + - name: Meetings API > Basic + - name: Meetings API > Public_Object + - name: Meetings API > GDPR + - name: Meetings API > Search + - name: Notes API + description: "You can log notes on CRM records to add information to the record timeline or associate an attachment with a record. For example, if you need to keep track of an offline conversation you had with a contact, you can add a note to their contact record with details and documents related to the conversation. Other users in the account will then be able to view and reference that note.\n\nYou can manage notes either\_[in HubSpot](https://knowledge.hubspot.com/contacts/manually-log-a-call-email-or-meeting-on-a-record)\_or through the notes API. Below, learn the basic methods of managing notes through the API. You can review all available endpoints on the\__Endpoints_\_tab at the top of this article.\n\n## Create a note\n\nTo create a note, make a\_`POST`\_request to\_`/crm/v3/objects/notes`.\n\nIn the request body, add note details in a\_properties\_object. You can also add an\_associations\_object to associate your new note with an existing record (e.g., contacts, companies).\n\n### Properties\n\nIn the properties object, you can include the following fields:\n\nUse this table to describe parameters / fields\n\n| FIELD | DESCRIPTION |\n| --- | --- |\n| `hs_timestamp` | Required. This field marks\_the note's time of creation and determines where the note sits on the record timeline. You can use either a Unix timestamp in milliseconds or UTC format. |\n| `hs_note_body` | The note's text content, limited to 65,536 characters. |\n| `hubspot_owner_id` | The\_[ID of the owner](https://developers.hubspot.com/docs/api/crm/owners)\_associated with the note. This field determines the user listed as the note creator on the record timeline in HubSpot. |\n| `hs_attachment_ids` | The IDs of the note's attachments. Multiple attachment IDs are separated by a semi-colon. |" + - name: Notes API > Batch + - name: Notes API > Basic + - name: Notes API > Public_Object + - name: Notes API > GDPR + - name: Notes API > Search + - name: Postal Mail API + description: "Use the postal mail engagement API to log and manage postal mail on CRM records. You can log the mail you've sent or received\_[in HubSpot](https://knowledge.hubspot.com/contacts/manually-log-a-call-email-or-meeting-on-a-record)\_or through the postal mail API. You can also retrieve, update, or delete existing postal mail engagements.\_\n\nBelow, learn the basic methods of managing postal mail through the API. To view all available endpoints and their requirements, click the\_Endpoints\_tab at the top of this article.\n\n## Create a postal mail engagement\n\nTo create a postal mail engagement, make a\_`POST`\_request to\_`/crm/v3/objects/postal_mail`.\n\nIn the request body, add postal mail details in a\_properties\_object. You can also add an\_associations\_object to associate your new postal mail with an existing record (e.g., contacts, companies).\n\n### Properties\n\nIn the properties object, you can include the following fields:\n\nUse this table to describe parameters / fields\n\n| FIELD | DESCRIPTION |\n| --- | --- |\n| `hs_timestamp` | The date that the postal mail was sent or received. |\n| `hs_postal_mail_body` | The body text of the postal mail engagement. |\n| `hubspot_owner_id` | The ID of the user that created the postal mail engagement. |\n| `hs_attachment_ids` | The IDs of any attachments to the postal mail engagement. Multiple attachment IDs are separated by a semi-colon. |" + - name: Postal Mail API > Batch + - name: Postal Mail API > Basic + - name: Postal Mail API > Public_Object + - name: Postal Mail API > GDPR + - name: Postal Mail API > Search + - name: Tasks API + description: "Use the tasks API to create and manage tasks. You can create tasks\_[in HubSpot](https://knowledge.hubspot.com/contacts/manually-log-a-call-email-or-meeting-on-a-record)\_or via the tasks API.\_\n\nBelow, learn the basic methods of managing tasks through the API. To view all available endpoints and their requirements, click the\_Endpoints\_tab at the top of this article.\n\n## Create a task\n\nTo create a task, make a\_`POST`\_request to\_`/crm/v3/objects/tasks`.\n\nIn the request body, add task details in a\_properties\_object. You can also add an\_associations\_object to associate your new task with an existing record (e.g., contacts, companies).\n\n### Properties\n\nIn the properties object, you can include the following fields:\n\nUse this table to describe parameters / fields\n\n| FIELD | DESCRIPTION |\n| --- | --- |\n| `hs_timestamp` | Required. This field marks\_the task's due date. You can use either a Unix timestamp in milliseconds or UTC format. |\n| `hs_task_body` | The task\_[ notes.](https://knowledge.hubspot.com/tasks/create-tasks#task-details) |\n| `hubspot_owner_id` | The\_[ owner ID ](https://developers.hubspot.com/docs/api/crm/owners)\_of the user assigned to the task. |\n| `hs_task_subject` | The title of the task. |\n| `hs_task_status` | The status of the task, either\_`COMPLETED`\_or\_`NOT_STARTED`. |\n| `hs_task_priority` | The priority of the task. Values include\_`LOW`,\_`MEDIUM`, or\_`HIGH`. |\n| `hs_task_type` | The type of task. Values include\_`EMAIL`,\_`CALL`, or\_`TODO`. |\n| `hs_task_reminders` | The timestamp for when to send a reminder for the due date of the task.\_You must use Unix timestamp in milliseconds. |" + - name: Tasks API > Batch + - name: Tasks API > Basic + - name: Tasks API > Public_Object + - name: Tasks API > GDPR + - name: Tasks API > Search + - name: Communications API + description: "You can log external communications via WhatsApp, LinkedIn, or SMS messages on CRM records to add information about the message to the record timeline.\_\n\nYou can\_[log a message directly in your HubSpot account](https://knowledge.hubspot.com/contacts/manually-log-a-call-email-or-meeting-on-a-record)\_or using the API endpoints below. You can review all available endpoints on the\__**Endpoints**_\_tab at the top of this article.\n\n**Please note**: the Communications API does not apply to marketing SMS messages. Learn how to create and view\_[marketing SMS messages in HubSpot](https://knowledge.hubspot.com/sms/create-and-send-sms-messages).\n\n## Create a WhatsApp, LinkedIn, or SMS message\n\nTo create a message, make a\_`POST`\_request to\_`/crm/v3/objects/communications`.\n\nIn the request body, add message details in a\_properties\_object. You can also add an\_associations\_object to associate your new message with an existing record (e.g., contacts, companies).\n\n### Properties\n\nIn the properties object, you can include the following fields:\n\n| FIELD | DESCRIPTION |\n| --- | --- |\n| `hs_communication_channel_type` | The channel type of the message that you sent or received from the contact. Supported values are\_`WHATS_APP`,\_`LINKEDIN_MESSAGE`, or\_`SMS`. |\n| `hs_communication_logged_from` | Enum used to differentiate between conversations objects. This\_must\_be set to\_`CRM`\_in your request. |\n| `hs_communication_body` | The text body of the engagement. |\n| `hs_timestamp` | This field marks the message's time of creation and determines where the message appears on the record timeline. You can use either a Unix timestamp in milliseconds or UTC format. |" + - name: Communications API > Batch + - name: Communications API > Basic + - name: Communications API > Public_Object + - name: Communications API > GDPR + - name: Communications API > Search +paths: + /crm/v3/objects/calls/batch/create: + post: + tags: + - Calls API > Batch + summary: Create a batch of calls + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - associations: + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + properties: + enim_6: <string> + - associations: + - to: + id: <string> + types: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + properties: + mollit_a71: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + occaecat30_: <string> + aute_418: <string> + updatedAt: <dateTime> + propertiesWithHistory: + incf5: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + fugiat_42b: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + sit27: <string> + updatedAt: <dateTime> + propertiesWithHistory: + proident_342: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + id_42: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + consecteturec: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PENDING + requestedAt: <dateTime> + links: + nostrude: <string> + in_d8: <string> + labore_c68: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + officia_7: <string> + dolore_3: <string> + updatedAt: <dateTime> + propertiesWithHistory: + aliqua_799: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + magna_b: <string> + in_50: <string> + cillumd6: <string> + sunt_c: <string> + updatedAt: <dateTime> + propertiesWithHistory: + dolorb7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PROCESSING + numErrors: <integer> + errors: + - category: <string> + context: + in_76f: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + sit_a1: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + laboris_75: + - <string> + - <string> + amet_54: + - <string> + - <string> + dolor_cfe: + - <string> + - <string> + links: + qui_ed0: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + dob9: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + irure300: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + enim_13: + - <string> + - <string> + elit_d: + - <string> + - <string> + links: + dolore07: <string> + in_af: <string> + exc: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + elit_b_: <string> + fugiat_8_9: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "dolore_4": [ + "<string>", + "<string>" + ], + "id__21": [ + "<string>", + "<string>" + ], + "nisi_1a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "fugiat_97c": [ + "<string>", + "<string>" + ], + "ex_c": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "aliquipa96": [ + "<string>", + "<string>" + ], + "cillum_c": [ + "<string>", + "<string>" + ], + "magna_9c": [ + "<string>", + "<string>" + ], + "mollit_f_": [ + "<string>", + "<string>" + ], + "in_9_2": [ + "<string>", + "<string>" + ] + }, + "links": { + "laboris_adf": "<string>", + "ut_01": "<string>" + } + } + /crm/v3/objects/calls/batch/read: + post: + tags: + - Calls API > Batch + summary: Read a batch of calls by internal ID, or unique property values + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + properties: + - <string> + - <string> + propertiesWithHistory: + - <string> + - <string> + idProperty: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + occaecat30_: <string> + aute_418: <string> + updatedAt: <dateTime> + propertiesWithHistory: + incf5: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + fugiat_42b: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + sit27: <string> + updatedAt: <dateTime> + propertiesWithHistory: + proident_342: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + id_42: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + consecteturec: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PENDING + requestedAt: <dateTime> + links: + nostrude: <string> + in_d8: <string> + labore_c68: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + officia_7: <string> + dolore_3: <string> + updatedAt: <dateTime> + propertiesWithHistory: + aliqua_799: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + magna_b: <string> + in_50: <string> + cillumd6: <string> + sunt_c: <string> + updatedAt: <dateTime> + propertiesWithHistory: + dolorb7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PROCESSING + numErrors: <integer> + errors: + - category: <string> + context: + in_76f: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + sit_a1: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + laboris_75: + - <string> + - <string> + amet_54: + - <string> + - <string> + dolor_cfe: + - <string> + - <string> + links: + qui_ed0: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + dob9: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + irure300: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + enim_13: + - <string> + - <string> + elit_d: + - <string> + - <string> + links: + dolore07: <string> + in_af: <string> + exc: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + elit_b_: <string> + fugiat_8_9: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "dolore_4": [ + "<string>", + "<string>" + ], + "id__21": [ + "<string>", + "<string>" + ], + "nisi_1a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "fugiat_97c": [ + "<string>", + "<string>" + ], + "ex_c": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "aliquipa96": [ + "<string>", + "<string>" + ], + "cillum_c": [ + "<string>", + "<string>" + ], + "magna_9c": [ + "<string>", + "<string>" + ], + "mollit_f_": [ + "<string>", + "<string>" + ], + "in_9_2": [ + "<string>", + "<string>" + ] + }, + "links": { + "laboris_adf": "<string>", + "ut_01": "<string>" + } + } + /crm/v3/objects/calls/batch/update: + post: + tags: + - Calls API > Batch + summary: Update a batch of calls by internal ID, or unique property values + requestBody: + content: {} + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + occaecat30_: <string> + aute_418: <string> + updatedAt: <dateTime> + propertiesWithHistory: + incf5: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + fugiat_42b: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + sit27: <string> + updatedAt: <dateTime> + propertiesWithHistory: + proident_342: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + id_42: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + consecteturec: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PENDING + requestedAt: <dateTime> + links: + nostrude: <string> + in_d8: <string> + labore_c68: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + officia_7: <string> + dolore_3: <string> + updatedAt: <dateTime> + propertiesWithHistory: + aliqua_799: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + magna_b: <string> + in_50: <string> + cillumd6: <string> + sunt_c: <string> + updatedAt: <dateTime> + propertiesWithHistory: + dolorb7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PROCESSING + numErrors: <integer> + errors: + - category: <string> + context: + in_76f: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + sit_a1: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + laboris_75: + - <string> + - <string> + amet_54: + - <string> + - <string> + dolor_cfe: + - <string> + - <string> + links: + qui_ed0: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + dob9: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + irure300: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + enim_13: + - <string> + - <string> + elit_d: + - <string> + - <string> + links: + dolore07: <string> + in_af: <string> + exc: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + elit_b_: <string> + fugiat_8_9: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "dolore_4": [ + "<string>", + "<string>" + ], + "id__21": [ + "<string>", + "<string>" + ], + "nisi_1a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "fugiat_97c": [ + "<string>", + "<string>" + ], + "ex_c": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "aliquipa96": [ + "<string>", + "<string>" + ], + "cillum_c": [ + "<string>", + "<string>" + ], + "magna_9c": [ + "<string>", + "<string>" + ], + "mollit_f_": [ + "<string>", + "<string>" + ], + "in_9_2": [ + "<string>", + "<string>" + ] + }, + "links": { + "laboris_adf": "<string>", + "ut_01": "<string>" + } + } + /crm/v3/objects/calls/batch/archive: + post: + tags: + - Calls API > Batch + summary: Archive a batch of calls by ID + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "dolore_4": [ + "<string>", + "<string>" + ], + "id__21": [ + "<string>", + "<string>" + ], + "nisi_1a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "fugiat_97c": [ + "<string>", + "<string>" + ], + "ex_c": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "aliquipa96": [ + "<string>", + "<string>" + ], + "cillum_c": [ + "<string>", + "<string>" + ], + "magna_9c": [ + "<string>", + "<string>" + ], + "mollit_f_": [ + "<string>", + "<string>" + ], + "in_9_2": [ + "<string>", + "<string>" + ] + }, + "links": { + "laboris_adf": "<string>", + "ut_01": "<string>" + } + } + /crm/v3/objects/calls: + get: + tags: + - Calls API > Basic + summary: List + description: >- + Read a page of calls. Control what is returned via the `properties` + query param. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: limit + in: query + schema: + type: integer + description: The maximum number of results to display per page. + example: '10' + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + ead: <string> + commodo_c: <string> + updatedAt: <dateTime> + propertiesWithHistory: + Duis_6e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + consequat_e6: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + ex6: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + proident541: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + - createdAt: <dateTime> + id: <string> + properties: + exercitation248: <string> + sinta05: <string> + updatedAt: <dateTime> + propertiesWithHistory: + dolore_a: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + anim2bf: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + Lorem_b: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + cupidatat_8ed: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + in_c57: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + consequat_b: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "dolore_4": [ + "<string>", + "<string>" + ], + "id__21": [ + "<string>", + "<string>" + ], + "nisi_1a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "fugiat_97c": [ + "<string>", + "<string>" + ], + "ex_c": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "aliquipa96": [ + "<string>", + "<string>" + ], + "cillum_c": [ + "<string>", + "<string>" + ], + "magna_9c": [ + "<string>", + "<string>" + ], + "mollit_f_": [ + "<string>", + "<string>" + ], + "in_9_2": [ + "<string>", + "<string>" + ] + }, + "links": { + "laboris_adf": "<string>", + "ut_01": "<string>" + } + } + post: + tags: + - Calls API > Basic + summary: Create + description: >- + Create a call with the given properties and return a copy of the object, + including the ID. Documentation and examples for creating standard calls + is provided. + requestBody: + content: + application/json: + schema: + type: object + example: + associations: + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + properties: + elit_0f: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + in05b: <string> + adipisicing5d: <string> + updatedAt: <dateTime> + propertiesWithHistory: + sunt_48f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "dolore_4": [ + "<string>", + "<string>" + ], + "id__21": [ + "<string>", + "<string>" + ], + "nisi_1a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "fugiat_97c": [ + "<string>", + "<string>" + ], + "ex_c": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "aliquipa96": [ + "<string>", + "<string>" + ], + "cillum_c": [ + "<string>", + "<string>" + ], + "magna_9c": [ + "<string>", + "<string>" + ], + "mollit_f_": [ + "<string>", + "<string>" + ], + "in_9_2": [ + "<string>", + "<string>" + ] + }, + "links": { + "laboris_adf": "<string>", + "ut_01": "<string>" + } + } + /crm/v3/objects/calls/{callId}: + get: + tags: + - Calls API > Basic + summary: Read + description: >- + Read an Object identified by `{callId}`. `{callId}` refers to the + internal object ID by default, or optionally any unique property value + as specified by the `idProperty` query param. Control what is returned + via the `properties` query param. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: callId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + dolor_2: <string> + et0: <string> + updatedAt: <dateTime> + propertiesWithHistory: + incididunt_8cd: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + Duis_027: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "dolore_4": [ + "<string>", + "<string>" + ], + "id__21": [ + "<string>", + "<string>" + ], + "nisi_1a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "fugiat_97c": [ + "<string>", + "<string>" + ], + "ex_c": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "aliquipa96": [ + "<string>", + "<string>" + ], + "cillum_c": [ + "<string>", + "<string>" + ], + "magna_9c": [ + "<string>", + "<string>" + ], + "mollit_f_": [ + "<string>", + "<string>" + ], + "in_9_2": [ + "<string>", + "<string>" + ] + }, + "links": { + "laboris_adf": "<string>", + "ut_01": "<string>" + } + } + delete: + tags: + - Calls API > Basic + summary: Archive + description: Move an Object identified by `{callId}` to the recycling bin. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: callId + in: path + schema: + type: string + required: true + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "dolore_4": [ + "<string>", + "<string>" + ], + "id__21": [ + "<string>", + "<string>" + ], + "nisi_1a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "fugiat_97c": [ + "<string>", + "<string>" + ], + "ex_c": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "aliquipa96": [ + "<string>", + "<string>" + ], + "cillum_c": [ + "<string>", + "<string>" + ], + "magna_9c": [ + "<string>", + "<string>" + ], + "mollit_f_": [ + "<string>", + "<string>" + ], + "in_9_2": [ + "<string>", + "<string>" + ] + }, + "links": { + "laboris_adf": "<string>", + "ut_01": "<string>" + } + } + patch: + tags: + - Calls API > Basic + summary: Update + description: >- + Perform a partial update of an Object identified by `{callId}`. + `{callId}` refers to the internal object ID by default, or optionally + any unique property value as specified by the `idProperty` query param. + Provided property values will be overwritten. Read-only and non-existent + properties will be ignored. Properties values can be cleared by passing + an empty string. + requestBody: + content: + application/json: + schema: + type: object + example: + properties: + incididunt_a: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: callId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + in05b: <string> + adipisicing5d: <string> + updatedAt: <dateTime> + propertiesWithHistory: + sunt_48f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "dolore_4": [ + "<string>", + "<string>" + ], + "id__21": [ + "<string>", + "<string>" + ], + "nisi_1a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "fugiat_97c": [ + "<string>", + "<string>" + ], + "ex_c": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "aliquipa96": [ + "<string>", + "<string>" + ], + "cillum_c": [ + "<string>", + "<string>" + ], + "magna_9c": [ + "<string>", + "<string>" + ], + "mollit_f_": [ + "<string>", + "<string>" + ], + "in_9_2": [ + "<string>", + "<string>" + ] + }, + "links": { + "laboris_adf": "<string>", + "ut_01": "<string>" + } + } + /crm/v3/objects/calls/search: + post: + tags: + - Calls API > Search + summary: post-/crm/v3/objects/calls/search do Search + requestBody: + content: {} + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + ullamco_c: <string> + ad4e: <string> + esse_a: <string> + updatedAt: <dateTime> + propertiesWithHistory: + Excepteur072: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + cillum_2: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + nisi_94f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + pariaturd5: <string> + dolor9cc: <string> + consectetur_e7b: <string> + magnaca5: <string> + updatedAt: <dateTime> + propertiesWithHistory: + mollit1: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + Utad: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "dolore_4": [ + "<string>", + "<string>" + ], + "id__21": [ + "<string>", + "<string>" + ], + "nisi_1a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "fugiat_97c": [ + "<string>", + "<string>" + ], + "ex_c": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "aliquipa96": [ + "<string>", + "<string>" + ], + "cillum_c": [ + "<string>", + "<string>" + ], + "magna_9c": [ + "<string>", + "<string>" + ], + "mollit_f_": [ + "<string>", + "<string>" + ], + "in_9_2": [ + "<string>", + "<string>" + ] + }, + "links": { + "laboris_adf": "<string>", + "ut_01": "<string>" + } + } + /crm/v3/objects/emails/batch/create: + post: + tags: + - Email API > Batch + summary: Create a batch of emails + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - associations: + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + properties: + ad_2: <string> + consequatcca: <string> + - associations: + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + properties: + Lorem__8: <string> + veniam_2: <string> + tempor15: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + eua6_: <string> + id_af5: <string> + updatedAt: <dateTime> + propertiesWithHistory: + id_cdc: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + sit_6e: <string> + updatedAt: <dateTime> + propertiesWithHistory: + et3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + consectetur0: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: COMPLETE + requestedAt: <dateTime> + links: + ex_1: <string> + laborum_2_: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + magnab: <string> + mollit_a: <string> + quisc: <string> + updatedAt: <dateTime> + propertiesWithHistory: + quisdb: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + deserunt_9: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + officia3dc: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + magna_357: <string> + updatedAt: <dateTime> + propertiesWithHistory: + consectetur_0: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + non_c8e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + culpa_2fa: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PENDING + numErrors: <integer> + errors: + - category: <string> + context: + eu5f_: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + aliqua_02: + - <string> + - <string> + nostrud_8: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + quis_652: + - <string> + - <string> + links: + consectetur_cd0: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + irure1f: + - <string> + - <string> + laborum954: + - <string> + - <string> + sint_e: + - <string> + - <string> + nulla81: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + fugiat_6: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + ametb: + - <string> + - <string> + eab81: + - <string> + - <string> + links: + ullamco_1: <string> + sed_e3: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + dolore_39f: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "aute_72": [ + "<string>", + "<string>" + ], + "eae": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "anim_b": [ + "<string>", + "<string>" + ], + "inf57": [ + "<string>", + "<string>" + ], + "sunt_12": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "cillum_f": [ + "<string>", + "<string>" + ], + "aliqua88": [ + "<string>", + "<string>" + ], + "mollit783": [ + "<string>", + "<string>" + ] + }, + "links": { + "est1": "<string>", + "anim_bb": "<string>" + } + } + /crm/v3/objects/emails/batch/read: + post: + tags: + - Email API > Batch + summary: Read a batch of emails by internal ID, or unique property values + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + properties: + - <string> + - <string> + propertiesWithHistory: + - <string> + - <string> + idProperty: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + eua6_: <string> + id_af5: <string> + updatedAt: <dateTime> + propertiesWithHistory: + id_cdc: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + sit_6e: <string> + updatedAt: <dateTime> + propertiesWithHistory: + et3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + consectetur0: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: COMPLETE + requestedAt: <dateTime> + links: + ex_1: <string> + laborum_2_: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + magnab: <string> + mollit_a: <string> + quisc: <string> + updatedAt: <dateTime> + propertiesWithHistory: + quisdb: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + deserunt_9: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + officia3dc: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + magna_357: <string> + updatedAt: <dateTime> + propertiesWithHistory: + consectetur_0: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + non_c8e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + culpa_2fa: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PENDING + numErrors: <integer> + errors: + - category: <string> + context: + eu5f_: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + aliqua_02: + - <string> + - <string> + nostrud_8: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + quis_652: + - <string> + - <string> + links: + consectetur_cd0: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + irure1f: + - <string> + - <string> + laborum954: + - <string> + - <string> + sint_e: + - <string> + - <string> + nulla81: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + fugiat_6: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + ametb: + - <string> + - <string> + eab81: + - <string> + - <string> + links: + ullamco_1: <string> + sed_e3: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + dolore_39f: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "aute_72": [ + "<string>", + "<string>" + ], + "eae": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "anim_b": [ + "<string>", + "<string>" + ], + "inf57": [ + "<string>", + "<string>" + ], + "sunt_12": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "cillum_f": [ + "<string>", + "<string>" + ], + "aliqua88": [ + "<string>", + "<string>" + ], + "mollit783": [ + "<string>", + "<string>" + ] + }, + "links": { + "est1": "<string>", + "anim_bb": "<string>" + } + } + /crm/v3/objects/emails/batch/archive: + post: + tags: + - Email API > Batch + summary: Archive a batch of emails by ID + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "aute_72": [ + "<string>", + "<string>" + ], + "eae": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "anim_b": [ + "<string>", + "<string>" + ], + "inf57": [ + "<string>", + "<string>" + ], + "sunt_12": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "cillum_f": [ + "<string>", + "<string>" + ], + "aliqua88": [ + "<string>", + "<string>" + ], + "mollit783": [ + "<string>", + "<string>" + ] + }, + "links": { + "est1": "<string>", + "anim_bb": "<string>" + } + } + /crm/v3/objects/emails/batch/update: + post: + tags: + - Email API > Batch + summary: Update a batch of emails by internal ID, or unique property values + requestBody: + content: {} + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + eua6_: <string> + id_af5: <string> + updatedAt: <dateTime> + propertiesWithHistory: + id_cdc: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + sit_6e: <string> + updatedAt: <dateTime> + propertiesWithHistory: + et3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + consectetur0: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: COMPLETE + requestedAt: <dateTime> + links: + ex_1: <string> + laborum_2_: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + magnab: <string> + mollit_a: <string> + quisc: <string> + updatedAt: <dateTime> + propertiesWithHistory: + quisdb: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + deserunt_9: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + officia3dc: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + magna_357: <string> + updatedAt: <dateTime> + propertiesWithHistory: + consectetur_0: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + non_c8e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + culpa_2fa: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PENDING + numErrors: <integer> + errors: + - category: <string> + context: + eu5f_: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + aliqua_02: + - <string> + - <string> + nostrud_8: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + quis_652: + - <string> + - <string> + links: + consectetur_cd0: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + irure1f: + - <string> + - <string> + laborum954: + - <string> + - <string> + sint_e: + - <string> + - <string> + nulla81: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + fugiat_6: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + ametb: + - <string> + - <string> + eab81: + - <string> + - <string> + links: + ullamco_1: <string> + sed_e3: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + dolore_39f: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "aute_72": [ + "<string>", + "<string>" + ], + "eae": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "anim_b": [ + "<string>", + "<string>" + ], + "inf57": [ + "<string>", + "<string>" + ], + "sunt_12": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "cillum_f": [ + "<string>", + "<string>" + ], + "aliqua88": [ + "<string>", + "<string>" + ], + "mollit783": [ + "<string>", + "<string>" + ] + }, + "links": { + "est1": "<string>", + "anim_bb": "<string>" + } + } + /crm/v3/objects/emails: + get: + tags: + - Email API > Basic + summary: List + description: >- + Read a page of emails. Control what is returned via the `properties` + query param. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: limit + in: query + schema: + type: integer + description: The maximum number of results to display per page. + example: '10' + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + veniam_29: <string> + officia_5: <string> + updatedAt: <dateTime> + propertiesWithHistory: + fugiat_8c: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + veniamea_: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + - createdAt: <dateTime> + id: <string> + properties: + in0e3: <string> + nisi58f: <string> + updatedAt: <dateTime> + propertiesWithHistory: + aliquip0: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + ullamcoa: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + nostrud28: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + quis_63: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + sed104: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "aute_72": [ + "<string>", + "<string>" + ], + "eae": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "anim_b": [ + "<string>", + "<string>" + ], + "inf57": [ + "<string>", + "<string>" + ], + "sunt_12": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "cillum_f": [ + "<string>", + "<string>" + ], + "aliqua88": [ + "<string>", + "<string>" + ], + "mollit783": [ + "<string>", + "<string>" + ] + }, + "links": { + "est1": "<string>", + "anim_bb": "<string>" + } + } + post: + tags: + - Email API > Basic + summary: Create + description: >- + Create a email with the given properties and return a copy of the + object, including the ID. Documentation and examples for creating + standard emails is provided. + requestBody: + content: + application/json: + schema: + type: object + example: + associations: + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + properties: + est_d6: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + qui_6ea: <string> + updatedAt: <dateTime> + propertiesWithHistory: + nulla_b9: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + do_d51: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + cupidatat07e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + culpa_8: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "aute_72": [ + "<string>", + "<string>" + ], + "eae": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "anim_b": [ + "<string>", + "<string>" + ], + "inf57": [ + "<string>", + "<string>" + ], + "sunt_12": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "cillum_f": [ + "<string>", + "<string>" + ], + "aliqua88": [ + "<string>", + "<string>" + ], + "mollit783": [ + "<string>", + "<string>" + ] + }, + "links": { + "est1": "<string>", + "anim_bb": "<string>" + } + } + /crm/v3/objects/emails/{emailId}: + get: + tags: + - Email API > Basic + summary: Read + description: >- + Read an Object identified by `{emailId}`. `{emailId}` refers to the + internal object ID by default, or optionally any unique property value + as specified by the `idProperty` query param. Control what is returned + via the `properties` query param. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: emailId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + officia4: <string> + laborum_8: <string> + incididunt__: <string> + updatedAt: <dateTime> + propertiesWithHistory: + culpa_6: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + magnab1b: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + officia_2: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "aute_72": [ + "<string>", + "<string>" + ], + "eae": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "anim_b": [ + "<string>", + "<string>" + ], + "inf57": [ + "<string>", + "<string>" + ], + "sunt_12": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "cillum_f": [ + "<string>", + "<string>" + ], + "aliqua88": [ + "<string>", + "<string>" + ], + "mollit783": [ + "<string>", + "<string>" + ] + }, + "links": { + "est1": "<string>", + "anim_bb": "<string>" + } + } + delete: + tags: + - Email API > Basic + summary: Archive + description: Move an Object identified by `{emailId}` to the recycling bin. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: emailId + in: path + schema: + type: string + required: true + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "aute_72": [ + "<string>", + "<string>" + ], + "eae": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "anim_b": [ + "<string>", + "<string>" + ], + "inf57": [ + "<string>", + "<string>" + ], + "sunt_12": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "cillum_f": [ + "<string>", + "<string>" + ], + "aliqua88": [ + "<string>", + "<string>" + ], + "mollit783": [ + "<string>", + "<string>" + ] + }, + "links": { + "est1": "<string>", + "anim_bb": "<string>" + } + } + patch: + tags: + - Email API > Basic + summary: Update + description: >- + Perform a partial update of an Object identified by `{emailId}`. + `{emailId}` refers to the internal object ID by default, or optionally + any unique property value as specified by the `idProperty` query param. + Provided property values will be overwritten. Read-only and non-existent + properties will be ignored. Properties values can be cleared by passing + an empty string. + requestBody: + content: + application/json: + schema: + type: object + example: + properties: + tempore0: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: emailId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + qui_6ea: <string> + updatedAt: <dateTime> + propertiesWithHistory: + nulla_b9: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + do_d51: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + cupidatat07e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + culpa_8: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "aute_72": [ + "<string>", + "<string>" + ], + "eae": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "anim_b": [ + "<string>", + "<string>" + ], + "inf57": [ + "<string>", + "<string>" + ], + "sunt_12": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "cillum_f": [ + "<string>", + "<string>" + ], + "aliqua88": [ + "<string>", + "<string>" + ], + "mollit783": [ + "<string>", + "<string>" + ] + }, + "links": { + "est1": "<string>", + "anim_bb": "<string>" + } + } + /crm/v3/objects/emails/search: + post: + tags: + - Email API > Search + summary: post-/crm/v3/objects/emails/search do Search + requestBody: + content: {} + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + Excepteur1_: <string> + velit11: <string> + Lorem_7: <string> + esse_8: <string> + updatedAt: <dateTime> + propertiesWithHistory: + est_01d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + sed__5: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + doloredb5: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + magna_56d: <string> + updatedAt: <dateTime> + propertiesWithHistory: + laboreb27: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "aute_72": [ + "<string>", + "<string>" + ], + "eae": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "anim_b": [ + "<string>", + "<string>" + ], + "inf57": [ + "<string>", + "<string>" + ], + "sunt_12": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "cillum_f": [ + "<string>", + "<string>" + ], + "aliqua88": [ + "<string>", + "<string>" + ], + "mollit783": [ + "<string>", + "<string>" + ] + }, + "links": { + "est1": "<string>", + "anim_bb": "<string>" + } + } + /crm/v3/objects/meetings/batch/update: + post: + tags: + - Meetings API > Batch + summary: Update a batch of meetings by internal ID, or unique property values + requestBody: + content: {} + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + anim_70c: <string> + updatedAt: <dateTime> + propertiesWithHistory: + quis_150: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + eu_a: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + Ut_6: <string> + Lorem5c2: <string> + add6: <string> + updatedAt: <dateTime> + propertiesWithHistory: + in_fb: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + dolor_5eb: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + Duis95: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: COMPLETE + requestedAt: <dateTime> + links: + incididunt_f64: <string> + ex_a: <string> + nulla_9: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + exercitation2e: <string> + Excepteur_64: <string> + updatedAt: <dateTime> + propertiesWithHistory: + sunt_f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + aliqua_179: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + commodo5a3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + Ut_5bf: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + pariaturd0: <string> + cillume4: <string> + amet_1d0: <string> + mollit_9: <string> + updatedAt: <dateTime> + propertiesWithHistory: + sit_d94: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + aliquab: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + laboris_17: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PENDING + numErrors: <integer> + errors: + - category: <string> + context: + utd: + - <string> + - <string> + ullamco___: + - <string> + - <string> + non_6: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + eiusmod17e: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + culpa_6: + - <string> + - <string> + veniam_19: + - <string> + - <string> + pariatur4_: + - <string> + - <string> + links: + culpa_f: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + cupidatat7: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + aliquipa60: + - <string> + - <string> + utf6: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + in454: + - <string> + - <string> + links: + velit_f: <string> + veniam_1f: <string> + magna_c: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + nondf: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ind": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "nostrud_55f": [ + "<string>", + "<string>" + ], + "velit9": [ + "<string>", + "<string>" + ], + "laborum0f3": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "est_e2": [ + "<string>", + "<string>" + ], + "ea2fd": [ + "<string>", + "<string>" + ], + "ea3": [ + "<string>", + "<string>" + ], + "mollite": [ + "<string>", + "<string>" + ] + }, + "links": { + "aliquip_cc": "<string>" + } + } + /crm/v3/objects/meetings/batch/archive: + post: + tags: + - Meetings API > Batch + summary: Archive a batch of meetings by ID + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ind": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "nostrud_55f": [ + "<string>", + "<string>" + ], + "velit9": [ + "<string>", + "<string>" + ], + "laborum0f3": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "est_e2": [ + "<string>", + "<string>" + ], + "ea2fd": [ + "<string>", + "<string>" + ], + "ea3": [ + "<string>", + "<string>" + ], + "mollite": [ + "<string>", + "<string>" + ] + }, + "links": { + "aliquip_cc": "<string>" + } + } + /crm/v3/objects/meetings/batch/read: + post: + tags: + - Meetings API > Batch + summary: Read a batch of meetings by internal ID, or unique property values + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + properties: + - <string> + - <string> + propertiesWithHistory: + - <string> + - <string> + idProperty: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + anim_70c: <string> + updatedAt: <dateTime> + propertiesWithHistory: + quis_150: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + eu_a: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + Ut_6: <string> + Lorem5c2: <string> + add6: <string> + updatedAt: <dateTime> + propertiesWithHistory: + in_fb: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + dolor_5eb: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + Duis95: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: COMPLETE + requestedAt: <dateTime> + links: + incididunt_f64: <string> + ex_a: <string> + nulla_9: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + exercitation2e: <string> + Excepteur_64: <string> + updatedAt: <dateTime> + propertiesWithHistory: + sunt_f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + aliqua_179: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + commodo5a3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + Ut_5bf: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + pariaturd0: <string> + cillume4: <string> + amet_1d0: <string> + mollit_9: <string> + updatedAt: <dateTime> + propertiesWithHistory: + sit_d94: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + aliquab: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + laboris_17: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PENDING + numErrors: <integer> + errors: + - category: <string> + context: + utd: + - <string> + - <string> + ullamco___: + - <string> + - <string> + non_6: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + eiusmod17e: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + culpa_6: + - <string> + - <string> + veniam_19: + - <string> + - <string> + pariatur4_: + - <string> + - <string> + links: + culpa_f: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + cupidatat7: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + aliquipa60: + - <string> + - <string> + utf6: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + in454: + - <string> + - <string> + links: + velit_f: <string> + veniam_1f: <string> + magna_c: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + nondf: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ind": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "nostrud_55f": [ + "<string>", + "<string>" + ], + "velit9": [ + "<string>", + "<string>" + ], + "laborum0f3": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "est_e2": [ + "<string>", + "<string>" + ], + "ea2fd": [ + "<string>", + "<string>" + ], + "ea3": [ + "<string>", + "<string>" + ], + "mollite": [ + "<string>", + "<string>" + ] + }, + "links": { + "aliquip_cc": "<string>" + } + } + /crm/v3/objects/meetings/batch/create: + post: + tags: + - Meetings API > Batch + summary: Create a batch of meetings + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - associations: + - to: + id: <string> + types: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + properties: + Loremd9_: <string> + - associations: + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + properties: + aute_5e4: <string> + minim_7: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + anim_70c: <string> + updatedAt: <dateTime> + propertiesWithHistory: + quis_150: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + eu_a: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + Ut_6: <string> + Lorem5c2: <string> + add6: <string> + updatedAt: <dateTime> + propertiesWithHistory: + in_fb: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + dolor_5eb: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + Duis95: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: COMPLETE + requestedAt: <dateTime> + links: + incididunt_f64: <string> + ex_a: <string> + nulla_9: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + exercitation2e: <string> + Excepteur_64: <string> + updatedAt: <dateTime> + propertiesWithHistory: + sunt_f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + aliqua_179: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + commodo5a3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + Ut_5bf: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + pariaturd0: <string> + cillume4: <string> + amet_1d0: <string> + mollit_9: <string> + updatedAt: <dateTime> + propertiesWithHistory: + sit_d94: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + aliquab: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + laboris_17: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PENDING + numErrors: <integer> + errors: + - category: <string> + context: + utd: + - <string> + - <string> + ullamco___: + - <string> + - <string> + non_6: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + eiusmod17e: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + culpa_6: + - <string> + - <string> + veniam_19: + - <string> + - <string> + pariatur4_: + - <string> + - <string> + links: + culpa_f: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + cupidatat7: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + aliquipa60: + - <string> + - <string> + utf6: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + in454: + - <string> + - <string> + links: + velit_f: <string> + veniam_1f: <string> + magna_c: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + nondf: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ind": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "nostrud_55f": [ + "<string>", + "<string>" + ], + "velit9": [ + "<string>", + "<string>" + ], + "laborum0f3": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "est_e2": [ + "<string>", + "<string>" + ], + "ea2fd": [ + "<string>", + "<string>" + ], + "ea3": [ + "<string>", + "<string>" + ], + "mollite": [ + "<string>", + "<string>" + ] + }, + "links": { + "aliquip_cc": "<string>" + } + } + /crm/v3/objects/meetings/{meetingId}: + get: + tags: + - Meetings API > Basic + summary: Read + description: >- + Read an Object identified by `{meetingId}`. `{meetingId}` refers to the + internal object ID by default, or optionally any unique property value + as specified by the `idProperty` query param. Control what is returned + via the `properties` query param. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: meetingId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + fugiat_28: <string> + consecteturf77: <string> + ut6f: <string> + et_d: <string> + updatedAt: <dateTime> + propertiesWithHistory: + ipsum7a: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + sintfe0: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + laborum__: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + aliqua_2a: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ind": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "nostrud_55f": [ + "<string>", + "<string>" + ], + "velit9": [ + "<string>", + "<string>" + ], + "laborum0f3": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "est_e2": [ + "<string>", + "<string>" + ], + "ea2fd": [ + "<string>", + "<string>" + ], + "ea3": [ + "<string>", + "<string>" + ], + "mollite": [ + "<string>", + "<string>" + ] + }, + "links": { + "aliquip_cc": "<string>" + } + } + delete: + tags: + - Meetings API > Basic + summary: Archive + description: Move an Object identified by `{meetingId}` to the recycling bin. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: meetingId + in: path + schema: + type: string + required: true + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ind": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "nostrud_55f": [ + "<string>", + "<string>" + ], + "velit9": [ + "<string>", + "<string>" + ], + "laborum0f3": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "est_e2": [ + "<string>", + "<string>" + ], + "ea2fd": [ + "<string>", + "<string>" + ], + "ea3": [ + "<string>", + "<string>" + ], + "mollite": [ + "<string>", + "<string>" + ] + }, + "links": { + "aliquip_cc": "<string>" + } + } + patch: + tags: + - Meetings API > Basic + summary: Update + description: >- + Perform a partial update of an Object identified by `{meetingId}`. + `{meetingId}` refers to the internal object ID by default, or optionally + any unique property value as specified by the `idProperty` query param. + Provided property values will be overwritten. Read-only and non-existent + properties will be ignored. Properties values can be cleared by passing + an empty string. + requestBody: + content: + application/json: + schema: + type: object + example: + properties: + tempor_5e: <string> + eiusmod_c: <string> + laborum_91: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: meetingId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + voluptate47b: <string> + Excepteur_e7_: <string> + Lorem_44e: <string> + updatedAt: <dateTime> + propertiesWithHistory: + deseruntd: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ind": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "nostrud_55f": [ + "<string>", + "<string>" + ], + "velit9": [ + "<string>", + "<string>" + ], + "laborum0f3": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "est_e2": [ + "<string>", + "<string>" + ], + "ea2fd": [ + "<string>", + "<string>" + ], + "ea3": [ + "<string>", + "<string>" + ], + "mollite": [ + "<string>", + "<string>" + ] + }, + "links": { + "aliquip_cc": "<string>" + } + } + /crm/v3/objects/meetings: + get: + tags: + - Meetings API > Basic + summary: List + description: >- + Read a page of meetings. Control what is returned via the `properties` + query param. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: limit + in: query + schema: + type: integer + description: The maximum number of results to display per page. + example: '10' + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + incididuntf7: <string> + updatedAt: <dateTime> + propertiesWithHistory: + in_6: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + commodoe6b: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + ea_d9a: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + - createdAt: <dateTime> + id: <string> + properties: + qui_1f: <string> + qui_24: <string> + updatedAt: <dateTime> + propertiesWithHistory: + in73: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + exercitation_99: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + consectetur776: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + eiusmodd: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ind": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "nostrud_55f": [ + "<string>", + "<string>" + ], + "velit9": [ + "<string>", + "<string>" + ], + "laborum0f3": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "est_e2": [ + "<string>", + "<string>" + ], + "ea2fd": [ + "<string>", + "<string>" + ], + "ea3": [ + "<string>", + "<string>" + ], + "mollite": [ + "<string>", + "<string>" + ] + }, + "links": { + "aliquip_cc": "<string>" + } + } + post: + tags: + - Meetings API > Basic + summary: Create + description: >- + Create a meeting with the given properties and return a copy of the + object, including the ID. Documentation and examples for creating + standard meetings is provided. + requestBody: + content: + application/json: + schema: + type: object + example: + associations: + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + properties: + eiusmod_a15: <string> + esse67: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + voluptate47b: <string> + Excepteur_e7_: <string> + Lorem_44e: <string> + updatedAt: <dateTime> + propertiesWithHistory: + deseruntd: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ind": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "nostrud_55f": [ + "<string>", + "<string>" + ], + "velit9": [ + "<string>", + "<string>" + ], + "laborum0f3": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "est_e2": [ + "<string>", + "<string>" + ], + "ea2fd": [ + "<string>", + "<string>" + ], + "ea3": [ + "<string>", + "<string>" + ], + "mollite": [ + "<string>", + "<string>" + ] + }, + "links": { + "aliquip_cc": "<string>" + } + } + /crm/v3/objects/meetings/search: + post: + tags: + - Meetings API > Search + summary: post-/crm/v3/objects/meetings/search do Search + requestBody: + content: {} + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + quis29: <string> + updatedAt: <dateTime> + propertiesWithHistory: + mollit_f5: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + utf7a: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + in_5a: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + ut4: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + tempor_94: <string> + updatedAt: <dateTime> + propertiesWithHistory: + exercitationc0e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ind": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "nostrud_55f": [ + "<string>", + "<string>" + ], + "velit9": [ + "<string>", + "<string>" + ], + "laborum0f3": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "est_e2": [ + "<string>", + "<string>" + ], + "ea2fd": [ + "<string>", + "<string>" + ], + "ea3": [ + "<string>", + "<string>" + ], + "mollite": [ + "<string>", + "<string>" + ] + }, + "links": { + "aliquip_cc": "<string>" + } + } + /crm/v3/objects/notes/batch/read: + post: + tags: + - Notes API > Batch + summary: Read a batch of notes by internal ID, or unique property values + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + properties: + - <string> + - <string> + propertiesWithHistory: + - <string> + - <string> + idProperty: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + adipisicing6f: <string> + dolor_31: <string> + updatedAt: <dateTime> + propertiesWithHistory: + dolore8: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + voluptate_8: <string> + updatedAt: <dateTime> + propertiesWithHistory: + nulla_66b: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + est_7aa: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: CANCELED + requestedAt: <dateTime> + links: + pariatur__2f: <string> + eu_cbf: <string> + elit_0: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + ut_e9: <string> + reprehenderitd0: <string> + updatedAt: <dateTime> + propertiesWithHistory: + incididunt4: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + id_809: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + dolor7bb: <string> + cupidatat_3: <string> + Duis_0: <string> + updatedAt: <dateTime> + propertiesWithHistory: + mollit_f_: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + cillum__e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + Excepteur8_d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + Lorem_6: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PENDING + numErrors: <integer> + errors: + - category: <string> + context: + exa8: + - <string> + - <string> + adipisicing6ad: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + ea96: + - <string> + - <string> + tempor8: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + consecteturd6_: + - <string> + - <string> + links: + deserunt417: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + sit_ce: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + ipsum140: + - <string> + - <string> + id_0: + - <string> + - <string> + cupidatat_5: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + cillum_743: + - <string> + - <string> + links: + anim_f6: <string> + cupidatat_f: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + consectetur_f: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "enim9": [ + "<string>", + "<string>" + ], + "officia_78": [ + "<string>", + "<string>" + ], + "Ut_5db": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "dolor_76": [ + "<string>", + "<string>" + ], + "quise7": [ + "<string>", + "<string>" + ], + "qui_123": [ + "<string>", + "<string>" + ], + "Excepteur__8": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "amet651": [ + "<string>", + "<string>" + ], + "sintb1": [ + "<string>", + "<string>" + ] + }, + "links": { + "incididunt_8a3": "<string>" + } + } + /crm/v3/objects/notes/batch/archive: + post: + tags: + - Notes API > Batch + summary: Archive a batch of notes by ID + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "enim9": [ + "<string>", + "<string>" + ], + "officia_78": [ + "<string>", + "<string>" + ], + "Ut_5db": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "dolor_76": [ + "<string>", + "<string>" + ], + "quise7": [ + "<string>", + "<string>" + ], + "qui_123": [ + "<string>", + "<string>" + ], + "Excepteur__8": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "amet651": [ + "<string>", + "<string>" + ], + "sintb1": [ + "<string>", + "<string>" + ] + }, + "links": { + "incididunt_8a3": "<string>" + } + } + /crm/v3/objects/notes/batch/update: + post: + tags: + - Notes API > Batch + summary: Update a batch of notes by internal ID, or unique property values + requestBody: + content: {} + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + adipisicing6f: <string> + dolor_31: <string> + updatedAt: <dateTime> + propertiesWithHistory: + dolore8: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + voluptate_8: <string> + updatedAt: <dateTime> + propertiesWithHistory: + nulla_66b: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + est_7aa: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: CANCELED + requestedAt: <dateTime> + links: + pariatur__2f: <string> + eu_cbf: <string> + elit_0: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + ut_e9: <string> + reprehenderitd0: <string> + updatedAt: <dateTime> + propertiesWithHistory: + incididunt4: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + id_809: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + dolor7bb: <string> + cupidatat_3: <string> + Duis_0: <string> + updatedAt: <dateTime> + propertiesWithHistory: + mollit_f_: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + cillum__e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + Excepteur8_d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + Lorem_6: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PENDING + numErrors: <integer> + errors: + - category: <string> + context: + exa8: + - <string> + - <string> + adipisicing6ad: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + ea96: + - <string> + - <string> + tempor8: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + consecteturd6_: + - <string> + - <string> + links: + deserunt417: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + sit_ce: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + ipsum140: + - <string> + - <string> + id_0: + - <string> + - <string> + cupidatat_5: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + cillum_743: + - <string> + - <string> + links: + anim_f6: <string> + cupidatat_f: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + consectetur_f: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "enim9": [ + "<string>", + "<string>" + ], + "officia_78": [ + "<string>", + "<string>" + ], + "Ut_5db": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "dolor_76": [ + "<string>", + "<string>" + ], + "quise7": [ + "<string>", + "<string>" + ], + "qui_123": [ + "<string>", + "<string>" + ], + "Excepteur__8": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "amet651": [ + "<string>", + "<string>" + ], + "sintb1": [ + "<string>", + "<string>" + ] + }, + "links": { + "incididunt_8a3": "<string>" + } + } + /crm/v3/objects/notes/batch/create: + post: + tags: + - Notes API > Batch + summary: Create a batch of notes + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - associations: + - to: + id: <string> + types: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + properties: + velite: <string> + - associations: + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + properties: + occaecat_d: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + adipisicing6f: <string> + dolor_31: <string> + updatedAt: <dateTime> + propertiesWithHistory: + dolore8: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + voluptate_8: <string> + updatedAt: <dateTime> + propertiesWithHistory: + nulla_66b: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + est_7aa: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: CANCELED + requestedAt: <dateTime> + links: + pariatur__2f: <string> + eu_cbf: <string> + elit_0: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + ut_e9: <string> + reprehenderitd0: <string> + updatedAt: <dateTime> + propertiesWithHistory: + incididunt4: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + id_809: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + dolor7bb: <string> + cupidatat_3: <string> + Duis_0: <string> + updatedAt: <dateTime> + propertiesWithHistory: + mollit_f_: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + cillum__e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + Excepteur8_d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + Lorem_6: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PENDING + numErrors: <integer> + errors: + - category: <string> + context: + exa8: + - <string> + - <string> + adipisicing6ad: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + ea96: + - <string> + - <string> + tempor8: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + consecteturd6_: + - <string> + - <string> + links: + deserunt417: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + sit_ce: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + ipsum140: + - <string> + - <string> + id_0: + - <string> + - <string> + cupidatat_5: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + cillum_743: + - <string> + - <string> + links: + anim_f6: <string> + cupidatat_f: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + consectetur_f: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "enim9": [ + "<string>", + "<string>" + ], + "officia_78": [ + "<string>", + "<string>" + ], + "Ut_5db": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "dolor_76": [ + "<string>", + "<string>" + ], + "quise7": [ + "<string>", + "<string>" + ], + "qui_123": [ + "<string>", + "<string>" + ], + "Excepteur__8": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "amet651": [ + "<string>", + "<string>" + ], + "sintb1": [ + "<string>", + "<string>" + ] + }, + "links": { + "incididunt_8a3": "<string>" + } + } + /crm/v3/objects/notes: + get: + tags: + - Notes API > Basic + summary: List + description: >- + Read a page of notes. Control what is returned via the `properties` + query param. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: limit + in: query + schema: + type: integer + description: The maximum number of results to display per page. + example: '10' + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + quisb6: <string> + updatedAt: <dateTime> + propertiesWithHistory: + ex2c0: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + nisi_4: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + nostrud3_: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + ex7: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + temporf6: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + - createdAt: <dateTime> + id: <string> + properties: + Ut_e: <string> + utc0: <string> + updatedAt: <dateTime> + propertiesWithHistory: + esse_dee: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + quis6: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "enim9": [ + "<string>", + "<string>" + ], + "officia_78": [ + "<string>", + "<string>" + ], + "Ut_5db": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "dolor_76": [ + "<string>", + "<string>" + ], + "quise7": [ + "<string>", + "<string>" + ], + "qui_123": [ + "<string>", + "<string>" + ], + "Excepteur__8": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "amet651": [ + "<string>", + "<string>" + ], + "sintb1": [ + "<string>", + "<string>" + ] + }, + "links": { + "incididunt_8a3": "<string>" + } + } + post: + tags: + - Notes API > Basic + summary: Create + description: >- + Create a note with the given properties and return a copy of the object, + including the ID. Documentation and examples for creating standard notes + is provided. + requestBody: + content: + application/json: + schema: + type: object + example: + associations: + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + properties: + irure_a: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + in_53: <string> + aute_577: <string> + commodo7: <string> + updatedAt: <dateTime> + propertiesWithHistory: + euabf: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + minim_b6: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "enim9": [ + "<string>", + "<string>" + ], + "officia_78": [ + "<string>", + "<string>" + ], + "Ut_5db": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "dolor_76": [ + "<string>", + "<string>" + ], + "quise7": [ + "<string>", + "<string>" + ], + "qui_123": [ + "<string>", + "<string>" + ], + "Excepteur__8": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "amet651": [ + "<string>", + "<string>" + ], + "sintb1": [ + "<string>", + "<string>" + ] + }, + "links": { + "incididunt_8a3": "<string>" + } + } + /crm/v3/objects/notes/{noteId}: + get: + tags: + - Notes API > Basic + summary: Read + description: >- + Read an Object identified by `{noteId}`. `{noteId}` refers to the + internal object ID by default, or optionally any unique property value + as specified by the `idProperty` query param. Control what is returned + via the `properties` query param. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: noteId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + laborise9: <string> + commodo_447: <string> + do_d2: <string> + updatedAt: <dateTime> + propertiesWithHistory: + quis_: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + et_0: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + veniam6: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + consequatcf1: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "enim9": [ + "<string>", + "<string>" + ], + "officia_78": [ + "<string>", + "<string>" + ], + "Ut_5db": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "dolor_76": [ + "<string>", + "<string>" + ], + "quise7": [ + "<string>", + "<string>" + ], + "qui_123": [ + "<string>", + "<string>" + ], + "Excepteur__8": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "amet651": [ + "<string>", + "<string>" + ], + "sintb1": [ + "<string>", + "<string>" + ] + }, + "links": { + "incididunt_8a3": "<string>" + } + } + delete: + tags: + - Notes API > Basic + summary: Archive + description: Move an Object identified by `{noteId}` to the recycling bin. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: noteId + in: path + schema: + type: string + required: true + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "enim9": [ + "<string>", + "<string>" + ], + "officia_78": [ + "<string>", + "<string>" + ], + "Ut_5db": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "dolor_76": [ + "<string>", + "<string>" + ], + "quise7": [ + "<string>", + "<string>" + ], + "qui_123": [ + "<string>", + "<string>" + ], + "Excepteur__8": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "amet651": [ + "<string>", + "<string>" + ], + "sintb1": [ + "<string>", + "<string>" + ] + }, + "links": { + "incididunt_8a3": "<string>" + } + } + patch: + tags: + - Notes API > Basic + summary: Update + description: >- + Perform a partial update of an Object identified by `{noteId}`. + `{noteId}` refers to the internal object ID by default, or optionally + any unique property value as specified by the `idProperty` query param. + Provided property values will be overwritten. Read-only and non-existent + properties will be ignored. Properties values can be cleared by passing + an empty string. + requestBody: + content: + application/json: + schema: + type: object + example: + properties: + laboris701: <string> + velit_: <string> + in_b: <string> + ex_1d: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: noteId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + in_53: <string> + aute_577: <string> + commodo7: <string> + updatedAt: <dateTime> + propertiesWithHistory: + euabf: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + minim_b6: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "enim9": [ + "<string>", + "<string>" + ], + "officia_78": [ + "<string>", + "<string>" + ], + "Ut_5db": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "dolor_76": [ + "<string>", + "<string>" + ], + "quise7": [ + "<string>", + "<string>" + ], + "qui_123": [ + "<string>", + "<string>" + ], + "Excepteur__8": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "amet651": [ + "<string>", + "<string>" + ], + "sintb1": [ + "<string>", + "<string>" + ] + }, + "links": { + "incididunt_8a3": "<string>" + } + } + /crm/v3/objects/notes/search: + post: + tags: + - Notes API > Search + summary: post-/crm/v3/objects/notes/search do Search + requestBody: + content: {} + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + ex9: <string> + updatedAt: <dateTime> + propertiesWithHistory: + sinte: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + ex4: <string> + updatedAt: <dateTime> + propertiesWithHistory: + ex6_: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + proident2d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + non_6: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + adb9: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "enim9": [ + "<string>", + "<string>" + ], + "officia_78": [ + "<string>", + "<string>" + ], + "Ut_5db": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "dolor_76": [ + "<string>", + "<string>" + ], + "quise7": [ + "<string>", + "<string>" + ], + "qui_123": [ + "<string>", + "<string>" + ], + "Excepteur__8": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "amet651": [ + "<string>", + "<string>" + ], + "sintb1": [ + "<string>", + "<string>" + ] + }, + "links": { + "incididunt_8a3": "<string>" + } + } + /crm/v3/objects/postal_mail/batch/read: + post: + tags: + - Postal Mail API > Batch + summary: Read a batch of postal mail by internal ID, or unique property values + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + properties: + - <string> + - <string> + propertiesWithHistory: + - <string> + - <string> + idProperty: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + commodo0: <string> + qui_4bf: <string> + updatedAt: <dateTime> + propertiesWithHistory: + labore66: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + tempor9c7: <string> + updatedAt: <dateTime> + propertiesWithHistory: + veniam_d56: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + amet8: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + sint__7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: CANCELED + requestedAt: <dateTime> + links: + ute_7: <string> + minim_9: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + sit96f: <string> + et_cf4: <string> + laboris14: <string> + updatedAt: <dateTime> + propertiesWithHistory: + voluptate_7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + ad_0e_: <string> + updatedAt: <dateTime> + propertiesWithHistory: + sint_7a: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + consequat_b: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PROCESSING + numErrors: <integer> + errors: + - category: <string> + context: + voluptate_08: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + tempor_e_: + - <string> + - <string> + aliquip6a7: + - <string> + - <string> + mollit__d: + - <string> + - <string> + ina1: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + elit_537: + - <string> + - <string> + links: + labore_08: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + dolore_1: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + anim_a: + - <string> + - <string> + enimc3: + - <string> + - <string> + anim5a3: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + nostrud_f4b: + - <string> + - <string> + ametc4e: + - <string> + - <string> + ut_2: + - <string> + - <string> + links: + nostrud_e: <string> + minim_ee7: <string> + sed85: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + ut_a3: <string> + fugiat0e0: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "mollitcfa": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "Excepteur_c": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "eiusmoda22": [ + "<string>", + "<string>" + ], + "anim0bf": [ + "<string>", + "<string>" + ] + }, + "links": { + "quis_b_": "<string>", + "incididunt5b6": "<string>" + } + } + /crm/v3/objects/postal_mail/batch/archive: + post: + tags: + - Postal Mail API > Batch + summary: Archive a batch of postal mail by ID + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "mollitcfa": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "Excepteur_c": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "eiusmoda22": [ + "<string>", + "<string>" + ], + "anim0bf": [ + "<string>", + "<string>" + ] + }, + "links": { + "quis_b_": "<string>", + "incididunt5b6": "<string>" + } + } + /crm/v3/objects/postal_mail/batch/create: + post: + tags: + - Postal Mail API > Batch + summary: Create a batch of postal mail + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - associations: + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + properties: + dolor1: <string> + magna5: <string> + - associations: + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + properties: + elit_2: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + commodo0: <string> + qui_4bf: <string> + updatedAt: <dateTime> + propertiesWithHistory: + labore66: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + tempor9c7: <string> + updatedAt: <dateTime> + propertiesWithHistory: + veniam_d56: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + amet8: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + sint__7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: CANCELED + requestedAt: <dateTime> + links: + ute_7: <string> + minim_9: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + sit96f: <string> + et_cf4: <string> + laboris14: <string> + updatedAt: <dateTime> + propertiesWithHistory: + voluptate_7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + ad_0e_: <string> + updatedAt: <dateTime> + propertiesWithHistory: + sint_7a: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + consequat_b: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PROCESSING + numErrors: <integer> + errors: + - category: <string> + context: + voluptate_08: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + tempor_e_: + - <string> + - <string> + aliquip6a7: + - <string> + - <string> + mollit__d: + - <string> + - <string> + ina1: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + elit_537: + - <string> + - <string> + links: + labore_08: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + dolore_1: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + anim_a: + - <string> + - <string> + enimc3: + - <string> + - <string> + anim5a3: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + nostrud_f4b: + - <string> + - <string> + ametc4e: + - <string> + - <string> + ut_2: + - <string> + - <string> + links: + nostrud_e: <string> + minim_ee7: <string> + sed85: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + ut_a3: <string> + fugiat0e0: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "mollitcfa": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "Excepteur_c": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "eiusmoda22": [ + "<string>", + "<string>" + ], + "anim0bf": [ + "<string>", + "<string>" + ] + }, + "links": { + "quis_b_": "<string>", + "incididunt5b6": "<string>" + } + } + /crm/v3/objects/postal_mail/batch/update: + post: + tags: + - Postal Mail API > Batch + summary: Update a batch of postal mail by internal ID, or unique property values + requestBody: + content: {} + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + commodo0: <string> + qui_4bf: <string> + updatedAt: <dateTime> + propertiesWithHistory: + labore66: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + tempor9c7: <string> + updatedAt: <dateTime> + propertiesWithHistory: + veniam_d56: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + amet8: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + sint__7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: CANCELED + requestedAt: <dateTime> + links: + ute_7: <string> + minim_9: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + sit96f: <string> + et_cf4: <string> + laboris14: <string> + updatedAt: <dateTime> + propertiesWithHistory: + voluptate_7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + ad_0e_: <string> + updatedAt: <dateTime> + propertiesWithHistory: + sint_7a: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + consequat_b: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PROCESSING + numErrors: <integer> + errors: + - category: <string> + context: + voluptate_08: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + tempor_e_: + - <string> + - <string> + aliquip6a7: + - <string> + - <string> + mollit__d: + - <string> + - <string> + ina1: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + elit_537: + - <string> + - <string> + links: + labore_08: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + dolore_1: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + anim_a: + - <string> + - <string> + enimc3: + - <string> + - <string> + anim5a3: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + nostrud_f4b: + - <string> + - <string> + ametc4e: + - <string> + - <string> + ut_2: + - <string> + - <string> + links: + nostrud_e: <string> + minim_ee7: <string> + sed85: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + ut_a3: <string> + fugiat0e0: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "mollitcfa": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "Excepteur_c": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "eiusmoda22": [ + "<string>", + "<string>" + ], + "anim0bf": [ + "<string>", + "<string>" + ] + }, + "links": { + "quis_b_": "<string>", + "incididunt5b6": "<string>" + } + } + /crm/v3/objects/postal_mail: + get: + tags: + - Postal Mail API > Basic + summary: List + description: >- + Read a page of postal mail. Control what is returned via the + `properties` query param. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: limit + in: query + schema: + type: integer + description: The maximum number of results to display per page. + example: '10' + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + dolore7: <string> + irure_6: <string> + dolord: <string> + Excepteur_15: <string> + updatedAt: <dateTime> + propertiesWithHistory: + dolore_dd6: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + consectetur5: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + in_8: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + mollit_2f: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + veniam_43: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + officia__9: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + occaecat_e: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + - createdAt: <dateTime> + id: <string> + properties: + in_4df: <string> + consequat_c: <string> + updatedAt: <dateTime> + propertiesWithHistory: + Duisf99: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + Duis_c9: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + cupidatat_1_: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + aliqua_f: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "mollitcfa": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "Excepteur_c": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "eiusmoda22": [ + "<string>", + "<string>" + ], + "anim0bf": [ + "<string>", + "<string>" + ] + }, + "links": { + "quis_b_": "<string>", + "incididunt5b6": "<string>" + } + } + post: + tags: + - Postal Mail API > Basic + summary: Create + description: >- + Create a postal mail with the given properties and return a copy of the + object, including the ID. Documentation and examples for creating + standard postal mail is provided. + requestBody: + content: + application/json: + schema: + type: object + example: + associations: + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + properties: + culpa_0: <string> + proident_99: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + adipisicing9: <string> + nulla_a_: <string> + irure_478: <string> + cupidatat_3_0: <string> + ada1: <string> + updatedAt: <dateTime> + propertiesWithHistory: + reprehenderit_9: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "mollitcfa": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "Excepteur_c": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "eiusmoda22": [ + "<string>", + "<string>" + ], + "anim0bf": [ + "<string>", + "<string>" + ] + }, + "links": { + "quis_b_": "<string>", + "incididunt5b6": "<string>" + } + } + /crm/v3/objects/postal_mail/{postalMailId}: + get: + tags: + - Postal Mail API > Basic + summary: Read + description: >- + Read an Object identified by `{postalMailId}`. `{postalMailId}` refers + to the internal object ID by default, or optionally any unique property + value as specified by the `idProperty` query param. Control what is + returned via the `properties` query param. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: postalMailId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + magna23e: <string> + sed_f3: <string> + eu2: <string> + updatedAt: <dateTime> + propertiesWithHistory: + Duiscbb: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + minim97: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "mollitcfa": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "Excepteur_c": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "eiusmoda22": [ + "<string>", + "<string>" + ], + "anim0bf": [ + "<string>", + "<string>" + ] + }, + "links": { + "quis_b_": "<string>", + "incididunt5b6": "<string>" + } + } + delete: + tags: + - Postal Mail API > Basic + summary: Archive + description: Move an Object identified by `{postalMailId}` to the recycling bin. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: postalMailId + in: path + schema: + type: string + required: true + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "mollitcfa": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "Excepteur_c": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "eiusmoda22": [ + "<string>", + "<string>" + ], + "anim0bf": [ + "<string>", + "<string>" + ] + }, + "links": { + "quis_b_": "<string>", + "incididunt5b6": "<string>" + } + } + patch: + tags: + - Postal Mail API > Basic + summary: Update + description: >- + Perform a partial update of an Object identified by `{postalMailId}`. + `{postalMailId}` refers to the internal object ID by default, or + optionally any unique property value as specified by the `idProperty` + query param. Provided property values will be overwritten. Read-only and + non-existent properties will be ignored. Properties values can be + cleared by passing an empty string. + requestBody: + content: + application/json: + schema: + type: object + example: + properties: + velita: <string> + et_cf: <string> + aliqua_1e: <string> + ex8fc: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: postalMailId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + adipisicing9: <string> + nulla_a_: <string> + irure_478: <string> + cupidatat_3_0: <string> + ada1: <string> + updatedAt: <dateTime> + propertiesWithHistory: + reprehenderit_9: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "mollitcfa": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "Excepteur_c": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "eiusmoda22": [ + "<string>", + "<string>" + ], + "anim0bf": [ + "<string>", + "<string>" + ] + }, + "links": { + "quis_b_": "<string>", + "incididunt5b6": "<string>" + } + } + /crm/v3/objects/postal_mail/search: + post: + tags: + - Postal Mail API > Search + summary: post-/crm/v3/objects/postal mail/search do Search + requestBody: + content: {} + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + adipisicing9a: <string> + ex31: <string> + updatedAt: <dateTime> + propertiesWithHistory: + in_b: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + sed_1c2: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + in5b: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + non5d: <string> + updatedAt: <dateTime> + propertiesWithHistory: + eiusmod5: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + in_93: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "mollitcfa": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "Excepteur_c": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "eiusmoda22": [ + "<string>", + "<string>" + ], + "anim0bf": [ + "<string>", + "<string>" + ] + }, + "links": { + "quis_b_": "<string>", + "incididunt5b6": "<string>" + } + } + /crm/v3/objects/tasks/batch/archive: + post: + tags: + - Tasks API > Batch + summary: Archive a batch of tasks by ID + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "Duis_1": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "et6_": [ + "<string>", + "<string>" + ], + "Duis_e6": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "officia80": [ + "<string>", + "<string>" + ], + "euf6": [ + "<string>", + "<string>" + ], + "incididuntb": [ + "<string>", + "<string>" + ], + "aliqua_a7": [ + "<string>", + "<string>" + ] + }, + "links": { + "aliquipdf5": "<string>", + "sed_82": "<string>" + } + } + /crm/v3/objects/tasks/batch/create: + post: + tags: + - Tasks API > Batch + summary: Create a batch of tasks + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - associations: + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + properties: + magna_07: <string> + - associations: + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + properties: + aliqua_8: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + do_21: <string> + deserunt_753: <string> + ina1: <string> + updatedAt: <dateTime> + propertiesWithHistory: + adipisicing_d1a: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + laborum_09: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + cupidatat2: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + dolore__ea: <string> + updatedAt: <dateTime> + propertiesWithHistory: + ullamcoaa: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PENDING + requestedAt: <dateTime> + links: + officia_64: <string> + eud: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + qui__3: <string> + updatedAt: <dateTime> + propertiesWithHistory: + in9f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + nostrud_a1: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + ut_5: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + dolorf: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + est_e: <string> + nisi_0: <string> + updatedAt: <dateTime> + propertiesWithHistory: + sit_a_2: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + aliquipf_d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PENDING + numErrors: <integer> + errors: + - category: <string> + context: + amet_4d: + - <string> + - <string> + qui_3: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + ea2: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + occaecat0: + - <string> + - <string> + links: + velit4: <string> + deserunt_bb: <string> + commodo_d8: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + quis_7df: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + eu_3: + - <string> + - <string> + ipsum_521: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + in_19: + - <string> + - <string> + links: + minim_31e: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + elit_: <string> + aliquipba: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "Duis_1": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "et6_": [ + "<string>", + "<string>" + ], + "Duis_e6": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "officia80": [ + "<string>", + "<string>" + ], + "euf6": [ + "<string>", + "<string>" + ], + "incididuntb": [ + "<string>", + "<string>" + ], + "aliqua_a7": [ + "<string>", + "<string>" + ] + }, + "links": { + "aliquipdf5": "<string>", + "sed_82": "<string>" + } + } + /crm/v3/objects/tasks/batch/update: + post: + tags: + - Tasks API > Batch + summary: Update a batch of tasks by internal ID, or unique property values + requestBody: + content: {} + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + do_21: <string> + deserunt_753: <string> + ina1: <string> + updatedAt: <dateTime> + propertiesWithHistory: + adipisicing_d1a: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + laborum_09: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + cupidatat2: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + dolore__ea: <string> + updatedAt: <dateTime> + propertiesWithHistory: + ullamcoaa: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PENDING + requestedAt: <dateTime> + links: + officia_64: <string> + eud: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + qui__3: <string> + updatedAt: <dateTime> + propertiesWithHistory: + in9f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + nostrud_a1: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + ut_5: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + dolorf: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + est_e: <string> + nisi_0: <string> + updatedAt: <dateTime> + propertiesWithHistory: + sit_a_2: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + aliquipf_d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PENDING + numErrors: <integer> + errors: + - category: <string> + context: + amet_4d: + - <string> + - <string> + qui_3: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + ea2: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + occaecat0: + - <string> + - <string> + links: + velit4: <string> + deserunt_bb: <string> + commodo_d8: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + quis_7df: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + eu_3: + - <string> + - <string> + ipsum_521: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + in_19: + - <string> + - <string> + links: + minim_31e: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + elit_: <string> + aliquipba: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "Duis_1": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "et6_": [ + "<string>", + "<string>" + ], + "Duis_e6": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "officia80": [ + "<string>", + "<string>" + ], + "euf6": [ + "<string>", + "<string>" + ], + "incididuntb": [ + "<string>", + "<string>" + ], + "aliqua_a7": [ + "<string>", + "<string>" + ] + }, + "links": { + "aliquipdf5": "<string>", + "sed_82": "<string>" + } + } + /crm/v3/objects/tasks/batch/read: + post: + tags: + - Tasks API > Batch + summary: Read a batch of tasks by internal ID, or unique property values + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + properties: + - <string> + - <string> + propertiesWithHistory: + - <string> + - <string> + idProperty: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + do_21: <string> + deserunt_753: <string> + ina1: <string> + updatedAt: <dateTime> + propertiesWithHistory: + adipisicing_d1a: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + laborum_09: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + cupidatat2: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + dolore__ea: <string> + updatedAt: <dateTime> + propertiesWithHistory: + ullamcoaa: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PENDING + requestedAt: <dateTime> + links: + officia_64: <string> + eud: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + qui__3: <string> + updatedAt: <dateTime> + propertiesWithHistory: + in9f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + nostrud_a1: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + ut_5: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + dolorf: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + est_e: <string> + nisi_0: <string> + updatedAt: <dateTime> + propertiesWithHistory: + sit_a_2: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + aliquipf_d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PENDING + numErrors: <integer> + errors: + - category: <string> + context: + amet_4d: + - <string> + - <string> + qui_3: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + ea2: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + occaecat0: + - <string> + - <string> + links: + velit4: <string> + deserunt_bb: <string> + commodo_d8: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + quis_7df: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + eu_3: + - <string> + - <string> + ipsum_521: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + in_19: + - <string> + - <string> + links: + minim_31e: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + elit_: <string> + aliquipba: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "Duis_1": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "et6_": [ + "<string>", + "<string>" + ], + "Duis_e6": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "officia80": [ + "<string>", + "<string>" + ], + "euf6": [ + "<string>", + "<string>" + ], + "incididuntb": [ + "<string>", + "<string>" + ], + "aliqua_a7": [ + "<string>", + "<string>" + ] + }, + "links": { + "aliquipdf5": "<string>", + "sed_82": "<string>" + } + } + /crm/v3/objects/tasks/{taskId}: + get: + tags: + - Tasks API > Basic + summary: Read + description: >- + Read an Object identified by `{taskId}`. `{taskId}` refers to the + internal object ID by default, or optionally any unique property value + as specified by the `idProperty` query param. Control what is returned + via the `properties` query param. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: taskId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + aliquip_0b4: <string> + dolore_8ed: <string> + amet51e: <string> + in_7: <string> + ea9: <string> + updatedAt: <dateTime> + propertiesWithHistory: + dolor_00: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + mollit_f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + laborum_d_: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + Duis_3: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + consectetur_05d: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "Duis_1": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "et6_": [ + "<string>", + "<string>" + ], + "Duis_e6": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "officia80": [ + "<string>", + "<string>" + ], + "euf6": [ + "<string>", + "<string>" + ], + "incididuntb": [ + "<string>", + "<string>" + ], + "aliqua_a7": [ + "<string>", + "<string>" + ] + }, + "links": { + "aliquipdf5": "<string>", + "sed_82": "<string>" + } + } + delete: + tags: + - Tasks API > Basic + summary: Archive + description: Move an Object identified by `{taskId}` to the recycling bin. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: taskId + in: path + schema: + type: string + required: true + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "Duis_1": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "et6_": [ + "<string>", + "<string>" + ], + "Duis_e6": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "officia80": [ + "<string>", + "<string>" + ], + "euf6": [ + "<string>", + "<string>" + ], + "incididuntb": [ + "<string>", + "<string>" + ], + "aliqua_a7": [ + "<string>", + "<string>" + ] + }, + "links": { + "aliquipdf5": "<string>", + "sed_82": "<string>" + } + } + patch: + tags: + - Tasks API > Basic + summary: Update + description: >- + Perform a partial update of an Object identified by `{taskId}`. + `{taskId}` refers to the internal object ID by default, or optionally + any unique property value as specified by the `idProperty` query param. + Provided property values will be overwritten. Read-only and non-existent + properties will be ignored. Properties values can be cleared by passing + an empty string. + requestBody: + content: + application/json: + schema: + type: object + example: + properties: + laborisab5: <string> + aliquip8: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: taskId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + nulla_13: <string> + consectetur_333: <string> + ullamco_63: <string> + updatedAt: <dateTime> + propertiesWithHistory: + consectetur__: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + eiusmode07: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + commodo_75f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "Duis_1": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "et6_": [ + "<string>", + "<string>" + ], + "Duis_e6": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "officia80": [ + "<string>", + "<string>" + ], + "euf6": [ + "<string>", + "<string>" + ], + "incididuntb": [ + "<string>", + "<string>" + ], + "aliqua_a7": [ + "<string>", + "<string>" + ] + }, + "links": { + "aliquipdf5": "<string>", + "sed_82": "<string>" + } + } + /crm/v3/objects/tasks: + get: + tags: + - Tasks API > Basic + summary: List + description: >- + Read a page of tasks. Control what is returned via the `properties` + query param. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: limit + in: query + schema: + type: integer + description: The maximum number of results to display per page. + example: '10' + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + sintf9: <string> + culpabef: <string> + incididunt_e: <string> + updatedAt: <dateTime> + propertiesWithHistory: + mollit7ea: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + culpa_1: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + labore_a: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + - createdAt: <dateTime> + id: <string> + properties: + quis_21: <string> + updatedAt: <dateTime> + propertiesWithHistory: + velit_8: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + consequat_7: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + id_5: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "Duis_1": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "et6_": [ + "<string>", + "<string>" + ], + "Duis_e6": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "officia80": [ + "<string>", + "<string>" + ], + "euf6": [ + "<string>", + "<string>" + ], + "incididuntb": [ + "<string>", + "<string>" + ], + "aliqua_a7": [ + "<string>", + "<string>" + ] + }, + "links": { + "aliquipdf5": "<string>", + "sed_82": "<string>" + } + } + post: + tags: + - Tasks API > Basic + summary: Create + description: >- + Create a task with the given properties and return a copy of the object, + including the ID. Documentation and examples for creating standard tasks + is provided. + requestBody: + content: + application/json: + schema: + type: object + example: + associations: + - to: + id: <string> + types: + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + properties: + sit__57: <string> + eiusmod_3c_: <string> + cillum_f: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + nulla_13: <string> + consectetur_333: <string> + ullamco_63: <string> + updatedAt: <dateTime> + propertiesWithHistory: + consectetur__: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + eiusmode07: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + commodo_75f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "Duis_1": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "et6_": [ + "<string>", + "<string>" + ], + "Duis_e6": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "officia80": [ + "<string>", + "<string>" + ], + "euf6": [ + "<string>", + "<string>" + ], + "incididuntb": [ + "<string>", + "<string>" + ], + "aliqua_a7": [ + "<string>", + "<string>" + ] + }, + "links": { + "aliquipdf5": "<string>", + "sed_82": "<string>" + } + } + /crm/v3/objects/tasks/search: + post: + tags: + - Tasks API > Search + summary: post-/crm/v3/objects/tasks/search do Search + requestBody: + content: {} + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + Ut_: <string> + nostrud_3b9: <string> + in__d: <string> + updatedAt: <dateTime> + propertiesWithHistory: + nullaa: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + dolore_3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + ametb: <string> + cupidatat6f: <string> + amet_: <string> + updatedAt: <dateTime> + propertiesWithHistory: + consequat_44: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + adf: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + proident_b: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + veniam_1: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + doloref4c: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "Duis_1": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "et6_": [ + "<string>", + "<string>" + ], + "Duis_e6": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "officia80": [ + "<string>", + "<string>" + ], + "euf6": [ + "<string>", + "<string>" + ], + "incididuntb": [ + "<string>", + "<string>" + ], + "aliqua_a7": [ + "<string>", + "<string>" + ] + }, + "links": { + "aliquipdf5": "<string>", + "sed_82": "<string>" + } + } + /crm/v3/objects/communications/batch/update: + post: + tags: + - Communications API > Batch + summary: >- + Update a batch of communications by internal ID, or unique property + values + requestBody: + content: {} + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + veniam_: <string> + nostrudc: <string> + updatedAt: <dateTime> + propertiesWithHistory: + proident_fc: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + occaecat_5b: <string> + laboris16: <string> + updatedAt: <dateTime> + propertiesWithHistory: + consectetur0_e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PENDING + requestedAt: <dateTime> + links: + culpa5: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + aliquipa: <string> + updatedAt: <dateTime> + propertiesWithHistory: + ut9: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + eiusmod7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + esse_2c: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + proident_b: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + dolore98: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + consectetur_9: <string> + officiab: <string> + updatedAt: <dateTime> + propertiesWithHistory: + irure_d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: COMPLETE + numErrors: <integer> + errors: + - category: <string> + context: + auteac: + - <string> + - <string> + eiusmod_3c: + - <string> + - <string> + sit73: + - <string> + - <string> + ex_a7f: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + non9e: + - <string> + - <string> + cillum6d4: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + laborum_f73: + - <string> + - <string> + links: + qui2: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + eu_03: + - <string> + - <string> + voluptate_f1e: + - <string> + - <string> + labore_d_e: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + elit_b8d: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + add0: + - <string> + - <string> + laborumc3: + - <string> + - <string> + dolor00: + - <string> + - <string> + inf: + - <string> + - <string> + links: + velit_b70: <string> + nostrud28: <string> + consequatb0: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + ex_9b8: <string> + aute49: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "non_6a": [ + "<string>", + "<string>" + ], + "incididunt69": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ad_e": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "et_7": [ + "<string>", + "<string>" + ], + "Lorem_11": [ + "<string>", + "<string>" + ], + "et_ca7": [ + "<string>", + "<string>" + ] + }, + "links": { + "eiusmod__01": "<string>", + "minimd": "<string>" + } + } + /crm/v3/objects/communications/batch/archive: + post: + tags: + - Communications API > Batch + summary: Archive a batch of communications by ID + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "non_6a": [ + "<string>", + "<string>" + ], + "incididunt69": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ad_e": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "et_7": [ + "<string>", + "<string>" + ], + "Lorem_11": [ + "<string>", + "<string>" + ], + "et_ca7": [ + "<string>", + "<string>" + ] + }, + "links": { + "eiusmod__01": "<string>", + "minimd": "<string>" + } + } + /crm/v3/objects/communications/batch/create: + post: + tags: + - Communications API > Batch + summary: Create a batch of communications + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - associations: + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + properties: + adipisicing6e: <string> + - associations: + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: INTEGRATOR_DEFINED + associationTypeId: <integer> + properties: + incididuntb6e: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + veniam_: <string> + nostrudc: <string> + updatedAt: <dateTime> + propertiesWithHistory: + proident_fc: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + occaecat_5b: <string> + laboris16: <string> + updatedAt: <dateTime> + propertiesWithHistory: + consectetur0_e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PENDING + requestedAt: <dateTime> + links: + culpa5: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + aliquipa: <string> + updatedAt: <dateTime> + propertiesWithHistory: + ut9: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + eiusmod7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + esse_2c: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + proident_b: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + dolore98: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + consectetur_9: <string> + officiab: <string> + updatedAt: <dateTime> + propertiesWithHistory: + irure_d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: COMPLETE + numErrors: <integer> + errors: + - category: <string> + context: + auteac: + - <string> + - <string> + eiusmod_3c: + - <string> + - <string> + sit73: + - <string> + - <string> + ex_a7f: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + non9e: + - <string> + - <string> + cillum6d4: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + laborum_f73: + - <string> + - <string> + links: + qui2: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + eu_03: + - <string> + - <string> + voluptate_f1e: + - <string> + - <string> + labore_d_e: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + elit_b8d: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + add0: + - <string> + - <string> + laborumc3: + - <string> + - <string> + dolor00: + - <string> + - <string> + inf: + - <string> + - <string> + links: + velit_b70: <string> + nostrud28: <string> + consequatb0: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + ex_9b8: <string> + aute49: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "non_6a": [ + "<string>", + "<string>" + ], + "incididunt69": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ad_e": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "et_7": [ + "<string>", + "<string>" + ], + "Lorem_11": [ + "<string>", + "<string>" + ], + "et_ca7": [ + "<string>", + "<string>" + ] + }, + "links": { + "eiusmod__01": "<string>", + "minimd": "<string>" + } + } + /crm/v3/objects/communications/batch/read: + post: + tags: + - Communications API > Batch + summary: Read a batch of communications by internal ID, or unique property values + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + properties: + - <string> + - <string> + propertiesWithHistory: + - <string> + - <string> + idProperty: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + veniam_: <string> + nostrudc: <string> + updatedAt: <dateTime> + propertiesWithHistory: + proident_fc: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + occaecat_5b: <string> + laboris16: <string> + updatedAt: <dateTime> + propertiesWithHistory: + consectetur0_e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: PENDING + requestedAt: <dateTime> + links: + culpa5: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + aliquipa: <string> + updatedAt: <dateTime> + propertiesWithHistory: + ut9: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + eiusmod7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + esse_2c: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + proident_b: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + dolore98: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + consectetur_9: <string> + officiab: <string> + updatedAt: <dateTime> + propertiesWithHistory: + irure_d: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + startedAt: <dateTime> + status: COMPLETE + numErrors: <integer> + errors: + - category: <string> + context: + auteac: + - <string> + - <string> + eiusmod_3c: + - <string> + - <string> + sit73: + - <string> + - <string> + ex_a7f: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + non9e: + - <string> + - <string> + cillum6d4: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + laborum_f73: + - <string> + - <string> + links: + qui2: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + eu_03: + - <string> + - <string> + voluptate_f1e: + - <string> + - <string> + labore_d_e: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + elit_b8d: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + add0: + - <string> + - <string> + laborumc3: + - <string> + - <string> + dolor00: + - <string> + - <string> + inf: + - <string> + - <string> + links: + velit_b70: <string> + nostrud28: <string> + consequatb0: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + ex_9b8: <string> + aute49: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "non_6a": [ + "<string>", + "<string>" + ], + "incididunt69": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ad_e": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "et_7": [ + "<string>", + "<string>" + ], + "Lorem_11": [ + "<string>", + "<string>" + ], + "et_ca7": [ + "<string>", + "<string>" + ] + }, + "links": { + "eiusmod__01": "<string>", + "minimd": "<string>" + } + } + /crm/v3/objects/communications: + get: + tags: + - Communications API > Basic + summary: List + description: >- + Read a page of communications. Control what is returned via the + `properties` query param. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: limit + in: query + schema: + type: integer + description: The maximum number of results to display per page. + example: '10' + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + dolore_9: <string> + updatedAt: <dateTime> + propertiesWithHistory: + nulla_9: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + dolor_bbc: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + laborum957: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + dolore_4a: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + - createdAt: <dateTime> + id: <string> + properties: + cupidatat_3: <string> + updatedAt: <dateTime> + propertiesWithHistory: + aute8: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + enim1: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + minim_b: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + quis_ba: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + proident08: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + magna__3c: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + inf: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + velit_: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "non_6a": [ + "<string>", + "<string>" + ], + "incididunt69": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ad_e": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "et_7": [ + "<string>", + "<string>" + ], + "Lorem_11": [ + "<string>", + "<string>" + ], + "et_ca7": [ + "<string>", + "<string>" + ] + }, + "links": { + "eiusmod__01": "<string>", + "minimd": "<string>" + } + } + post: + tags: + - Communications API > Basic + summary: Create + description: >- + Create a communication with the given properties and return a copy of + the object, including the ID. Documentation and examples for creating + standard communications is provided. + requestBody: + content: + application/json: + schema: + type: object + example: + associations: + - to: + id: <string> + types: + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + - to: + id: <string> + types: + - associationCategory: USER_DEFINED + associationTypeId: <integer> + - associationCategory: HUBSPOT_DEFINED + associationTypeId: <integer> + properties: + suntb1: <string> + officiae: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + id_6: <string> + updatedAt: <dateTime> + propertiesWithHistory: + sit_5ea: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + dolor_09c: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "non_6a": [ + "<string>", + "<string>" + ], + "incididunt69": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ad_e": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "et_7": [ + "<string>", + "<string>" + ], + "Lorem_11": [ + "<string>", + "<string>" + ], + "et_ca7": [ + "<string>", + "<string>" + ] + }, + "links": { + "eiusmod__01": "<string>", + "minimd": "<string>" + } + } + /crm/v3/objects/communications/{communicationId}: + get: + tags: + - Communications API > Basic + summary: Read + description: >- + Read an Object identified by `{communicationId}`. `{communicationId}` + refers to the internal object ID by default, or optionally any unique + property value as specified by the `idProperty` query param. Control + what is returned via the `properties` query param. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: communicationId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + eiusmod_c: <string> + magna5: <string> + updatedAt: <dateTime> + propertiesWithHistory: + exercitation_e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + associations: + aliqua_d52: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "non_6a": [ + "<string>", + "<string>" + ], + "incididunt69": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ad_e": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "et_7": [ + "<string>", + "<string>" + ], + "Lorem_11": [ + "<string>", + "<string>" + ], + "et_ca7": [ + "<string>", + "<string>" + ] + }, + "links": { + "eiusmod__01": "<string>", + "minimd": "<string>" + } + } + delete: + tags: + - Communications API > Basic + summary: Archive + description: Move an Object identified by `{communicationId}` to the recycling bin. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: communicationId + in: path + schema: + type: string + required: true + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "non_6a": [ + "<string>", + "<string>" + ], + "incididunt69": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ad_e": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "et_7": [ + "<string>", + "<string>" + ], + "Lorem_11": [ + "<string>", + "<string>" + ], + "et_ca7": [ + "<string>", + "<string>" + ] + }, + "links": { + "eiusmod__01": "<string>", + "minimd": "<string>" + } + } + patch: + tags: + - Communications API > Basic + summary: Update + description: >- + Perform a partial update of an Object identified by `{communicationId}`. + `{communicationId}` refers to the internal object ID by default, or + optionally any unique property value as specified by the `idProperty` + query param. Provided property values will be overwritten. Read-only and + non-existent properties will be ignored. Properties values can be + cleared by passing an empty string. + requestBody: + content: + application/json: + schema: + type: object + example: + properties: + nulla_6_5: <string> + sit_85e: <string> + Duis7cc: <string> + aliqua_0: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: communicationId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + id_6: <string> + updatedAt: <dateTime> + propertiesWithHistory: + sit_5ea: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + dolor_09c: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "non_6a": [ + "<string>", + "<string>" + ], + "incididunt69": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ad_e": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "et_7": [ + "<string>", + "<string>" + ], + "Lorem_11": [ + "<string>", + "<string>" + ], + "et_ca7": [ + "<string>", + "<string>" + ] + }, + "links": { + "eiusmod__01": "<string>", + "minimd": "<string>" + } + } + /crm/v3/objects/communications/search: + post: + tags: + - Communications API > Search + summary: post-/crm/v3/objects/communications/search do Search + requestBody: + content: {} + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + occaecat_aef: <string> + et1d1: <string> + updatedAt: <dateTime> + propertiesWithHistory: + deserunt_75e: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + fugiatf12: <string> + in_2: <string> + ullamco3: <string> + updatedAt: <dateTime> + propertiesWithHistory: + dolorf: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + inb: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + archived: <boolean> + archivedAt: <dateTime> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "non_6a": [ + "<string>", + "<string>" + ], + "incididunt69": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "ad_e": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "et_7": [ + "<string>", + "<string>" + ], + "Lorem_11": [ + "<string>", + "<string>" + ], + "et_ca7": [ + "<string>", + "<string>" + ] + }, + "links": { + "eiusmod__01": "<string>", + "minimd": "<string>" + } + } diff --git a/server/node-service/src/plugins/hubspot/specsV4/Events API Collections.json b/server/node-service/src/plugins/hubspot/specsV4/Events API Collections.json new file mode 100644 index 000000000..7efafc52e --- /dev/null +++ b/server/node-service/src/plugins/hubspot/specsV4/Events API Collections.json @@ -0,0 +1,2062 @@ +openapi: 3.0.0 +info: + title: Events API Collections + description: >- + Custom events enable you to define and track events that are unique to your + business, such as events on your site or in an app. You can configure events + to store information within properties, which you can then use across + HubSpot's tools. + + + To send [custom + event](https://developers.hubspot.com/docs/api/analytics/events) data to + HubSpot, you first need to define the event. This is similar to custom CRM + objects, where you first need to define the custom object before you can + create individual records for that object. An event definition includes + details such as its metadata, CRM object associations, and properties. + + + Below, learn more about creating and managing event definitions using the + API. To learn how to create event definitions without using the API, check + out [HubSpot's Knowledge + Base](https://knowledge.hubspot.com/analytics-tools/create-custom-behavioral-events-with-the-code-wizard). + + + **Fork the collections using Run in Postman:** + + + [<img src="https://run.pstmn.io/button.svg" alt="Run In + Postman">](https://app.getpostman.com/run-collection/26126890-7e433548-43f3-4a64-83b5-989f6e81694f?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D26126890-7e433548-43f3-4a64-83b5-989f6e81694f%26entityType%3Dcollection%26workspaceId%3Dd7645f33-539d-49c6-9e0c-efa6faae355d) + version: 1.0.0 +servers: + - url: http://{{baseurl}} +components: + securitySchemes: + apikeyAuth: + type: http + scheme: apikey +tags: + - name: Custom Behavioral Events API + description: "Custom events are account-defined events that store event details in event properties. There are three types of custom events that you can create in HubSpot:\n\n- [Clicked element](https://knowledge.hubspot.com/analytics-tools/create-clicked-element-events)\_and\_[visited URL ](https://knowledge.hubspot.com/analytics-tools/create-visited-url-events)\_events are custom events that the tracking code automatically populates with data. You can further customize these events by updating your tracking code with the\_[trackCustomEvent](https://developers.hubspot.com/docs/api/events/tracking-code#events-js-api)\_function.\_\n \n- [Manually tracked events](https://knowledge.hubspot.com/analytics-tools/create-custom-behavioral-events)\_are\_custom events that are unique to your business that are not captured automatically by HubSpot or by an integration. You can manually send data to these events through this API.\n \n\nBelow, learn how to create a manually tracked custom event, send event data through the API, and to use event data once captured.\n\n## Define the event\n\nTo send event completion data to HubSpot, you first need to define the event itself, including its metadata, CRM object associations, and properties. You can define events using the\_[custom event definition API](https://developers.hubspot.com/docs/api/events/custom-events), or if you have a\_Marketing Hub\_Enterprise\_subscription you can\_[create the event in HubSpot](https://knowledge.hubspot.com/analytics-tools/create-custom-behavioral-events). When creating the event, HubSpot will include a set of default event properties that you can use to store event data. You can also create additional properties for the event. These properties can be created or edited at any time.\_\n\nOnce you’ve set up your event, you can send data to it through the API." + - name: Custom Behavioral Events API > Custom Behavioral Events API + - name: Custom Event Definitions API + description: "Custom events enable you to define and track events that are unique to your business, such as events on your site or in an app. You can configure events to store information within properties, which you can then use across HubSpot's tools.\_\n\nTo send\_[custom event](https://developers.hubspot.com/docs/api/analytics/events)\_data to HubSpot, you first need to define the event. This is similar to custom CRM objects, where you first need to define the custom object before you can create individual records for that object.\_An event definition includes details such as its metadata, CRM object associations, and properties.\n\nBelow, learn more about creating and managing event definitions using the API. To learn how to create event definitions without using the API, check out\_[HubSpot's Knowledge Base](https://knowledge.hubspot.com/analytics-tools/create-custom-behavioral-events-with-the-code-wizard).\n\n## Create an event definition\n\nTo create the custom event schema, make a\_`POST`\_request to\_`events/v3/event-definitions`. In the request body, include definitions for your event schema, including its label, name, CRM object associations, and custom properties.\n\nBelow is an example request body along with parameter definitions. For a full example, view the\_[custom event example below](https://developers.hubspot.com/docs/api/events/custom-events#custom-event-example).\n\n| `label`\_\_**string**\_(required)<br><br>The event's human readable label, which will display in HubSpot (up to 100 characters). Long labels may be cut off in certain parts of HubSpot's UI. |\n| `name`\_\_**string**<br><br>The unique, internal name of the event, which you'll use to reference the event through the API. If no value is provided, HubSpot will automatically generate one based on the\_`label`. This property\_cannot\_be changed after the event definition is created.<br><br>Note the following naming requirements:\_<br><br>- This property can only contain lowercase letters, numbers, underscores, and hyphens (up to 50 characters).<br> <br>- The first character must be a letter. |\n| `description`\_\_**string**<br><br>The event's description, which will display in HubSpot. |\n| `primaryObject`\_\_**string**<br><br>The CRM object that the event will be associated with. Event completions will display on CRM record timelines of the specified object. Can be one of\_`CONTACT`,\_`COMPANY`,\_`DEAL`,\_`TICKET`\_or\_`CUSTOM OBJECT NAME`.<br><br>If no value is provided, HubSpot will automatically associate the event with contacts. This\_cannot\_be changed after the event definition is created. |\n| `propertyDefinitions`\_\_**array**<br><br>For each custom event definition, HubSpot provides a set of default properties that you can use when sending event data. Include this array to define any custom properties that your event needs outside of those default properties. You can include up to 50 custom properties per event.<br><br>For each property, include:<br><br>- `label`: the property's in-app label.<br> <br>- `name`: the property's internal name, which you'll use when sending property data through the API.<br> <br>- `type`: the\_[type of property](https://developers.hubspot.com/docs/api/events/custom-events#custom-property-types). Default is\_`string`.<br> <br>- `options`: for\_`enumeration`\_properties, the array of pre-defined values, including a\_`label`\_and\_`value`\_for each.<br> <br>- `description`: optional text to describe the property. |" + - name: Custom Event Definitions API > Event definition + - name: Custom Event Definitions API > Event tracking +paths: + /events/v3/send: + post: + tags: + - Custom Event Definitions API > Event tracking + summary: Send custom event completion data + description: Send event data to HubSpot using an existing custom event definition. + requestBody: + content: + application/json: + schema: + type: object + example: + eventName: <string> + occurredAt: <dateTime> + utk: <string> + uuid: <string> + email: <string> + properties: + site: <string> + objectId: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "reprehenderit36": [ + "<string>", + "<string>" + ], + "laboris0_": [ + "<string>", + "<string>" + ], + "laborumfb": [ + "<string>", + "<string>" + ], + "Duis_81": [ + "<string>", + "<string>" + ] + }, + "links": { + "dolore_dbd": "<string>", + "non_52": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "occaecat_805": [ + "<string>", + "<string>" + ], + "anim_9e": [ + "<string>", + "<string>" + ], + "consectetur_c6c": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "dolor2": [ + "<string>", + "<string>" + ], + "eu1": [ + "<string>", + "<string>" + ], + "adipisicing_1": [ + "<string>", + "<string>" + ], + "labore_06": [ + "<string>", + "<string>" + ] + } + } + ] + } + /events/v3/event-definitions: + get: + tags: + - Custom Event Definitions API > Event definition + summary: Query custom event definitions + description: Search for existing custom event definitions. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: searchString + in: query + schema: + type: string + description: >- + Characters in the event name that the user is searching for. This + search is a naive “contains” search, no fuzzy matching is done. + example: <string> + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: limit + in: query + schema: + type: string + description: The maximum number of results to display per page. + example: <integer> + - name: includeProperties + in: query + schema: + type: string + example: <boolean> + - name: sortOrder + in: query + schema: + type: string + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - archived: <boolean> + associations: + - allowsCustomLabels: <boolean> + cardinality: ONE_TO_ONE + category: USER_DEFINED + fromObjectTypeId: <string> + hasAllAssociatedObjects: <boolean> + hasCascadingDeletes: <boolean> + hasUserEnforcedMaxFromObjectIds: <boolean> + hasUserEnforcedMaxToObjectIds: <boolean> + hidden: <boolean> + id: <integer> + inverseAllowsCustomLabels: <boolean> + inverseCardinality: ONE_TO_ONE + inverseHasAllAssociatedObjects: <boolean> + inverseId: <integer> + inverseName: <string> + isInversePrimary: <boolean> + isPrimary: <boolean> + maxFromObjectIds: <integer> + maxToObjectIds: <integer> + name: <string> + portalUniqueIdentifier: <string> + toObjectTypeId: <string> + inverseLabel: <string> + fromObjectType: AD_CAMPAIGN + toObjectType: TEMPLATE + label: <string> + - allowsCustomLabels: <boolean> + cardinality: ONE_TO_MANY + category: HUBSPOT_DEFINED + fromObjectTypeId: <string> + hasAllAssociatedObjects: <boolean> + hasCascadingDeletes: <boolean> + hasUserEnforcedMaxFromObjectIds: <boolean> + hasUserEnforcedMaxToObjectIds: <boolean> + hidden: <boolean> + id: <integer> + inverseAllowsCustomLabels: <boolean> + inverseCardinality: ONE_TO_MANY + inverseHasAllAssociatedObjects: <boolean> + inverseId: <integer> + inverseName: <string> + isInversePrimary: <boolean> + isPrimary: <boolean> + maxFromObjectIds: <integer> + maxToObjectIds: <integer> + name: <string> + portalUniqueIdentifier: <string> + toObjectTypeId: <string> + inverseLabel: <string> + fromObjectType: AD + toObjectType: SOCIAL_PROFILE + label: <string> + fullyQualifiedName: <string> + id: <string> + labels: + singular: <string> + plural: <string> + name: <string> + objectTypeId: <string> + properties: + - description: <string> + fieldType: <string> + groupName: <string> + label: <string> + name: <string> + options: + - hidden: <boolean> + label: <string> + value: <string> + displayOrder: <integer> + description: <string> + - hidden: <boolean> + label: <string> + value: <string> + displayOrder: <integer> + description: <string> + type: <string> + createdUserId: <string> + hidden: <boolean> + modificationMetadata: + archivable: <boolean> + readOnlyDefinition: <boolean> + readOnlyValue: <boolean> + readOnlyOptions: <boolean> + displayOrder: <integer> + showCurrencySymbol: <boolean> + hubspotDefined: <boolean> + formField: <boolean> + createdAt: <dateTime> + archivedAt: <dateTime> + archived: <boolean> + referencedObjectType: <string> + calculationFormula: <string> + hasUniqueValue: <boolean> + updatedUserId: <string> + calculated: <boolean> + externalOptions: <boolean> + updatedAt: <dateTime> + - description: <string> + fieldType: <string> + groupName: <string> + label: <string> + name: <string> + options: + - hidden: <boolean> + label: <string> + value: <string> + displayOrder: <integer> + description: <string> + - hidden: <boolean> + label: <string> + value: <string> + displayOrder: <integer> + description: <string> + type: <string> + createdUserId: <string> + hidden: <boolean> + modificationMetadata: + archivable: <boolean> + readOnlyDefinition: <boolean> + readOnlyValue: <boolean> + readOnlyOptions: <boolean> + displayOrder: <integer> + showCurrencySymbol: <boolean> + hubspotDefined: <boolean> + formField: <boolean> + createdAt: <dateTime> + archivedAt: <dateTime> + archived: <boolean> + referencedObjectType: <string> + calculationFormula: <string> + hasUniqueValue: <boolean> + updatedUserId: <string> + calculated: <boolean> + externalOptions: <boolean> + updatedAt: <dateTime> + createdUserId: <integer> + trackingType: VISITED_URL + description: <string> + primaryObjectId: <string> + primaryObject: <string> + createdAt: <dateTime> + - archived: <boolean> + associations: + - allowsCustomLabels: <boolean> + cardinality: ONE_TO_MANY + category: USER_DEFINED + fromObjectTypeId: <string> + hasAllAssociatedObjects: <boolean> + hasCascadingDeletes: <boolean> + hasUserEnforcedMaxFromObjectIds: <boolean> + hasUserEnforcedMaxToObjectIds: <boolean> + hidden: <boolean> + id: <integer> + inverseAllowsCustomLabels: <boolean> + inverseCardinality: ONE_TO_MANY + inverseHasAllAssociatedObjects: <boolean> + inverseId: <integer> + inverseName: <string> + isInversePrimary: <boolean> + isPrimary: <boolean> + maxFromObjectIds: <integer> + maxToObjectIds: <integer> + name: <string> + portalUniqueIdentifier: <string> + toObjectTypeId: <string> + inverseLabel: <string> + fromObjectType: CAMPAIGN_TEMPLATE + toObjectType: SITE_PAGE + label: <string> + - allowsCustomLabels: <boolean> + cardinality: ONE_TO_ONE + category: USER_DEFINED + fromObjectTypeId: <string> + hasAllAssociatedObjects: <boolean> + hasCascadingDeletes: <boolean> + hasUserEnforcedMaxFromObjectIds: <boolean> + hasUserEnforcedMaxToObjectIds: <boolean> + hidden: <boolean> + id: <integer> + inverseAllowsCustomLabels: <boolean> + inverseCardinality: ONE_TO_MANY + inverseHasAllAssociatedObjects: <boolean> + inverseId: <integer> + inverseName: <string> + isInversePrimary: <boolean> + isPrimary: <boolean> + maxFromObjectIds: <integer> + maxToObjectIds: <integer> + name: <string> + portalUniqueIdentifier: <string> + toObjectTypeId: <string> + inverseLabel: <string> + fromObjectType: PLAYLIST + toObjectType: SOCIAL_PROFILE + label: <string> + fullyQualifiedName: <string> + id: <string> + labels: + singular: <string> + plural: <string> + name: <string> + objectTypeId: <string> + properties: + - description: <string> + fieldType: <string> + groupName: <string> + label: <string> + name: <string> + options: + - hidden: <boolean> + label: <string> + value: <string> + displayOrder: <integer> + description: <string> + - hidden: <boolean> + label: <string> + value: <string> + displayOrder: <integer> + description: <string> + type: <string> + createdUserId: <string> + hidden: <boolean> + modificationMetadata: + archivable: <boolean> + readOnlyDefinition: <boolean> + readOnlyValue: <boolean> + readOnlyOptions: <boolean> + displayOrder: <integer> + showCurrencySymbol: <boolean> + hubspotDefined: <boolean> + formField: <boolean> + createdAt: <dateTime> + archivedAt: <dateTime> + archived: <boolean> + referencedObjectType: <string> + calculationFormula: <string> + hasUniqueValue: <boolean> + updatedUserId: <string> + calculated: <boolean> + externalOptions: <boolean> + updatedAt: <dateTime> + - description: <string> + fieldType: <string> + groupName: <string> + label: <string> + name: <string> + options: + - hidden: <boolean> + label: <string> + value: <string> + displayOrder: <integer> + description: <string> + - hidden: <boolean> + label: <string> + value: <string> + displayOrder: <integer> + description: <string> + type: <string> + createdUserId: <string> + hidden: <boolean> + modificationMetadata: + archivable: <boolean> + readOnlyDefinition: <boolean> + readOnlyValue: <boolean> + readOnlyOptions: <boolean> + displayOrder: <integer> + showCurrencySymbol: <boolean> + hubspotDefined: <boolean> + formField: <boolean> + createdAt: <dateTime> + archivedAt: <dateTime> + archived: <boolean> + referencedObjectType: <string> + calculationFormula: <string> + hasUniqueValue: <boolean> + updatedUserId: <string> + calculated: <boolean> + externalOptions: <boolean> + updatedAt: <dateTime> + createdUserId: <integer> + trackingType: VISITED_URL + description: <string> + primaryObjectId: <string> + primaryObject: <string> + createdAt: <dateTime> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "reprehenderit36": [ + "<string>", + "<string>" + ], + "laboris0_": [ + "<string>", + "<string>" + ], + "laborumfb": [ + "<string>", + "<string>" + ], + "Duis_81": [ + "<string>", + "<string>" + ] + }, + "links": { + "dolore_dbd": "<string>", + "non_52": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "occaecat_805": [ + "<string>", + "<string>" + ], + "anim_9e": [ + "<string>", + "<string>" + ], + "consectetur_c6c": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "dolor2": [ + "<string>", + "<string>" + ], + "eu1": [ + "<string>", + "<string>" + ], + "adipisicing_1": [ + "<string>", + "<string>" + ], + "labore_06": [ + "<string>", + "<string>" + ] + } + } + ] + } + post: + tags: + - Custom Event Definitions API > Event definition + summary: Create custom event definition + description: Create a custom event definition. + requestBody: + content: + application/json: + schema: + type: object + example: + label: <string> + propertyDefinitions: + - label: <string> + type: <string> + name: <string> + options: + - displayOrder: <integer> + hidden: <boolean> + label: <string> + value: <string> + description: <string> + - displayOrder: <integer> + hidden: <boolean> + label: <string> + value: <string> + description: <string> + description: <string> + - label: <string> + type: <string> + name: <string> + options: + - displayOrder: <integer> + hidden: <boolean> + label: <string> + value: <string> + description: <string> + - displayOrder: <integer> + hidden: <boolean> + label: <string> + value: <string> + description: <string> + description: <string> + name: <string> + description: <string> + primaryObject: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + archived: <boolean> + associations: + - allowsCustomLabels: <boolean> + cardinality: ONE_TO_ONE + category: HUBSPOT_DEFINED + fromObjectTypeId: <string> + hasAllAssociatedObjects: <boolean> + hasCascadingDeletes: <boolean> + hasUserEnforcedMaxFromObjectIds: <boolean> + hasUserEnforcedMaxToObjectIds: <boolean> + hidden: <boolean> + id: <integer> + inverseAllowsCustomLabels: <boolean> + inverseCardinality: ONE_TO_MANY + inverseHasAllAssociatedObjects: <boolean> + inverseId: <integer> + inverseName: <string> + isInversePrimary: <boolean> + isPrimary: <boolean> + maxFromObjectIds: <integer> + maxToObjectIds: <integer> + name: <string> + portalUniqueIdentifier: <string> + toObjectTypeId: <string> + inverseLabel: <string> + fromObjectType: CALL + toObjectType: CAMPAIGN_BUDGET_ITEM + label: <string> + - allowsCustomLabels: <boolean> + cardinality: ONE_TO_ONE + category: USER_DEFINED + fromObjectTypeId: <string> + hasAllAssociatedObjects: <boolean> + hasCascadingDeletes: <boolean> + hasUserEnforcedMaxFromObjectIds: <boolean> + hasUserEnforcedMaxToObjectIds: <boolean> + hidden: <boolean> + id: <integer> + inverseAllowsCustomLabels: <boolean> + inverseCardinality: ONE_TO_ONE + inverseHasAllAssociatedObjects: <boolean> + inverseId: <integer> + inverseName: <string> + isInversePrimary: <boolean> + isPrimary: <boolean> + maxFromObjectIds: <integer> + maxToObjectIds: <integer> + name: <string> + portalUniqueIdentifier: <string> + toObjectTypeId: <string> + inverseLabel: <string> + fromObjectType: PARTNER_CLIENT + toObjectType: PAYMENT_SCHEDULE_INSTALLMENT + label: <string> + fullyQualifiedName: <string> + id: <string> + labels: + singular: <string> + plural: <string> + name: <string> + objectTypeId: <string> + properties: + - description: <string> + fieldType: <string> + groupName: <string> + label: <string> + name: <string> + options: + - hidden: <boolean> + label: <string> + value: <string> + displayOrder: <integer> + description: <string> + - hidden: <boolean> + label: <string> + value: <string> + displayOrder: <integer> + description: <string> + type: <string> + createdUserId: <string> + hidden: <boolean> + modificationMetadata: + archivable: <boolean> + readOnlyDefinition: <boolean> + readOnlyValue: <boolean> + readOnlyOptions: <boolean> + displayOrder: <integer> + showCurrencySymbol: <boolean> + hubspotDefined: <boolean> + formField: <boolean> + createdAt: <dateTime> + archivedAt: <dateTime> + archived: <boolean> + referencedObjectType: <string> + calculationFormula: <string> + hasUniqueValue: <boolean> + updatedUserId: <string> + calculated: <boolean> + externalOptions: <boolean> + updatedAt: <dateTime> + - description: <string> + fieldType: <string> + groupName: <string> + label: <string> + name: <string> + options: + - hidden: <boolean> + label: <string> + value: <string> + displayOrder: <integer> + description: <string> + - hidden: <boolean> + label: <string> + value: <string> + displayOrder: <integer> + description: <string> + type: <string> + createdUserId: <string> + hidden: <boolean> + modificationMetadata: + archivable: <boolean> + readOnlyDefinition: <boolean> + readOnlyValue: <boolean> + readOnlyOptions: <boolean> + displayOrder: <integer> + showCurrencySymbol: <boolean> + hubspotDefined: <boolean> + formField: <boolean> + createdAt: <dateTime> + archivedAt: <dateTime> + archived: <boolean> + referencedObjectType: <string> + calculationFormula: <string> + hasUniqueValue: <boolean> + updatedUserId: <string> + calculated: <boolean> + externalOptions: <boolean> + updatedAt: <dateTime> + createdUserId: <integer> + trackingType: VISITED_URL + description: <string> + primaryObjectId: <string> + primaryObject: <string> + createdAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "reprehenderit36": [ + "<string>", + "<string>" + ], + "laboris0_": [ + "<string>", + "<string>" + ], + "laborumfb": [ + "<string>", + "<string>" + ], + "Duis_81": [ + "<string>", + "<string>" + ] + }, + "links": { + "dolore_dbd": "<string>", + "non_52": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "occaecat_805": [ + "<string>", + "<string>" + ], + "anim_9e": [ + "<string>", + "<string>" + ], + "consectetur_c6c": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "dolor2": [ + "<string>", + "<string>" + ], + "eu1": [ + "<string>", + "<string>" + ], + "adipisicing_1": [ + "<string>", + "<string>" + ], + "labore_06": [ + "<string>", + "<string>" + ] + } + } + ] + } + /events/v3/event-definitions/{eventName}: + get: + tags: + - Custom Event Definitions API > Event definition + summary: Fetch a specific custom event definition + description: Fetch a single custom event definition by name. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: eventName + in: path + schema: + type: string + required: true + description: (Required) The internal name of the custom event. + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + archived: <boolean> + associations: + - allowsCustomLabels: <boolean> + cardinality: ONE_TO_ONE + category: HUBSPOT_DEFINED + fromObjectTypeId: <string> + hasAllAssociatedObjects: <boolean> + hasCascadingDeletes: <boolean> + hasUserEnforcedMaxFromObjectIds: <boolean> + hasUserEnforcedMaxToObjectIds: <boolean> + hidden: <boolean> + id: <integer> + inverseAllowsCustomLabels: <boolean> + inverseCardinality: ONE_TO_MANY + inverseHasAllAssociatedObjects: <boolean> + inverseId: <integer> + inverseName: <string> + isInversePrimary: <boolean> + isPrimary: <boolean> + maxFromObjectIds: <integer> + maxToObjectIds: <integer> + name: <string> + portalUniqueIdentifier: <string> + toObjectTypeId: <string> + inverseLabel: <string> + fromObjectType: CALL + toObjectType: CAMPAIGN_BUDGET_ITEM + label: <string> + - allowsCustomLabels: <boolean> + cardinality: ONE_TO_ONE + category: USER_DEFINED + fromObjectTypeId: <string> + hasAllAssociatedObjects: <boolean> + hasCascadingDeletes: <boolean> + hasUserEnforcedMaxFromObjectIds: <boolean> + hasUserEnforcedMaxToObjectIds: <boolean> + hidden: <boolean> + id: <integer> + inverseAllowsCustomLabels: <boolean> + inverseCardinality: ONE_TO_ONE + inverseHasAllAssociatedObjects: <boolean> + inverseId: <integer> + inverseName: <string> + isInversePrimary: <boolean> + isPrimary: <boolean> + maxFromObjectIds: <integer> + maxToObjectIds: <integer> + name: <string> + portalUniqueIdentifier: <string> + toObjectTypeId: <string> + inverseLabel: <string> + fromObjectType: PARTNER_CLIENT + toObjectType: PAYMENT_SCHEDULE_INSTALLMENT + label: <string> + fullyQualifiedName: <string> + id: <string> + labels: + singular: <string> + plural: <string> + name: <string> + objectTypeId: <string> + properties: + - description: <string> + fieldType: <string> + groupName: <string> + label: <string> + name: <string> + options: + - hidden: <boolean> + label: <string> + value: <string> + displayOrder: <integer> + description: <string> + - hidden: <boolean> + label: <string> + value: <string> + displayOrder: <integer> + description: <string> + type: <string> + createdUserId: <string> + hidden: <boolean> + modificationMetadata: + archivable: <boolean> + readOnlyDefinition: <boolean> + readOnlyValue: <boolean> + readOnlyOptions: <boolean> + displayOrder: <integer> + showCurrencySymbol: <boolean> + hubspotDefined: <boolean> + formField: <boolean> + createdAt: <dateTime> + archivedAt: <dateTime> + archived: <boolean> + referencedObjectType: <string> + calculationFormula: <string> + hasUniqueValue: <boolean> + updatedUserId: <string> + calculated: <boolean> + externalOptions: <boolean> + updatedAt: <dateTime> + - description: <string> + fieldType: <string> + groupName: <string> + label: <string> + name: <string> + options: + - hidden: <boolean> + label: <string> + value: <string> + displayOrder: <integer> + description: <string> + - hidden: <boolean> + label: <string> + value: <string> + displayOrder: <integer> + description: <string> + type: <string> + createdUserId: <string> + hidden: <boolean> + modificationMetadata: + archivable: <boolean> + readOnlyDefinition: <boolean> + readOnlyValue: <boolean> + readOnlyOptions: <boolean> + displayOrder: <integer> + showCurrencySymbol: <boolean> + hubspotDefined: <boolean> + formField: <boolean> + createdAt: <dateTime> + archivedAt: <dateTime> + archived: <boolean> + referencedObjectType: <string> + calculationFormula: <string> + hasUniqueValue: <boolean> + updatedUserId: <string> + calculated: <boolean> + externalOptions: <boolean> + updatedAt: <dateTime> + createdUserId: <integer> + trackingType: VISITED_URL + description: <string> + primaryObjectId: <string> + primaryObject: <string> + createdAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "reprehenderit36": [ + "<string>", + "<string>" + ], + "laboris0_": [ + "<string>", + "<string>" + ], + "laborumfb": [ + "<string>", + "<string>" + ], + "Duis_81": [ + "<string>", + "<string>" + ] + }, + "links": { + "dolore_dbd": "<string>", + "non_52": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "occaecat_805": [ + "<string>", + "<string>" + ], + "anim_9e": [ + "<string>", + "<string>" + ], + "consectetur_c6c": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "dolor2": [ + "<string>", + "<string>" + ], + "eu1": [ + "<string>", + "<string>" + ], + "adipisicing_1": [ + "<string>", + "<string>" + ], + "labore_06": [ + "<string>", + "<string>" + ] + } + } + ] + } + delete: + tags: + - Custom Event Definitions API > Event definition + summary: delete-/events/v3/event-definitions/{event Name} + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: eventName + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "reprehenderit36": [ + "<string>", + "<string>" + ], + "laboris0_": [ + "<string>", + "<string>" + ], + "laborumfb": [ + "<string>", + "<string>" + ], + "Duis_81": [ + "<string>", + "<string>" + ] + }, + "links": { + "dolore_dbd": "<string>", + "non_52": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "occaecat_805": [ + "<string>", + "<string>" + ], + "anim_9e": [ + "<string>", + "<string>" + ], + "consectetur_c6c": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "dolor2": [ + "<string>", + "<string>" + ], + "eu1": [ + "<string>", + "<string>" + ], + "adipisicing_1": [ + "<string>", + "<string>" + ], + "labore_06": [ + "<string>", + "<string>" + ] + } + } + ] + } + patch: + tags: + - Custom Event Definitions API > Event definition + summary: Update a custom event definition + description: Update a specific custom event definition by name. + requestBody: + content: + application/json: + schema: + type: object + example: + description: <string> + label: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: eventName + in: path + schema: + type: string + required: true + description: (Required) The internal name of the custom event. + example: <string> + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + archived: <boolean> + associations: + - allowsCustomLabels: <boolean> + cardinality: ONE_TO_ONE + category: HUBSPOT_DEFINED + fromObjectTypeId: <string> + hasAllAssociatedObjects: <boolean> + hasCascadingDeletes: <boolean> + hasUserEnforcedMaxFromObjectIds: <boolean> + hasUserEnforcedMaxToObjectIds: <boolean> + hidden: <boolean> + id: <integer> + inverseAllowsCustomLabels: <boolean> + inverseCardinality: ONE_TO_MANY + inverseHasAllAssociatedObjects: <boolean> + inverseId: <integer> + inverseName: <string> + isInversePrimary: <boolean> + isPrimary: <boolean> + maxFromObjectIds: <integer> + maxToObjectIds: <integer> + name: <string> + portalUniqueIdentifier: <string> + toObjectTypeId: <string> + inverseLabel: <string> + fromObjectType: CALL + toObjectType: CAMPAIGN_BUDGET_ITEM + label: <string> + - allowsCustomLabels: <boolean> + cardinality: ONE_TO_ONE + category: USER_DEFINED + fromObjectTypeId: <string> + hasAllAssociatedObjects: <boolean> + hasCascadingDeletes: <boolean> + hasUserEnforcedMaxFromObjectIds: <boolean> + hasUserEnforcedMaxToObjectIds: <boolean> + hidden: <boolean> + id: <integer> + inverseAllowsCustomLabels: <boolean> + inverseCardinality: ONE_TO_ONE + inverseHasAllAssociatedObjects: <boolean> + inverseId: <integer> + inverseName: <string> + isInversePrimary: <boolean> + isPrimary: <boolean> + maxFromObjectIds: <integer> + maxToObjectIds: <integer> + name: <string> + portalUniqueIdentifier: <string> + toObjectTypeId: <string> + inverseLabel: <string> + fromObjectType: PARTNER_CLIENT + toObjectType: PAYMENT_SCHEDULE_INSTALLMENT + label: <string> + fullyQualifiedName: <string> + id: <string> + labels: + singular: <string> + plural: <string> + name: <string> + objectTypeId: <string> + properties: + - description: <string> + fieldType: <string> + groupName: <string> + label: <string> + name: <string> + options: + - hidden: <boolean> + label: <string> + value: <string> + displayOrder: <integer> + description: <string> + - hidden: <boolean> + label: <string> + value: <string> + displayOrder: <integer> + description: <string> + type: <string> + createdUserId: <string> + hidden: <boolean> + modificationMetadata: + archivable: <boolean> + readOnlyDefinition: <boolean> + readOnlyValue: <boolean> + readOnlyOptions: <boolean> + displayOrder: <integer> + showCurrencySymbol: <boolean> + hubspotDefined: <boolean> + formField: <boolean> + createdAt: <dateTime> + archivedAt: <dateTime> + archived: <boolean> + referencedObjectType: <string> + calculationFormula: <string> + hasUniqueValue: <boolean> + updatedUserId: <string> + calculated: <boolean> + externalOptions: <boolean> + updatedAt: <dateTime> + - description: <string> + fieldType: <string> + groupName: <string> + label: <string> + name: <string> + options: + - hidden: <boolean> + label: <string> + value: <string> + displayOrder: <integer> + description: <string> + - hidden: <boolean> + label: <string> + value: <string> + displayOrder: <integer> + description: <string> + type: <string> + createdUserId: <string> + hidden: <boolean> + modificationMetadata: + archivable: <boolean> + readOnlyDefinition: <boolean> + readOnlyValue: <boolean> + readOnlyOptions: <boolean> + displayOrder: <integer> + showCurrencySymbol: <boolean> + hubspotDefined: <boolean> + formField: <boolean> + createdAt: <dateTime> + archivedAt: <dateTime> + archived: <boolean> + referencedObjectType: <string> + calculationFormula: <string> + hasUniqueValue: <boolean> + updatedUserId: <string> + calculated: <boolean> + externalOptions: <boolean> + updatedAt: <dateTime> + createdUserId: <integer> + trackingType: VISITED_URL + description: <string> + primaryObjectId: <string> + primaryObject: <string> + createdAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "reprehenderit36": [ + "<string>", + "<string>" + ], + "laboris0_": [ + "<string>", + "<string>" + ], + "laborumfb": [ + "<string>", + "<string>" + ], + "Duis_81": [ + "<string>", + "<string>" + ] + }, + "links": { + "dolore_dbd": "<string>", + "non_52": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "occaecat_805": [ + "<string>", + "<string>" + ], + "anim_9e": [ + "<string>", + "<string>" + ], + "consectetur_c6c": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "dolor2": [ + "<string>", + "<string>" + ], + "eu1": [ + "<string>", + "<string>" + ], + "adipisicing_1": [ + "<string>", + "<string>" + ], + "labore_06": [ + "<string>", + "<string>" + ] + } + } + ] + } + /events/v3/event-definitions/{eventName}/property: + post: + tags: + - Custom Event Definitions API > Event definition + summary: Create a new property for a custom event definition. + description: Add a new property to an existing custom event definition. + requestBody: + content: + application/json: + schema: + type: object + example: + label: <string> + type: <string> + name: <string> + options: + - displayOrder: <integer> + hidden: <boolean> + label: <string> + value: <string> + description: <string> + - displayOrder: <integer> + hidden: <boolean> + label: <string> + value: <string> + description: <string> + description: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: eventName + in: path + schema: + type: string + required: true + description: (Required) The internal name of the custom event. + example: <string> + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + description: <string> + fieldType: <string> + groupName: <string> + label: <string> + name: <string> + options: + - hidden: <boolean> + label: <string> + value: <string> + displayOrder: <integer> + description: <string> + - hidden: <boolean> + label: <string> + value: <string> + displayOrder: <integer> + description: <string> + type: <string> + createdUserId: <string> + hidden: <boolean> + modificationMetadata: + archivable: <boolean> + readOnlyDefinition: <boolean> + readOnlyValue: <boolean> + readOnlyOptions: <boolean> + displayOrder: <integer> + showCurrencySymbol: <boolean> + hubspotDefined: <boolean> + formField: <boolean> + createdAt: <dateTime> + archivedAt: <dateTime> + archived: <boolean> + referencedObjectType: <string> + calculationFormula: <string> + hasUniqueValue: <boolean> + updatedUserId: <string> + calculated: <boolean> + externalOptions: <boolean> + updatedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "reprehenderit36": [ + "<string>", + "<string>" + ], + "laboris0_": [ + "<string>", + "<string>" + ], + "laborumfb": [ + "<string>", + "<string>" + ], + "Duis_81": [ + "<string>", + "<string>" + ] + }, + "links": { + "dolore_dbd": "<string>", + "non_52": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "occaecat_805": [ + "<string>", + "<string>" + ], + "anim_9e": [ + "<string>", + "<string>" + ], + "consectetur_c6c": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "dolor2": [ + "<string>", + "<string>" + ], + "eu1": [ + "<string>", + "<string>" + ], + "adipisicing_1": [ + "<string>", + "<string>" + ], + "labore_06": [ + "<string>", + "<string>" + ] + } + } + ] + } + /events/v3/event-definitions/{eventName}/property/{propertyName}: + delete: + tags: + - Custom Event Definitions API > Event definition + summary: Delete a property from a custom event definition + description: Deletes a property from an existing custom event definition. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: eventName + in: path + schema: + type: string + required: true + description: (Required) The internal name of the custom event. + example: <string> + - name: propertyName + in: path + schema: + type: string + required: true + description: (Required) The internal name of the property to delete. + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "reprehenderit36": [ + "<string>", + "<string>" + ], + "laboris0_": [ + "<string>", + "<string>" + ], + "laborumfb": [ + "<string>", + "<string>" + ], + "Duis_81": [ + "<string>", + "<string>" + ] + }, + "links": { + "dolore_dbd": "<string>", + "non_52": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "occaecat_805": [ + "<string>", + "<string>" + ], + "anim_9e": [ + "<string>", + "<string>" + ], + "consectetur_c6c": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "dolor2": [ + "<string>", + "<string>" + ], + "eu1": [ + "<string>", + "<string>" + ], + "adipisicing_1": [ + "<string>", + "<string>" + ], + "labore_06": [ + "<string>", + "<string>" + ] + } + } + ] + } + patch: + tags: + - Custom Event Definitions API > Event definition + summary: Update an existing custom event property + description: Updates an existing property in a custom event definition. + requestBody: + content: + application/json: + schema: + type: object + example: + options: + - displayOrder: <integer> + hidden: <boolean> + label: <string> + value: <string> + description: <string> + - displayOrder: <integer> + hidden: <boolean> + label: <string> + value: <string> + description: <string> + description: <string> + label: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: eventName + in: path + schema: + type: string + required: true + description: (Required) The internal name of the custom event. + example: <string> + - name: propertyName + in: path + schema: + type: string + required: true + description: (Required) The internal name of the property to update. + example: <string> + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + description: <string> + fieldType: <string> + groupName: <string> + label: <string> + name: <string> + options: + - hidden: <boolean> + label: <string> + value: <string> + displayOrder: <integer> + description: <string> + - hidden: <boolean> + label: <string> + value: <string> + displayOrder: <integer> + description: <string> + type: <string> + createdUserId: <string> + hidden: <boolean> + modificationMetadata: + archivable: <boolean> + readOnlyDefinition: <boolean> + readOnlyValue: <boolean> + readOnlyOptions: <boolean> + displayOrder: <integer> + showCurrencySymbol: <boolean> + hubspotDefined: <boolean> + formField: <boolean> + createdAt: <dateTime> + archivedAt: <dateTime> + archived: <boolean> + referencedObjectType: <string> + calculationFormula: <string> + hasUniqueValue: <boolean> + updatedUserId: <string> + calculated: <boolean> + externalOptions: <boolean> + updatedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "reprehenderit36": [ + "<string>", + "<string>" + ], + "laboris0_": [ + "<string>", + "<string>" + ], + "laborumfb": [ + "<string>", + "<string>" + ], + "Duis_81": [ + "<string>", + "<string>" + ] + }, + "links": { + "dolore_dbd": "<string>", + "non_52": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "occaecat_805": [ + "<string>", + "<string>" + ], + "anim_9e": [ + "<string>", + "<string>" + ], + "consectetur_c6c": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "dolor2": [ + "<string>", + "<string>" + ], + "eu1": [ + "<string>", + "<string>" + ], + "adipisicing_1": [ + "<string>", + "<string>" + ], + "labore_06": [ + "<string>", + "<string>" + ] + } + } + ] + } diff --git a/server/node-service/src/plugins/hubspot/specsV4/Marketing API Collections.json b/server/node-service/src/plugins/hubspot/specsV4/Marketing API Collections.json new file mode 100644 index 000000000..4606b149d --- /dev/null +++ b/server/node-service/src/plugins/hubspot/specsV4/Marketing API Collections.json @@ -0,0 +1,18195 @@ +openapi: 3.0.0 +info: + title: Marketing API Collections + description: >- + **Transactional Email API: I**f you have the [transactional email + add-on](https://www.hubspot.com/products/email/transactional-email), you can + send emails over a dedicated IP address for commerce receipts, account + updates, terms of service changes, and other essential business + transactions. + + + Transactional emails are for relationship-based interactions, unlike + [marketing + emails](https://developers.hubspot.com/docs/api/marketing/marketing-emails), + which are typically used to promote content. + + **Subscriptions Preferences API:** Subscriptions types represent the legal + basis to communicate with your contacts through email. Contacts can [manage + their email + preferences](https://knowledge.hubspot.com/articles/kcs_article/email/how-to-send-contacts-an-email-with-an-opt-out-link-so-they-can-manage-their-preferences) + so that they're only opted into the emails they want to receive. + + **Marketing Emails API:** The Marketing Emails API can be used to + programmatically create, update, and get details about marketing emails. You + can also query details about the post-send statistics of a specific email or + set of emails. These statistics should match what you can access in the app + on the _Details_ section of a particular email and will be returned under + the stats object in your JSON response. The Marketing Email API cannot be + used to create or retrieve data for sales emails that are created and sent + via the contact record. To get details for sales emails, use the Engagements + API. + + + **Marketing Events API:** A marketing event is a CRM object, similar to + contacts and companies, that enables you to track and associate marketing + events, such as a webinar, with other HubSpot CRM objects. + + + **Single-Send Email API:** The single-send API allows you to send template + emails created in the HubSpot marketing email tool using a JSON-formatted + POST request. + + + **Fork the collections using Run in Postman:** + + + [<img src="https://run.pstmn.io/button.svg" alt="Run In + Postman">](https://app.getpostman.com/run-collection/26126890-feae66ed-9a0d-4354-8f57-51b856b57ff4?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D26126890-feae66ed-9a0d-4354-8f57-51b856b57ff4%26entityType%3Dcollection%26workspaceId%3Dd7645f33-539d-49c6-9e0c-efa6faae355d) + version: 1.0.0 +servers: + - url: http://{{baseurl}} +components: + securitySchemes: + oauth2Auth: + type: http + scheme: oauth2 + apikeyAuth: + type: http + scheme: apikey +tags: + - name: Transactional Email API + description: "If you have the\_[transactional email add-on](https://www.hubspot.com/products/email/transactional-email),\_you can send emails over\_a dedicated IP address for commerce receipts, account updates, terms of service changes, and other essential business transactions.\n\nTransactional emails are for relationship-based interactions, unlike\_[marketing emails](https://developers.hubspot.com/docs/api/marketing/marketing-emails), which are typically used to promote content.\n\n## Methods for sending transactional email\n\nThere are\_three ways\_to implement transactional email:\n\n- [Set up transactional email in-app](https://knowledge.hubspot.com/email/how-to-use-transactional-email-in-hubspot?_ga=2.45076132.1868562849.1588606909-500942594.1573763828)\n \n- [SMTP API](https://developers.hubspot.com/docs/api/marketing/transactional-emails#smtp-api)\n \n- [Single-send API](https://developers.hubspot.com/docs/api/marketing/transactional-emails#single-send-api)\n \n\n| **METHOD** | **OVERVIEW** | **EXAMPLE USE CASE** |\n| --- | --- | --- |\n| **In-app transactional Email** | Create transactional emails using HubSpot's email editor. <br> <br>This provides the same benefits of standard HubSpot emails, such as smart content, personalization and templates. <br> <br>Learn more about\_[setting up transactional emails in-app](https://knowledge.hubspot.com/email/how-to-use-transactional-email-in-hubspot). | Send a\_policy update\_email to your customers with a link to a new policy page. This is a service update, not a marketing email, so you don't need to include subscription links (e.g CAN-SPAM links).\_You don't need to use any custom properties or info from external systems. |\n| **SMTP API** | Send transactional email through your own site or app while also tracking email performance and create contact information within HubSpot. The optional ability to create contact information is based on the smtp token creation. <br> <br>Learn more in\_[<b> SMTP API section below </b>](https://developers.hubspot.com/docs/api/marketing/transactional-emails#smtp-api) | Send an\_account signup confirmation\_email from a\_separate transactional email system, while also tracking email performance and creating contacts in HubSpot. |\n| **Single-send API** | A combination of in-app transactional email and SMTP API. <br> <br>Create transactional emails using HubSpot's email editor, and add custom external tokens to your email which you can send to HubSpot via the API. <br> <br>Learn more in the\_[<b>single-send API below </b>](https://developers.hubspot.com/docs/api/marketing/transactional-emails#single-send) | Send a\_purchase receipt\_email to your customer using HubSpot. The email is triggered when the purchase is made, and passes custom values from another system\_(e.g.\_purchased item and purchase total). In addition, track the performance of this email in HubSpot. |\n\n**Please note:**\_any contacts who are CC'd on a transactional email will not be tracked and the email will not appear on the record timeline of the CC'd contact.\n\n## SMTP API\n\nTransactional email sent using the SMTP API is automatically triggered by specific criteria, like making a purchase on an e-commerce website. This API integrates with any internal or third-party systems to both trigger the email and incorporate data stored outside of HubSpot (e.g. shipping info or purchase price). The email is sent from your system, but is wrapped with HubSpot tracking codes that allow full\_[engagement tracking and measurement](https://knowledge.hubspot.com/email/analyze-your-marketing-email-campaign-performance).\n\nTo send an email using the SMTP API, you need to use an SMTP API token to get login credentials for the HubSpot SMTP server. Once you log in to the server, you can send the email over SMTP.\_If you haven't created any SMTP API tokens, you'll first need to\_[generate a new token](https://developers.hubspot.com/docs/api/marketing/transactional-emails#create-a-new-smtp-api-token). If you've already created SMTP API tokens, learn about the\_[different methods for getting your tokens through the API](https://developers.hubspot.com/docs/api/marketing/transactional-emails#get-existing-smtp-api-tokens). After getting your token, learn about how to\_[log in to HubSpot's SMTP server](https://developers.hubspot.com/docs/api/marketing/transactional-emails#log-in).\n\nAny domains you use as the\__From Address_\_of your emails must be connected as an\_[email sending domain](https://knowledge.hubspot.com/domains-and-urls/connect-your-email-sending-domain)\_in HubSpot. You will encounter an error if you send transactional emails through the SMTP API using a domain that isn't authorized to send on behalf of your HubSpot account.\n\n**Please note**: all methods in the SMTP API require an\_[OAuth token](https://developers.hubspot.com/docs/api/oauth-quickstart-guide)\_for authentication.\n\nIf you prefer, all of the methods below for creating, retrieving, deleting, and resetting passwords for SMTP API tokens can be done\_[within your HubSpot account](https://knowledge.hubspot.com/email/how-to-use-transactional-email-in-hubspot#send-a-transactional-email-using-the-smtp-api), rather than the API.\n\n### Create a new SMTP API token\n\nTo create a new SMTP API token, make a\_`POST`\_request to\_`/marketing/v3/transactional/smtp-tokens/`.\n\nThe request body must be a JSON-formatted object with the following properties:\n\n- **`createContact`**:\_indicates whether a contact should be created for email recipients.\n \n- **`campaignName`**:\_a\_name for the campaign associated with the SMTP API token.\n \n\nThe response includes an SMTP token object,\_which contains:\n\n- **`id`**: username to log into the HubSpot SMTP server.\n \n- **`createdBy`**: email address of the user that sent the token creation request.\n \n- **`password`**: the password for logging in to the HubSpot SMTP server.\n \n- **`emailCampaignId`**: identifier assigned to the campaign provided in the token creation request.\n \n- **`createdAt`**: timestamp generated when a token is created.\n \n- **`createContact`**: indicates whether a contact should be created for email recipients.\n \n- **`campaignName`**: the name of the campaign associated with the token.\n \n\nWith your token created, you can\_[log in to HubSpot's SMTP server ](https://developers.hubspot.com/docs/api/marketing/transactional-emails#log-in)\_using the\_`id`\_and\_`password`\_values.\n\nA token's password can only be retrieved at the time of creation. If you lose the password, or want to set a new password, you'll need to\_[reset the token's password](https://developers.hubspot.com/docs/api/marketing/transactional-emails#manage-existing-tokens).\_\n\n**Please note:**\_SMTP API tokens generated through the public API expire after 12 months. Once expired, they're automatically deleted. Tokens created directly\_[within your HubSpot account](https://knowledge.hubspot.com/email/how-to-use-transactional-email-in-hubspot#send-a-transactional-email-using-the-smtp-api)\_do\_not\_expire automatically.\n\n### Retrieving SMTP tokens\n\nBelow are the available methods of getting token data using the API.\n\n#### List SMTP API tokens by campaign\n\nTo get either a list of tokens by campaign name, or get a single token by campaign ID, make a\_`GET`\_request to\_`/marketing/v3/transactional/smtp-tokens`.\n\nYou'll also need to include either a\_`campaignName`\_or\_`emailCampaignId`\_parameter with the request. You can find all request details in the Endpoints tab at the top of this article.\n\n**Response details**\n\nThe response contains\_`results`\_and\_`paging`\_as its top-level fields:\n\n- `results`: a collection of\_`SmtpApiTokenView`\_containing:\n \n - **`id`**: username to log into the HubSpot SMTP server.\n \n - **`createdBy`**: email address of the user that sent the token creation request.\n \n - **`emailCampaignId`**: identifier assigned to the campaign provided in the token creation request.\n \n - **`createdAt`**: timestamp generated when a token is created.\n \n - **`createContact`**: indicates whether a contact should be created for email recipients.\n \n - **`campaignName`**: the name of the campaign associated with the token.\n \n- `paging`: contains a\_`next.after`\_field that can be used to request more results.\n \n\n#### Query a single SMTP API token\n\nTo query a single SMTP API token by ID, make a\_`GET`\_request to\_`/marketing/v3/transactional/smtp-tokens/{tokenId}`.\n\n##### **Response details**\n\nThe response includes\_`SmtpApiTokenView`, which contains:\n\n- **`id`**: username to log into the HubSpot SMTP server.\n \n- **`createdBy`**: email address of the user that sent the token creation request.\n \n- **`emailCampaignId`**: identifier assigned to the campaign provided in the token creation request.\n \n- **`createdAt`**: timestamp generated when a token is created.\n \n- **`createContact`**: indicates whether a contact should be created for email recipients.\n \n- **`campaignName`**: the name of the campaign associated with the token.\n \n\n### Manage existing tokens\n\nAfter creating tokens, you can reset a password or delete the token using the API.\n\n#### Reset password\n\nTo reset a token password, make a POST request to\_`/marketing/v3/transactional/smtp-tokens/{tokenId}/password-reset`.\n\nThe response includes\_`SmtpApiTokenView`, which contains:\n\n- **`id`**: username to log into the HubSpot SMTP server.\n \n- **`createdBy`**: email address of the user that sent the token creation request.\n \n- **`emailCampaignId`**: identifier assigned to the campaign provided in the token creation request.\n \n- **`createdAt`**: timestamp generated when a token is created.\n \n- **`createContact`**: indicates whether a contact should be created for email recipients.\n \n- **`campaignName`**: the name of the campaign associated with the token.\n \n\n#### Delete a token\n\nTo delete a single SMTP API token, make a DELETE request to\_\_`/marketing/v3/transactional/smtp-tokens/{tokenId}`.\_\n\nThe response does not include any content.\n\n### Log in to HubSpot's SMTP server\n\nBelow are the details for logging in to HubSpot's SMTP server, using the username (`id`) and password provided by your token.\n\n- **SMTP Hostname:**\n \n - If you're not based in the EU, use\_`smtp.hubapi.com`\_for the hostname.\n \n - If you're based in the EU, use\_`smtp-eu1.hubapi.com`\_for the hostname.\n \n- **SMTP Port:**\n \n - For STARTTLS, you can use port 25 or 587.\n \n - For direct TLS, use port 465.\n \n- **SMTP User Name:**\_provided in the ID field\n \n- **SMTP Password:**\_provided in the password field\n \n\n## Single-send API\n\nThe\_Single-Send API\_sends\_template emails created in the HubSpot email tool using a JSON-formatted\_`POST`\_request. Any emails sent through this API will be automatically associated with contact records based on email address. If there's no contact with a matching email address, a new contact with that email will be created. If you want to send emails without creating contacts, use the\_[SMTP API](https://developers.hubspot.com/docs/api/marketing/transactional-emails#SMTP-API).\n\n### Create and publish your email template\n\nThe\_Single-Send API\_sends\_template emails created in the HubSpot email tool using a JSON-formatted\_`POST`\_request. Any emails sent through this API will be automatically associated with contact records based on email address. If there's no contact with a matching email address, a new contact with that email will be created. If you want to send emails without creating contacts, use the\_[SMTP API](https://developers.hubspot.com/docs/api/marketing/transactional-emails#SMTP-API).\n\nFirst,\_[set up your email in HubSpot](https://knowledge.hubspot.com/email/how-to-use-transactional-email-in-hubspot). After you create the email, you can set the recipient details, including any contact or custom properties set up in the email template, in the body of the API request. Before you can make the API request, you'll need the ID of the email:\n\n- If you leave the email drafted without publishing it, you can get the email ID from the URL when you're in the email editor. The ID is the final numeric value before the final slash character (`/`) in the URL (e.g.,\_`https://app.hubspot.com/email/{PORTAL_ID}/edit/{EMAIL_ID}/settings`).\n \n\n<img src=\"https://developers.hubspot.com/hs-fs/hubfs/Knowledge_Base_2023/email-id-for-drafted-single-send-api-email.png?width=800&height=133&name=email-id-for-drafted-single-send-api-email.png\" alt=\"\">\n\n- If you publish your email, you can copy the email ID from the email details page.\n \n\n<img src=\"https://developers.hubspot.com/hs-fs/hubfs/Screen Shot 2020-04-15 at 1.00.37 PM.png?width=872&name=Screen Shot 2020-04-15 at 1.00.37 PM.png\" alt=\"\">\n\n**Please note:**\_HubSpot does not save the HTML/JSON sent through this API. You can review the email template from the recipient contact's timeline, but if you want to keep a record of the email's contents, it's recommended to add a BCC to the email.\n\n### Send your email using the single-send API\n\nTo send an email with the Single-Send API, make a\_`POST`\_request to\_`/marketing/v3/transactional/single-email/send`.\n\nThe response contains the following fields:\n\n- `requestedAt`: the timestamp of when the send was requested.\n \n- `statusId`: an identifier that can be used to\_[query the status of the send](https://developers.hubspot.com/docs/api/marketing/transactional-emails#query-the-status-of-an-email-send).\n \n- `status`: the status of the send request. Includes\_`PENDING`,\_`PROCESSING`,\_`CANCELED`, and\_`COMPLETE`.\n \n\n### Request properties\n\nThe request body must be a JSON-formatted object with the following properties:\n\n- `emailId`\n \n- `message`\n \n- `contactProperties`\n \n- `customProperties`\n \n\n#### emailId\n\nThe\_`emailId`\_field contains the transactional email's content ID, which can be found in HubSpot's email tool.\n\n#### message\n\nThe message field is a JSON object containing anything that you want to override. At the minimum, you must include the\_`to`\_field.\n\nMessage object fields:\n\n- `to`: the recipient of the email\n \n- `from`: the \"From\" header for the email. You can define a from name with the following format:\_`\"from\":\"Sender Name \"`\n \n- `sendId`: the ID of a particular send. Only one email with a given\_`sendId`\_will be sent per account, so you can include this field to prevent duplicate email sends.\n \n- `replyTo`:\_ a JSON list of \"Reply-To\" header values for the email.\n \n- `cc`: a JSON list of email addresses to send as Cc.\n \n- `bcc`: a JSON list of email addresses to send as Bcc.\n \n\n#### contactProperties\n\nThe\_`contactProperties`\_field is a JSON map of contact property values. Each contact property value contains a\_`name`\_and\_`value`. Each property will be set on the contact record and will be visible in the template under:\n\n<img src=\"https://developers.hubspot.com/hs-fs/hubfs/Knowledge_Base_2021/Developer/name-token-in-template-for-transactional-email.png?width=88&height=29&name=name-token-in-template-for-transactional-email.png\" alt=\"\">\n\nUse these properties when you want to set a contact property while you’re sending the email. For example, when sending a receipt you may want to set a\_`last_paid_date`\_property, as the sending of the receipt will have information about the last payment.\n\nJSON\n\n```\n{\n \"emailId\": 4126643121,\n \"message\": {\n \"to\": \"jdoe@hubspot.com\"\n \"sendId\": \"6\"\n },\n \"contactProperties\": {\n \"last_paid_date\": \"2022-03-01\",\n \"firstname\": \"jane\"\n } \n}\n\n ```\n\n#### customProperties\n\nThe\_`customProperties`\_field is a JSON map of key-value properties. These properties are generally related to the email itself, not the contact receiving the email. They will not appear in the\_[web page version of the email](https://knowledge.hubspot.com/email/create-a-web-version-of-your-marketing-email), or in the view of the email from the contact's timeline. These properties are also not stored in HubSpot and will only be included in the sent email.\n\nEach key in the\_`customProperties`\_field can be referenced in the template using a\_[HubL expression](https://developers.hubspot.com/docs/cms/hubl)\_for fields contained within the\_`custom`\_variable (e.g.,\_`{{custom.NAME_OF_PROPERTY}}`\_).\n\nFor example, if your email template references two properties,\_`purchaseUrl`\_and\_`productName`, you could provide the associated values for these properties with the following request body:\n\nJSON\n\n```\n{\n \"emailId\": 4126643121,\n \"message\": {\n \"to\": \"jdoe@hubspot.com\"\n \"sendId\": \"6\"\n },\n \"customProperties\": {\n \"purchaseUrl\": \"https://example.com/link-to-product\",\n \"productName\": \"vanilla\"\n } \n}\n\n ```\n\nYou can then reference these properties in your email template:\n\nHubL\n\n```\n\n<html>\n <p>\n Congrats on purchasing some of the best ice cream around.\n </p>\n <a href={{custom.purchaseUrl}}>{{custom.productName}}</a>\n</html>\n\n ```\n\nThe\_`customProperties`\_field only supports arrays when used with\_[programmable email content](https://developers.hubspot.com/docs/cms/guides/email/hubdb-crm-objects). In your email template, you can reference the items defined in your\_`customProperties`\_field by using a\_[HubL expression](https://developers.hubspot.com/docs/cms/hubl)\_(e.g., using a\_[for loop](https://developers.hubspot.com/docs/cms/hubl/for-loops)\_to render each item in a list).\_For example, if the\_`customProperties`\_you included in your request body was structured like the following JSON snippet below:\n\nJSON\n\n```\n{\n \"emailId\": 4126643122,\n \"message\": {\n \"to\": \"jdoe@hubspot.com\"\n \"sendId\": \"7\"\n },\n \"customProperties\": {\n \"exampleArray\": [\n {\"firstKey\": \"someValue\", \"secondKey\": \"anotherValue\"},\n {\"firstKey\": \"value1\", \"secondKey\": \"value2\" }\n ]\n } \n}\n\n ```\n\nYou could then reference the values for each item in\_`exampleArray`\_with the following HubL code:\n\nHubL\n\n```\n\n<html>\n <p>\n Thanks for your recent purchase! Here are the details of the items you'll be receiving:\n </p>\n <ul>\n {% for item in custom.exampleArray %}\n <li>First key: {{ item.firstKey }}, Second key: {{item.secondKey}}</li>\n {% endfor %} \n </ul>\n</html>\n\n ```\n\nOnce sent, the transactional email would render the contents of the associated programmable email template as follows:\n\n<img src=\"https://developers.hubspot.com/hs-fs/hubfs/Knowledge_Base_2021/Developer/example-transactional-email-with-customProperties-array.png?width=568&height=114&name=example-transactional-email-with-customProperties-array.png\" alt=\"\">\n\n### Query the status of an email send\n\nTo get the status of the email send, make a\_`GET`\_request to\_`https://api.hubapi.com/marketing/v3/email/send-statuses/{statusId}`.\_\n\nThe response contains the following fields:\n\n- `sendResult`: an enumeration that represents the email's send status. The possible values are\_[listed below](https://developers.hubspot.com/docs/api/marketing/transactional-emails#sendresult-values).\n \n- `requestedAt`: the timestamp from when the send was requested.\n \n- `startedAt`: the timestamp when the send began processing.\n \n- `completedAt`: the timestamp when the send completed.\n \n- `statusId`: an identifier that can be used to query the status of the send.\n \n- `status`: the status of the send request. Includes\_`PENDING`,\_`PROCESSING`,\_`CANCELED`, and\_`COMPLETE`.\n \n- `eventId`: if sent, the ID and created timestamp of the sent event.\n \n\n#### sendResult\n\nThe\_`sendResult`\_is an enumeration that reflects the result of an email send attempt. Its possible values are:\n\n- `SENT`: the email was sent successfully.\n \n- `QUEUED`: the email was queued and will send as the queue gets processed.\n \n- `PORTAL_SUSPENDED`: due to\_[Acceptable Use Policy](https://legal.hubspot.com/acceptable-use)\_violations, the HubSpot customer's email has been suspended.\n \n- `INVALID_TO_ADDRESS`: the recipient address is invalid. This error will also occur if you attempt to send an email with any of the following role-based prefixes in the email address:\_`abuse`,\_`no-reply`,\_`noreply`,\_`root`,\_`spam`,\_`security`,\_`undisclosed-recipients`,\_`unsubscribe`,\_`inoc`,\_`postmaster`, or\_`privacy`.\n \n- `BLOCKED_DOMAIN`: the domain cannot receive emails from HubSpot at this time.\n \n- `PREVIOUSLY_BOUNCED`: the recipient has previously bounced, and the sending logic resulted in no send.\n \n- `PREVIOUS_SPAM`: the recipient has previously marked similar email as spam.\n \n- `INVALID_FROM_ADDRESS`: the\__From_\_address is invalid.\n \n- `MISSING_CONTENT`: the\_`emailId`\_is invalid, or the\_`emailId`\_corresponds to an email that wasn't set up for Single-Send.\n \n- `MISSING_TEMPLATE_PROPERTIES`: there are properties set up in the template that have not been included in the\_`customProperties`\_sent in the request." + - name: Transactional Email API > Public_Smtp_Tokens + - name: Transactional Email API > Single_Send + - name: Subscription Preferences API + description: "Subscriptions types represent the legal basis to communicate with your contacts through email.\_Contacts can\_[manage their email preferences](https://knowledge.hubspot.com/articles/kcs_article/email/how-to-send-contacts-an-email-with-an-opt-out-link-so-they-can-manage-their-preferences)\_so that they're only opted into the emails they want to receive.\n\n**Please note:**\_the subscription preferences API does\_not\_currently support retrieving or updating\_[WhatsApp](https://knowledge.hubspot.com/inbox/collect-consent-for-whatsapp-conversations)\_subscription information for a contact.\n\n## **Get contact subscription status**\n\nThe contact subscription status endpoint allows users to retrieve the subscription statuses for an email address in an account.\n\nThis endpoint is ideal for when you have an external preferences center or integration and need to know the subscription statuses for any given email address in your account.\n\n---\n\n## **Subscribe contact**\n\nThe subscribe contact endpoint allows you to subscribe an email address to any given subscription type in an account, but\_**will not allow you to resubscribe contacts who have opted out.**\_\n\n**Example use case:**\_This endpoint is ideal for when you have an integration or external form that needs to opt contacts into a subscription type.\_\n\n**Note**: The subscribe contact endpoint should only be used to honor requests from contacts who have given you permission to subscribe them. Please\_[ review applicable laws and regulations](https://knowledge.hubspot.com/contacts/how-do-subscription-preferences-and-types-work)\_before subscribing a contact.\_\n\n---\n\n## **Unsubscribe contact**\n\nThe unsubscribe contact endpoint allows allows you to unsubscribe an email address in an account from any given subscription type.\_\n\n**Example use case:**\_This endpoint is ideal for when you have an integration or external form that needs to opt contacts out of a subscription type.\n\n---\n\n## **Get subscription types**\n\nThe subscription info endpoint allows users to retrieve all subscription types in their account.\n\n**Example use case:**\_This endpoint is ideal for when you have an external preferences center, integration, or form and need to know which subscription types exist in your account so you can update the subscription statuses for your contacts accordingly." + - name: Subscription Preferences API > Status + - name: Subscription Preferences API > Subscription_Status + - name: Subscription Preferences API > Definition + - name: Marketing Emails API + description: "**Please note**: This API is currently in beta and is subject to change based on testing and feedback. By using these endpoints you agree to adhere to our\_[Developer Terms](https://legal.hubspot.com/hubspot-developer-terms)&\_[Developer Beta](https://legal.hubspot.com/developerbetaterms?)Terms. You also acknowledge and understand the risk associated with testing an unstable API.\_\n\nIf you have a\__**Marketing Hub**_\__Professional_\_or\__Enterprise_\_account, you can use the Marketing Emails API to programmatically create, update, and get details about marketing emails. You can also query details about the post-send statistics of a specific email or set of emails. These statistics should match what you can access in the app on the\__Details_\_section of a particular email and will be returned under the stats object in your JSON response.\_The Marketing Email API cannot be used to create or retrieve data for\_sales emails that are created and sent via the contact record. To get details for sales emails, use the Engagements API.\n\n**Please note:**\n\n- To programmatically send transactional emails to contacts, use the\_[Single-send API](https://developers.hubspot.com/docs/api/marketing/transactional-emails#single-send-api).\n \n- To use the\_`/publish`\_and\_`/unpublish`\_endpoints, you must have a\__**Marketing Hub**_\__Enterprise_\_account or the\_[transactional email add-on](https://www.hubspot.com/products/marketing/transactional-email)." + - name: Marketing Emails API > Statistics + - name: Marketing Emails API > Marketing Emails + - name: Marketing Events API + description: "# [Marketing Events](https://developers.hubspot.com/beta-docs/guides/api/marketing/marketing-events#marketing-events)\n\n[Marketing events endpoint reference](https://developers.hubspot.com/beta-docs/reference/api/marketing/marketing-events)\n\nA marketing event is a CRM object, similar to contacts and companies, that enables you to track and associate marketing events, such as a webinar, with other HubSpot CRM objects. Below, learn more about working with the marketing event API to integrate marketing events into an app.\n\n## [In this article](https://developers.hubspot.com/beta-docs/guides/api/marketing/marketing-events#in-this-article)\n\n- [Scope requirements](https://developers.hubspot.com/beta-docs/guides/api/marketing/marketing-events#scope-requirements)\n \n- [Differences between internal ID and external ID endpoints](https://developers.hubspot.com/beta-docs/guides/api/marketing/marketing-events#differences-between-internal-id-and-external-id-endpoints)\n \n- [Event management endpoints](https://developers.hubspot.com/beta-docs/guides/api/marketing/marketing-events#create-and-update-events)\n \n- [Event attendance endpoints](https://developers.hubspot.com/beta-docs/guides/api/marketing/marketing-events#event-attendance-endpoints)\n \n- [Participant state endpoints](https://developers.hubspot.com/beta-docs/guides/api/marketing/marketing-events#participant-state-endpoints)\n \n- [List association endpoints](https://developers.hubspot.com/beta-docs/guides/api/marketing/marketing-events#list-association-endpoints)\n \n- [Configure app settings](https://developers.hubspot.com/beta-docs/guides/api/marketing/marketing-events#configure-app-settings)\n \n - [Step 1: Create an API in your app](https://developers.hubspot.com/beta-docs/guides/api/marketing/marketing-events#step-1-create-an-api-in-your-app)\n \n - [Step 2: Provide HubSpot with the URL path to your API](https://developers.hubspot.com/beta-docs/guides/api/marketing/marketing-events#step-2-provide-hubspot-with-the-url-path-to-your-api)\n \n\n## [Scope requirements](https://developers.hubspot.com/beta-docs/guides/api/marketing/marketing-events#scope-requirements)\n\nTo make an API request to one of the marketing event endpoints, the following\_[scopes](https://developers.hubspot.com/beta-docs/guides/apps/authentication/working-with-oauth#scopes)\_are required:\n\n- `crm.objects.marketing_events.read`: grants permission to retrieve marketing event and attendance data.\n \n- `crm.objects.marketing_events.write`: grants permission to create, delete, or make changes to marketing event information.\n \n\nWhen authenticating calls made by your app, you can either use a\_[private app access token](https://developers.hubspot.com/beta-docs/guides/apps/private-apps/overview)\_or\_[OAuth](https://developers.hubspot.com/beta-docs/guides/api/app-management/oauth-tokens). Learn more about\_[authentication methods](https://developers.hubspot.com/beta-docs/guides/apps/authentication/intro-to-auth). For the full list of endpoints available, check out the\_[reference documentation](https://developers.hubspot.com/beta-docs/reference/api/marketing/marketing-events).\n\n## [Differences between internal ID and external ID endpoints](https://developers.hubspot.com/beta-docs/guides/api/marketing/marketing-events#differences-between-internal-id-and-external-id-endpoints)\n\nMany endpoints below provide two different ways to identify an event you want to fetch or update. Though the end result for similar endpoints might be the same, they differ mainly in the associated IDs you provide:\n\n- **Endpoints using external IDs:**\_endpoints that require\_`externalEventId`\_and\_`externalAccountId`\_parameters will only work in the same app that originally created the event. For example, if you created two public apps, called\__App A_\_and\__App B_, and you created a marketing event via the authentication and IDs associated with\__App A_, only\__App A_\_can read, update, or add new participants to the event. If you attempt to access the same event with\__App B_\_using the same externalEventId and externalAccountId, a 404 error will result.\n \n- **Endpoints using an objectId (BETA):**\_endpoints that require an\_`objectId`\_can be used to access an event by any app with the associated scopes listed in the section above, regardless of the app that originally created the event. If\__App A_\_created a marketing event,\__App B_\_can still read, update, or add participants through\_`objectId`\\-based endpoints.\n \n\n**Please note:**\_the endpoints that require the\_`objectId`\_of an event are currently in beta, and are subject to change based on testing and feedback. By using these endpoints, you agree to adhere to\_[HubSpot's Developer Terms](https://legal.hubspot.com/hubspot-developer-terms)\_&\_[Developer Beta Terms](https://legal.hubspot.com/developerbetaterms). You also acknowledge and understand the risk associated with testing an unstable API.\n\n## [Event management endpoints](https://developers.hubspot.com/beta-docs/guides/api/marketing/marketing-events#event-management-endpoints)\n\nThe following sections provide context on common event properties, and detail how to use the various event management endpoints to create, read, update, and archive events.\n\n### [Event properties](https://developers.hubspot.com/beta-docs/guides/api/marketing/marketing-events#event-properties)\n\nThe following properties are available to fetch and update when using the event management endpoints:\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| `eventName` | String | The title of your event. |\n| `eventType` | String | The type of the event (e.g., webinar, tradeshow, etc.). |\n| `eventOrganizer` | String | The individual or organization that's hosting the event. |\n| `eventDescription` | String | A description for your event. |\n| `eventUrl` | String | A URL that users can navigate to where they can learn more details and/or register for your event. |\n| `eventCancelled` | Boolean | Whether or not the event is cancelled. |\n| `eventStartTime` | String | An ISO 8601 formatted timestamp of the event's start time. |\n| `eventEndTime` | String | An ISO 8601 formatted timestamp of the event's start time. |\n\n### [Create an event](https://developers.hubspot.com/beta-docs/guides/api/marketing/marketing-events#create-an-event)\n\nTo create a marketing event you can make a\_`POST`\_request to\_`/marketing/v3/marketing-events/events`\_and provide the\_`eventName`,\_`externalEventId`,\_`externalAccountId`, and\_`eventOrganizer`\_in the body of your request. You can optionally provide any additional properties listed in the\_[table above](https://developers.hubspot.com/beta-docs/guides/api/marketing/marketing-events#event-properties)\_in your request.\n\nFor example, if the\_`externalAccountId`\_of your app is\_`\"12345\"`, and the\_`externalEventId`\_of your event in your app is\_`\"67890\"`, you could create a new event called\_`\"Winter webinar\"`\_with a request that would resemble the following:\n\nCopy code snippet1\n\n```\n// Example request body for POST request to /marketing/v3/marketing-events\n\n ```\n\n2\n\n```\n{\n\n ```\n\n3\n\n```\n \_\"externalAccountId\": \"12345\",\n\n ```\n\n4\n\n```\n \_\"externalEventId\": \"67890\",\n\n ```\n\n5\n\n```\n \_\"eventName\": \"Winter webinar\",\n\n ```\n\n6\n\n```\n \_\"eventOrganizer\": \"Snowman Fellowship\",\n\n ```\n\n7\n\n```\n \_\"eventCancelled\": false,\n\n ```\n\n8\n\n```\n \_\"eventUrl\": \"https://example.com/holiday-jam\",\n\n ```\n\n9\n\n```\n \_\"eventDescription\": \"Let's get together to plan for the holidays\",\n\n ```\n\n10\n\n```\n \_\"eventCompleted\": false,\n\n ```\n\n11\n\n```\n \_\"startDateTime\": \"2024-08-07T12:36:59.286Z\",\n\n ```\n\n12\n\n```\n \_\"endDateTime\": \"2024-08-07T12:36:59.286Z\",\n\n ```\n\n13\n\n```\n \_\"customProperties\": [\n\n ```\n\n14\n\n```\n \_ {\n\n ```\n\n15\n\n```\n \_ \_ \_\"eventSeason\": \"winter\"\n\n ```\n\n16\n\n```\n \_ }\n\n ```\n\n17\n\n```\n ]\n\n ```\n\n18\n\n```\n}\n\n ```\n\n### [Update event properties using external IDs](https://developers.hubspot.com/beta-docs/guides/api/marketing/marketing-events#update-event-properties-using-external-ids)\n\nYou can update marketing events by making a\_`POST`\_request to\_`/marketing/v3/marketing-events/events/upsert`\_endpoint. You can include any\_`customProperties`\_along with any other details of your event (including its name, start time, and description).\n\nIf a marketing event already exists with the specified ID in your request, it will be updated. Otherwise, a new event will be created.\n\nFor example, the following request would create an event with an ID of\_`4`\_named \"Virtual cooking class\":\n\nCopy code snippet\n\n1\n\n```\n// Example request body for POST request to /marketing/v3/marketing-events/events/upsert\n\n ```\n\n2\n\n```\n{\n\n ```\n\n3\n\n```\n \_\"inputs\": [\n\n ```\n\n4\n\n```\n \_ {\n\n ```\n\n5\n\n```\n \_ \_ \_\"customProperties\": [\n\n ```\n\n6\n\n```\n \_ \_ \_ {\n\n ```\n\n7\n\n```\n \_ \_ \_ \_ \_\"name\": \"property1\",\n\n ```\n\n8\n\n```\n \_ \_ \_ \_ \_\"value\": \"1234\"\n\n ```\n\n9\n\n```\n \_ \_ \_ }\n\n ```\n\n10\n\n```\n \_ \_ ],\n\n ```\n\n11\n\n```\n \_ \_ \_\"eventName\": \"Virtual cooking class\",\n\n ```\n\n12\n\n```\n \_ \_ \_\"startDateTime\": \"2023-11-30T17:46:20.461Z\",\n\n ```\n\n13\n\n```\n \_ \_ \_\"eventOrganizer\": \"Chef Joe\",\n\n ```\n\n14\n\n```\n \_ \_ \_\"eventDescription\": \"Join us for a virtual cooking class! Yum.\"\n\n ```\n\n15\n\n```\n \_ \_ \_\"eventCancelled\": false,\n\n ```\n\n16\n\n```\n \_ \_ \_\"externalAccountId\": \"CookingCo\",\n\n ```\n\n17\n\n```\n \_ \_ \_\"externalEventId\": \"4\"\n\n ```\n\n18\n\n```\n \_ }\n\n ```\n\n19\n\n```\n ]\n\n ```\n\n20\n\n```\n}\n\n ```\n\n### [Update event properties using its objectId](https://developers.hubspot.com/beta-docs/guides/api/marketing/marketing-events#update-event-properties-using-its-objectid)\n\nOnce an event is created, you can update its properties by making a\_`PATCH`\_request to\_`/marketing/v3/marketing-events/{objectId}`.\n\n- To get the\_`objectId`\_for a specific marketing event, follow the instructions in\_[this knowledge base article](https://knowledge.hubspot.com/integrations/use-marketing-events#view-and-analyze-marketing-events)\_to view the details for an event in your HubSpot account, then locate the ID under the\__Record ID_\_field. The\_`objectId`\_will also be returned in the response when you successfully create an event.\n \n- You can also make a\_`GET`\_request to the\_`/marketing/v3/marketing-events`\_endpoint described in the next section.\n \n- If you have the\_`externalEventId`\_of an event, you can include it as a path when making a\_`GET`\_request to\_`/marketing/v3/marketing-events/{externalEventId}/identifiers`. The response will include all marketing events along with the relevant identifiers for each event (i.e., the event's\_`objectId`, its\_`appInfo`, the\_`marketingEventName`, and the\_`externalAccountId`).\n \n\n### [Get event details](https://developers.hubspot.com/beta-docs/guides/api/marketing/marketing-events#get-event-details)\n\nTo get a list of all marketing events along with their properties, make a\_`GET`\_request to\_`/marketing/v3/marketing-events`.\n\nIf you need to retrieve the details for a specific marketing event by its\__Record ID_\_in HubSpot, you can provide the ID as the objectId in a\_`GET`\_request to\_`/marketing/v3/marketing-events/{objectId}`.\n\nCopy code snippet\n\n1\n\n```\n// Example response for GET request to /marketing/v3/marketing-events/{objectId}\n\n ```\n\n2\n\n```\n{\n\n ```\n\n3\n\n```\n \_\"eventName\": \"Test Marketing Event\",\n\n ```\n\n4\n\n```\n \_\"eventType\": \"test-type\",\n\n ```\n\n5\n\n```\n \_\"startDateTime\": \"2024-05-22T12:29:50.734Z\",\n\n ```\n\n6\n\n```\n \_\"endDateTime\": \"2024-05-25T12:29:50.734Z\",\n\n ```\n\n7\n\n```\n \_\"eventOrganizer\": \"testEventOrganizer\",\n\n ```\n\n8\n\n```\n \_\"eventDescription\": \"testDescription\",\n\n ```\n\n9\n\n```\n \_\"eventUrl\": \"testURL\",\n\n ```\n\n10\n\n```\n \_\"eventCancelled\": true,\n\n ```\n\n11\n\n```\n \_\"eventCompleted\": false,\n\n ```\n\n12\n\n```\n \_\"customProperties\": [\n\n ```\n\n13\n\n```\n \_ {\n\n ```\n\n14\n\n```\n \_ \_ \_\"name\": \"test_custom_prop\",\n\n ```\n\n15\n\n```\n \_ \_ \_\"value\": \"1\"\n\n ```\n\n16\n\n```\n \_ },\n\n ```\n\n17\n\n```\n \_ {\n\n ```\n\n18\n\n```\n \_ \_ \_\"name\": \"test_prop\",\n\n ```\n\n19\n\n```\n \_ \_ \_\"value\": \"2\"\n\n ```\n\n20\n\n```\n \_ }\n\n ```\n\n21\n\n```\n ],\n\n ```\n\n22\n\n```\n \_\"objectId\": \"58237132332\",\n\n ```\n\n23\n\n```\n \_\"externalEventId\": null,\n\n ```\n\n24\n\n```\n \_\"eventStatus\": \"CANCELLED\",\n\n ```\n\n25\n\n```\n \_\"appInfo\": {\n\n ```\n\n26\n\n```\n \_ \_\"id\": \"111\",\n\n ```\n\n27\n\n```\n \_ \_\"name\": \"Zoom\"\n\n ```\n\n28\n\n```\n },\n\n ```\n\n29\n\n```\n \_\"registrants\": 1,\n\n ```\n\n30\n\n```\n \_\"attendees\": 1,\n\n ```\n\n31\n\n```\n \_\"cancellations\": 2,\n\n ```\n\n32\n\n```\n \_\"noShows\": 0,\n\n ```\n\n33\n\n```\n \_\"createdAt\": \"2024-08-07T12:58:40.635Z\",\n\n ```\n\n34\n\n```\n \_\"updatedAt\": \"2024-10-15T13:35:03.353Z\"\n\n ```\n\n35\n\n```\n}\n\n ```\n\n### [Delete an event](https://developers.hubspot.com/beta-docs/guides/api/marketing/marketing-events#delete-an-event)\n\nTo delete a marketing event, make a\_`DELETE`\_request to\_`/marketing/v3/marketing-events/{objectId}`\_with the event's associated\_`objectId`.\n\nIf successful, you'll receive a\_`204 No Content`\_response.\n\n### [Update multiple events in bulk](https://developers.hubspot.com/beta-docs/guides/api/marketing/marketing-events#update-multiple-events-in-bulk)\n\nTo update multiple marketing events in bulk, you can make a\_`POST`\_request to\_`/marketing-events/v3/marketing-events/batch/update`\_and provide the properties you want to update for each event within the inputs array of the request body.\n\nFor example, if you wanted to update several properties of two marketing events with object IDs of 58237132332 and 54073507364 in a single request, the body of your request would resemble the following:\n\nCopy code snippet\n\n1\n\n```\n// Example request body for batch request to update marketing events\n\n ```\n\n2\n\n```\n{\n\n ```\n\n3\n\n```\n \_\"inputs\": [\n\n ```\n\n4\n\n```\n \_ {\n\n ```\n\n5\n\n```\n \_ \_ \_\"objectId\": \"58237132332\",\n\n ```\n\n6\n\n```\n \_ \_ \_\"eventCancelled\": true,\n\n ```\n\n7\n\n```\n \_ \_ \_\"eventOrganizer\": \"testEventOrganizer\",\n\n ```\n\n8\n\n```\n \_ \_ \_\"eventUrl\": \"testURL\",\n\n ```\n\n9\n\n```\n \_ \_ \_\"eventDescription\": \"testDescription\",\n\n ```\n\n10\n\n```\n \_ \_ \_\"eventName\": \"Test Marketing Event Update\",\n\n ```\n\n11\n\n```\n \_ \_ \_\"eventType\": \"test-type\"\n\n ```\n\n12\n\n```\n \_ },\n\n ```\n\n13\n\n```\n \_ {\n\n ```\n\n14\n\n```\n \_ \_ \_\"objectId\": \"54073507364\",\n\n ```\n\n15\n\n```\n \_ \_ \_\"eventCancelled\": true,\n\n ```\n\n16\n\n```\n \_ \_ \_\"eventOrganizer\": \"testEventOrganizer\",\n\n ```\n\n17\n\n```\n \_ \_ \_\"eventUrl\": \"testURL\",\n\n ```\n\n18\n\n```\n \_ \_ \_\"eventDescription\": \"testDescription\",\n\n ```\n\n19\n\n```\n \_ \_ \_\"eventName\": \"Test Marketing Event Update 2\",\n\n ```\n\n20\n\n```\n \_ \_ \_\"eventType\": \"test-type\"\n\n ```\n\n21\n\n```\n \_ }\n\n ```\n\n22\n\n```\n ]\n\n ```\n\n23\n\n```\n}\n\n ```\n\n## [Event attendance endpoints](https://developers.hubspot.com/beta-docs/guides/api/marketing/marketing-events#event-attendance-endpoints)\n\nThe event attendance state endpoints allow you to record registration activities for a contact, such as whether they registered, attended, or cancelled their registration for your event. For example, you can use this endpoint to record that a HubSpot contact has registered for a marketing event.\n\n### [Update attendance using the event objectId](https://developers.hubspot.com/beta-docs/guides/api/marketing/marketing-events#update-attendance-using-the-event-objectid)\n\nIf you want to use the\_`objectId`\_of a marketing event, you can either use the contact ID of the contact you want to record participation state for, or you can use their email address.\n\n- To use a contact's ID, make a POST request to\_`/marketing/v3/marketing-events/{objectId}/attendance/{subscribeState}/create`\_then provide the ID of the contact using the\_`vid`\_field within the\_`inputs`\_array of your request body. For example, the request body below provides an example of updating the attendance data for a contact with an ID of\_`47733471576`\_and specifying when the attendee joined and left the event via the\_`joinedAt`\_and\_`leftAt`\_properties:\n \n\nCopy code snippet\n\n1\n\n```\n// Example POST request to /marketing/v3/marketing-events/{objectId}/attendance/{subscriberState}/create\n\n ```\n\n2\n\n```\n{\n\n ```\n\n3\n\n```\n \_\"inputs\": [\n\n ```\n\n4\n\n```\n \_ {\n\n ```\n\n5\n\n```\n \_ \_ \_\"vid\": 47733471576,\n\n ```\n\n6\n\n```\n \_ \_ \_\"properties\": {\n\n ```\n\n7\n\n```\n \_ \_ \_ \_\"joinedAt\": \"2024-05-22T13:38:16.500Z\",\n\n ```\n\n8\n\n```\n \_ \_ \_ \_\"leftAt\": \"2024-05-22T15:40:16.500Z\"\n\n ```\n\n9\n\n```\n \_ \_ },\n\n ```\n\n10\n\n```\n \_ \_ \_\"interactionDateTime\": 1716382579000\n\n ```\n\n11\n\n```\n \_ }\n\n ```\n\n12\n\n```\n ]\n\n ```\n\n13\n\n```\n}\n\n ```\n\n- To use a contact's email, make a POST request to\_`/marketing/v3/marketing-events/{objectId}/attendance/{subscribeState}/email-create`\_then provide the email of the contact using the\_`email`\_field within the\_`inputs`\_array of your request body.\n \n - If you're creating a new contact, you can include the\_`contactProperties`\_field within the\_`inputs`\_array of your request body to set any associated properties on the newly created contact. Otherwise, if the contact already exists,\_`contactProperties`\_provided in the request will\_<u>not</u>\_be updated.\n \n - For example, the request body below provides an example of updating the attendance data for a contact with an email address of\_`john@example.com`\_and specifying when the attendee joined and left the event via the\_`joinedAt`\_and\_`leftAt`\_fields within the\_`properties`\_object of your\_`inputs`\_array:\n \n\nCopy code snippet\n\n1\n\n```\n// Example POST request to /marketing/v3/marketing-events/{objectId}/attendance/{subscriberState}/create\n\n ```\n\n2\n\n```\n{\n\n ```\n\n3\n\n```\n \_\"inputs\": [\n\n ```\n\n4\n\n```\n \_ {\n\n ```\n\n5\n\n```\n \_ \_ \_\"contactProperties\": {\n\n ```\n\n6\n\n```\n \_ \_ \_ \_\"additionalProp1\": \"string\",\n\n ```\n\n7\n\n```\n \_ \_ \_ \_\"additionalProp2\": \"string\"\n\n ```\n\n8\n\n```\n \_ \_ },\n\n ```\n\n9\n\n```\n \_ \_ \_\"properties\": {\n\n ```\n\n10\n\n```\n \_ \_ \_ \_\"joinedAt\": \"2024-05-22T13:38:16.500Z\",\n\n ```\n\n11\n\n```\n \_ \_ \_ \_\"leftAt\": \"2024-05-22T15:40:16.500Z\"\n\n ```\n\n12\n\n```\n \_ \_ },\n\n ```\n\n13\n\n```\n \_ \_ \_\"email\": \"john@example.com\",\n\n ```\n\n14\n\n```\n \_ \_ \_\"interactionDateTime\": 1716382579000\n\n ```\n\n15\n\n```\n \_ }\n\n ```\n\n16\n\n```\n ]\n\n ```\n\n17\n\n```\n}\n\n ```\n\nFor either of the approaches above, provide the following values for the corresponding path parameters:\n\n- `objectId`: the\__Record ID_\_of the marketing event in your HubSpot account. Check out the\_[section above](https://developers.hubspot.com/beta-docs/guides/api/marketing/marketing-events#differences-between-internal-id-and-external-id-endpoints)\_for more details on using the objectId of an event versus using its external IDs.\n \n- `subscriberState`: an enumeration that matches the new attendance status of the contact:\n \n- `REGISTERED`: indicates that the HubSpot contact has registered for the event.\n \n- `ATTENDED`: indicates that the HubSpot contact has attended the event. If you're updating a contact's status to ATTENDED, you can also include the\_`joinedAt`\_and\_`leftAt`\_timestamps as parameters in the request body, specified in the ISO8601 Instant format.\n \n- `CANCELLED`: indicates that the HubSpot contact, who had previously registered for the event, has cancelled their registration.\n \n\n### [Update attendance using the external IDs of the event](https://developers.hubspot.com/beta-docs/guides/api/marketing/marketing-events#update-attendance-using-the-external-ids-of-the-event)\n\n**Please note:**\_if you were previously using the\_`/upsert`\_or\_`/email-upsert`\_endpoints to update an attendee's status, you can instead use the alternate endpoints listed below. However, compared to the event attendance endpoints above, using these endpoints will\_<u>not</u>\_provide support for the following:\n\n- Creating a new contact if it doesn't already exist.\n \n- Showing timeline events on the contact record page.\n \n- Specifying the\_`joinedAt`\_or\_`leftAt`\_properties.\n \n- Providing a detailed response upon success.\n \n\nIf you do use the endpoints that require the\_`externalEventId`\_from your app, you can either use the contact IDs or email address of existing contacts:\n\n- If you want to use the contact IDs of existing contacts:\n \n - Make a\_`POST`\_request to\_`/marketing/v3/marketing-events/attendance/{externalEventId}/{subscriberState}/create`, using the ID of the event from your external application as the\_`externalEventId`.\n \n - In the request body, provide an\_`inputs`\_object that includes the following fields:\n \n - `interactionDateTime`: the date and time at which the contact subscribed to the event.\n \n - `vid`: the contact ID of an existing contact.\n \n- If you want to use the email address of one of the event's attendees:\n \n - Make a\_`POST`\_request to\_`/marketing/v3/marketing-events/attendance/{externalEventId}/{subscriberState}/email-create`.\n \n - In the request body, provide an\_`inputs`\_object that includes the following fields:\n \n - `interactionDateTime`: the date and time at which the contact subscribed to the event.\n \n - `email`: the email address of the attendee as the value of the email field within an inputs\n \n - If the email address you include don't match the address of an existing contact, a new contact will be created.\n \n\nFor both of the endpoints above, provide the following values for the corresponding path parameters:\n\n- `externalEventId`: the ID of the\_[marketing event](https://knowledge.hubspot.com/integrations/use-marketing-events#view-edit-and-analyze-marketing-events). Check out the\_[section above](https://developers.hubspot.com/beta-docs/guides/api/marketing/marketing-events#differences-between-internal-id-and-external-id-endpoints)\_for more details on using the objectId of an event versus using its external IDs.\n \n- `subscriberState`: an enumeration that matches the new attendance status of the contact:\n \n- `REGISTERED`: indicates that the HubSpot contact has registered for the event.\n \n- `ATTENDED`: indicates that the HubSpot contact has attended the event. If you're updating a contact's status to ATTENDED, you can also include the\_`joinedAt`\_and\_`leftAt`\_timestamps as parameters in the request body, specified in the ISO8601 Instant format.\n \n- `CANCELLED`: indicates that the HubSpot contact, who had previously registered for the event, has cancelled their registration.\n \n\n**Please note:**\_these APIs are idempotent so long as the ID of the contact and the\_`interactionDateTime`\_value in the event has not changed. This enables you to safely set attendance state multiple times without HubSpot creating duplicate events in the marketing events properties.\n\n## [Participant state endpoints](https://developers.hubspot.com/beta-docs/guides/api/marketing/marketing-events#participant-state-endpoints)\n\nYou can use the participation endpoints to retrieve event participant data for your marketing events. You can query data such as aggregate metrics for a specific event, as well as participant data for a specific contact or event.\n\nReview the available participation endpoints below. For a full reference of all available parameters for each endpoint, check out the\_[reference documentation](https://developers.hubspot.com/beta-docs/reference/api/marketing/marketing-events).\n\n**Please note:**\_the activity counts in the\_[marketing events page](https://knowledge.hubspot.com/integrations/use-marketing-events)\_in your HubSpot account may differ from the corresponding aggregate metrics from the participation counters API endpoint.\n\nFor example, if a participant registered for an event, then cancelled, then re-registered for the same event, each of those activities will be included in the totals you see in the marketing events UI in your account. If you're using the participant state endpoints below, only the current state of a participant is included in the associated counter for that metric (e.g.,\_`attended`,\_`registered`,\_`cancelled`, or\_`noShows`).\n\n### [Read participations for a specific contact](https://developers.hubspot.com/beta-docs/guides/api/marketing/marketing-events#read-participations-for-a-specific-contact)\n\nTo get event participation data for a specific contact, make a\_`GET`\_request to\_`/marketing/v3/marketing-events/participations/contacts/{contactIdentifier}/breakdown`, using's the contact's ID or email address as the\_`contactIdentifier`\_path parameter.\n\nThe response will include a summary of the contact's event participation in the\_`properties`\_field:\n\nCopy code snippet\n\n1\n\n```\n// Example response for GET request for contact participation data\n\n ```\n\n2\n\n```\n{\n\n ```\n\n3\n\n```\n \_\"results\": [\n\n ```\n\n4\n\n```\n \_ {\n\n ```\n\n5\n\n```\n \_ \_ \_\"associations\": {\n\n ```\n\n6\n\n```\n \_ \_ \_ \_\"marketingEvent\": {\n\n ```\n\n7\n\n```\n \_ \_ \_ \_ \_\"externalAccountId\": \"4\",\n\n ```\n\n8\n\n```\n \_ \_ \_ \_ \_\"marketingEventId\": \"123\",\n\n ```\n\n9\n\n```\n \_ \_ \_ \_ \_\"externalEventId\": \"456\",\n\n ```\n\n10\n\n```\n \_ \_ \_ \_ \_\"name\": \"Virtual baking workshop\"\n\n ```\n\n11\n\n```\n \_ \_ \_ },\n\n ```\n\n12\n\n```\n \_ \_ \_ \_\"contact\": {\n\n ```\n\n13\n\n```\n \_ \_ \_ \_ \_\"firstname\": \"Jane\",\n\n ```\n\n14\n\n```\n \_ \_ \_ \_ \_\"contactId\": \"156792341\",\n\n ```\n\n15\n\n```\n \_ \_ \_ \_ \_\"email\": \"jdoe@example.com\",\n\n ```\n\n16\n\n```\n \_ \_ \_ \_ \_\"lastname\": \"Doe\"\n\n ```\n\n17\n\n```\n \_ \_ \_ }\n\n ```\n\n18\n\n```\n \_ \_ },\n\n ```\n\n19\n\n```\n \_ \_ \_\"createdAt\": \"2024-05-21T18:35:04.838Z\",\n\n ```\n\n20\n\n```\n \_ \_ \_\"id\": \"string\",\n\n ```\n\n21\n\n```\n \_ \_ \_\"properties\": {\n\n ```\n\n22\n\n```\n \_ \_ \_ \_\"occurredAt\": \"2024-05-22T10:35:04.838Z\",\n\n ```\n\n23\n\n```\n \_ \_ \_ \_\"attendancePercentage\": \"string\",\n\n ```\n\n24\n\n```\n \_ \_ \_ \_\"attendanceState\": \"REGISTERED\",\n\n ```\n\n25\n\n```\n \_ \_ \_ \_\"attendanceDurationSeconds\": 3600\n\n ```\n\n26\n\n```\n \_ \_ }\n\n ```\n\n27\n\n```\n \_ }\n\n ```\n\n28\n\n```\n ]\n\n ```\n\n29\n\n```\n}\n\n ```\n\n### [Read participation breakdown data](https://developers.hubspot.com/beta-docs/guides/api/marketing/marketing-events#read-participation-breakdown-data)\n\nTo get a breakdown of participation data for a specific event, use your\_`externalAccountId`\_and the\_`externalEventId`\_of your event to make a\_`GET`\_request to\_`/marketing/v3/marketing-events/participations/{externalAccountId}/{externalEventId}/breakdown`.\n\n### [Read participation counters](https://developers.hubspot.com/beta-docs/guides/api/marketing/marketing-events#read-participation-counters)\n\nTo get an aggregate participation summary for an event, use your\_`externalAccountId`\_and the\_`externalEventId`\_of your event to make a\_`GET`\_request to\_`/marketing/v3/marketing-events/participations/{externalAccountId}/{externalEventId}`.\n\nThe response will include the total attendance counts:\n\nCopy code snippet\n\n1\n\n```\n// Example response for GET request for event participation counters\n\n ```\n\n2\n\n```\n{\n\n ```\n\n3\n\n```\n \_\"attended\": 152,\n\n ```\n\n4\n\n```\n \_\"registered\": 200,\n\n ```\n\n5\n\n```\n \_\"cancelled\": 3,\n\n ```\n\n6\n\n```\n \_\"noShows\": 8\n\n ```\n\n7\n\n```\n}\n\n ```\n\n### [Filtering participation breakdown data](https://developers.hubspot.com/beta-docs/guides/api/marketing/marketing-events#filtering-participation-breakdown-data)\n\nWhen fetching breakdown data or event participation data for a specific contact, you can filter the resulting data using the contactIdentifier, state, limit, or after fields as query parameters in your request.\n\n| Query parameter | Type | Description |\n| --- | --- | --- |\n| `contactIdentifier` | string | The email address or ID of a specific contact |\n| `state` | Enumeration | The participation state for the event. The possible participation states are:<br><br>- `REGISTERED`: The contact has registered for the event<br> <br>- `CANCELLED`: The contact's registration has been cancelled.<br> <br>- `ATTENDED`: The contact attended the event.<br> <br>- `NO_SHOW`: The contact registered but did not end up attending the event. |\n| `limit` | Number | Limit the results returned. By default, the limit is set to 10. The valid range is 1-100. |\n| `after` | Number | Used for paging between results in the response. Consult the provided offset in the previous page of response data to determine the next index of results to return. |\n\n## [List association endpoints](https://developers.hubspot.com/beta-docs/guides/api/marketing/marketing-events#list-association-endpoints)\n\nYou can use the endpoints described in the sections below to manage associations between lists and your marketing events.\n\nMany of these endpoints require a\_`listId`\_as a path parameter, which you can find on the list details page in your HubSpot account:\n\n- In your HubSpot account, navigate to\_**CRM**\_>\_**Lists**.\n \n- Click the\_**name**\_of a list.\n \n- In the top right, click\_**Details**.\n \n- In the right panel, the list ID will appear under\__List IDs for API integrations_. You can click\_**Copy list ID**\_to copy the ID to the clipboard.\n \n\n<img src=\"https://www.hubspot.com/hubfs/Knowledge_Base_2023_2024/list-details-panel-list-associations-api.png\" alt=\"list-details-panel-list-associations-api\">\n\nAs you associate lists with your marketing events, they'll appear on the details page for a marketing event in your HubSpot account:\n\n- In your HubSpot account, navigate to\_**CRM**\_>\_**Contacts**.\n \n- In the upper left, click\_**Contacts**\_and in the dropdown menu, select\_**Marketing events**.\n \n- Click the\_**name**\_of a marketing event.\n \n- On the\__Performance_\_tab, click\_**Lists**\_to expand the section, then click the\_**Lists added through associations**\_tab.\n \n\n<img src=\"https://www.hubspot.com/hubfs/Knowledge_Base_2023_2024/review-list-associations-for-marketing-events-api.png\" alt=\"review-list-associations-for-marketing-events-api\">\n\n### [Create list association with a marketing event ID](https://developers.hubspot.com/beta-docs/guides/api/marketing/marketing-events#create-list-association-with-a-marketing-event-id)\n\nTo create a new association between a marketing event and an existing list, make a\_`PUT`\_request to\_`/marketing/v3/marketing-events/associations/{marketingEventId}/lists/{listId}`.\n\nIf successful, you'll receive a\_`204 No content`\_response.\n\n### [Create list association with external event and account IDs](https://developers.hubspot.com/beta-docs/guides/api/marketing/marketing-events#create-list-association-with-external-event-and-account-ids)\n\nTo create a new association between a marketing event and an existing list using the external account ID and the external event ID, make a\_`PUT`\_request to\_`/marketing/v3/marketing-events/associations/{externalAccountId}/{externalEventId}/lists/{listId}`.\n\nIf successful, you'll receive a\_`204 No content`\_response.\n\n### [Get lists associated with a marketing event using a marketing event ID](https://developers.hubspot.com/beta-docs/guides/api/marketing/marketing-events#get-lists-associated-with-a-marketing-event-using-a-marketing-event-id)\n\nTo get all lists associated with a marketing event, make a\_`GET`\_request to\_`/marketing/v3/marketing-events/associations/{marketingEventId}/lists`.\n\nThe response will resemble the following:\n\nCopy code snippet\n\n1\n\n```\n// Example response for GET request for all associated lists for a marketing event\n\n ```\n\n2\n\n```\n{\n\n ```\n\n3\n\n```\n \_\"total\": 1,\n\n ```\n\n4\n\n```\n \_\"results\": [\n\n ```\n\n5\n\n```\n \_ {\n\n ```\n\n6\n\n```\n \_ \_ \_\"listId\": \"string\",\n\n ```\n\n7\n\n```\n \_ \_ \_\"listVersion\": 0,\n\n ```\n\n8\n\n```\n \_ \_ \_\"createdAt\": \"2024-05-10T08:58:35.769Z\",\n\n ```\n\n9\n\n```\n \_ \_ \_\"updatedAt\": \"2024-05-10T08:58:35.769Z\",\n\n ```\n\n10\n\n```\n \_ \_ \_\"filtersUpdatedAt\": \"2024-05-10T08:58:35.769Z\",\n\n ```\n\n11\n\n```\n \_ \_ \_\"processingStatus\": \"string\",\n\n ```\n\n12\n\n```\n \_ \_ \_\"createdById\": \"string\",\n\n ```\n\n13\n\n```\n \_ \_ \_\"updatedById\": \"string\",\n\n ```\n\n14\n\n```\n \_ \_ \_\"processingType\": \"string\",\n\n ```\n\n15\n\n```\n \_ \_ \_\"objectTypeId\": \"string\",\n\n ```\n\n16\n\n```\n \_ \_ \_\"name\": \"string\",\n\n ```\n\n17\n\n```\n \_ \_ \_\"size\": 0\n\n ```\n\n18\n\n```\n \_ }\n\n ```\n\n19\n\n```\n ]\n\n ```\n\n20\n\n```\n}\n\n ```\n\n### [Get lists associated with a event using external event and account IDs](https://developers.hubspot.com/beta-docs/guides/api/marketing/marketing-events#get-lists-associated-with-a-event-using-external-event-and-account-ids)\n\nYou can also get lists associated with a marketing event using an external account ID and the external event ID, make a\_`GET`\_request to\_`/marketing/v3/marketing-events/associations/{externalAccountId}/{externalEventId}/lists`.\n\n### [Delete list association using a marketing event ID](https://developers.hubspot.com/beta-docs/guides/api/marketing/marketing-events#delete-list-association-using-a-marketing-event-id)\n\nTo delete a list association for a marketing event using a marketing event ID, make a\_`DELETE`\_request to\_`/marketing/v3/marketing-events/associations/{marketingEventId}/lists/{listId}`.\n\nIf successful, you'll receive a\_`204 No content`\_response.\n\n### [Delete list association using external event and account IDs](https://developers.hubspot.com/beta-docs/guides/api/marketing/marketing-events#delete-list-association-using-external-event-and-account-ids)\n\nTo delete a list association for a marketing event using the external account ID and an external event ID, make a\_`DELETE`\_request to\_`/marketing/v3/marketing-events/associations/{externalAccountId}/{externalEventId}/lists/{listId}`.\n\nIf successful, you'll receive a\_`204 No content`\_response.\n\n## [Configure app settings](https://developers.hubspot.com/beta-docs/guides/api/marketing/marketing-events#configure-app-settings)\n\nThere's some setup required to allow marketing events to sync properly with HubSpot.\n\nIf you send HubSpot an attendance state change (e.g., a registration or cancellation), HubSpot will first check to see if a Marketing Event exists for the specified event ID. If it doesn't, HubSpot will call the configured endpoint for your app to retrieve the details of the marketing event, then create the event in HubSpot and then publish the attendance state change.\n\nThis is provided for convenience; however, it's still recommended that you create the Marketing Events yourself via the CRUD methods provided in the\_[reference documentation](https://developers.hubspot.com/beta-docs/reference/api/marketing/marketing-events), and don't rely on this functionality to create your marketing events in HubSpot.\n\n### [Step 1: Create an API in your app](https://developers.hubspot.com/beta-docs/guides/api/marketing/marketing-events#step-1-create-an-api-in-your-app)\n\nIn order to support this, HubSpot requires each app that uses Marketing Events to define an API to fetch information about a specific marketing event.\n\nRequirements:\n\n- Accepts:\n \n - `externalAccountId`: a query parameter that specifies the accountId of the customer in the external app.\n \n - `appId`: a query parameter that specifies the ID of the HubSpot application that is requesting the event details. This will be the ID of your app.\n \n - `externalEventId`: a path parameter in the URL of the request that specifies the ID of the event in the external app that HubSpot requires details about.\n \n- Returns:\n \n - A JSON object that provides details for the marketing event, that includes the following fields detailed in the table below:\n \n\n| Field Name | Required | Type | Field Description |\n| --- | --- | --- | --- |\n| `eventName` | true | string | The name of the marketing event |\n| `eventOrganizer` | true | string | The name of the organizer of the marketing event. |\n| `eventType` | false | string | Describes what type of event this is. For example:\_`WEBINAR`,\_`CONFERENCE`,\_`WORKSHOP` |\n| `startDateTime` | false | string($date-time) | The start date and time of the marketing event. |\n| `endDateTime` | false | string($date-time) | The end date and time of the marketing event. |\n| `eventDescription` | false | string | The description of the marketing event. |\n| `eventUrl` | false | string | A URL in the external event application where the marketing event. |\n| `eventCancelled` | false | bool | Indicates if the marketing event has been cancelled. Defaults to\_`false` |\n\nHubSpot will also send a\_`X-HubSpot-Signature-v3`\_header that you can use to verify that the request came from HubSpot. Read more about\_[request signatures](https://developers.hubspot.com/beta-docs/guides/apps/authentication/validating-requests)\_for additional details on the signature and how to validate it.\n\n### [Step 2: Provide HubSpot with the URL path to your API](https://developers.hubspot.com/beta-docs/guides/api/marketing/marketing-events#step-2-provide-hubspot-with-the-url-path-to-your-api)\n\nNow that you've created the API in your app that will return an object that provides the details of a specific marketing event, you will need to provide HubSpot with the URL path to your API by making a\_`POST`\_request to\_`/marketing/v3/marketing-events/{appId}/settings`. This will allow HubSpot to determine how to make requests to your app to get the details of a marketing event.\n\nIn the body of your\_`POST`\_request, specify your URL using the\_`eventDetailsURL`\_field. The\_`eventDetailsURL`\_must adhere to the following two requirements:\n\n- Contain a\_`%s`\_character sequence, which HubSpot will use to substitute in the ID of the event (`externalEventId`) as a path parameter.\n \n- It must be the full path to the API resource, including the\_`https://`\_prefix and the domain name (e.g.,\_`my.event.app`).\n \n\nFor example, if you configure an\_`eventDetailsURL`\_of\_`https://my.event.app/events/%s`, and you need to make a request to fetch details of an event with id\_`1234-event-XYZ`, for the HubSpot app with id\_`app-101`\_and account with id\_`ABC-account-789`, HubSpot will make a\_`GET`\_request to:\n\n`https://my.event.app/events/1234-event-XYZ?appId=app-101&externalAccountId=ABC-account-789`" + - name: Marketing Events API > Batch + - name: Marketing Events API > Attendance Subscriber State Changes + - name: Marketing Events API > Subscriber State Changes + - name: Marketing Events API > Marketing_Events_External + - name: Marketing Events API > Basic + - name: Marketing Events API > Settings + - name: Marketing Events API > Search + - name: Single-Send API + description: "The single-send API allows you to send template emails created in the HubSpot\_[marketing email tool](https://knowledge.hubspot.com/email/create-marketing-emails-in-the-drag-and-drop-email-editor)\_using a JSON-formatted POST request.\n\nAll contacts receiving marketing content must be\_[set as marketing](https://knowledge.hubspot.com/contacts/set-contacts-as-marketing). Any marketing emails sent through the single-send API will automatically be associated with contact records based on their email address, and update non-marketing contacts and set them to marketing contacts . If there's no contact with a matching email address, a new contact record with that email will be created, and the contact will be set as marketing.\n\n## Requirements\n\nTo use the marketing single send API, the following requirements must be met:\n\n- You must have a\__**Marketing Hub**_\__Enterprise_\_account.\n \n- The\_[private app](https://developers.hubspot.com/docs/api/private-apps)\_or\_[public app](https://developers.hubspot.com/docs/api/creating-an-app)\_you're using to make API requests has been granted the\_`marketing-email`\_scope.\n \n\n## Create an email and send it via the single-send API\n\nFirst,\_[set up your email in HubSpot](https://knowledge.hubspot.com/email/how-to-use-transactional-email-in-hubspot). After you create the email, you can set the recipient details, including any contact or custom properties set up in the email template, in the body of the API request. Before you can make the API request, you'll need the ID of the email:\n\n- If you leave the email drafted without publishing it, you can get the email ID from the URL when you're in the email editor. The ID is the final numeric value before the final slash character (`/`) in the URL (e.g.,\_`https://app.hubspot.com/email/{PORTAL_ID}/edit/{EMAIL_ID}/settings`).\n \n\n<img src=\"https://developers.hubspot.com/hs-fs/hubfs/Knowledge_Base_2023/email-id-for-drafted-single-send-api-email.png?width=800&height=133&name=email-id-for-drafted-single-send-api-email.png\" alt=\"\">\n\n- If you publish your email, you can copy the email ID from the email details page.\n \n\n<img src=\"https://developers.hubspot.com/hs-fs/hubfs/Screen Shot 2020-04-15 at 1.00.37 PM.png?width=872&name=Screen Shot 2020-04-15 at 1.00.37 PM.png\" alt=\"\">\n\n**Please note:**\_HubSpot does not save the HTML/JSON sent through this API. You can review the email template from the recipient contact's timeline, but if you want to keep a record of the email's contents, it's recommended to add a BCC to the email.\n\nTo send an email with the Single-Send API, make a\_`POST`\_request to\_`/marketing/v4/email/single-send`.\n\nThe response contains the following fields:\n\n- `requestedAt`: the timestamp of when the send was requested.\n \n- `statusId`: an identifier that can be used to\_[query the status of the send](https://developers.hubspot.com/docs/api/marketing/single-send-api#query-the-status-of-an-email-send).\n \n- `status`: the status of the send request. Includes\_`PENDING`,\_`PROCESSING`,\_`CANCELED`, and\_`COMPLETE`.\n \n\n### Request properties\n\nThe request body must be a JSON-formatted object with the following properties:\n\n- `emailId`\n \n- `message`\n \n- `contactProperties`\n \n- `customProperties`\n \n\n#### emailId\n\nThe\_`emailId`\_field contains the email's content ID, which can be found in HubSpot's email tool.\n\n#### message\n\nThe message field is a JSON object containing anything that you want to override. At the minimum, you must include the\_`to`\_field.\n\nMessage object fields:\n\n- `to`: the recipient of the email\n \n- `from`: the \"From\" header for the email. You can define a from name with the following format:\_`\"from\":\"Sender Name \"`\n \n- `sendId`: the ID of a particular send. Only one email with a given\_`sendId`\_will be sent per account, so you can include this field to prevent duplicate email sends.\n \n- `replyTo`:\_ a JSON list of \"Reply-To\" header values for the email.\n \n- `cc`: a JSON list of email addresses to send as Cc.\n \n- `bcc`: a JSON list of email addresses to send as Bcc.\n \n\n#### contactProperties\n\nThe\_`contactProperties`\_field is a JSON map of contact property values. Each contact property value contains a\_`name`\_and\_`value`. Each property will be set on the contact record and will be visible in the template under:\n\n<img src=\"https://developers.hubspot.com/hs-fs/hubfs/Knowledge_Base_2021/Developer/name-token-in-template-for-transactional-email.png?width=88&height=29&name=name-token-in-template-for-transactional-email.png\" alt=\"\">\n\nUse these properties when you want to set a contact property while you’re sending the email. For example, when sending a receipt you may want to set a\_`last_paid_date`\_property, as the sending of the receipt will have information about the last payment.\n\n```\n{\n \"emailId\": 4126643121,\n \"message\": {\n \"to\": \"jdoe@hubspot.com\"\n \"sendId\": \"6\"\n },\n \"contactProperties\": {\n \"last_paid_date\": \"2022-03-01\",\n \"firstname\": \"jane\"\n } \n}\n\n ```\n\n#### customProperties\n\nThe\_`customProperties`\_field is a JSON map of key-value properties. These properties are generally related to the email itself, not the contact receiving the email. They will not appear in the\_[web page version of the email](https://knowledge.hubspot.com/email/create-a-web-version-of-your-marketing-email), or in the view of the email from the contact's timeline. These properties are also not stored in HubSpot and will only be included in the sent email.\n\nEach key in the\_`customProperties`\_field can be referenced in the template using a\_[HubL expression](https://developers.hubspot.com/docs/cms/hubl)\_for fields contained within the\_`custom`\_variable (e.g.,\_`{{custom.NAME_OF_PROPERTY}}`\_).\n\nFor example, if your email template references two properties,\_`purchaseUrl`\_and\_`productName`, you could provide the associated values for these properties with the following request body:\n\n```\n{\n \"emailId\": 4126643121,\n \"message\": {\n \"to\": \"jdoe@hubspot.com\"\n \"sendId\": \"6\"\n },\n \"customProperties\": {\n \"purchaseUrl\": \"https://example.com/link-to-product\",\n \"productName\": \"vanilla\"\n } \n\n ```\n\nYou can then reference these properties in your email template:\n\nHubL\n\n```\n\n<html>\n <p>\n Congrats on purchasing some of the best ice cream around.\n </p>\n <a href={{custom.purchaseUrl}}>{{custom.productName}}</a>\n</html>\n\n ```\n\nThe\_`customProperties`\_field only supports arrays when used with\_[programmable email content](https://developers.hubspot.com/docs/cms/guides/email/hubdb-crm-objects). In your email template, you can reference the items defined in your\_`customProperties`\_field by using a\_[HubL expression](https://developers.hubspot.com/docs/cms/hubl)\_(e.g., using a\_[for loop](https://developers.hubspot.com/docs/cms/hubl/for-loops)\_to render each item in a list).\_For example, if the\_`customProperties`\_you included in your request body was structured like the following JSON snippet below:\n\nJSON\n\n```\n{\n \"emailId\": 4126643122,\n \"message\": {\n \"to\": \"jdoe@hubspot.com\"\n \"sendId\": \"7\"\n },\n \"customProperties\": {\n \"exampleArray\": [\n {\"firstKey\": \"someValue\", \"secondKey\": \"anotherValue\"},\n {\"firstKey\": \"value1\", \"secondKey\": \"value2\" }\n ]\n } \n}\n\n ```\n\nYou could then reference the values for each item in\_`exampleArray`\_with the following HubL code:\n\nHubL\n\n```\n\n<html>\n <p>\n Thanks for your recent purchase! Here are the details of the items you'll be receiving:\n </p>\n <ul>\n {% for item in custom.exampleArray %}\n <li>First key: {{ item.firstKey }}, Second key: {{item.secondKey}}</li>\n {% endfor %} \n </ul>\n</html>\n\n ```\n\nOnce sent, the email would render the contents of the associated programmable email template as follows:\n\n<img src=\"https://developers.hubspot.com/hs-fs/hubfs/Knowledge_Base_2021/Developer/example-transactional-email-with-customProperties-array.png?width=568&height=114&name=example-transactional-email-with-customProperties-array.png\" alt=\"\">\n\n### Query the status of an email send\n\nTo get the status of the email send, make a\_`GET`\_request to\_`https://api.hubapi.com/marketing/v3/email/send-statuses/{statusId}`.\_\n\nThe response contains the following fields:\n\n- `sendResult`: an enumeration that represents the email's send status. The possible values are\_[listed below](https://developers.hubspot.com/docs/api/marketing/single-send-api#sendresult-values).\n \n- `requestedAt`: the timestamp from when the send was requested.\n \n- `startedAt`: the timestamp when the send began processing.\n \n- `completedAt`: the timestamp when the send completed.\n \n- `statusId`: an identifier that can be used to query the status of the send.\n \n- `status`: the status of the send request. Includes\_`PENDING`,\_`PROCESSING`,\_`CANCELED`, and\_`COMPLETE`.\n \n- `eventId`: if sent, the ID and created timestamp of the sent event.\n \n\n#### sendResult\n\nThe\_`sendResult`\_is an enumeration that reflects the result of an email send attempt. Its possible values are:\n\n- `SENT`: the email was sent successfully.\n \n- `QUEUED`: the email was queued and will send as the queue gets processed.\n \n- `PORTAL_SUSPENDED`: due to\_[Acceptable Use Policy](https://legal.hubspot.com/acceptable-use)\_violations, the HubSpot customer's email has been suspended.\n \n- `INVALID_TO_ADDRESS`: the recipient address is invalid. This error will also occur if you attempt to send an email with any of the following role-based prefixes in the email address:\_`abuse`,\_`no-reply`,\_`noreply`,\_`root`,\_`spam`,\_`security`,\_`undisclosed-recipients`,\_`unsubscribe`,\_`inoc`,\_`postmaster`, or\_`privacy`.\n \n- `BLOCKED_DOMAIN`: the domain cannot receive emails from HubSpot at this time.\n \n- `PREVIOUSLY_BOUNCED`: the recipient has previously bounced, and the sending logic resulted in no send.\n \n- `PREVIOUS_SPAM`: the recipient has previously marked similar email as spam.\n \n- `INVALID_FROM_ADDRESS`: the\__From_\_address is invalid.\n \n- `MISSING_CONTENT`: the\_`emailId`\_is invalid, or the\_`emailId`\_corresponds to an email that wasn't set up for Single-Send.\n \n- `MISSING_TEMPLATE_PROPERTIES`: there are properties set up in the template that have not been included in the\_`customProperties`\_sent in the request." + - name: Single-Send API > Single_Send + - name: Campaigns API + description: "Use the\_[campaigns tool](https://knowledge.hubspot.com/campaigns/understand-campaigns)\_to campaigns to create, manage, and report on a single marketing campaign using multiple assets in one place. For example, you can create a campaign using marketing emails and social posts and raise awareness of a new product or an event. To use the campaigns tool and its corresponding endpoints, you'll need a\_Marketing Hub\_Professional\_or\_Enterprise\_subscription.\_\n\nYou can use campaign endpoints to create, read, update, and delete marketing campaign data. For example, you can use these endpoints to create and manage HubSpot campaigns from your external applications. You can also transfer campaign data to external data warehouses for analytics.\n\nYou can also create, read, update, and delete multiple campaigns with the associated batch endpoints, click the\_Endpoints\_tab at the top of this article for a full list of endpoints and the associated parameters available.\n\n## Scope requirements\n\nThe following scopes are required to use the campaigns API, based on the endpoints you're using:\n\n- `marketing.campaigns.read`: provides access to view details about marketing campaigns and their associated assets.\n \n- `marketing.campaigns.write`: grants access to create, delete, and modify marketing campaigns.\n \n- `marketing.campaigns.revenue.read`: provides access to view revenue details and deal amounts attributed to a marketing campaign.\n \n\n## Create a campaign\n\nTo create a campaign, make a\_`POST`\_request to\_`/marketing/v3/campaigns`.\n\nCreate a campaign with the given properties and return the campaign object, including the\_`campaignGuid`\_and created properties. For example, to create a new campaign, you would make a\_`POST`\_request with the following request body.\_\_\n\nJSON\n\n```\n//Example create request body\n{\n \"properties\": {\n \"hs_name\": \"Inbound\",\n \"hs_start_date\": \"2024-10-30\",\n \"hs_notes\": \"Campaign notes\"\n }\n}\n\n ```\n\nCopy\n\nThe response will include a\_`campaignGuid`, a unique identifier for the campaign. This will be formatted as a UUID. In the following example, the\_`campaignGuid`\_is\_`edb9b6c3-d2e2-4ca8-8396-832262aed0d4`.\n\nJSON\n\n```\n//Example create response body\n{\n \"id\": \"edb9b6c3-d2e2-4ca8-8396-832262aed0d4\",\n \"properties\": {\n \"hs_name\": \"Inbound\",\n \"hs_start_date\": \"2024-10-30\",\n \"hs_notes\": \"Campaign notes\"\n },\n \"createdAt\": \"2024-10-30T03:30:17.883Z\",\n \"updatedAt\": \"2024-12-07T16:50:06.678Z\"\n}\n\n ```\n\nCopy\n\n## Retrieve a campaign\n\nTo retrieve the details of an existing campaign, make a\_`GET`\_request to\_`/marketing/v3/campaigns/{campaignGuid}`.\n\nThis endpoint will return the campaign information. Depending on the query parameters used, this can also be used to return information about the assets and the corresponding assets' metrics. When using this endpoint, you can use the following query parameters.\_\n\n- `properties`**:**\_a comma-separated list of the properties to be returned in the response. For example,\_`hs_name`,\_`hs_campaign_status`,\_`hs_notes`. If any of the specified properties has an empty value on the requested object, it will be ignored and not returned in response. If the parameter is empty, the response will include an empty properties map. \n \n- `startDate`**:**\_the start date to fetch asset metrics, formatted as YYYY-MM-DD. This is used to fetch the metrics associated with the assets for a specified period.\_ If no date is specified, no asset metrics will be retrieved.\_ \_\_ \n \n- `endDate`**:**\_the end date to fetch asset metrics, formatted as YYYY-MM-DD. This is used to fetch the metrics associated with the assets for a specified period. If no date is specified, no asset metrics will be retrieved. \n \n\nFor example, if you made a\_`POST`\_request with\_`/marketing/v3/campaigns/edb9b6c3-d2e2-4ca8-8396-832262aed0d4?properties=hs_name,hs_start_date`, this would result in the following response body:\n\nJSON\n\n```\n//Example get response body\n{\n \"id\": \"edb9b6c3-d2e2-4ca8-8396-832262aed0d4\",\n \"properties\": {\n \"hs_name\": \"Inbound\",\n \"hs_start_date\": \"2024-10-30\",\n },\n \"assets\": {\n \"EMAIL\": {\n \"paging\": {\n \"next\": {\n \"link\": \"?after=NTI1Cg==\",\n \"after\": \"NTI1Cg==\"\n },\n \"results\": [\n {\n \"id\": \"832\",\n \"name\": \"My email\"\n }\n ]\n }\n }\n }, \n \"createdAt\": \"2024-10-30T03:30:17.883Z\",\n \"updatedAt\": \"2024-12-07T16:50:06.678Z\"\n}\n\n ```\n\nCopy\n\n## List assets\n\nTo retrieve the assets associated with a campaign make a\_`GET`\_request to\_`/marketing/v3/campaigns/{campaignId}/assets/{assetType}`.\n\nThis endpoint lists all assets of the campaign by asset type. The\_`assetType`\_parameter is required, and each request can only fetch assets of a single type. The following are required:\n\n- `campaignGuid`**:**\_the UUID of the campaign. \n \n- `assetType`**:**\_the type of asset to be fetched. \n \n\nYou can use the following query parameters with the endpoint:\n\n- `after`**:**\_a cursor for pagination. If provided, the results will start after the given cursor. For example, you can use the value NTI1Cg==.\_\_ \n \n- `limit`**:**\_define the maximum number of results to return. The allowed values range from\_1 to 100. If no limit is specified, it will be set to 10 assets by default.\n \n- `startDate`**:**\_the start date to fetch asset metrics, formatted as YYYY-MM-DD. This is used to fetch the metrics associated with the assets for a specified period. If no date is specified, no asset metrics will be retrieved.\_ \_ \n \n- `endDate`**:**\_the end date to fetch asset metrics, formatted as YYYY-MM-DD. This is used to fetch the metrics associated with the assets for a specified period. If no date is specified, no asset metrics will be retrieved.\n \n\nThe following is a list of available asset types and metrics related to the assets that are returned in response.:\n\n| Asset | Asset type | Metrics |\n| --- | --- | --- |\n| Ad campaigns | `AD_CAMPAIGN` | CLICKS, CONTACTS, and COST |\n| Blog posts | `BLOG_POST` | CONTACTS_FIRST_TOUCH, CONTACTS_LAST_TOUCH, SUBMISSIONS, and VIEWS |\n| Social posts | `SOCIAL_BROADCAST` | FACEBOOK_CLICKS, LINKEDIN_CLICKS, and TWITTER_CLICKS |\n| CTAs | `WEB_INTERACTIVE` | CLICKS and VIEWS |\n| CTAs (Legacy) | `CTA` | CLICKS, SUBMISSIONS, and VIEWS |\n| External website pages | `EXTERNAL_WEB_URL` | VIEWS |\n| Forms | `FORM` | CONVERSION_RATE, SUBMISSIONS, and VIEWS |\n| Landing pages | `LANDING_PAGE` | CONTACTS_FIRST_TOUCH, CONTACTS_LAST_TOUCH, CUSTOMERS, SUBMISSIONS, and VIEWS |\n| Emails | `MARKETING_EMAIL` | CLICKS, OPEN, and SENT |\n| Marketing events | `MARKETING_EVENT` | ATTENDEES, CANCELLATIONS, and REGISTRATIONS |\n| Static lists | `OBJECT_LIST` | CONTACTS |\n| Website pages | `SITE_PAGE` | CONTACTS_FIRST_TOUCH, CONTACTS_LAST_TOUCH, CUSTOMERS,\_SUBMISSIONS, and VIEWS. |\n| Workflows | `AUTOMATION_PLATFORM_FLOW` | CURRENTLY_ENROLLED and STARTED |\n| Marketing SMS | `MARKETING_SMS` | SENT, DELIVERED, and UNIQUE_CLICKS |\n\n## Manage asset associations\n\nTo associate an asset with a campaign make a\_`PUT`\_request to\_`/marketing/v3/campaigns/{campaignGuid}/assets/{assetType}/{assetId}`.\n\nTo remove an asset from a campaign make a\_`DELETE`\_request to\_`/marketing/v3/campaigns/{campaignGuid}/assets/{assetType}/{assetId}`.\n\nYou can use the endpoints above to create and remove associations for the following asset types. For other asset types, learn how to\_[associate assets and content with a campaign](https://knowledge.hubspot.com/campaigns/associate-assets-and-content-with-a-campaign)\_in HubSpot.\_ \_\n\n- `FORM`\n \n- `OBJECT_LIST`\n \n- `EXTERNAL_WEB_URL`\n \n\n## Update campaign\n\nTo perform a partial update of a campaign identified by the specified campaignGuid, make a\_`PATCH`\_request to\_`/marketing/v3/campaigns/{campaignGuid}`.\n\nYou can use the following properties to update your campaign. The provided property values will be overwritten. If your request includes read-only or non-existent properties, you will encounter\_a\_`400 error`. Learn more about which properties can be used.\_\n\nJSON\n\n```\n//Example update request\n{\n \"properties\": {\n \"hs_name\": \"Inbound 2024\",\n }\n}\n\n ```\n\nCopyJSON\n\n```\n//Example update response\n{\n \"id\": \"edb9b6c3-d2e2-4ca8-8396-832262aed0d4\",\n \"properties\": {\n \"hs_name\": \"Inbound 2024\",\n },\n \"createdAt\": \"2024-10-30T03:30:17.883Z\",\n \"updatedAt\": \"2024-12-07T16:50:06.678Z\"\n}\n\n ```\n\nCopy\n\n## Delete a campaign\n\nTo delete a campaign,\_make a\_`DELETE`\_request to\_`/marketing/v3/campaigns?`.\n\nThis call will always return a\_`204 No Content`\_response, regardless of whether the campaignGuid provided corresponds to an existing campaign or not.\n\n## Search for campaigns\n\nTo search for campaigns based on query parameters,\_make a\_`GET`\_request to\_`/marketing/v3/campaigns/{campaignGuid}`.\n\nWhen using this endpoint, you can use the following query parameters.\_\n\n- `name`**:**\_return all campaigns whose names contain the specified substring. This allows partial matching of campaign names, returning all campaigns that include the given substring in their name. If this parameter is not provided, the search will return all campaigns. \n \n- `sort`**:**\_the field by which to sort the results. Allowed values are hs_name, createdAt, updatedAt. An optional '-' before the property name will denote descending order. For example, you can use -CREATED_AT to sort your campaigns from newest to oldest. If this is not specified, the list of campaigns will be sorted in alphabetical order by campaign name.\_\_ \n \n- `after`**:**\_a cursor for pagination. If provided, the results will start after the given cursor. For example, you can use the value NTI1Cg==.\_\_ \n \n- `limit`**:**\_define the maximum number of results to return. The allowed values range from\_1 to 100. If no limit is specified, it will be set to 50 campaigns by default.\_\n \n- `properties:`\_a comma-separated list of the properties to be returned in the response. For example,\_`hs_name`,\_`hs_campaign_status`,\_`hs_notes`. If any of the specified properties has an empty value on the requested object, it will be ignored and not returned in response. If the parameter is empty, the response will include an empty properties map. \n \n\nJSON\n\n```\n//Example reponse body \n// for GET request to https://api.hubapi.com/marketing/v3/campaigns?properties=hs_name&limit=2\n{\n \"total\": 14,\n \"results\": [\n {\n \"id\": \"972e2774-7409-43c2-a8b9-581732dff5a7\",\n \"properties\": {\n \"hs_name\": \"Inbound 2023\"\n },\n \"createdAt\": \"2023-09-07T10:18:06.320Z\",\n \"updatedAt\": \"2023-09-07T10:18:06.320Z\"\n },\n {\n \"id\": \"703bc2f0-f000-4840-b6ae-b2d74bc09fa0\",\n \"properties\": {\n \"hs_name\": \"Inbound 2024\"\n },\n \"createdAt\": \"2024-06-25T10:57:26.232Z\",\n \"updatedAt\": \"2024-06-25T10:57:26.232Z\"\n }\n ],\n \"paging\": {\n \"next\": {\n \"after\": \"Mg==\",\n \"link\": \"https://api.hubspotqa.com/marketing/v3/campaigns? properties=hs_name&limit=2&after=Mg==\"\n }\n }\n}\n\n ```\n\nCopy\n\n## Campaign properties\n\nWhen using the\__properties_\_query parameter for your campaign endpoints, you can use the following properties:\n\n| Property Name | Read Only | Format | Description |\n| --- | --- | --- | --- |\n| `hs_name` | read & write | string | The campaign's name. This should be unique, with a max size of 256 characters. |\n| `hs_start_date` | read & write | date (YYYY-MM-DD) | The campaign's start date. |\n| `hs_end_date` | read & write | date (YYYY-MM-DD) | The campaign's end date. |\n| `hs_notes` | read & write | string | Any notes about the campaign. |\n| `hs_audience` | read & write | string | The campaign's audience. |\n| `hs_goal` | read & write | string | The campaign's goal. |\n| `hs_currency_code` | read & write | ISO currency code | The currency code used for the campaign. |\n| `hs_campaign_status` | read & write | predefined values | The status of the campaign. This includes\_`planned`,\_`in_progress`,\_`active`,\_`paused`, and\_`completed`. |\n| `hs_owner` | read | user id | The user id of the user that owns the campaign |\n| `hs_color_hex` | read | color id | The color of the campaign in hex color code. |\n| `hs_created_by_user_id` | read | user id | The user id of the user that originally created the campaign |\n| `hs_object_id` | read | string | The internal CRM object id. |\n| `hs_budget_items_sum_amount` | read | monetary value | The sum of all budget items. Learn more about managing your\_[campaign budget](https://knowledge.hubspot.com/campaigns/manage-your-campaign-budget). |\n| `hs_spend_items_sum_amount` | read | monetary value | The sum of all spend items. Learn more about managing your\_[campaign budget](https://knowledge.hubspot.com/campaigns/manage-your-campaign-budget). |" + - name: Campaigns API > Basic + - name: Campaigns API > Search + - name: Campaigns API > Batch + - name: Campaigns API > Reports + - name: Campaigns API > Asset + - name: Campaigns API > Budget + - name: Forms API + - name: Forms API > Forms +paths: + /marketing/v3/transactional/smtp-tokens/{tokenId}: + get: + tags: + - Transactional Email API > Public_Smtp_Tokens + summary: Query a single token by ID. + description: Query a single token by ID. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: tokenId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + campaignName: <string> + createContact: <boolean> + createdAt: <dateTime> + createdBy: <string> + emailCampaignId: <string> + id: <string> + password: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "consequat74": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "exercitation_fb5": [ + "<string>", + "<string>" + ], + "tempor168": [ + "<string>", + "<string>" + ], + "quiad9": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "esse_c1": [ + "<string>", + "<string>" + ], + "pariatur__": [ + "<string>", + "<string>" + ], + "laboris5a": [ + "<string>", + "<string>" + ] + }, + "links": { + "iruref0d": "<string>" + } + } + delete: + tags: + - Transactional Email API > Public_Smtp_Tokens + summary: Delete a single token by ID. + description: Delete a single token by ID. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: tokenId + in: path + schema: + type: string + required: true + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "consequat74": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "exercitation_fb5": [ + "<string>", + "<string>" + ], + "tempor168": [ + "<string>", + "<string>" + ], + "quiad9": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "esse_c1": [ + "<string>", + "<string>" + ], + "pariatur__": [ + "<string>", + "<string>" + ], + "laboris5a": [ + "<string>", + "<string>" + ] + }, + "links": { + "iruref0d": "<string>" + } + } + /marketing/v3/transactional/smtp-tokens: + get: + tags: + - Transactional Email API > Public_Smtp_Tokens + summary: Query SMTP API tokens by campaign name or an emailCampaignId. + description: >- + Query multiple SMTP API tokens by campaign name or a single token by + emailCampaignId. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: campaignName + in: query + schema: + type: string + description: A name for the campaign tied to the SMTP API token. + example: <string> + - name: emailCampaignId + in: query + schema: + type: string + description: >- + Identifier assigned to the campaign provided during the token + creation. + example: <string> + - name: after + in: query + schema: + type: string + description: Starting point to get the next set of results. + example: <string> + - name: limit + in: query + schema: + type: string + description: Maximum number of tokens to return. + example: <integer> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - campaignName: <string> + createContact: <boolean> + createdAt: <dateTime> + createdBy: <string> + emailCampaignId: <string> + id: <string> + password: <string> + - campaignName: <string> + createContact: <boolean> + createdAt: <dateTime> + createdBy: <string> + emailCampaignId: <string> + id: <string> + password: <string> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "consequat74": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "exercitation_fb5": [ + "<string>", + "<string>" + ], + "tempor168": [ + "<string>", + "<string>" + ], + "quiad9": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "esse_c1": [ + "<string>", + "<string>" + ], + "pariatur__": [ + "<string>", + "<string>" + ], + "laboris5a": [ + "<string>", + "<string>" + ] + }, + "links": { + "iruref0d": "<string>" + } + } + post: + tags: + - Transactional Email API > Public_Smtp_Tokens + summary: Create a SMTP API token. + description: Create a SMTP API token. + requestBody: + content: + application/json: + schema: + type: object + example: + campaignName: <string> + createContact: <boolean> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + campaignName: <string> + createContact: <boolean> + createdAt: <dateTime> + createdBy: <string> + emailCampaignId: <string> + id: <string> + password: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "consequat74": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "exercitation_fb5": [ + "<string>", + "<string>" + ], + "tempor168": [ + "<string>", + "<string>" + ], + "quiad9": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "esse_c1": [ + "<string>", + "<string>" + ], + "pariatur__": [ + "<string>", + "<string>" + ], + "laboris5a": [ + "<string>", + "<string>" + ] + }, + "links": { + "iruref0d": "<string>" + } + } + /marketing/v3/transactional/smtp-tokens/{tokenId}/password-reset: + post: + tags: + - Transactional Email API > Public_Smtp_Tokens + summary: Reset the password of an existing token. + description: >- + Allows the creation of a replacement password for a given token. Once + the password is successfully reset, the old password for the token will + be invalid. + requestBody: + content: {} + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: tokenId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + campaignName: <string> + createContact: <boolean> + createdAt: <dateTime> + createdBy: <string> + emailCampaignId: <string> + id: <string> + password: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "consequat74": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "exercitation_fb5": [ + "<string>", + "<string>" + ], + "tempor168": [ + "<string>", + "<string>" + ], + "quiad9": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "esse_c1": [ + "<string>", + "<string>" + ], + "pariatur__": [ + "<string>", + "<string>" + ], + "laboris5a": [ + "<string>", + "<string>" + ] + }, + "links": { + "iruref0d": "<string>" + } + } + /marketing/v3/transactional/single-email/send: + post: + tags: + - Transactional Email API > Single_Send + summary: Send a single transactional email asynchronously. + description: >- + Asynchronously send a transactional email. Returns the status of the + email send with a statusId that can be used to continuously query for + the status using the Email Send Status API. + requestBody: + content: + application/json: + schema: + type: object + example: + emailId: <integer> + message: + to: <string> + from: <string> + sendId: <string> + replyTo: + - <string> + - <string> + cc: + - <string> + - <string> + bcc: + - <string> + - <string> + contactProperties: + proident3ed: <string> + tempor_7d: <string> + dolor713: <string> + customProperties: + id_ff: {} + in45: {} + sed3: {} + suntd_: {} + qui0f5: {} + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + status: PROCESSING + statusId: <string> + sendResult: GRAYMAIL_SUPPRESSED + requestedAt: <dateTime> + startedAt: <dateTime> + completedAt: <dateTime> + eventId: + created: <dateTime> + id: <uuid> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "consequat74": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "exercitation_fb5": [ + "<string>", + "<string>" + ], + "tempor168": [ + "<string>", + "<string>" + ], + "quiad9": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "esse_c1": [ + "<string>", + "<string>" + ], + "pariatur__": [ + "<string>", + "<string>" + ], + "laboris5a": [ + "<string>", + "<string>" + ] + }, + "links": { + "iruref0d": "<string>" + } + } + /communication-preferences/v3/subscribe: + post: + tags: + - Subscription Preferences API > Status + summary: Subscribe a contact + description: >- + Subscribes a contact to the given subscription type. This API is not + valid to use for subscribing a contact at a brand or portal level and + will return an error. + requestBody: + content: + application/json: + schema: + type: object + example: + emailAddress: <string> + subscriptionId: <string> + legalBasis: CONSENT_WITH_NOTICE + legalBasisExplanation: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + description: <string> + id: <string> + name: <string> + sourceOfStatus: PORTAL_WIDE_STATUS + status: NOT_SUBSCRIBED + brandId: <long> + preferenceGroupName: <string> + legalBasis: LEGITIMATE_INTEREST_PQL + legalBasisExplanation: <string> + '400': + description: Bad Request + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + example: + status: error + message: >- + subscription 7148712 for example@example.com cannot be + updated because they have unsubscribed + correlationId: af3df921-1418-4b18-b6f4-35ca117728ae + category: VALIDATION_ERROR + requestId: 3b0e0c44-fd57-4714-a3c9-42f6fead33c8 + '404': + description: Not Found + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + example: + status: error + message: >- + example@example.com either has no subscriptions associated + with this portal or does not exist + correlationId: af3df921-1418-4b18-b6f4-35ca117728ae + category: OBJECT_NOT_FOUND + requestId: 3b0e0c44-fd57-4714-a3c9-42f6fead33c8 + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "sint_f8": [ + "<string>", + "<string>" + ], + "veniam_8f": [ + "<string>", + "<string>" + ], + "dolore_27": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "culpa65": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "in_0": [ + "<string>", + "<string>" + ], + "nulla_aee": [ + "<string>", + "<string>" + ] + }, + "links": { + "veniam_69": "<string>", + "aute_65": "<string>", + "nulla_278": "<string>", + "eu_a": "<string>" + } + } + /communication-preferences/v3/unsubscribe: + post: + tags: + - Subscription Preferences API > Status + summary: Unsubscribe a contact + description: >- + Unsubscribes a contact from the given subscription type. This API is not + valid to use for unsubscribing a contact at a brand or portal level and + will return an error. + requestBody: + content: + application/json: + schema: + type: object + example: + emailAddress: <string> + subscriptionId: <string> + legalBasis: CONSENT_WITH_NOTICE + legalBasisExplanation: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + description: <string> + id: <string> + name: <string> + sourceOfStatus: PORTAL_WIDE_STATUS + status: NOT_SUBSCRIBED + brandId: <long> + preferenceGroupName: <string> + legalBasis: LEGITIMATE_INTEREST_PQL + legalBasisExplanation: <string> + '400': + description: Bad Request + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + example: + status: error + message: >- + example@example.com is already unsubscribed to subscription + 7148712 + correlationId: af3df921-1418-4b18-b6f4-35ca117728ae + category: VALIDATION_ERROR + requestId: 3b0e0c44-fd57-4714-a3c9-42f6fead33c8 + '404': + description: Not Found + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + example: + status: error + message: >- + example@example.com either has no subscriptions associated + with this portal or does not exist + correlationId: af3df921-1418-4b18-b6f4-35ca117728ae + category: OBJECT_NOT_FOUND + requestId: 3b0e0c44-fd57-4714-a3c9-42f6fead33c8 + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "sint_f8": [ + "<string>", + "<string>" + ], + "veniam_8f": [ + "<string>", + "<string>" + ], + "dolore_27": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "culpa65": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "in_0": [ + "<string>", + "<string>" + ], + "nulla_aee": [ + "<string>", + "<string>" + ] + }, + "links": { + "veniam_69": "<string>", + "aute_65": "<string>", + "nulla_278": "<string>", + "eu_a": "<string>" + } + } + /communication-preferences/v3/status/email/{emailAddress}: + get: + tags: + - Subscription Preferences API > Status + summary: Get subscription statuses for a contact + description: Returns a list of subscriptions and their status for a given contact. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: emailAddress + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + recipient: <string> + subscriptionStatuses: + - description: <string> + id: <string> + name: <string> + sourceOfStatus: PORTAL_WIDE_STATUS + status: NOT_SUBSCRIBED + brandId: <long> + preferenceGroupName: <string> + legalBasis: LEGITIMATE_INTEREST_OTHER + legalBasisExplanation: <string> + - description: <string> + id: <string> + name: <string> + sourceOfStatus: BRAND_WIDE_STATUS + status: NOT_SUBSCRIBED + brandId: <long> + preferenceGroupName: <string> + legalBasis: NON_GDPR + legalBasisExplanation: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "sint_f8": [ + "<string>", + "<string>" + ], + "veniam_8f": [ + "<string>", + "<string>" + ], + "dolore_27": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "culpa65": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "in_0": [ + "<string>", + "<string>" + ], + "nulla_aee": [ + "<string>", + "<string>" + ] + }, + "links": { + "veniam_69": "<string>", + "aute_65": "<string>", + "nulla_278": "<string>", + "eu_a": "<string>" + } + } + /communication-preferences/v3/definitions: + get: + tags: + - Subscription Preferences API > Definition + summary: Get subscription definitions + description: Get a list of all subscription definitions for the portal + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + subscriptionDefinitions: + - createdAt: <dateTime> + description: <string> + id: <string> + isActive: <boolean> + isDefault: <boolean> + isInternal: <boolean> + name: <string> + updatedAt: <dateTime> + purpose: <string> + communicationMethod: <string> + - createdAt: <dateTime> + description: <string> + id: <string> + isActive: <boolean> + isDefault: <boolean> + isInternal: <boolean> + name: <string> + updatedAt: <dateTime> + purpose: <string> + communicationMethod: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "sint_f8": [ + "<string>", + "<string>" + ], + "veniam_8f": [ + "<string>", + "<string>" + ], + "dolore_27": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "culpa65": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "in_0": [ + "<string>", + "<string>" + ], + "nulla_aee": [ + "<string>", + "<string>" + ] + }, + "links": { + "veniam_69": "<string>", + "aute_65": "<string>", + "nulla_278": "<string>", + "eu_a": "<string>" + } + } + /marketing/v3/emails/statistics/list: + get: + tags: + - Marketing Emails API > Statistics + summary: Get aggregated statistics. + description: >- + Use this endpoint to get aggregated statistics of emails sent in a + specified time span. It also returns the list of emails that were sent + during the time span. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: startTimestamp + in: query + schema: + type: string + description: The start timestamp of the time span, in ISO8601 representation. + example: <string> + - name: endTimestamp + in: query + schema: + type: string + description: The end timestamp of the time span, in ISO8601 representation. + example: <string> + - name: emailIds + in: query + schema: + type: string + description: >- + Filter by email IDs. Only include statistics of emails with these + IDs. + example: <long> + - name: emailIds + in: query + schema: + type: string + description: >- + Filter by email IDs. Only include statistics of emails with these + IDs. + example: <long> + - name: property + in: query + schema: + type: string + description: >- + Specifies which email properties should be returned. All properties + will be returned by default. + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + emails: + - <long> + - <long> + campaignAggregations: + iruree6: + counters: + officiabde: <long> + deviceBreakdown: + ut_ed: + aute_f: <long> + in4: <long> + consectetur39: + Duis_b2: <long> + do_2: <long> + qualifierStats: + adipisicing299: + laboris_01: <long> + dolora: + non12: <long> + ratios: + Duis5: <number> + enim_bd: <number> + minimd2: + counters: + estf: <long> + esse46: <long> + dolor_ba1: <long> + deviceBreakdown: + officia_c6: + officia03: <long> + tempor_373: <long> + anim_eb5: <long> + ex_a: <long> + qualifierStats: + laboris_e: + aliquip3: <long> + ea1bb: <long> + cupidatat5b: + sint_44e: <long> + minim_b: <long> + consectetur_2a3: + sunt_c7f: <long> + sed_8: <long> + ratios: + essea: <number> + eu_fd4: <number> + Excepteurf7a: <number> + Lorem9fb: <number> + ut_0: + counters: + consectetur6: <long> + irurecd6: <long> + deviceBreakdown: + aliquip_5_6: + ut_1: <long> + Duisd49: <long> + cupidatat_b: + dolor27: <long> + deseruntb: <long> + qualifierStats: + irure_a9b: + cupidatatc3_: <long> + reprehenderit_7: + eub: <long> + ratios: + officia_b: <number> + velit_2e: <number> + aggregate: + counters: + velite9: <long> + consequat5f: <long> + nisi_f: <long> + deviceBreakdown: + sunt641: + animae: <long> + etf6: <long> + in_26_: + in_c1a: <long> + officia_97: <long> + Duis7: <long> + qualifierStats: + culpa_1: + esse_5: <long> + qui_63: <long> + ratios: + sit2c: <number> + exfa: <number> + Ut__b4: <number> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "est92": [ + "<string>", + "<string>" + ], + "aliquad3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "et_b": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "sed42_": [ + "<string>", + "<string>" + ], + "qui__42": [ + "<string>", + "<string>" + ] + }, + "links": { + "velit02": "<string>" + } + } + /marketing/v3/emails/statistics/histogram: + get: + tags: + - Marketing Emails API > Statistics + summary: Get aggregated statistic intervals. + description: >- + Get aggregated statistics in intervals for a specified time span. Each + interval contains aggregated statistics of the emails that were sent in + that time. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: interval + in: query + schema: + type: string + description: The interval to aggregate statistics for. + example: YEAR + - name: startTimestamp + in: query + schema: + type: string + description: The start timestamp of the time span, in ISO8601 representation. + example: <string> + - name: endTimestamp + in: query + schema: + type: string + description: The end timestamp of the time span, in ISO8601 representation. + example: <string> + - name: emailIds + in: query + schema: + type: string + description: >- + Filter by email IDs. Only include statistics of emails with these + IDs. + example: <long> + - name: emailIds + in: query + schema: + type: string + description: >- + Filter by email IDs. Only include statistics of emails with these + IDs. + example: <long> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - aggregations: + counters: + nostrudf: <long> + deviceBreakdown: + enim__1: + ea_d: <long> + consectetur_bfa: <long> + nisid5: <long> + proident52: + tempor_0: <long> + laborum_2: <long> + tempor387: <long> + eiusmod_3: + Excepteur0: <long> + qualifierStats: + ea_58d: + deseruntb7: <long> + incididunt6: + Excepteurc: <long> + adipisicing_58: <long> + ex_cf: + Lorem_7: <long> + utf_: <long> + ratios: + cupidatatb01: <number> + interval: + end: <dateTime> + start: <dateTime> + - aggregations: + counters: + voluptate2c6: <long> + ea_447: <long> + deviceBreakdown: + in_752: + minim25: <long> + Duisbd0: <long> + qualifierStats: + Duis_09: + anim0: <long> + veniam_52c: <long> + aute_a5: <long> + eiusmod_2: <long> + ratios: + deserunt_1: <number> + irureece: <number> + interval: + end: <dateTime> + start: <dateTime> + total: <integer> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "est92": [ + "<string>", + "<string>" + ], + "aliquad3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "et_b": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "sed42_": [ + "<string>", + "<string>" + ], + "qui__42": [ + "<string>", + "<string>" + ] + }, + "links": { + "velit02": "<string>" + } + } + /marketing/v3/emails/{emailId}/ab-test/get-variation: + get: + tags: + - Marketing Emails API > Marketing Emails + summary: Get the variation of a an A/B marketing email + description: >- + This endpoint lets you obtain the variation of an A/B marketing email. + If the email is variation A (master) it will return variation B + (variant) and vice versa. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: emailId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + content: + templatePath: <string> + plainTextVersion: <string> + widgets: + Excepteur_8: {} + in15: {} + tempor_0: {} + widgetContainers: + fugiat_f8: {} + labore9: {} + in74c: {} + flexAreas: + commodoed3: {} + laborea8: {} + ut_5: {} + styleSettings: {} + smartFields: + culpaf3: {} + proident2f: {} + themeSettingsValues: + commodo2aa: {} + from: + fromName: <string> + replyTo: <string> + customReplyTo: <string> + id: <string> + name: <string> + sendOnPublish: <boolean> + state: RSS_TO_EMAIL_DRAFT + subcategory: <string> + subject: <string> + to: + contactLists: + include: + - <long> + - <long> + exclude: + - <long> + - <long> + contactIds: + include: + - <long> + - <long> + exclude: + - <long> + - <long> + limitSendFrequency: <boolean> + suppressGraymail: <boolean> + createdById: <integer> + type: RESUBSCRIBE_EMAIL + activeDomain: <string> + archived: <boolean> + folderId: <long> + feedbackSurveyId: <integer> + stats: + counters: + occaecat_35: <long> + esse_dae: <long> + aliquip_9b: <long> + deviceBreakdown: + ad_9: + ea586: <long> + amet_cce: <long> + exercitation_2f: + ut_2: <long> + eiusmod_d1: <long> + qualifierStats: + Duis_4: + qui_e3: <long> + laborisf: <long> + Ut_2: + doloref: <long> + sunt_3: + qui045: <long> + nostrud1: <long> + ratios: + eiusmode34: <number> + fugiat_41: <number> + testing: + testId: <long> + hoursToWait: <integer> + abSuccessMetric: OPENS_BY_DELIVERED + abSampleSizeDefault: variant + abStatus: automated_master + abTestPercentage: <integer> + abSamplingDefault: master + subscriptionDetails: + subscriptionId: <long> + preferencesGroupId: <long> + officeLocationId: <string> + updatedById: <integer> + publishedById: <integer> + language: bo-in + campaign: <string> + webversion: + slug: <string> + domain: <string> + title: <string> + metaDescription: <string> + redirectToUrl: <string> + redirectToPageId: <long> + expiresAt: <dateTime> + rssData: + maxEntries: <integer> + timing: + laborisfe_: {} + ipsum2: {} + url: <string> + hubspotBlogId: <long> + blogEmailType: <string> + blogImageMaxWidth: <integer> + rssEntryTemplate: <string> + useHeadlineAsSubject: <boolean> + blogLayout: <string> + isTransactional: <boolean> + isPublished: <boolean> + publishDate: <dateTime> + updatedAt: <dateTime> + createdAt: <dateTime> + deletedAt: <dateTime> + publishedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "est92": [ + "<string>", + "<string>" + ], + "aliquad3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "et_b": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "sed42_": [ + "<string>", + "<string>" + ], + "qui__42": [ + "<string>", + "<string>" + ] + }, + "links": { + "velit02": "<string>" + } + } + /marketing/v3/emails/{emailId}/draft/reset: + post: + tags: + - Marketing Emails API > Marketing Emails + summary: Reset Draft + description: Resets the draft back to a copy of the live object. + requestBody: + content: {} + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: emailId + in: path + schema: + type: string + required: true + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "est92": [ + "<string>", + "<string>" + ], + "aliquad3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "et_b": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "sed42_": [ + "<string>", + "<string>" + ], + "qui__42": [ + "<string>", + "<string>" + ] + }, + "links": { + "velit02": "<string>" + } + } + /marketing/v3/emails/{emailId}/revisions/{revisionId}/restore-to-draft: + post: + tags: + - Marketing Emails API > Marketing Emails + summary: Restore a revision of a marketing email to DRAFT state + description: >- + Restores a previous revision of a marketing email to DRAFT state. If + there is currently something in the draft for that object, it is + overwritten. + requestBody: + content: {} + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: emailId + in: path + schema: + type: string + required: true + example: <string> + - name: revisionId + in: path + schema: + type: string + required: true + example: <long> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + content: + templatePath: <string> + plainTextVersion: <string> + widgets: + Excepteur_8: {} + in15: {} + tempor_0: {} + widgetContainers: + fugiat_f8: {} + labore9: {} + in74c: {} + flexAreas: + commodoed3: {} + laborea8: {} + ut_5: {} + styleSettings: {} + smartFields: + culpaf3: {} + proident2f: {} + themeSettingsValues: + commodo2aa: {} + from: + fromName: <string> + replyTo: <string> + customReplyTo: <string> + id: <string> + name: <string> + sendOnPublish: <boolean> + state: RSS_TO_EMAIL_DRAFT + subcategory: <string> + subject: <string> + to: + contactLists: + include: + - <long> + - <long> + exclude: + - <long> + - <long> + contactIds: + include: + - <long> + - <long> + exclude: + - <long> + - <long> + limitSendFrequency: <boolean> + suppressGraymail: <boolean> + createdById: <integer> + type: RESUBSCRIBE_EMAIL + activeDomain: <string> + archived: <boolean> + folderId: <long> + feedbackSurveyId: <integer> + stats: + counters: + occaecat_35: <long> + esse_dae: <long> + aliquip_9b: <long> + deviceBreakdown: + ad_9: + ea586: <long> + amet_cce: <long> + exercitation_2f: + ut_2: <long> + eiusmod_d1: <long> + qualifierStats: + Duis_4: + qui_e3: <long> + laborisf: <long> + Ut_2: + doloref: <long> + sunt_3: + qui045: <long> + nostrud1: <long> + ratios: + eiusmode34: <number> + fugiat_41: <number> + testing: + testId: <long> + hoursToWait: <integer> + abSuccessMetric: OPENS_BY_DELIVERED + abSampleSizeDefault: variant + abStatus: automated_master + abTestPercentage: <integer> + abSamplingDefault: master + subscriptionDetails: + subscriptionId: <long> + preferencesGroupId: <long> + officeLocationId: <string> + updatedById: <integer> + publishedById: <integer> + language: bo-in + campaign: <string> + webversion: + slug: <string> + domain: <string> + title: <string> + metaDescription: <string> + redirectToUrl: <string> + redirectToPageId: <long> + expiresAt: <dateTime> + rssData: + maxEntries: <integer> + timing: + laborisfe_: {} + ipsum2: {} + url: <string> + hubspotBlogId: <long> + blogEmailType: <string> + blogImageMaxWidth: <integer> + rssEntryTemplate: <string> + useHeadlineAsSubject: <boolean> + blogLayout: <string> + isTransactional: <boolean> + isPublished: <boolean> + publishDate: <dateTime> + updatedAt: <dateTime> + createdAt: <dateTime> + deletedAt: <dateTime> + publishedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "est92": [ + "<string>", + "<string>" + ], + "aliquad3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "et_b": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "sed42_": [ + "<string>", + "<string>" + ], + "qui__42": [ + "<string>", + "<string>" + ] + }, + "links": { + "velit02": "<string>" + } + } + /marketing/v3/emails/{emailId}/draft: + get: + tags: + - Marketing Emails API > Marketing Emails + summary: Get draft version of a marketing email + description: >- + Get the draft version of an email (if it exists). If no draft version + exists, the published email is returned. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: emailId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + content: + templatePath: <string> + plainTextVersion: <string> + widgets: + Excepteur_8: {} + in15: {} + tempor_0: {} + widgetContainers: + fugiat_f8: {} + labore9: {} + in74c: {} + flexAreas: + commodoed3: {} + laborea8: {} + ut_5: {} + styleSettings: {} + smartFields: + culpaf3: {} + proident2f: {} + themeSettingsValues: + commodo2aa: {} + from: + fromName: <string> + replyTo: <string> + customReplyTo: <string> + id: <string> + name: <string> + sendOnPublish: <boolean> + state: RSS_TO_EMAIL_DRAFT + subcategory: <string> + subject: <string> + to: + contactLists: + include: + - <long> + - <long> + exclude: + - <long> + - <long> + contactIds: + include: + - <long> + - <long> + exclude: + - <long> + - <long> + limitSendFrequency: <boolean> + suppressGraymail: <boolean> + createdById: <integer> + type: RESUBSCRIBE_EMAIL + activeDomain: <string> + archived: <boolean> + folderId: <long> + feedbackSurveyId: <integer> + stats: + counters: + occaecat_35: <long> + esse_dae: <long> + aliquip_9b: <long> + deviceBreakdown: + ad_9: + ea586: <long> + amet_cce: <long> + exercitation_2f: + ut_2: <long> + eiusmod_d1: <long> + qualifierStats: + Duis_4: + qui_e3: <long> + laborisf: <long> + Ut_2: + doloref: <long> + sunt_3: + qui045: <long> + nostrud1: <long> + ratios: + eiusmode34: <number> + fugiat_41: <number> + testing: + testId: <long> + hoursToWait: <integer> + abSuccessMetric: OPENS_BY_DELIVERED + abSampleSizeDefault: variant + abStatus: automated_master + abTestPercentage: <integer> + abSamplingDefault: master + subscriptionDetails: + subscriptionId: <long> + preferencesGroupId: <long> + officeLocationId: <string> + updatedById: <integer> + publishedById: <integer> + language: bo-in + campaign: <string> + webversion: + slug: <string> + domain: <string> + title: <string> + metaDescription: <string> + redirectToUrl: <string> + redirectToPageId: <long> + expiresAt: <dateTime> + rssData: + maxEntries: <integer> + timing: + laborisfe_: {} + ipsum2: {} + url: <string> + hubspotBlogId: <long> + blogEmailType: <string> + blogImageMaxWidth: <integer> + rssEntryTemplate: <string> + useHeadlineAsSubject: <boolean> + blogLayout: <string> + isTransactional: <boolean> + isPublished: <boolean> + publishDate: <dateTime> + updatedAt: <dateTime> + createdAt: <dateTime> + deletedAt: <dateTime> + publishedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "est92": [ + "<string>", + "<string>" + ], + "aliquad3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "et_b": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "sed42_": [ + "<string>", + "<string>" + ], + "qui__42": [ + "<string>", + "<string>" + ] + }, + "links": { + "velit02": "<string>" + } + } + patch: + tags: + - Marketing Emails API > Marketing Emails + summary: Create or update draft version + description: >- + Create or update the draft version of a marketing email. If no draft + exists, the system creates a draft from the current “live” email then + applies the request body to that draft. The draft version only lives on + the buffer—the email is not cloned. + requestBody: + content: + application/json: + schema: + type: object + example: + content: + templatePath: <string> + plainTextVersion: <string> + widgets: + Excepteur_8: {} + in15: {} + tempor_0: {} + widgetContainers: + fugiat_f8: {} + labore9: {} + in74c: {} + flexAreas: + commodoed3: {} + laborea8: {} + ut_5: {} + styleSettings: {} + smartFields: + culpaf3: {} + proident2f: {} + themeSettingsValues: + commodo2aa: {} + from: + fromName: <string> + replyTo: <string> + customReplyTo: <string> + id: <string> + name: <string> + sendOnPublish: <boolean> + state: RSS_TO_EMAIL_DRAFT + subcategory: <string> + subject: <string> + to: + contactLists: + include: + - <long> + - <long> + exclude: + - <long> + - <long> + contactIds: + include: + - <long> + - <long> + exclude: + - <long> + - <long> + limitSendFrequency: <boolean> + suppressGraymail: <boolean> + createdById: <integer> + type: RESUBSCRIBE_EMAIL + activeDomain: <string> + archived: <boolean> + folderId: <long> + feedbackSurveyId: <integer> + stats: + counters: + occaecat_35: <long> + esse_dae: <long> + aliquip_9b: <long> + deviceBreakdown: + ad_9: + ea586: <long> + amet_cce: <long> + exercitation_2f: + ut_2: <long> + eiusmod_d1: <long> + qualifierStats: + Duis_4: + qui_e3: <long> + laborisf: <long> + Ut_2: + doloref: <long> + sunt_3: + qui045: <long> + nostrud1: <long> + ratios: + eiusmode34: <number> + fugiat_41: <number> + testing: + testId: <long> + hoursToWait: <integer> + abSuccessMetric: OPENS_BY_DELIVERED + abSampleSizeDefault: variant + abStatus: automated_master + abTestPercentage: <integer> + abSamplingDefault: master + subscriptionDetails: + subscriptionId: <long> + preferencesGroupId: <long> + officeLocationId: <string> + updatedById: <integer> + publishedById: <integer> + language: bo-in + campaign: <string> + webversion: + slug: <string> + domain: <string> + title: <string> + metaDescription: <string> + redirectToUrl: <string> + redirectToPageId: <long> + expiresAt: <dateTime> + rssData: + maxEntries: <integer> + timing: + laborisfe_: {} + ipsum2: {} + url: <string> + hubspotBlogId: <long> + blogEmailType: <string> + blogImageMaxWidth: <integer> + rssEntryTemplate: <string> + useHeadlineAsSubject: <boolean> + blogLayout: <string> + isTransactional: <boolean> + isPublished: <boolean> + publishDate: <dateTime> + updatedAt: <dateTime> + createdAt: <dateTime> + deletedAt: <dateTime> + publishedAt: <dateTime> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: emailId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + content: + templatePath: <string> + plainTextVersion: <string> + widgets: + Excepteur_8: {} + in15: {} + tempor_0: {} + widgetContainers: + fugiat_f8: {} + labore9: {} + in74c: {} + flexAreas: + commodoed3: {} + laborea8: {} + ut_5: {} + styleSettings: {} + smartFields: + culpaf3: {} + proident2f: {} + themeSettingsValues: + commodo2aa: {} + from: + fromName: <string> + replyTo: <string> + customReplyTo: <string> + id: <string> + name: <string> + sendOnPublish: <boolean> + state: RSS_TO_EMAIL_DRAFT + subcategory: <string> + subject: <string> + to: + contactLists: + include: + - <long> + - <long> + exclude: + - <long> + - <long> + contactIds: + include: + - <long> + - <long> + exclude: + - <long> + - <long> + limitSendFrequency: <boolean> + suppressGraymail: <boolean> + createdById: <integer> + type: RESUBSCRIBE_EMAIL + activeDomain: <string> + archived: <boolean> + folderId: <long> + feedbackSurveyId: <integer> + stats: + counters: + occaecat_35: <long> + esse_dae: <long> + aliquip_9b: <long> + deviceBreakdown: + ad_9: + ea586: <long> + amet_cce: <long> + exercitation_2f: + ut_2: <long> + eiusmod_d1: <long> + qualifierStats: + Duis_4: + qui_e3: <long> + laborisf: <long> + Ut_2: + doloref: <long> + sunt_3: + qui045: <long> + nostrud1: <long> + ratios: + eiusmode34: <number> + fugiat_41: <number> + testing: + testId: <long> + hoursToWait: <integer> + abSuccessMetric: OPENS_BY_DELIVERED + abSampleSizeDefault: variant + abStatus: automated_master + abTestPercentage: <integer> + abSamplingDefault: master + subscriptionDetails: + subscriptionId: <long> + preferencesGroupId: <long> + officeLocationId: <string> + updatedById: <integer> + publishedById: <integer> + language: bo-in + campaign: <string> + webversion: + slug: <string> + domain: <string> + title: <string> + metaDescription: <string> + redirectToUrl: <string> + redirectToPageId: <long> + expiresAt: <dateTime> + rssData: + maxEntries: <integer> + timing: + laborisfe_: {} + ipsum2: {} + url: <string> + hubspotBlogId: <long> + blogEmailType: <string> + blogImageMaxWidth: <integer> + rssEntryTemplate: <string> + useHeadlineAsSubject: <boolean> + blogLayout: <string> + isTransactional: <boolean> + isPublished: <boolean> + publishDate: <dateTime> + updatedAt: <dateTime> + createdAt: <dateTime> + deletedAt: <dateTime> + publishedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "est92": [ + "<string>", + "<string>" + ], + "aliquad3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "et_b": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "sed42_": [ + "<string>", + "<string>" + ], + "qui__42": [ + "<string>", + "<string>" + ] + }, + "links": { + "velit02": "<string>" + } + } + /marketing/v3/emails/{emailId}/revisions: + get: + tags: + - Marketing Emails API > Marketing Emails + summary: Get revisions of a marketing email + description: >- + Get a list of all versions of a marketing email, with each entry + including the full state of that particular version. The current + revision has the ID -1. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: after + in: query + schema: + type: string + description: >- + The cursor token value to get the next set of results. You can get + this from the `paging.next.after` JSON property of a paged response + containing more results. + example: <string> + - name: before + in: query + schema: + type: string + description: >- + The cursor token value to get the previous set of results. You can + get this from the `paging.prev.before` JSON property of a paged + response containing more results. + example: <string> + - name: limit + in: query + schema: + type: string + description: The maximum number of results to return. Default is 100. + example: <integer> + - name: emailId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - id: <string> + object: + abHoursToWait: <integer> + abStatus: mab_variant + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - magna_d6: {} + - velitd: {} + sunt_2_8: {} + authorName: <string> + blogEmailType: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '6' + createPage: <boolean> + created: <dateTime> + createdById: <string> + currentState: AUTOMATED_AB_VARIANT + currentlyPublished: <boolean> + customReplyTo: <string> + customReplyToEnabled: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + emailType: MEMBERSHIP_PASSWORD_RESET_EMAIL + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <long> + footerHtml: <string> + fromName: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + isGraymailSuppressionEnabled: <boolean> + language: ar-iq + layoutSections: + irure2: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + reprehenderit_a_6: {} + sit1d: {} + ex_c: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - ex__e8: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - magna8d: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + in3: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + id_04: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + Ut_d4b: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + id2: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - nulla_c8a: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cupidatat_8: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - culpa1_4: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + ut_dd0: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + Duis_9: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + fugiat182: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + deserunt_91: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - Lorem_35c: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cillum__e9: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - ullamco90_: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + doloree: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + doloreeee: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - Excepteurba: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + deserunt_69d: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - mollit_4f: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + aliqua506: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + tempor_92: {} + doc: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - aute_5: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + deserunt66: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - ex_56: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + ullamco_7ba: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + mailingListsExcluded: + - <integer> + - <integer> + mailingListsIncluded: + - <integer> + - <integer> + maxRssEntries: <integer> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + replyTo: <string> + rssEmailAuthorLineTemplate: <string> + rssEmailBlogImageMaxWidth: <integer> + rssEmailByText: <string> + rssEmailClickThroughText: <string> + rssEmailCommentText: <string> + rssEmailEntryTemplate: <string> + rssEmailEntryTemplateEnabled: <boolean> + rssEmailId: <long> + rssEmailUrl: <string> + rssToEmailTiming: + Excepteur_8ba: {} + cupidatat_d37: {} + voluptate94: {} + nostrud_b59: {} + slug: <string> + state: AUTOMATED_LOSER_ABVARIANT + stats: + counters: + proident_2c5: <long> + deviceBreakdown: + laboris_6: + pariatur_2: <long> + sit_c6: + id348: <long> + reprehenderitb97: <long> + velit_9e: + quis7: <long> + fugiat_66: <long> + qualifierStats: + aliquipc4c: + elit86: <long> + eiusmod_1: <long> + aliquad37: <long> + ullamcoe0c: + proident_5: <long> + enimae9: <long> + ratios: + enimc3: <number> + id498: <number> + subcategory: <string> + subject: <string> + subscription: <long> + subscriptionBlogId: <long> + subscriptionName: <string> + templatePath: <string> + themeSettingsValues: + reprehenderit_7f: {} + commodo2: {} + cupidatat_64: {} + transactional: <boolean> + translatedFromId: <string> + translations: + fugiat_a: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + pariatur__c: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + elit_4d9: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + useRssHeadlineAsSubject: <boolean> + vidsExcluded: + - <long> + - <long> + vidsIncluded: + - <long> + - <long> + widgetContainers: + Excepteur_86: {} + cupidatat_1: {} + widgets: + qui2ee: {} + consectetur_f: {} + proident_fe: {} + laboris_3f4: {} + workflowNames: + - <string> + - <string> + isRecipientFatigueSuppressionEnabled: <boolean> + smartEmailFields: + ametad5: {} + feedbackSurveyId: <integer> + content: + smartFields: + consecteturef: {} + mollit_0d3: {} + themeSettingsValues: + elit63: {} + laborum_7: {} + flexAreas: + suntf: {} + widgets: + ea_3: {} + plainTextVersion: <string> + templatePath: <string> + widgetContainers: + incididunt_0c3: {} + sint_35e: {} + styleSettings: + emailBodyPadding: <string> + colorPickerFavorite5: <string> + bodyColor: <string> + colorPickerFavorite6: <string> + backgroundImage: <string> + emailBodyWidth: <string> + secondaryFont: <string> + primaryAccentColor: <string> + colorPickerFavorite3: <string> + primaryFontLineHeight: <string> + colorPickerFavorite4: <string> + secondaryFontColor: <string> + colorPickerFavorite1: <string> + colorPickerFavorite2: <string> + bodyBorderColor: <string> + bodyBorderWidth: <integer> + linksFont: + size: <integer> + color: <string> + underline: <boolean> + bold: <boolean> + italic: <boolean> + font: <string> + backgroundColor: <string> + backgroundImageType: <string> + dividerStyleSettings: + color: {} + lineType: <string> + height: <integer> + secondaryAccentColor: <string> + secondaryFontLineHeight: <string> + primaryFontSize: <integer> + secondaryFontSize: <integer> + primaryFontColor: <string> + headingOneFont: + size: <integer> + color: <string> + underline: <boolean> + bold: <boolean> + italic: <boolean> + font: <string> + primaryFont: <string> + headingTwoFont: + size: <integer> + color: <string> + underline: <boolean> + bold: <boolean> + italic: <boolean> + font: <string> + buttonStyleSettings: + backgroundColor: {} + fontStyle: + size: <integer> + color: <string> + underline: <boolean> + bold: <boolean> + italic: <boolean> + font: <string> + cornerRadius: <integer> + bodyBorderColorChoice: <string> + from: + customReplyTo: <string> + fromName: <string> + replyTo: <string> + sendOnPublish: <boolean> + to: + limitSendFrequency: <boolean> + suppressGraymail: <boolean> + contactIds: + include: + - <string> + - <string> + exclude: + - <string> + - <string> + contactLists: + include: + - <string> + - <string> + exclude: + - <string> + - <string> + user: + email: <string> + fullName: <string> + id: <string> + updatedAt: <dateTime> + - id: <string> + object: + abHoursToWait: <integer> + abStatus: automated_master + abTestId: <string> + archivedAt: <dateTime> + archivedInDashboard: <boolean> + attachedStylesheets: + - ea_5: {} + aliqua_058: {} + - sed_f_2: {} + authorName: <string> + blogEmailType: <string> + campaign: <string> + categoryId: <integer> + contentGroupId: <string> + contentTypeCategory: '5' + createPage: <boolean> + created: <dateTime> + createdById: <string> + currentState: PROCESSING + currentlyPublished: <boolean> + customReplyTo: <string> + customReplyToEnabled: <boolean> + domain: <string> + dynamicPageDataSourceId: <string> + dynamicPageDataSourceType: <integer> + dynamicPageHubDbTableId: <string> + emailType: BLOG_EMAIL + enableDomainStylesheets: <boolean> + enableLayoutStylesheets: <boolean> + featuredImage: <string> + featuredImageAltText: <string> + folderId: <long> + footerHtml: <string> + fromName: <string> + headHtml: <string> + htmlTitle: <string> + id: <string> + includeDefaultCustomCss: <boolean> + isGraymailSuppressionEnabled: <boolean> + language: en-il + layoutSections: + ad_72d: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + nisi_6: {} + sunt5ef: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - ex_0: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + reprehenderit_a8c: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - magna821: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + do2ac: + cells: + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + cssClass: <string> + cssId: <string> + cssStyle: <string> + label: <string> + name: <string> + params: + Uta5e: {} + Duis_8: {} + rowMetaData: + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + - cssClass: <string> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + rows: + - sed5cd: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + aliqua1: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + - elite9: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + magnac5: + value: >- + <Circular reference to + #/components/schemas/LayoutSection detected> + styles: + backgroundColor: + a: <number> + b: <integer> + g: <integer> + r: <integer> + backgroundGradient: + angle: + units: <string> + value: <number> + colors: + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + - color: + a: <number> + b: <integer> + g: <integer> + r: <integer> + sideOrCorner: + horizontalSide: <string> + verticalSide: <string> + backgroundImage: + backgroundPosition: <string> + backgroundSize: <string> + imageUrl: <string> + flexboxPositioning: <string> + forceFullWidthSection: <boolean> + maxWidthSectionCentering: <integer> + verticalAlignment: <string> + type: <string> + w: <integer> + x: <integer> + linkRelCanonicalUrl: <string> + mabExperimentId: <string> + mailingListsExcluded: + - <integer> + - <integer> + mailingListsIncluded: + - <integer> + - <integer> + maxRssEntries: <integer> + metaDescription: <string> + name: <string> + pageExpiryDate: <long> + pageExpiryEnabled: <boolean> + pageExpiryRedirectId: <long> + pageExpiryRedirectUrl: <string> + pageRedirected: <boolean> + password: <string> + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + publishImmediately: <boolean> + replyTo: <string> + rssEmailAuthorLineTemplate: <string> + rssEmailBlogImageMaxWidth: <integer> + rssEmailByText: <string> + rssEmailClickThroughText: <string> + rssEmailCommentText: <string> + rssEmailEntryTemplate: <string> + rssEmailEntryTemplateEnabled: <boolean> + rssEmailId: <long> + rssEmailUrl: <string> + rssToEmailTiming: + ex_03: {} + slug: <string> + state: PAGE_STUB + stats: + counters: + dolor_f: <long> + deviceBreakdown: + labore_5ce: + sint_036: <long> + laborum6a8: <long> + Loremae: + veniam_2: <long> + pariaturf: <long> + qualifierStats: + eab96: + occaecatc: <long> + aliquip5: <long> + eiusmod_1e: <long> + nisi95: + sit_18: <long> + ratios: + qui_57: <number> + subcategory: <string> + subject: <string> + subscription: <long> + subscriptionBlogId: <long> + subscriptionName: <string> + templatePath: <string> + themeSettingsValues: + est_96: {} + amet_56: {} + transactional: <boolean> + translatedFromId: <string> + translations: + irure_a21: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + sit__c: + archivedInDashboard: <boolean> + authorName: <string> + campaign: <string> + created: <dateTime> + id: <long> + name: <string> + password: <string> + publicAccessRules: [] + publicAccessRulesEnabled: <boolean> + publishDate: <dateTime> + slug: <string> + state: <string> + updated: <dateTime> + tagIds: + - <long> + - <long> + updated: <dateTime> + updatedById: <string> + url: <string> + useFeaturedImage: <boolean> + useRssHeadlineAsSubject: <boolean> + vidsExcluded: + - <long> + - <long> + vidsIncluded: + - <long> + - <long> + widgetContainers: + do4b6: {} + eucf: {} + dolor_8f: {} + eu_b: {} + widgets: + dolore91: {} + pariatur_2: {} + workflowNames: + - <string> + - <string> + isRecipientFatigueSuppressionEnabled: <boolean> + smartEmailFields: + consequat_87: {} + in2e: {} + aliqua01: {} + feedbackSurveyId: <integer> + content: + smartFields: + aliquip73e: {} + consectetur7e: {} + themeSettingsValues: + reprehenderit_f6: {} + nullab: {} + flexAreas: + sunt_f: {} + widgets: + adipisicing_71e: {} + id97: {} + plainTextVersion: <string> + templatePath: <string> + widgetContainers: + pariatur00: {} + ullamcobf: {} + cupidatat455: {} + commodo5fb: {} + styleSettings: + emailBodyPadding: <string> + colorPickerFavorite5: <string> + bodyColor: <string> + colorPickerFavorite6: <string> + backgroundImage: <string> + emailBodyWidth: <string> + secondaryFont: <string> + primaryAccentColor: <string> + colorPickerFavorite3: <string> + primaryFontLineHeight: <string> + colorPickerFavorite4: <string> + secondaryFontColor: <string> + colorPickerFavorite1: <string> + colorPickerFavorite2: <string> + bodyBorderColor: <string> + bodyBorderWidth: <integer> + linksFont: + size: <integer> + color: <string> + underline: <boolean> + bold: <boolean> + italic: <boolean> + font: <string> + backgroundColor: <string> + backgroundImageType: <string> + dividerStyleSettings: + color: {} + lineType: <string> + height: <integer> + secondaryAccentColor: <string> + secondaryFontLineHeight: <string> + primaryFontSize: <integer> + secondaryFontSize: <integer> + primaryFontColor: <string> + headingOneFont: + size: <integer> + color: <string> + underline: <boolean> + bold: <boolean> + italic: <boolean> + font: <string> + primaryFont: <string> + headingTwoFont: + size: <integer> + color: <string> + underline: <boolean> + bold: <boolean> + italic: <boolean> + font: <string> + buttonStyleSettings: + backgroundColor: {} + fontStyle: + size: <integer> + color: <string> + underline: <boolean> + bold: <boolean> + italic: <boolean> + font: <string> + cornerRadius: <integer> + bodyBorderColorChoice: <string> + from: + customReplyTo: <string> + fromName: <string> + replyTo: <string> + sendOnPublish: <boolean> + to: + limitSendFrequency: <boolean> + suppressGraymail: <boolean> + contactIds: + include: + - <string> + - <string> + exclude: + - <string> + - <string> + contactLists: + include: + - <string> + - <string> + exclude: + - <string> + - <string> + user: + email: <string> + fullName: <string> + id: <string> + updatedAt: <dateTime> + total: <integer> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "est92": [ + "<string>", + "<string>" + ], + "aliquad3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "et_b": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "sed42_": [ + "<string>", + "<string>" + ], + "qui__42": [ + "<string>", + "<string>" + ] + }, + "links": { + "velit02": "<string>" + } + } + /marketing/v3/emails/{emailId}/revisions/{revisionId}: + get: + tags: + - Marketing Emails API > Marketing Emails + summary: Get a revision of a marketing email. + description: Get a specific revision of a marketing email. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: emailId + in: path + schema: + type: string + required: true + example: <string> + - name: revisionId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + id: <string> + object: + content: + templatePath: <string> + plainTextVersion: <string> + widgets: + Duis__a4: {} + ad_af9: {} + occaecat_a: {} + widgetContainers: + eiusmod0: {} + pariatur10f: {} + flexAreas: + velit1a4: {} + styleSettings: {} + smartFields: + culpadd: {} + dolor_d95: {} + themeSettingsValues: + amet_74: {} + from: + fromName: <string> + replyTo: <string> + customReplyTo: <string> + id: <string> + name: <string> + sendOnPublish: <boolean> + state: AUTOMATED_FOR_FORM_LEGACY + subcategory: <string> + subject: <string> + to: + contactLists: + include: + - <long> + - <long> + exclude: + - <long> + - <long> + contactIds: + include: + - <long> + - <long> + exclude: + - <long> + - <long> + limitSendFrequency: <boolean> + suppressGraymail: <boolean> + createdById: <integer> + type: MEMBERSHIP_REGISTRATION_EMAIL + activeDomain: <string> + archived: <boolean> + folderId: <long> + feedbackSurveyId: <integer> + stats: + counters: + adipisicingfb: <long> + deviceBreakdown: + dolor0: + pariatur8: <long> + officia9: + cupidatat774: <long> + qualifierStats: + cupidatat95: + aliqua_f_: <long> + in_a: <long> + ratios: + dolore3: <number> + Lorem_9: <number> + testing: + testId: <long> + hoursToWait: <integer> + abSuccessMetric: CLICKS_BY_OPENS + abSampleSizeDefault: automated_loser_variant + abStatus: automated_variant + abTestPercentage: <integer> + abSamplingDefault: master + subscriptionDetails: + subscriptionId: <long> + preferencesGroupId: <long> + officeLocationId: <string> + updatedById: <integer> + publishedById: <integer> + language: jmc + campaign: <string> + webversion: + slug: <string> + domain: <string> + title: <string> + metaDescription: <string> + redirectToUrl: <string> + redirectToPageId: <long> + expiresAt: <dateTime> + rssData: + maxEntries: <integer> + timing: + voluptate0e5: {} + url: <string> + hubspotBlogId: <long> + blogEmailType: <string> + blogImageMaxWidth: <integer> + rssEntryTemplate: <string> + useHeadlineAsSubject: <boolean> + blogLayout: <string> + isTransactional: <boolean> + isPublished: <boolean> + publishDate: <dateTime> + updatedAt: <dateTime> + createdAt: <dateTime> + deletedAt: <dateTime> + publishedAt: <dateTime> + updatedAt: <dateTime> + user: + email: <string> + fullName: <string> + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "est92": [ + "<string>", + "<string>" + ], + "aliquad3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "et_b": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "sed42_": [ + "<string>", + "<string>" + ], + "qui__42": [ + "<string>", + "<string>" + ] + }, + "links": { + "velit02": "<string>" + } + } + /marketing/v3/emails/: + get: + tags: + - Marketing Emails API > Marketing Emails + summary: Get all marketing emails for a HubSpot account. + description: >- + The results can be filtered, allowing you to find a specific set of + emails. See the table below for a full list of filtering options. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: createdAt + in: query + schema: + type: string + description: Only return emails created at exactly the specified time. + example: <dateTime> + - name: createdAfter + in: query + schema: + type: string + description: Only return emails created after the specified time. + example: <dateTime> + - name: createdBefore + in: query + schema: + type: string + description: Only return emails created before the specified time. + example: <dateTime> + - name: updatedAt + in: query + schema: + type: string + description: Only return emails last updated at exactly the specified time. + example: <dateTime> + - name: updatedAfter + in: query + schema: + type: string + description: Only return emails last updated after the specified time. + example: <dateTime> + - name: updatedBefore + in: query + schema: + type: string + description: Only return emails last updated before the specified time. + example: <dateTime> + - name: sort + in: query + schema: + type: string + description: >- + Specifies which fields to use for sorting results. Valid fields are + `name`, `createdAt`, `updatedAt`, `createdBy`, `updatedBy`. + `createdAt` will be used by default. + example: <string> + - name: sort + in: query + schema: + type: string + description: >- + Specifies which fields to use for sorting results. Valid fields are + `name`, `createdAt`, `updatedAt`, `createdBy`, `updatedBy`. + `createdAt` will be used by default. + example: <string> + - name: after + in: query + schema: + type: string + description: >- + The cursor token value to get the next set of results. You can get + this from the `paging.next.after` JSON property of a paged response + containing more results. + example: <string> + - name: limit + in: query + schema: + type: string + description: The maximum number of results to return. Default is 100. + example: <integer> + - name: includeStats + in: query + schema: + type: string + description: Include statistics with emails. + example: <boolean> + - name: type + in: query + schema: + type: string + description: >- + Email types to be filtered by. Multiple types can be included. All + emails will be returned if not present. + example: OPTIN_EMAIL + - name: isPublished + in: query + schema: + type: string + description: >- + Filter by published/draft emails. All emails will be returned if not + present. + example: <boolean> + - name: includedProperties + in: query + schema: + type: string + example: <string> + - name: includedProperties + in: query + schema: + type: string + example: <string> + - name: archived + in: query + schema: + type: string + description: Specifies whether to return archived emails. Defaults to `false`. + example: <boolean> + - name: marketingCampaignNames + in: query + schema: + type: string + example: <boolean> + - name: workflowNames + in: query + schema: + type: string + example: <boolean> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - content: + templatePath: <string> + plainTextVersion: <string> + widgets: + ad_d84: {} + widgetContainers: + irure_34: {} + sed_9: {} + fugiat2: {} + et_7c0: {} + sunt_acc: {} + flexAreas: + magna726: {} + sintebe: {} + tempor_4a: {} + occaecatf15: {} + styleSettings: {} + smartFields: + adipisicing_d4: {} + enim1_: {} + culpac6: {} + themeSettingsValues: + elit0: {} + occaecatb: {} + anim_e5: {} + cupidatat3: {} + from: + fromName: <string> + replyTo: <string> + customReplyTo: <string> + id: <string> + name: <string> + sendOnPublish: <boolean> + state: SCHEDULED_AB + subcategory: <string> + subject: <string> + to: + contactLists: + include: + - <long> + - <long> + exclude: + - <long> + - <long> + contactIds: + include: + - <long> + - <long> + exclude: + - <long> + - <long> + limitSendFrequency: <boolean> + suppressGraymail: <boolean> + createdById: <integer> + type: MEMBERSHIP_REGISTRATION_EMAIL + activeDomain: <string> + archived: <boolean> + folderId: <long> + feedbackSurveyId: <integer> + stats: + counters: + mollit_9d7: <long> + utd: <long> + excd7: <long> + deviceBreakdown: + inb33: + tempor_b52: <long> + adb7c: + quis_0: <long> + qualifierStats: + dolore47: + est7: <long> + ratios: + dolord55: <number> + testing: + testId: <long> + hoursToWait: <integer> + abSuccessMetric: OPENS_BY_DELIVERED + abSampleSizeDefault: automated_loser_variant + abStatus: mab_variant + abTestPercentage: <integer> + abSamplingDefault: automated_loser_variant + subscriptionDetails: + subscriptionId: <long> + preferencesGroupId: <long> + officeLocationId: <string> + updatedById: <integer> + publishedById: <integer> + language: ff + campaign: <string> + webversion: + slug: <string> + domain: <string> + title: <string> + metaDescription: <string> + redirectToUrl: <string> + redirectToPageId: <long> + expiresAt: <dateTime> + rssData: + maxEntries: <integer> + timing: + deseruntc34: {} + Duis_772: {} + nulla_328: {} + idfd2: {} + url: <string> + hubspotBlogId: <long> + blogEmailType: <string> + blogImageMaxWidth: <integer> + rssEntryTemplate: <string> + useHeadlineAsSubject: <boolean> + blogLayout: <string> + isTransactional: <boolean> + isPublished: <boolean> + publishDate: <dateTime> + updatedAt: <dateTime> + createdAt: <dateTime> + deletedAt: <dateTime> + publishedAt: <dateTime> + - content: + templatePath: <string> + plainTextVersion: <string> + widgets: + dolore6: {} + veniamcf: {} + widgetContainers: + cillumb3: {} + consequat_e: {} + flexAreas: + pariaturcd6: {} + sitf: {} + styleSettings: {} + smartFields: + tempor_8e3: {} + themeSettingsValues: + esse_c47: {} + dolore_0f: {} + from: + fromName: <string> + replyTo: <string> + customReplyTo: <string> + id: <string> + name: <string> + sendOnPublish: <boolean> + state: AUTOMATED_DRAFT_ABVARIANT + subcategory: <string> + subject: <string> + to: + contactLists: + include: + - <long> + - <long> + exclude: + - <long> + - <long> + contactIds: + include: + - <long> + - <long> + exclude: + - <long> + - <long> + limitSendFrequency: <boolean> + suppressGraymail: <boolean> + createdById: <integer> + type: OPTIN_EMAIL + activeDomain: <string> + archived: <boolean> + folderId: <long> + feedbackSurveyId: <integer> + stats: + counters: + magna8: <long> + deviceBreakdown: + nona0d: + culpa6f2: <long> + ea_11: + velit8b: <long> + aute___: <long> + qualifierStats: + et634: + sedec: <long> + ratios: + dolor_0a: <number> + amet_a2: <number> + enime: <number> + testing: + testId: <long> + hoursToWait: <integer> + abSuccessMetric: CLICKS_BY_DELIVERED + abSampleSizeDefault: mab_master + abStatus: automated_variant + abTestPercentage: <integer> + abSamplingDefault: loser_variant + subscriptionDetails: + subscriptionId: <long> + preferencesGroupId: <long> + officeLocationId: <string> + updatedById: <integer> + publishedById: <integer> + language: sq-mk + campaign: <string> + webversion: + slug: <string> + domain: <string> + title: <string> + metaDescription: <string> + redirectToUrl: <string> + redirectToPageId: <long> + expiresAt: <dateTime> + rssData: + maxEntries: <integer> + timing: + dolore_e_: {} + url: <string> + hubspotBlogId: <long> + blogEmailType: <string> + blogImageMaxWidth: <integer> + rssEntryTemplate: <string> + useHeadlineAsSubject: <boolean> + blogLayout: <string> + isTransactional: <boolean> + isPublished: <boolean> + publishDate: <dateTime> + updatedAt: <dateTime> + createdAt: <dateTime> + deletedAt: <dateTime> + publishedAt: <dateTime> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "est92": [ + "<string>", + "<string>" + ], + "aliquad3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "et_b": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "sed42_": [ + "<string>", + "<string>" + ], + "qui__42": [ + "<string>", + "<string>" + ] + }, + "links": { + "velit02": "<string>" + } + } + post: + tags: + - Marketing Emails API > Marketing Emails + summary: Create a new marketing email. + description: Use this endpoint to create a new marketing email. + requestBody: + content: + application/json: + schema: + type: object + example: + content: + templatePath: <string> + plainTextVersion: <string> + widgets: + Excepteur_8: {} + in15: {} + tempor_0: {} + widgetContainers: + fugiat_f8: {} + labore9: {} + in74c: {} + flexAreas: + commodoed3: {} + laborea8: {} + ut_5: {} + styleSettings: {} + smartFields: + culpaf3: {} + proident2f: {} + themeSettingsValues: + commodo2aa: {} + from: + fromName: <string> + replyTo: <string> + customReplyTo: <string> + id: <string> + name: <string> + sendOnPublish: <boolean> + state: RSS_TO_EMAIL_DRAFT + subcategory: <string> + subject: <string> + to: + contactLists: + include: + - <long> + - <long> + exclude: + - <long> + - <long> + contactIds: + include: + - <long> + - <long> + exclude: + - <long> + - <long> + limitSendFrequency: <boolean> + suppressGraymail: <boolean> + createdById: <integer> + type: RESUBSCRIBE_EMAIL + activeDomain: <string> + archived: <boolean> + folderId: <long> + feedbackSurveyId: <integer> + stats: + counters: + occaecat_35: <long> + esse_dae: <long> + aliquip_9b: <long> + deviceBreakdown: + ad_9: + ea586: <long> + amet_cce: <long> + exercitation_2f: + ut_2: <long> + eiusmod_d1: <long> + qualifierStats: + Duis_4: + qui_e3: <long> + laborisf: <long> + Ut_2: + doloref: <long> + sunt_3: + qui045: <long> + nostrud1: <long> + ratios: + eiusmode34: <number> + fugiat_41: <number> + testing: + testId: <long> + hoursToWait: <integer> + abSuccessMetric: OPENS_BY_DELIVERED + abSampleSizeDefault: variant + abStatus: automated_master + abTestPercentage: <integer> + abSamplingDefault: master + subscriptionDetails: + subscriptionId: <long> + preferencesGroupId: <long> + officeLocationId: <string> + updatedById: <integer> + publishedById: <integer> + language: bo-in + campaign: <string> + webversion: + slug: <string> + domain: <string> + title: <string> + metaDescription: <string> + redirectToUrl: <string> + redirectToPageId: <long> + expiresAt: <dateTime> + rssData: + maxEntries: <integer> + timing: + laborisfe_: {} + ipsum2: {} + url: <string> + hubspotBlogId: <long> + blogEmailType: <string> + blogImageMaxWidth: <integer> + rssEntryTemplate: <string> + useHeadlineAsSubject: <boolean> + blogLayout: <string> + isTransactional: <boolean> + isPublished: <boolean> + publishDate: <dateTime> + updatedAt: <dateTime> + createdAt: <dateTime> + deletedAt: <dateTime> + publishedAt: <dateTime> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + content: + templatePath: <string> + plainTextVersion: <string> + widgets: + Excepteur_8: {} + in15: {} + tempor_0: {} + widgetContainers: + fugiat_f8: {} + labore9: {} + in74c: {} + flexAreas: + commodoed3: {} + laborea8: {} + ut_5: {} + styleSettings: {} + smartFields: + culpaf3: {} + proident2f: {} + themeSettingsValues: + commodo2aa: {} + from: + fromName: <string> + replyTo: <string> + customReplyTo: <string> + id: <string> + name: <string> + sendOnPublish: <boolean> + state: RSS_TO_EMAIL_DRAFT + subcategory: <string> + subject: <string> + to: + contactLists: + include: + - <long> + - <long> + exclude: + - <long> + - <long> + contactIds: + include: + - <long> + - <long> + exclude: + - <long> + - <long> + limitSendFrequency: <boolean> + suppressGraymail: <boolean> + createdById: <integer> + type: RESUBSCRIBE_EMAIL + activeDomain: <string> + archived: <boolean> + folderId: <long> + feedbackSurveyId: <integer> + stats: + counters: + occaecat_35: <long> + esse_dae: <long> + aliquip_9b: <long> + deviceBreakdown: + ad_9: + ea586: <long> + amet_cce: <long> + exercitation_2f: + ut_2: <long> + eiusmod_d1: <long> + qualifierStats: + Duis_4: + qui_e3: <long> + laborisf: <long> + Ut_2: + doloref: <long> + sunt_3: + qui045: <long> + nostrud1: <long> + ratios: + eiusmode34: <number> + fugiat_41: <number> + testing: + testId: <long> + hoursToWait: <integer> + abSuccessMetric: OPENS_BY_DELIVERED + abSampleSizeDefault: variant + abStatus: automated_master + abTestPercentage: <integer> + abSamplingDefault: master + subscriptionDetails: + subscriptionId: <long> + preferencesGroupId: <long> + officeLocationId: <string> + updatedById: <integer> + publishedById: <integer> + language: bo-in + campaign: <string> + webversion: + slug: <string> + domain: <string> + title: <string> + metaDescription: <string> + redirectToUrl: <string> + redirectToPageId: <long> + expiresAt: <dateTime> + rssData: + maxEntries: <integer> + timing: + laborisfe_: {} + ipsum2: {} + url: <string> + hubspotBlogId: <long> + blogEmailType: <string> + blogImageMaxWidth: <integer> + rssEntryTemplate: <string> + useHeadlineAsSubject: <boolean> + blogLayout: <string> + isTransactional: <boolean> + isPublished: <boolean> + publishDate: <dateTime> + updatedAt: <dateTime> + createdAt: <dateTime> + deletedAt: <dateTime> + publishedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "est92": [ + "<string>", + "<string>" + ], + "aliquad3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "et_b": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "sed42_": [ + "<string>", + "<string>" + ], + "qui__42": [ + "<string>", + "<string>" + ] + }, + "links": { + "velit02": "<string>" + } + } + /marketing/v3/emails/{emailId}/revisions/{revisionId}/restore: + post: + tags: + - Marketing Emails API > Marketing Emails + summary: Restore a revision of a marketing email + description: >- + Restores a previous revision of a marketing email. The current revision + becomes old, and the restored revision is given a new version number. + requestBody: + content: {} + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: emailId + in: path + schema: + type: string + required: true + example: <string> + - name: revisionId + in: path + schema: + type: string + required: true + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "est92": [ + "<string>", + "<string>" + ], + "aliquad3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "et_b": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "sed42_": [ + "<string>", + "<string>" + ], + "qui__42": [ + "<string>", + "<string>" + ] + }, + "links": { + "velit02": "<string>" + } + } + /marketing/v3/emails/{emailId}: + get: + tags: + - Marketing Emails API > Marketing Emails + summary: Get the details of a specified marketing email. + description: Get the details for a marketing email. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: includeStats + in: query + schema: + type: string + description: Include statistics with email + example: <boolean> + - name: includedProperties + in: query + schema: + type: string + example: <string> + - name: includedProperties + in: query + schema: + type: string + example: <string> + - name: archived + in: query + schema: + type: string + description: Whether to return only results that have been archived. + example: <boolean> + - name: marketingCampaignNames + in: query + schema: + type: string + example: <boolean> + - name: workflowNames + in: query + schema: + type: string + example: <boolean> + - name: emailId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + content: + templatePath: <string> + plainTextVersion: <string> + widgets: + Excepteur_8: {} + in15: {} + tempor_0: {} + widgetContainers: + fugiat_f8: {} + labore9: {} + in74c: {} + flexAreas: + commodoed3: {} + laborea8: {} + ut_5: {} + styleSettings: {} + smartFields: + culpaf3: {} + proident2f: {} + themeSettingsValues: + commodo2aa: {} + from: + fromName: <string> + replyTo: <string> + customReplyTo: <string> + id: <string> + name: <string> + sendOnPublish: <boolean> + state: RSS_TO_EMAIL_DRAFT + subcategory: <string> + subject: <string> + to: + contactLists: + include: + - <long> + - <long> + exclude: + - <long> + - <long> + contactIds: + include: + - <long> + - <long> + exclude: + - <long> + - <long> + limitSendFrequency: <boolean> + suppressGraymail: <boolean> + createdById: <integer> + type: RESUBSCRIBE_EMAIL + activeDomain: <string> + archived: <boolean> + folderId: <long> + feedbackSurveyId: <integer> + stats: + counters: + occaecat_35: <long> + esse_dae: <long> + aliquip_9b: <long> + deviceBreakdown: + ad_9: + ea586: <long> + amet_cce: <long> + exercitation_2f: + ut_2: <long> + eiusmod_d1: <long> + qualifierStats: + Duis_4: + qui_e3: <long> + laborisf: <long> + Ut_2: + doloref: <long> + sunt_3: + qui045: <long> + nostrud1: <long> + ratios: + eiusmode34: <number> + fugiat_41: <number> + testing: + testId: <long> + hoursToWait: <integer> + abSuccessMetric: OPENS_BY_DELIVERED + abSampleSizeDefault: variant + abStatus: automated_master + abTestPercentage: <integer> + abSamplingDefault: master + subscriptionDetails: + subscriptionId: <long> + preferencesGroupId: <long> + officeLocationId: <string> + updatedById: <integer> + publishedById: <integer> + language: bo-in + campaign: <string> + webversion: + slug: <string> + domain: <string> + title: <string> + metaDescription: <string> + redirectToUrl: <string> + redirectToPageId: <long> + expiresAt: <dateTime> + rssData: + maxEntries: <integer> + timing: + laborisfe_: {} + ipsum2: {} + url: <string> + hubspotBlogId: <long> + blogEmailType: <string> + blogImageMaxWidth: <integer> + rssEntryTemplate: <string> + useHeadlineAsSubject: <boolean> + blogLayout: <string> + isTransactional: <boolean> + isPublished: <boolean> + publishDate: <dateTime> + updatedAt: <dateTime> + createdAt: <dateTime> + deletedAt: <dateTime> + publishedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "est92": [ + "<string>", + "<string>" + ], + "aliquad3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "et_b": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "sed42_": [ + "<string>", + "<string>" + ], + "qui__42": [ + "<string>", + "<string>" + ] + }, + "links": { + "velit02": "<string>" + } + } + delete: + tags: + - Marketing Emails API > Marketing Emails + summary: Delete a marketing email. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: archived + in: query + schema: + type: string + description: Whether to return only results that have been archived. + example: <boolean> + - name: emailId + in: path + schema: + type: string + required: true + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "est92": [ + "<string>", + "<string>" + ], + "aliquad3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "et_b": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "sed42_": [ + "<string>", + "<string>" + ], + "qui__42": [ + "<string>", + "<string>" + ] + }, + "links": { + "velit02": "<string>" + } + } + patch: + tags: + - Marketing Emails API > Marketing Emails + summary: Update a marketing email. + description: Change properties of a marketing email. + requestBody: + content: + application/json: + schema: + type: object + example: + content: + templatePath: <string> + plainTextVersion: <string> + widgets: + Excepteur_8: {} + in15: {} + tempor_0: {} + widgetContainers: + fugiat_f8: {} + labore9: {} + in74c: {} + flexAreas: + commodoed3: {} + laborea8: {} + ut_5: {} + styleSettings: {} + smartFields: + culpaf3: {} + proident2f: {} + themeSettingsValues: + commodo2aa: {} + from: + fromName: <string> + replyTo: <string> + customReplyTo: <string> + id: <string> + name: <string> + sendOnPublish: <boolean> + state: RSS_TO_EMAIL_DRAFT + subcategory: <string> + subject: <string> + to: + contactLists: + include: + - <long> + - <long> + exclude: + - <long> + - <long> + contactIds: + include: + - <long> + - <long> + exclude: + - <long> + - <long> + limitSendFrequency: <boolean> + suppressGraymail: <boolean> + createdById: <integer> + type: RESUBSCRIBE_EMAIL + activeDomain: <string> + archived: <boolean> + folderId: <long> + feedbackSurveyId: <integer> + stats: + counters: + occaecat_35: <long> + esse_dae: <long> + aliquip_9b: <long> + deviceBreakdown: + ad_9: + ea586: <long> + amet_cce: <long> + exercitation_2f: + ut_2: <long> + eiusmod_d1: <long> + qualifierStats: + Duis_4: + qui_e3: <long> + laborisf: <long> + Ut_2: + doloref: <long> + sunt_3: + qui045: <long> + nostrud1: <long> + ratios: + eiusmode34: <number> + fugiat_41: <number> + testing: + testId: <long> + hoursToWait: <integer> + abSuccessMetric: OPENS_BY_DELIVERED + abSampleSizeDefault: variant + abStatus: automated_master + abTestPercentage: <integer> + abSamplingDefault: master + subscriptionDetails: + subscriptionId: <long> + preferencesGroupId: <long> + officeLocationId: <string> + updatedById: <integer> + publishedById: <integer> + language: bo-in + campaign: <string> + webversion: + slug: <string> + domain: <string> + title: <string> + metaDescription: <string> + redirectToUrl: <string> + redirectToPageId: <long> + expiresAt: <dateTime> + rssData: + maxEntries: <integer> + timing: + laborisfe_: {} + ipsum2: {} + url: <string> + hubspotBlogId: <long> + blogEmailType: <string> + blogImageMaxWidth: <integer> + rssEntryTemplate: <string> + useHeadlineAsSubject: <boolean> + blogLayout: <string> + isTransactional: <boolean> + isPublished: <boolean> + publishDate: <dateTime> + updatedAt: <dateTime> + createdAt: <dateTime> + deletedAt: <dateTime> + publishedAt: <dateTime> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: string + description: Whether to return only results that have been archived. + example: <boolean> + - name: emailId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + content: + templatePath: <string> + plainTextVersion: <string> + widgets: + Excepteur_8: {} + in15: {} + tempor_0: {} + widgetContainers: + fugiat_f8: {} + labore9: {} + in74c: {} + flexAreas: + commodoed3: {} + laborea8: {} + ut_5: {} + styleSettings: {} + smartFields: + culpaf3: {} + proident2f: {} + themeSettingsValues: + commodo2aa: {} + from: + fromName: <string> + replyTo: <string> + customReplyTo: <string> + id: <string> + name: <string> + sendOnPublish: <boolean> + state: RSS_TO_EMAIL_DRAFT + subcategory: <string> + subject: <string> + to: + contactLists: + include: + - <long> + - <long> + exclude: + - <long> + - <long> + contactIds: + include: + - <long> + - <long> + exclude: + - <long> + - <long> + limitSendFrequency: <boolean> + suppressGraymail: <boolean> + createdById: <integer> + type: RESUBSCRIBE_EMAIL + activeDomain: <string> + archived: <boolean> + folderId: <long> + feedbackSurveyId: <integer> + stats: + counters: + occaecat_35: <long> + esse_dae: <long> + aliquip_9b: <long> + deviceBreakdown: + ad_9: + ea586: <long> + amet_cce: <long> + exercitation_2f: + ut_2: <long> + eiusmod_d1: <long> + qualifierStats: + Duis_4: + qui_e3: <long> + laborisf: <long> + Ut_2: + doloref: <long> + sunt_3: + qui045: <long> + nostrud1: <long> + ratios: + eiusmode34: <number> + fugiat_41: <number> + testing: + testId: <long> + hoursToWait: <integer> + abSuccessMetric: OPENS_BY_DELIVERED + abSampleSizeDefault: variant + abStatus: automated_master + abTestPercentage: <integer> + abSamplingDefault: master + subscriptionDetails: + subscriptionId: <long> + preferencesGroupId: <long> + officeLocationId: <string> + updatedById: <integer> + publishedById: <integer> + language: bo-in + campaign: <string> + webversion: + slug: <string> + domain: <string> + title: <string> + metaDescription: <string> + redirectToUrl: <string> + redirectToPageId: <long> + expiresAt: <dateTime> + rssData: + maxEntries: <integer> + timing: + laborisfe_: {} + ipsum2: {} + url: <string> + hubspotBlogId: <long> + blogEmailType: <string> + blogImageMaxWidth: <integer> + rssEntryTemplate: <string> + useHeadlineAsSubject: <boolean> + blogLayout: <string> + isTransactional: <boolean> + isPublished: <boolean> + publishDate: <dateTime> + updatedAt: <dateTime> + createdAt: <dateTime> + deletedAt: <dateTime> + publishedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "est92": [ + "<string>", + "<string>" + ], + "aliquad3": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "et_b": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "sed42_": [ + "<string>", + "<string>" + ], + "qui__42": [ + "<string>", + "<string>" + ] + }, + "links": { + "velit02": "<string>" + } + } + /marketing/v3/emails/{emailId}/publish: + post: + tags: + - Marketing Emails API + summary: Publish or send a marketing email. + description: >- + If you have a Marketing Hub Enterprise account or the transactional + email add-on, you can use this endpoint to publish an automated email or + send/schedule a regular email. + requestBody: + content: {} + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: emailId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "in_f3": [ + "<string>", + "<string>" + ], + "sint__6": [ + "<string>", + "<string>" + ] + }, + "links": { + "est5": "<string>", + "amet_b4e": "<string>", + "adab4": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "occaecat_7": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "commodoff": [ + "<string>", + "<string>" + ], + "cillum5d": [ + "<string>", + "<string>" + ], + "culpa_c": [ + "<string>", + "<string>" + ], + "ina": [ + "<string>", + "<string>" + ] + } + } + ] + } + /marketing/v3/emails/ab-test/create-variation: + post: + tags: + - Marketing Emails API + summary: Create an A/B test variation of a marketing email. + description: >- + Create a variation of a marketing email for an A/B test. The new + variation will be created as a draft. If an active variation already + exists, a new one won't be created. + requestBody: + content: + application/json: + schema: + type: object + example: + contentId: <string> + variationName: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + content: + smartFields: + dolor4de: {} + themeSettingsValues: + dolore_3a9: {} + flexAreas: + irure5: {} + widgets: + ad50b: {} + plainTextVersion: Lorem quis sint + templatePath: ipsum officia in + widgetContainers: + id_0: {} + styleSettings: + emailBodyPadding: Excepteur proident + colorPickerFavorite5: in ipsum veniam magna + bodyColor: in Excepteur + colorPickerFavorite6: sed voluptate + backgroundImage: deserunt est + emailBodyWidth: commodo dolore + secondaryFont: magna sed commodo enim + primaryAccentColor: amet mollit + colorPickerFavorite3: aliquip esse + primaryFontLineHeight: quis nostrud + colorPickerFavorite4: aliqua sed labore ullamco laboris + secondaryFontColor: dolore enim sint nulla + colorPickerFavorite1: cillum elit id + colorPickerFavorite2: ad in reprehenderit + bodyBorderColor: consequat adipisicing labore consectetur + bodyBorderWidth: -2897480 + linksFont: + size: -21850777 + color: minim officia fugiat laborum + underline: true + bold: false + italic: true + font: sint tempor ad nostrud + backgroundColor: elit laboris + backgroundImageType: 'id ' + dividerStyleSettings: + color: {} + lineType: reprehenderit in id + height: 37893315 + secondaryAccentColor: proident do veniam voluptate + secondaryFontLineHeight: Duis + primaryFontSize: 69367268 + secondaryFontSize: 89866613 + primaryFontColor: proident anim adipisicing ea + headingOneFont: + size: -56364228 + color: dolore laborum sunt do ut + underline: false + bold: true + italic: false + font: in magna sint esse + primaryFont: sunt elit + headingTwoFont: + size: 27320681 + color: ad + underline: false + bold: false + italic: false + font: est nostrud do Lorem + buttonStyleSettings: + backgroundColor: {} + fontStyle: + size: -26290660 + color: esse voluptate + underline: true + bold: false + italic: true + font: sint consequat nisi + cornerRadius: -78024490 + bodyBorderColorChoice: sunt est voluptate + from: + customReplyTo: laborum sunt + fromName: Excepteur + replyTo: consectetur nisi ullamco officia Ut + id: ullamco ut + name: aliqua occae + sendOnPublish: false + state: DRAFT + subcategory: dolore cupidatat dolor + subject: enim in quis + to: + limitSendFrequency: false + suppressGraymail: true + contactIds: + include: + - id deserunt fugiat veniam + - voluptate consequat + exclude: + - et eiusmod + - quis Duis + contactLists: + include: + - laborum nulla + - magna sunt ipsum deserunt cupidatat + exclude: + - consectetur velit dolor cupidatat Duis + - eiusmod + feedbackSurveyId: culpa in ut aliquip dolor + publishDate: '1956-08-19T04:42:41.747Z' + isTransactional: false + language: lkt-us + type: OPTIN_FOLLOWUP_EMAIL + businessUnitId: do eiusmod nostrud + webversion: + domain: ullamco dolore in id nostrud + redirectToPageId: esse non qui voluptate + redirectToUrl: magna dolore + title: laborum nisi + metaDescription: reprehenderit ex eu + slug: sed amet Ut + expiresAt: '2023-07-22T08:47:36.366Z' + workflowNames: + - quis esse + - ad in incididunt et + archived: false + createdAt: '1991-06-24T08:04:13.834Z' + stats: + counters: + Excepteur3f7: 34246249 + deviceBreakdown: + ipsuma7: + Lorem_d: 87380802 + velit_26f: 41299676 + ullamco_5: + sint73b: -1454320 + dolor_4a: 16658635 + qualifierStats: + non_7de: + dolor_9: -19347437 + non_109: 90928796 + consectetur_6d: -63325910 + incididuntd: 68574952 + aute_57: + labore4cc: 52749655 + ut_f: 11717357 + aliquipa_: 84287081 + cillume5: + incididunt10: -92781785 + elit0e1: + veniam_4: 74597948 + ratios: + quicc: -9498520.397970632 + sit6: -25074633.92610587 + mollited6: 99210944.7586346 + createdById: in in + updatedAt: '1958-08-29T16:49:43.082Z' + rssData: + blogImageMaxWidth: -12492327 + blogEmailType: occaecat eiusmod + hubspotBlogId: occaecat q + rssEntryTemplate: deserunt incididunt + timing: + Excepteuraf: {} + reprehenderit032: {} + maxEntries: -89194318 + useHeadlineAsSubject: true + blogLayout: nisi in id + url: Excepteur culpa dolore veniam + publishedAt: '1984-01-01T22:52:10.410Z' + publishedById: id sunt ipsum sint com + isPublished: true + testing: + abSamplingDefault: master + abSampleSizeDefault: automated_master + abStatus: master + abTestPercentage: 38774587 + hoursToWait: 6305454 + testId: sint non anim + abSuccessMetric: CLICKS_BY_DELIVERED + updatedById: nostrud sit ipsum ut + folderId: -67722642 + subscriptionDetails: + officeLocationId: do enim + preferencesGroupId: adipisicing non deserunt + subscriptionId: minim amet ut velit + deletedAt: '1993-12-16T22:48:26.981Z' + activeDomain: exercitation et + campaign: laboris + campaignName: dolor sunt sint laborum laboris + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "in_f3": [ + "<string>", + "<string>" + ], + "sint__6": [ + "<string>", + "<string>" + ] + }, + "links": { + "est5": "<string>", + "amet_b4e": "<string>", + "adab4": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "occaecat_7": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "commodoff": [ + "<string>", + "<string>" + ], + "cillum5d": [ + "<string>", + "<string>" + ], + "culpa_c": [ + "<string>", + "<string>" + ], + "ina": [ + "<string>", + "<string>" + ] + } + } + ] + } + /marketing/v3/emails/{emailId}/unpublish: + post: + tags: + - Marketing Emails API + summary: Unpublish or cancel a marketing email. + description: >- + If you have a Marketing Hub Enterprise account or the transactional + email add-on, you can use this endpoint to unpublish an automated email + or cancel a regular email. If the email is already in the process of + being sent, canceling might not be possible. + requestBody: + content: {} + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: emailId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "in_f3": [ + "<string>", + "<string>" + ], + "sint__6": [ + "<string>", + "<string>" + ] + }, + "links": { + "est5": "<string>", + "amet_b4e": "<string>", + "adab4": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "occaecat_7": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "commodoff": [ + "<string>", + "<string>" + ], + "cillum5d": [ + "<string>", + "<string>" + ], + "culpa_c": [ + "<string>", + "<string>" + ], + "ina": [ + "<string>", + "<string>" + ] + } + } + ] + } + /marketing/v3/emails/clone: + post: + tags: + - Marketing Emails API + summary: Clone a marketing email. + description: >- + This will create a duplicate email with the same properties as the + original, with the exception of a unique ID. + requestBody: + content: + application/json: + schema: + type: object + example: + id: <string> + cloneName: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + content: + smartFields: + dolor4de: {} + themeSettingsValues: + dolore_3a9: {} + flexAreas: + irure5: {} + widgets: + ad50b: {} + plainTextVersion: Lorem quis sint + templatePath: ipsum officia in + widgetContainers: + id_0: {} + styleSettings: + emailBodyPadding: Excepteur proident + colorPickerFavorite5: in ipsum veniam magna + bodyColor: in Excepteur + colorPickerFavorite6: sed voluptate + backgroundImage: deserunt est + emailBodyWidth: commodo dolore + secondaryFont: magna sed commodo enim + primaryAccentColor: amet mollit + colorPickerFavorite3: aliquip esse + primaryFontLineHeight: quis nostrud + colorPickerFavorite4: aliqua sed labore ullamco laboris + secondaryFontColor: dolore enim sint nulla + colorPickerFavorite1: cillum elit id + colorPickerFavorite2: ad in reprehenderit + bodyBorderColor: consequat adipisicing labore consectetur + bodyBorderWidth: -2897480 + linksFont: + size: -21850777 + color: minim officia fugiat laborum + underline: true + bold: false + italic: true + font: sint tempor ad nostrud + backgroundColor: elit laboris + backgroundImageType: 'id ' + dividerStyleSettings: + color: {} + lineType: reprehenderit in id + height: 37893315 + secondaryAccentColor: proident do veniam voluptate + secondaryFontLineHeight: Duis + primaryFontSize: 69367268 + secondaryFontSize: 89866613 + primaryFontColor: proident anim adipisicing ea + headingOneFont: + size: -56364228 + color: dolore laborum sunt do ut + underline: false + bold: true + italic: false + font: in magna sint esse + primaryFont: sunt elit + headingTwoFont: + size: 27320681 + color: ad + underline: false + bold: false + italic: false + font: est nostrud do Lorem + buttonStyleSettings: + backgroundColor: {} + fontStyle: + size: -26290660 + color: esse voluptate + underline: true + bold: false + italic: true + font: sint consequat nisi + cornerRadius: -78024490 + bodyBorderColorChoice: sunt est voluptate + from: + customReplyTo: laborum sunt + fromName: Excepteur + replyTo: consectetur nisi ullamco officia Ut + id: ullamco ut + name: aliqua occae + sendOnPublish: false + state: DRAFT + subcategory: dolore cupidatat dolor + subject: enim in quis + to: + limitSendFrequency: false + suppressGraymail: true + contactIds: + include: + - id deserunt fugiat veniam + - voluptate consequat + exclude: + - et eiusmod + - quis Duis + contactLists: + include: + - laborum nulla + - magna sunt ipsum deserunt cupidatat + exclude: + - consectetur velit dolor cupidatat Duis + - eiusmod + feedbackSurveyId: culpa in ut aliquip dolor + publishDate: '1956-08-19T04:42:41.747Z' + isTransactional: false + language: lkt-us + type: OPTIN_FOLLOWUP_EMAIL + businessUnitId: do eiusmod nostrud + webversion: + domain: ullamco dolore in id nostrud + redirectToPageId: esse non qui voluptate + redirectToUrl: magna dolore + title: laborum nisi + metaDescription: reprehenderit ex eu + slug: sed amet Ut + expiresAt: '2023-07-22T08:47:36.366Z' + workflowNames: + - quis esse + - ad in incididunt et + archived: false + createdAt: '1991-06-24T08:04:13.834Z' + stats: + counters: + Excepteur3f7: 34246249 + deviceBreakdown: + ipsuma7: + Lorem_d: 87380802 + velit_26f: 41299676 + ullamco_5: + sint73b: -1454320 + dolor_4a: 16658635 + qualifierStats: + non_7de: + dolor_9: -19347437 + non_109: 90928796 + consectetur_6d: -63325910 + incididuntd: 68574952 + aute_57: + labore4cc: 52749655 + ut_f: 11717357 + aliquipa_: 84287081 + cillume5: + incididunt10: -92781785 + elit0e1: + veniam_4: 74597948 + ratios: + quicc: -9498520.397970632 + sit6: -25074633.92610587 + mollited6: 99210944.7586346 + createdById: in in + updatedAt: '1958-08-29T16:49:43.082Z' + rssData: + blogImageMaxWidth: -12492327 + blogEmailType: occaecat eiusmod + hubspotBlogId: occaecat q + rssEntryTemplate: deserunt incididunt + timing: + Excepteuraf: {} + reprehenderit032: {} + maxEntries: -89194318 + useHeadlineAsSubject: true + blogLayout: nisi in id + url: Excepteur culpa dolore veniam + publishedAt: '1984-01-01T22:52:10.410Z' + publishedById: id sunt ipsum sint com + isPublished: true + testing: + abSamplingDefault: master + abSampleSizeDefault: automated_master + abStatus: master + abTestPercentage: 38774587 + hoursToWait: 6305454 + testId: sint non anim + abSuccessMetric: CLICKS_BY_DELIVERED + updatedById: nostrud sit ipsum ut + folderId: -67722642 + subscriptionDetails: + officeLocationId: do enim + preferencesGroupId: adipisicing non deserunt + subscriptionId: minim amet ut velit + deletedAt: '1993-12-16T22:48:26.981Z' + activeDomain: exercitation et + campaign: laboris + campaignName: dolor sunt sint laborum laboris + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "in_f3": [ + "<string>", + "<string>" + ], + "sint__6": [ + "<string>", + "<string>" + ] + }, + "links": { + "est5": "<string>", + "amet_b4e": "<string>", + "adab4": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "occaecat_7": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "commodoff": [ + "<string>", + "<string>" + ], + "cillum5d": [ + "<string>", + "<string>" + ], + "culpa_c": [ + "<string>", + "<string>" + ], + "ina": [ + "<string>", + "<string>" + ] + } + } + ] + } + /marketing/v3/marketing-events/events/upsert: + post: + tags: + - Marketing Events API > Batch + summary: Create or Update Multiple Marketing Events + description: >- + Upset multiple Marketing Event. If there is an existing Marketing event + with the specified id, it will be updated; otherwise a new event will be + created. + requestBody: + content: {} + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + eventName: <string> + eventOrganizer: <string> + id: <string> + updatedAt: <dateTime> + startDateTime: <dateTime> + customProperties: + - name: <string> + requestId: <string> + selectedByUser: <boolean> + selectedByUserTimestamp: <long> + source: EMAIL_INTEGRATION + sourceId: <string> + sourceLabel: <string> + sourceMetadata: <string> + sourceVid: + - <long> + - <long> + timestamp: <long> + value: <string> + updatedByUserId: <integer> + persistenceTimestamp: <long> + useTimestampAsPersistenceTimestamp: <boolean> + isLargeValue: <boolean> + dataSensitivity: none + isEncrypted: <boolean> + unit: <string> + - name: <string> + requestId: <string> + selectedByUser: <boolean> + selectedByUserTimestamp: <long> + source: CRM_UI_BULK_ACTION + sourceId: <string> + sourceLabel: <string> + sourceMetadata: <string> + sourceVid: + - <long> + - <long> + timestamp: <long> + value: <string> + updatedByUserId: <integer> + persistenceTimestamp: <long> + useTimestampAsPersistenceTimestamp: <boolean> + isLargeValue: <boolean> + dataSensitivity: standard + isEncrypted: <boolean> + unit: <string> + eventCancelled: <boolean> + eventUrl: <string> + eventDescription: <string> + eventType: <string> + endDateTime: <dateTime> + - createdAt: <dateTime> + eventName: <string> + eventOrganizer: <string> + id: <string> + updatedAt: <dateTime> + startDateTime: <dateTime> + customProperties: + - name: <string> + requestId: <string> + selectedByUser: <boolean> + selectedByUserTimestamp: <long> + source: BET_CRM_CONNECTOR + sourceId: <string> + sourceLabel: <string> + sourceMetadata: <string> + sourceVid: + - <long> + - <long> + timestamp: <long> + value: <string> + updatedByUserId: <integer> + persistenceTimestamp: <long> + useTimestampAsPersistenceTimestamp: <boolean> + isLargeValue: <boolean> + dataSensitivity: none + isEncrypted: <boolean> + unit: <string> + - name: <string> + requestId: <string> + selectedByUser: <boolean> + selectedByUserTimestamp: <long> + source: INTEGRATION + sourceId: <string> + sourceLabel: <string> + sourceMetadata: <string> + sourceVid: + - <long> + - <long> + timestamp: <long> + value: <string> + updatedByUserId: <integer> + persistenceTimestamp: <long> + useTimestampAsPersistenceTimestamp: <boolean> + isLargeValue: <boolean> + dataSensitivity: high + isEncrypted: <boolean> + unit: <string> + eventCancelled: <boolean> + eventUrl: <string> + eventDescription: <string> + eventType: <string> + endDateTime: <dateTime> + startedAt: <dateTime> + status: CANCELED + numErrors: <integer> + requestedAt: <dateTime> + links: + laborumc: <string> + errors: + - category: <string> + context: + commodof_5: + - <string> + - <string> + labore_c_: + - <string> + - <string> + laborum21: + - <string> + - <string> + non17f: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + magnac8: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + doloref: + - <string> + - <string> + links: + ipsum_17: <string> + dolore7c5: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + - category: <string> + context: + aliquip__a4: + - <string> + - <string> + exercitation_2: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + uta: + - <string> + - <string> + eiusmod_1: + - <string> + - <string> + ut02f: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + nullafe7: + - <string> + - <string> + in_5: + - <string> + - <string> + aute7: + - <string> + - <string> + cupidatat_c_: + - <string> + - <string> + links: + nulla5: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "mollit4b": [ + "<string>", + "<string>" + ], + "dolore_d7b": [ + "<string>", + "<string>" + ], + "proident_f7": [ + "<string>", + "<string>" + ], + "proident_5": [ + "<string>", + "<string>" + ] + }, + "links": { + "ad034": "<string>", + "proident3e_": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "pariatur__": [ + "<string>", + "<string>" + ], + "labore_2d": [ + "<string>", + "<string>" + ], + "fugiat_ad": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "officiac6f": [ + "<string>", + "<string>" + ], + "id_a1": [ + "<string>", + "<string>" + ], + "ut_19": [ + "<string>", + "<string>" + ], + "in4": [ + "<string>", + "<string>" + ] + } + } + ] + } + /marketing/v3/marketing-events/events/delete: + post: + tags: + - Marketing Events API > Batch + summary: Delete Multiple Marketing Events by External Ids + description: Bulk delete a number of marketing events in HubSpot + requestBody: + content: {} + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "mollit4b": [ + "<string>", + "<string>" + ], + "dolore_d7b": [ + "<string>", + "<string>" + ], + "proident_f7": [ + "<string>", + "<string>" + ], + "proident_5": [ + "<string>", + "<string>" + ] + }, + "links": { + "ad034": "<string>", + "proident3e_": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "pariatur__": [ + "<string>", + "<string>" + ], + "labore_2d": [ + "<string>", + "<string>" + ], + "fugiat_ad": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "officiac6f": [ + "<string>", + "<string>" + ], + "id_a1": [ + "<string>", + "<string>" + ], + "ut_19": [ + "<string>", + "<string>" + ], + "in4": [ + "<string>", + "<string>" + ] + } + } + ] + } + /marketing/v3/marketing-events/attendance/{externalEventId}/{subscriberState}/create: + post: + tags: + - Marketing Events API > Attendance Subscriber State Changes + summary: Record Participants by ContactId with Marketing Event External Ids + description: >- + Record a subscription state between multiple HubSpot contacts and a + marketing event, using HubSpot contact ids. + requestBody: + content: {} + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: externalAccountId + in: query + schema: + type: string + description: The account id associated with the marketing event + example: <string> + - name: externalEventId + in: path + schema: + type: string + required: true + description: (Required) The id of the marketing event + example: <string> + - name: subscriberState + in: path + schema: + type: string + required: true + description: >- + (Required) The new subscriber state for the HubSpot contacts and the + specified marketing event. For example: 'register', 'attend' or + 'cancel'. + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - vid: <integer> + - vid: <integer> + startedAt: <dateTime> + status: PENDING + numErrors: <integer> + requestedAt: <dateTime> + links: + cupidatat3_: <string> + ullamco3: <string> + errors: + - category: <string> + context: + labore_a: + - <string> + - <string> + incididunt_405: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + mollitb: + - <string> + - <string> + autef_8: + - <string> + - <string> + non0: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + ex_10: + - <string> + - <string> + exercitation_cab: + - <string> + - <string> + nostrud17d: + - <string> + - <string> + links: + fugiat_a0: <string> + dolor507: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + - category: <string> + context: + adipisicing17: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + pariaturf: + - <string> + - <string> + enime: + - <string> + - <string> + culpa_83: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + in7: + - <string> + - <string> + links: + eu1f2: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "mollit4b": [ + "<string>", + "<string>" + ], + "dolore_d7b": [ + "<string>", + "<string>" + ], + "proident_f7": [ + "<string>", + "<string>" + ], + "proident_5": [ + "<string>", + "<string>" + ] + }, + "links": { + "ad034": "<string>", + "proident3e_": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "pariatur__": [ + "<string>", + "<string>" + ], + "labore_2d": [ + "<string>", + "<string>" + ], + "fugiat_ad": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "officiac6f": [ + "<string>", + "<string>" + ], + "id_a1": [ + "<string>", + "<string>" + ], + "ut_19": [ + "<string>", + "<string>" + ], + "in4": [ + "<string>", + "<string>" + ] + } + } + ] + } + /marketing/v3/marketing-events/attendance/{externalEventId}/{subscriberState}/email-create: + post: + tags: + - Marketing Events API > Attendance Subscriber State Changes + summary: Record Participants by Email with Marketing Event External Ids + description: >- + Record a subscription state between multiple HubSpot contacts and a + marketing event, using contact email addresses. If contact is not + present it will be automatically created. + requestBody: + content: {} + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: externalAccountId + in: query + schema: + type: string + description: The account id associated with the marketing event + example: <string> + - name: externalEventId + in: path + schema: + type: string + required: true + description: (Required) The id of the marketing event + example: <string> + - name: subscriberState + in: path + schema: + type: string + required: true + description: >- + (Required) The new subscriber state for the HubSpot contacts and the + specified marketing event. For example: 'register', 'attend' or + 'cancel'. + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - email: <string> + vid: <integer> + - email: <string> + vid: <integer> + startedAt: <dateTime> + status: PENDING + numErrors: <integer> + requestedAt: <dateTime> + links: + dolor_c: <string> + est_f8_: <string> + ullamco_4: <string> + errors: + - category: <string> + context: + adf2: + - <string> + - <string> + nostrud_6c: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + aliqua_f9d: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + Duis_86: + - <string> + - <string> + links: + in_: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + - category: <string> + context: + velit_c3_: + - <string> + - <string> + dolor29: + - <string> + - <string> + iruref05: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + et52: + - <string> + - <string> + laborum6: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + occaecat__c: + - <string> + - <string> + links: + occaecat_1d: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "mollit4b": [ + "<string>", + "<string>" + ], + "dolore_d7b": [ + "<string>", + "<string>" + ], + "proident_f7": [ + "<string>", + "<string>" + ], + "proident_5": [ + "<string>", + "<string>" + ] + }, + "links": { + "ad034": "<string>", + "proident3e_": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "pariatur__": [ + "<string>", + "<string>" + ], + "labore_2d": [ + "<string>", + "<string>" + ], + "fugiat_ad": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "officiac6f": [ + "<string>", + "<string>" + ], + "id_a1": [ + "<string>", + "<string>" + ], + "ut_19": [ + "<string>", + "<string>" + ], + "in4": [ + "<string>", + "<string>" + ] + } + } + ] + } + /marketing/v3/marketing-events/events/{externalEventId}/{subscriberState}/email-upsert: + post: + tags: + - Marketing Events API > Subscriber State Changes + summary: Record a subscriber state by contact email + description: >- + Record a subscription state between multiple HubSpot contacts and a + marketing event, using contact email addresses. Note that the contact + must already exist in HubSpot; a contact will not be created. + requestBody: + content: {} + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: externalAccountId + in: query + schema: + type: string + description: (Required) The account id associated with the marketing event + example: <string> + - name: externalEventId + in: path + schema: + type: string + required: true + description: (Required) The id of the marketing event + example: <string> + - name: subscriberState + in: path + schema: + type: string + required: true + description: >- + (Required) The new subscriber state for the HubSpot contacts and the + specified marketing event + example: <string> + responses: + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "mollit4b": [ + "<string>", + "<string>" + ], + "dolore_d7b": [ + "<string>", + "<string>" + ], + "proident_f7": [ + "<string>", + "<string>" + ], + "proident_5": [ + "<string>", + "<string>" + ] + }, + "links": { + "ad034": "<string>", + "proident3e_": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "pariatur__": [ + "<string>", + "<string>" + ], + "labore_2d": [ + "<string>", + "<string>" + ], + "fugiat_ad": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "officiac6f": [ + "<string>", + "<string>" + ], + "id_a1": [ + "<string>", + "<string>" + ], + "ut_19": [ + "<string>", + "<string>" + ], + "in4": [ + "<string>", + "<string>" + ] + } + } + ] + } + /marketing/v3/marketing-events/events/{externalEventId}/{subscriberState}/upsert: + post: + tags: + - Marketing Events API > Subscriber State Changes + summary: Record a subscriber state by contact ID + description: >- + Record a subscription state between multiple HubSpot contacts and a + marketing event, using HubSpot contact ids. Note that the contact must + already exist in HubSpot; a contact will not be create. + requestBody: + content: {} + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: externalAccountId + in: query + schema: + type: string + description: (Required) The account id associated with the marketing event + example: <string> + - name: externalEventId + in: path + schema: + type: string + required: true + description: (Required) The id of the marketing event + example: <string> + - name: subscriberState + in: path + schema: + type: string + required: true + description: >- + (Required) The new subscriber state for the HubSpot contacts and the + specified marketing event + example: <string> + responses: + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "mollit4b": [ + "<string>", + "<string>" + ], + "dolore_d7b": [ + "<string>", + "<string>" + ], + "proident_f7": [ + "<string>", + "<string>" + ], + "proident_5": [ + "<string>", + "<string>" + ] + }, + "links": { + "ad034": "<string>", + "proident3e_": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "pariatur__": [ + "<string>", + "<string>" + ], + "labore_2d": [ + "<string>", + "<string>" + ], + "fugiat_ad": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "officiac6f": [ + "<string>", + "<string>" + ], + "id_a1": [ + "<string>", + "<string>" + ], + "ut_19": [ + "<string>", + "<string>" + ], + "in4": [ + "<string>", + "<string>" + ] + } + } + ] + } + /marketing/v3/marketing-events/events/{externalEventId}/complete: + post: + tags: + - Marketing Events API > Marketing_Events_External + summary: Mark a marketing event as completed + requestBody: + content: {} + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: externalAccountId + in: query + schema: + type: string + description: '(Required) ' + example: <string> + - name: externalEventId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + eventName: <string> + eventOrganizer: <string> + startDateTime: <dateTime> + customProperties: + - name: <string> + requestId: <string> + selectedByUser: <boolean> + selectedByUserTimestamp: <long> + source: BOT + sourceId: <string> + sourceLabel: <string> + sourceMetadata: <string> + sourceVid: + - <long> + - <long> + timestamp: <long> + value: <string> + updatedByUserId: <integer> + persistenceTimestamp: <long> + useTimestampAsPersistenceTimestamp: <boolean> + isLargeValue: <boolean> + dataSensitivity: high + isEncrypted: <boolean> + unit: <string> + - name: <string> + requestId: <string> + selectedByUser: <boolean> + selectedByUserTimestamp: <long> + source: SALES_MESSAGES + sourceId: <string> + sourceLabel: <string> + sourceMetadata: <string> + sourceVid: + - <long> + - <long> + timestamp: <long> + value: <string> + updatedByUserId: <integer> + persistenceTimestamp: <long> + useTimestampAsPersistenceTimestamp: <boolean> + isLargeValue: <boolean> + dataSensitivity: none + isEncrypted: <boolean> + unit: <string> + eventCancelled: <boolean> + eventUrl: <string> + eventDescription: <string> + eventType: <string> + endDateTime: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "mollit4b": [ + "<string>", + "<string>" + ], + "dolore_d7b": [ + "<string>", + "<string>" + ], + "proident_f7": [ + "<string>", + "<string>" + ], + "proident_5": [ + "<string>", + "<string>" + ] + }, + "links": { + "ad034": "<string>", + "proident3e_": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "pariatur__": [ + "<string>", + "<string>" + ], + "labore_2d": [ + "<string>", + "<string>" + ], + "fugiat_ad": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "officiac6f": [ + "<string>", + "<string>" + ], + "id_a1": [ + "<string>", + "<string>" + ], + "ut_19": [ + "<string>", + "<string>" + ], + "in4": [ + "<string>", + "<string>" + ] + } + } + ] + } + /marketing/v3/marketing-events/events: + post: + tags: + - Marketing Events API > Basic + summary: Create a marketing event + description: Creates a new marketing event in HubSpot + requestBody: + content: + application/json: + schema: + type: object + example: + eventName: <string> + eventOrganizer: <string> + externalAccountId: <string> + externalEventId: <string> + startDateTime: <dateTime> + customProperties: + - name: <string> + requestId: <string> + selectedByUser: <boolean> + selectedByUserTimestamp: <long> + source: IMPORT + sourceId: <string> + sourceLabel: <string> + sourceMetadata: <string> + sourceVid: + - <long> + - <long> + timestamp: <long> + value: <string> + updatedByUserId: <integer> + persistenceTimestamp: <long> + useTimestampAsPersistenceTimestamp: <boolean> + isLargeValue: <boolean> + dataSensitivity: standard + isEncrypted: <boolean> + unit: <string> + - name: <string> + requestId: <string> + selectedByUser: <boolean> + selectedByUserTimestamp: <long> + source: COMPANY_FAMILIES + sourceId: <string> + sourceLabel: <string> + sourceMetadata: <string> + sourceVid: + - <long> + - <long> + timestamp: <long> + value: <string> + updatedByUserId: <integer> + persistenceTimestamp: <long> + useTimestampAsPersistenceTimestamp: <boolean> + isLargeValue: <boolean> + dataSensitivity: standard + isEncrypted: <boolean> + unit: <string> + eventCancelled: <boolean> + eventUrl: <string> + eventDescription: <string> + eventType: <string> + endDateTime: <dateTime> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + eventName: <string> + eventOrganizer: <string> + startDateTime: <dateTime> + customProperties: + - name: <string> + requestId: <string> + selectedByUser: <boolean> + selectedByUserTimestamp: <long> + source: BOT + sourceId: <string> + sourceLabel: <string> + sourceMetadata: <string> + sourceVid: + - <long> + - <long> + timestamp: <long> + value: <string> + updatedByUserId: <integer> + persistenceTimestamp: <long> + useTimestampAsPersistenceTimestamp: <boolean> + isLargeValue: <boolean> + dataSensitivity: standard + isEncrypted: <boolean> + unit: <string> + - name: <string> + requestId: <string> + selectedByUser: <boolean> + selectedByUserTimestamp: <long> + source: SALES_MESSAGES + sourceId: <string> + sourceLabel: <string> + sourceMetadata: <string> + sourceVid: + - <long> + - <long> + timestamp: <long> + value: <string> + updatedByUserId: <integer> + persistenceTimestamp: <long> + useTimestampAsPersistenceTimestamp: <boolean> + isLargeValue: <boolean> + dataSensitivity: none + isEncrypted: <boolean> + unit: <string> + eventCancelled: <boolean> + eventUrl: <string> + eventDescription: <string> + eventType: <string> + endDateTime: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "mollit4b": [ + "<string>", + "<string>" + ], + "dolore_d7b": [ + "<string>", + "<string>" + ], + "proident_f7": [ + "<string>", + "<string>" + ], + "proident_5": [ + "<string>", + "<string>" + ] + }, + "links": { + "ad034": "<string>", + "proident3e_": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "pariatur__": [ + "<string>", + "<string>" + ], + "labore_2d": [ + "<string>", + "<string>" + ], + "fugiat_ad": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "officiac6f": [ + "<string>", + "<string>" + ], + "id_a1": [ + "<string>", + "<string>" + ], + "ut_19": [ + "<string>", + "<string>" + ], + "in4": [ + "<string>", + "<string>" + ] + } + } + ] + } + /marketing/v3/marketing-events/events/{externalEventId}/cancel: + post: + tags: + - Marketing Events API > Basic + summary: Mark a marketing event as cancelled + description: Mark a marketing event as cancelled. + requestBody: + content: {} + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: externalAccountId + in: query + schema: + type: string + description: (Required) The account id associated with the marketing event + example: <string> + - name: externalEventId + in: path + schema: + type: string + required: true + description: (Required) The id of the marketing event to mark as cancelled + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + eventName: <string> + eventOrganizer: <string> + startDateTime: <dateTime> + customProperties: + - name: <string> + requestId: <string> + selectedByUser: <boolean> + selectedByUserTimestamp: <long> + source: BOT + sourceId: <string> + sourceLabel: <string> + sourceMetadata: <string> + sourceVid: + - <long> + - <long> + timestamp: <long> + value: <string> + updatedByUserId: <integer> + persistenceTimestamp: <long> + useTimestampAsPersistenceTimestamp: <boolean> + isLargeValue: <boolean> + dataSensitivity: none + isEncrypted: <boolean> + unit: <string> + - name: <string> + requestId: <string> + selectedByUser: <boolean> + selectedByUserTimestamp: <long> + source: SALES_MESSAGES + sourceId: <string> + sourceLabel: <string> + sourceMetadata: <string> + sourceVid: + - <long> + - <long> + timestamp: <long> + value: <string> + updatedByUserId: <integer> + persistenceTimestamp: <long> + useTimestampAsPersistenceTimestamp: <boolean> + isLargeValue: <boolean> + dataSensitivity: none + isEncrypted: <boolean> + unit: <string> + eventCancelled: <boolean> + eventUrl: <string> + eventDescription: <string> + eventType: <string> + endDateTime: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "mollit4b": [ + "<string>", + "<string>" + ], + "dolore_d7b": [ + "<string>", + "<string>" + ], + "proident_f7": [ + "<string>", + "<string>" + ], + "proident_5": [ + "<string>", + "<string>" + ] + }, + "links": { + "ad034": "<string>", + "proident3e_": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "pariatur__": [ + "<string>", + "<string>" + ], + "labore_2d": [ + "<string>", + "<string>" + ], + "fugiat_ad": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "officiac6f": [ + "<string>", + "<string>" + ], + "id_a1": [ + "<string>", + "<string>" + ], + "ut_19": [ + "<string>", + "<string>" + ], + "in4": [ + "<string>", + "<string>" + ] + } + } + ] + } + /marketing/v3/marketing-events/events/{externalEventId}: + get: + tags: + - Marketing Events API > Basic + summary: Get Marketing Event by External IDs + description: >- + Returns the details of the Marketing Event with the specified id, if one + exists. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: externalAccountId + in: query + schema: + type: string + description: (Required) The account id associated with the marketing event + example: <string> + - name: externalEventId + in: path + schema: + type: string + required: true + description: (Required) The id of the marketing event to return + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + attendees: <integer> + cancellations: <integer> + createdAt: <dateTime> + eventName: <string> + eventOrganizer: <string> + externalEventId: <string> + id: <string> + noShows: <integer> + registrants: <integer> + updatedAt: <dateTime> + eventUrl: <string> + eventType: <string> + endDateTime: <dateTime> + startDateTime: <dateTime> + customProperties: + - name: <string> + requestId: <string> + selectedByUser: <boolean> + selectedByUserTimestamp: <long> + source: EXTENSION + sourceId: <string> + sourceLabel: <string> + sourceMetadata: <string> + sourceVid: + - <long> + - <long> + timestamp: <long> + value: <string> + updatedByUserId: <integer> + persistenceTimestamp: <long> + useTimestampAsPersistenceTimestamp: <boolean> + isLargeValue: <boolean> + dataSensitivity: high + isEncrypted: <boolean> + unit: <string> + - name: <string> + requestId: <string> + selectedByUser: <boolean> + selectedByUserTimestamp: <long> + source: EMAIL + sourceId: <string> + sourceLabel: <string> + sourceMetadata: <string> + sourceVid: + - <long> + - <long> + timestamp: <long> + value: <string> + updatedByUserId: <integer> + persistenceTimestamp: <long> + useTimestampAsPersistenceTimestamp: <boolean> + isLargeValue: <boolean> + dataSensitivity: none + isEncrypted: <boolean> + unit: <string> + eventCancelled: <boolean> + eventDescription: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "mollit4b": [ + "<string>", + "<string>" + ], + "dolore_d7b": [ + "<string>", + "<string>" + ], + "proident_f7": [ + "<string>", + "<string>" + ], + "proident_5": [ + "<string>", + "<string>" + ] + }, + "links": { + "ad034": "<string>", + "proident3e_": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "pariatur__": [ + "<string>", + "<string>" + ], + "labore_2d": [ + "<string>", + "<string>" + ], + "fugiat_ad": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "officiac6f": [ + "<string>", + "<string>" + ], + "id_a1": [ + "<string>", + "<string>" + ], + "ut_19": [ + "<string>", + "<string>" + ], + "in4": [ + "<string>", + "<string>" + ] + } + } + ] + } + put: + tags: + - Marketing Events API > Basic + summary: Create or update a marketing event + description: >- + Upsets a Marketing Event. If there is an existing Marketing event with + the specified id, it will be updated; otherwise a new event will be + created. + requestBody: + content: + application/json: + schema: + type: object + example: + eventName: <string> + eventOrganizer: <string> + externalAccountId: <string> + externalEventId: <string> + startDateTime: <dateTime> + customProperties: + - name: <string> + requestId: <string> + selectedByUser: <boolean> + selectedByUserTimestamp: <long> + source: IMPORT + sourceId: <string> + sourceLabel: <string> + sourceMetadata: <string> + sourceVid: + - <long> + - <long> + timestamp: <long> + value: <string> + updatedByUserId: <integer> + persistenceTimestamp: <long> + useTimestampAsPersistenceTimestamp: <boolean> + isLargeValue: <boolean> + dataSensitivity: standard + isEncrypted: <boolean> + unit: <string> + - name: <string> + requestId: <string> + selectedByUser: <boolean> + selectedByUserTimestamp: <long> + source: COMPANY_FAMILIES + sourceId: <string> + sourceLabel: <string> + sourceMetadata: <string> + sourceVid: + - <long> + - <long> + timestamp: <long> + value: <string> + updatedByUserId: <integer> + persistenceTimestamp: <long> + useTimestampAsPersistenceTimestamp: <boolean> + isLargeValue: <boolean> + dataSensitivity: none + isEncrypted: <boolean> + unit: <string> + eventCancelled: <boolean> + eventUrl: <string> + eventDescription: <string> + eventType: <string> + endDateTime: <dateTime> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: externalEventId + in: path + schema: + type: string + required: true + description: (Required) The id of the marketing event to upsert + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + eventName: <string> + eventOrganizer: <string> + id: <string> + updatedAt: <dateTime> + startDateTime: <dateTime> + customProperties: + - name: <string> + requestId: <string> + selectedByUser: <boolean> + selectedByUserTimestamp: <long> + source: SETTINGS + sourceId: <string> + sourceLabel: <string> + sourceMetadata: <string> + sourceVid: + - <long> + - <long> + timestamp: <long> + value: <string> + updatedByUserId: <integer> + persistenceTimestamp: <long> + useTimestampAsPersistenceTimestamp: <boolean> + isLargeValue: <boolean> + dataSensitivity: high + isEncrypted: <boolean> + unit: <string> + - name: <string> + requestId: <string> + selectedByUser: <boolean> + selectedByUserTimestamp: <long> + source: EMAIL_INTEGRATION + sourceId: <string> + sourceLabel: <string> + sourceMetadata: <string> + sourceVid: + - <long> + - <long> + timestamp: <long> + value: <string> + updatedByUserId: <integer> + persistenceTimestamp: <long> + useTimestampAsPersistenceTimestamp: <boolean> + isLargeValue: <boolean> + dataSensitivity: none + isEncrypted: <boolean> + unit: <string> + eventCancelled: <boolean> + eventUrl: <string> + eventDescription: <string> + eventType: <string> + endDateTime: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "mollit4b": [ + "<string>", + "<string>" + ], + "dolore_d7b": [ + "<string>", + "<string>" + ], + "proident_f7": [ + "<string>", + "<string>" + ], + "proident_5": [ + "<string>", + "<string>" + ] + }, + "links": { + "ad034": "<string>", + "proident3e_": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "pariatur__": [ + "<string>", + "<string>" + ], + "labore_2d": [ + "<string>", + "<string>" + ], + "fugiat_ad": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "officiac6f": [ + "<string>", + "<string>" + ], + "id_a1": [ + "<string>", + "<string>" + ], + "ut_19": [ + "<string>", + "<string>" + ], + "in4": [ + "<string>", + "<string>" + ] + } + } + ] + } + delete: + tags: + - Marketing Events API > Basic + summary: Delete Marketing Event by External Ids + description: >- + Deletes an existing Marketing Event with the specified id, if one + exists. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: externalAccountId + in: query + schema: + type: string + description: (Required) The account id associated with the marketing event + example: <string> + - name: externalEventId + in: path + schema: + type: string + required: true + description: (Required) The id of the marketing event to delete + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "mollit4b": [ + "<string>", + "<string>" + ], + "dolore_d7b": [ + "<string>", + "<string>" + ], + "proident_f7": [ + "<string>", + "<string>" + ], + "proident_5": [ + "<string>", + "<string>" + ] + }, + "links": { + "ad034": "<string>", + "proident3e_": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "pariatur__": [ + "<string>", + "<string>" + ], + "labore_2d": [ + "<string>", + "<string>" + ], + "fugiat_ad": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "officiac6f": [ + "<string>", + "<string>" + ], + "id_a1": [ + "<string>", + "<string>" + ], + "ut_19": [ + "<string>", + "<string>" + ], + "in4": [ + "<string>", + "<string>" + ] + } + } + ] + } + patch: + tags: + - Marketing Events API > Basic + summary: Update Marketing Event by External IDs + description: >- + Updates an existing Marketing Event with the specified id, if one + exists. + requestBody: + content: {} + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: externalAccountId + in: query + schema: + type: string + description: (Required) The account id associated with the marketing event + example: <string> + - name: externalEventId + in: path + schema: + type: string + required: true + description: (Required) The id of the marketing event to update + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + eventName: <string> + eventOrganizer: <string> + id: <string> + updatedAt: <dateTime> + startDateTime: <dateTime> + customProperties: + - name: <string> + requestId: <string> + selectedByUser: <boolean> + selectedByUserTimestamp: <long> + source: SETTINGS + sourceId: <string> + sourceLabel: <string> + sourceMetadata: <string> + sourceVid: + - <long> + - <long> + timestamp: <long> + value: <string> + updatedByUserId: <integer> + persistenceTimestamp: <long> + useTimestampAsPersistenceTimestamp: <boolean> + isLargeValue: <boolean> + dataSensitivity: standard + isEncrypted: <boolean> + unit: <string> + - name: <string> + requestId: <string> + selectedByUser: <boolean> + selectedByUserTimestamp: <long> + source: EMAIL_INTEGRATION + sourceId: <string> + sourceLabel: <string> + sourceMetadata: <string> + sourceVid: + - <long> + - <long> + timestamp: <long> + value: <string> + updatedByUserId: <integer> + persistenceTimestamp: <long> + useTimestampAsPersistenceTimestamp: <boolean> + isLargeValue: <boolean> + dataSensitivity: high + isEncrypted: <boolean> + unit: <string> + eventCancelled: <boolean> + eventUrl: <string> + eventDescription: <string> + eventType: <string> + endDateTime: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "mollit4b": [ + "<string>", + "<string>" + ], + "dolore_d7b": [ + "<string>", + "<string>" + ], + "proident_f7": [ + "<string>", + "<string>" + ], + "proident_5": [ + "<string>", + "<string>" + ] + }, + "links": { + "ad034": "<string>", + "proident3e_": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "pariatur__": [ + "<string>", + "<string>" + ], + "labore_2d": [ + "<string>", + "<string>" + ], + "fugiat_ad": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "officiac6f": [ + "<string>", + "<string>" + ], + "id_a1": [ + "<string>", + "<string>" + ], + "ut_19": [ + "<string>", + "<string>" + ], + "in4": [ + "<string>", + "<string>" + ] + } + } + ] + } + /marketing/v3/marketing-events/{appId}/settings: + get: + tags: + - Marketing Events API > Settings + summary: Retrieve the application settings + description: Retrieve the current settings for the application. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: appId + in: path + schema: + type: string + required: true + description: (Required) The id of the application to retrieve the settings for. + example: <integer> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + appId: <integer> + eventDetailsUrl: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "mollit4b": [ + "<string>", + "<string>" + ], + "dolore_d7b": [ + "<string>", + "<string>" + ], + "proident_f7": [ + "<string>", + "<string>" + ], + "proident_5": [ + "<string>", + "<string>" + ] + }, + "links": { + "ad034": "<string>", + "proident3e_": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "pariatur__": [ + "<string>", + "<string>" + ], + "labore_2d": [ + "<string>", + "<string>" + ], + "fugiat_ad": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "officiac6f": [ + "<string>", + "<string>" + ], + "id_a1": [ + "<string>", + "<string>" + ], + "ut_19": [ + "<string>", + "<string>" + ], + "in4": [ + "<string>", + "<string>" + ] + } + } + ] + } + post: + tags: + - Marketing Events API > Settings + summary: Update the application settings + description: Create or update the current settings for the application. + requestBody: + content: + application/json: + schema: + type: object + example: + eventDetailsUrl: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: appId + in: path + schema: + type: string + required: true + description: (Required) The id of the application to update the settings for. + example: <integer> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + appId: <integer> + eventDetailsUrl: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "mollit4b": [ + "<string>", + "<string>" + ], + "dolore_d7b": [ + "<string>", + "<string>" + ], + "proident_f7": [ + "<string>", + "<string>" + ], + "proident_5": [ + "<string>", + "<string>" + ] + }, + "links": { + "ad034": "<string>", + "proident3e_": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "pariatur__": [ + "<string>", + "<string>" + ], + "labore_2d": [ + "<string>", + "<string>" + ], + "fugiat_ad": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "officiac6f": [ + "<string>", + "<string>" + ], + "id_a1": [ + "<string>", + "<string>" + ], + "ut_19": [ + "<string>", + "<string>" + ], + "in4": [ + "<string>", + "<string>" + ] + } + } + ] + } + /marketing/v3/marketing-events/events/search: + get: + tags: + - Marketing Events API > Search + summary: Find App-Specific Marketing Events by External Event Id + description: >- + Search for marketing events that have an event id that starts with the + query string + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: q + in: query + schema: + type: string + description: >- + (Required) The id of the marketing event in the external event + application + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - appId: <integer> + externalAccountId: <string> + externalEventId: <string> + objectId: <string> + - appId: <integer> + externalAccountId: <string> + externalEventId: <string> + objectId: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "mollit4b": [ + "<string>", + "<string>" + ], + "dolore_d7b": [ + "<string>", + "<string>" + ], + "proident_f7": [ + "<string>", + "<string>" + ], + "proident_5": [ + "<string>", + "<string>" + ] + }, + "links": { + "ad034": "<string>", + "proident3e_": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "pariatur__": [ + "<string>", + "<string>" + ], + "labore_2d": [ + "<string>", + "<string>" + ], + "fugiat_ad": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "officiac6f": [ + "<string>", + "<string>" + ], + "id_a1": [ + "<string>", + "<string>" + ], + "ut_19": [ + "<string>", + "<string>" + ], + "in4": [ + "<string>", + "<string>" + ] + } + } + ] + } + /marketing/v3/marketing-events/participations/{marketingEventId}/breakdown: + get: + tags: + - Marketing Events API + summary: Read participations breakdown by Marketing Event internal identifier + description: >- + Read Marketing event's participations breakdown with optional filters by + internal identifier marketingEventId. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: contactIdentifier + in: query + schema: + type: string + description: The identifier of the Contact. It may be email or internal id. + example: <string> + - name: state + in: query + schema: + type: string + description: >- + The participation state value. It may be REGISTERED, CANCELLED, + ATTENDED, NO_SHOW + example: <string> + - name: limit + in: query + schema: + type: integer + description: >- + The limit for response size. The default value is 10, the max number + is 100 + example: '10' + - name: after + in: query + schema: + type: string + description: The cursor indicating the position of the last retrieved item. + example: <string> + - name: marketingEventId + in: path + schema: + type: string + required: true + description: (Required) The internal id of the marketing event in HubSpot. + example: <long> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - associations: + contact: + contactId: <string> + email: <string> + firstname: <string> + lastname: <string> + marketingEvent: + marketingEventId: <string> + name: <string> + externalAccountId: <string> + externalEventId: <string> + createdAt: <dateTime> + id: <string> + properties: + attendanceState: REGISTERED + occurredAt: <long> + attendancePercentage: <string> + attendanceDurationSeconds: <integer> + - associations: + contact: + contactId: <string> + email: <string> + firstname: <string> + lastname: <string> + marketingEvent: + marketingEventId: <string> + name: <string> + externalAccountId: <string> + externalEventId: <string> + createdAt: <dateTime> + id: <string> + properties: + attendanceState: NO_SHOW + occurredAt: <long> + attendancePercentage: <string> + attendanceDurationSeconds: <integer> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "non_729": [ + "<string>", + "<string>" + ], + "nostrud3cd": [ + "<string>", + "<string>" + ] + }, + "links": { + "ut9": "<string>", + "sunt_88_": "<string>", + "eu5": "<string>", + "non__": "<string>" + }, + "errors": [ + { + "message": "in adipisicing", + "subCategory": "tempor sunt aliquip", + "code": "ullamco eu", + "in": "id cillum do sed", + "context": { + "sint5": [ + "mollit anim proident", + "ut culpa" + ] + } + }, + { + "message": "eiusmod incididunt proident", + "subCategory": "sint ut Excepteur", + "code": "Duis Lorem in reprehenderit", + "in": "consequat", + "context": { + "occaecataac": [ + "minim fugiat cillum exer", + "amet dolor consequat" + ], + "non1": [ + "non ex culpa", + "" + ] + } + } + ] + } + /marketing/v3/marketing-events/participations/{externalAccountId}/{externalEventId}: + get: + tags: + - Marketing Events API + summary: Read participations counters by Marketing Event external identifier + description: >- + Read Marketing event's participations counters by externalAccountId and + externalEventId pair. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: externalAccountId + in: path + schema: + type: string + required: true + description: >- + (Required) The accountId that is associated with this marketing + event in the external event application. + example: <string> + - name: externalEventId + in: path + schema: + type: string + required: true + description: >- + (Required) The id of the marketing event in the external event + application. + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + attended: <integer> + cancelled: <integer> + noShows: <integer> + registered: <integer> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "non_729": [ + "<string>", + "<string>" + ], + "nostrud3cd": [ + "<string>", + "<string>" + ] + }, + "links": { + "ut9": "<string>", + "sunt_88_": "<string>", + "eu5": "<string>", + "non__": "<string>" + }, + "errors": [ + { + "message": "in adipisicing", + "subCategory": "tempor sunt aliquip", + "code": "ullamco eu", + "in": "id cillum do sed", + "context": { + "sint5": [ + "mollit anim proident", + "ut culpa" + ] + } + }, + { + "message": "eiusmod incididunt proident", + "subCategory": "sint ut Excepteur", + "code": "Duis Lorem in reprehenderit", + "in": "consequat", + "context": { + "occaecataac": [ + "minim fugiat cillum exer", + "amet dolor consequat" + ], + "non1": [ + "non ex culpa", + "" + ] + } + } + ] + } + /marketing/v3/marketing-events/participations/{marketingEventId}: + get: + tags: + - Marketing Events API + summary: Read participations counters by Marketing Event internal identifier + description: >- + Read Marketing event's participations counters by internal identifier + marketingEventId. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: marketingEventId + in: path + schema: + type: string + required: true + description: (Required) The internal id of the marketing event in HubSpot. + example: <long> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + attended: <integer> + cancelled: <integer> + noShows: <integer> + registered: <integer> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "non_729": [ + "<string>", + "<string>" + ], + "nostrud3cd": [ + "<string>", + "<string>" + ] + }, + "links": { + "ut9": "<string>", + "sunt_88_": "<string>", + "eu5": "<string>", + "non__": "<string>" + }, + "errors": [ + { + "message": "in adipisicing", + "subCategory": "tempor sunt aliquip", + "code": "ullamco eu", + "in": "id cillum do sed", + "context": { + "sint5": [ + "mollit anim proident", + "ut culpa" + ] + } + }, + { + "message": "eiusmod incididunt proident", + "subCategory": "sint ut Excepteur", + "code": "Duis Lorem in reprehenderit", + "in": "consequat", + "context": { + "occaecataac": [ + "minim fugiat cillum exer", + "amet dolor consequat" + ], + "non1": [ + "non ex culpa", + "" + ] + } + } + ] + } + /marketing/v3/marketing-events/participations/{externalAccountId}/{externalEventId}/breakdown: + get: + tags: + - Marketing Events API + summary: Read participations breakdown by Marketing Event external identifier + description: >- + Read Marketing event's participations breakdown with optional filters by + externalAccountId and externalEventId pair. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: contactIdentifier + in: query + schema: + type: string + description: The identifier of the Contact. It may be email or internal id. + example: <string> + - name: state + in: query + schema: + type: string + description: >- + The participation state value. It may be REGISTERED, CANCELLED, + ATTENDED, NO_SHOW + example: <string> + - name: limit + in: query + schema: + type: integer + description: >- + The limit for response size. The default value is 10, the max number + is 100 + example: '10' + - name: after + in: query + schema: + type: string + description: The cursor indicating the position of the last retrieved item. + example: <string> + - name: externalAccountId + in: path + schema: + type: string + required: true + description: >- + (Required) The accountId that is associated with this marketing + event in the external event application. + example: <string> + - name: externalEventId + in: path + schema: + type: string + required: true + description: >- + (Required) The id of the marketing event in the external event + application. + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - associations: + contact: + contactId: <string> + email: <string> + firstname: <string> + lastname: <string> + marketingEvent: + marketingEventId: <string> + name: <string> + externalAccountId: <string> + externalEventId: <string> + createdAt: <dateTime> + id: <string> + properties: + attendanceState: REGISTERED + occurredAt: <long> + attendancePercentage: <string> + attendanceDurationSeconds: <integer> + - associations: + contact: + contactId: <string> + email: <string> + firstname: <string> + lastname: <string> + marketingEvent: + marketingEventId: <string> + name: <string> + externalAccountId: <string> + externalEventId: <string> + createdAt: <dateTime> + id: <string> + properties: + attendanceState: NO_SHOW + occurredAt: <long> + attendancePercentage: <string> + attendanceDurationSeconds: <integer> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "non_729": [ + "<string>", + "<string>" + ], + "nostrud3cd": [ + "<string>", + "<string>" + ] + }, + "links": { + "ut9": "<string>", + "sunt_88_": "<string>", + "eu5": "<string>", + "non__": "<string>" + }, + "errors": [ + { + "message": "in adipisicing", + "subCategory": "tempor sunt aliquip", + "code": "ullamco eu", + "in": "id cillum do sed", + "context": { + "sint5": [ + "mollit anim proident", + "ut culpa" + ] + } + }, + { + "message": "eiusmod incididunt proident", + "subCategory": "sint ut Excepteur", + "code": "Duis Lorem in reprehenderit", + "in": "consequat", + "context": { + "occaecataac": [ + "minim fugiat cillum exer", + "amet dolor consequat" + ], + "non1": [ + "non ex culpa", + "" + ] + } + } + ] + } + /marketing/v3/marketing-events/participations/contacts/{contactIdentifier}/breakdown: + get: + tags: + - Marketing Events API + summary: Read participations breakdown by Contact identifier + description: Read Contact's participations by identifier - email or internal id. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: state + in: query + schema: + type: string + description: >- + The participation state value. It may be REGISTERED, CANCELLED, + ATTENDED, NO_SHOW + example: <string> + - name: limit + in: query + schema: + type: integer + description: >- + The limit for response size. The default value is 10, the max number + is 100 + example: '10' + - name: after + in: query + schema: + type: string + description: The cursor indicating the position of the last retrieved item. + example: <string> + - name: contactIdentifier + in: path + schema: + type: string + required: true + description: >- + (Required) The identifier of the Contact. It may be email or + internal id. + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - associations: + contact: + contactId: <string> + email: <string> + firstname: <string> + lastname: <string> + marketingEvent: + marketingEventId: <string> + name: <string> + externalAccountId: <string> + externalEventId: <string> + createdAt: <dateTime> + id: <string> + properties: + attendanceState: REGISTERED + occurredAt: <long> + attendancePercentage: <string> + attendanceDurationSeconds: <integer> + - associations: + contact: + contactId: <string> + email: <string> + firstname: <string> + lastname: <string> + marketingEvent: + marketingEventId: <string> + name: <string> + externalAccountId: <string> + externalEventId: <string> + createdAt: <dateTime> + id: <string> + properties: + attendanceState: NO_SHOW + occurredAt: <long> + attendancePercentage: <string> + attendanceDurationSeconds: <integer> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "non_729": [ + "<string>", + "<string>" + ], + "nostrud3cd": [ + "<string>", + "<string>" + ] + }, + "links": { + "ut9": "<string>", + "sunt_88_": "<string>", + "eu5": "<string>", + "non__": "<string>" + }, + "errors": [ + { + "message": "in adipisicing", + "subCategory": "tempor sunt aliquip", + "code": "ullamco eu", + "in": "id cillum do sed", + "context": { + "sint5": [ + "mollit anim proident", + "ut culpa" + ] + } + }, + { + "message": "eiusmod incididunt proident", + "subCategory": "sint ut Excepteur", + "code": "Duis Lorem in reprehenderit", + "in": "consequat", + "context": { + "occaecataac": [ + "minim fugiat cillum exer", + "amet dolor consequat" + ], + "non1": [ + "non ex culpa", + "" + ] + } + } + ] + } + /marketing/v3/marketing-events/associations/{marketingEventId}/lists/{listId}: + put: + tags: + - Marketing Events API + summary: Associate a list with a marketing event + description: >- + Associates a list with a marketing event by marketing event id and ILS + list id + requestBody: + content: {} + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: marketingEventId + in: path + schema: + type: string + required: true + description: (Required) The internal id of the marketing event in HubSpot. + example: <string> + - name: listId + in: path + schema: + type: string + required: true + description: (Required) The ILS ID of the list. + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "esse_0": [ + "<string>", + "<string>" + ], + "euc": [ + "<string>", + "<string>" + ] + }, + "links": { + "ad__0": "<string>" + }, + "errors": [ + { + "message": "Lorem irure", + "subCategory": "non in ipsum in ut", + "code": "mollit dolor", + "in": "do labore nulla", + "context": { + "est_7": [ + "exercitation id adipisicing et", + "Duis dolor" + ] + } + }, + { + "message": "mollit dolor do", + "subCategory": "dolor sed", + "code": "consectetur", + "in": "culpa ullamco do nisi", + "context": { + "do5d": [ + "ut pariatur fugiat", + "elit est" + ], + "Lorem_5a": [ + "dolo", + "tempor ipsum do Ut" + ], + "tempor9_e": [ + "nostrud sit sed", + "quis commodo" + ] + } + } + ] + } + delete: + tags: + - Marketing Events API + summary: Disassociate a list from a marketing event + description: >- + Disassociates a list from a marketing event by marketing event id and + ILS list id + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: marketingEventId + in: path + schema: + type: string + required: true + description: (Required) The internal id of the marketing event in HubSpot. + example: <string> + - name: listId + in: path + schema: + type: string + required: true + description: (Required) The ILS ID of the list. + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "esse_0": [ + "<string>", + "<string>" + ], + "euc": [ + "<string>", + "<string>" + ] + }, + "links": { + "ad__0": "<string>" + }, + "errors": [ + { + "message": "Lorem irure", + "subCategory": "non in ipsum in ut", + "code": "mollit dolor", + "in": "do labore nulla", + "context": { + "est_7": [ + "exercitation id adipisicing et", + "Duis dolor" + ] + } + }, + { + "message": "mollit dolor do", + "subCategory": "dolor sed", + "code": "consectetur", + "in": "culpa ullamco do nisi", + "context": { + "do5d": [ + "ut pariatur fugiat", + "elit est" + ], + "Lorem_5a": [ + "dolo", + "tempor ipsum do Ut" + ], + "tempor9_e": [ + "nostrud sit sed", + "quis commodo" + ] + } + } + ] + } + /marketing/v3/marketing-events/associations/{externalAccountId}/{externalEventId}/lists: + get: + tags: + - Marketing Events API + summary: Get lists associated with a marketing event + description: >- + Gets lists associated with a marketing event by external account id and + external event id + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: externalAccountId + in: path + schema: + type: string + required: true + description: >- + (Required) The accountId that is associated with this marketing + event in the external event application. + example: <string> + - name: externalEventId + in: path + schema: + type: string + required: true + description: >- + (Required) The id of the marketing event in the external event + application. + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - listId: <string> + listVersion: <integer> + name: <string> + objectTypeId: <string> + processingStatus: <string> + processingType: <string> + updatedById: <string> + filtersUpdatedAt: <dateTime> + createdAt: <dateTime> + deletedAt: <dateTime> + size: <long> + createdById: <string> + updatedAt: <dateTime> + - listId: <string> + listVersion: <integer> + name: <string> + objectTypeId: <string> + processingStatus: <string> + processingType: <string> + updatedById: <string> + filtersUpdatedAt: <dateTime> + createdAt: <dateTime> + deletedAt: <dateTime> + size: <long> + createdById: <string> + updatedAt: <dateTime> + total: <integer> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "esse_0": [ + "<string>", + "<string>" + ], + "euc": [ + "<string>", + "<string>" + ] + }, + "links": { + "ad__0": "<string>" + }, + "errors": [ + { + "message": "Lorem irure", + "subCategory": "non in ipsum in ut", + "code": "mollit dolor", + "in": "do labore nulla", + "context": { + "est_7": [ + "exercitation id adipisicing et", + "Duis dolor" + ] + } + }, + { + "message": "mollit dolor do", + "subCategory": "dolor sed", + "code": "consectetur", + "in": "culpa ullamco do nisi", + "context": { + "do5d": [ + "ut pariatur fugiat", + "elit est" + ], + "Lorem_5a": [ + "dolo", + "tempor ipsum do Ut" + ], + "tempor9_e": [ + "nostrud sit sed", + "quis commodo" + ] + } + } + ] + } + /marketing/v3/marketing-events/associations/{externalAccountId}/{externalEventId}/lists/{listId}: + put: + tags: + - Marketing Events API + summary: Associate a list with a marketing event + description: >- + Associates a list with a marketing event by external account id, + external event id, and ILS list id + requestBody: + content: {} + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: externalAccountId + in: path + schema: + type: string + required: true + description: >- + (Required) The accountId that is associated with this marketing + event in the external event application. + example: <string> + - name: externalEventId + in: path + schema: + type: string + required: true + description: >- + (Required) The id of the marketing event in the external event + application. + example: <string> + - name: listId + in: path + schema: + type: string + required: true + description: (Required) The ILS ID of the list. + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "esse_0": [ + "<string>", + "<string>" + ], + "euc": [ + "<string>", + "<string>" + ] + }, + "links": { + "ad__0": "<string>" + }, + "errors": [ + { + "message": "Lorem irure", + "subCategory": "non in ipsum in ut", + "code": "mollit dolor", + "in": "do labore nulla", + "context": { + "est_7": [ + "exercitation id adipisicing et", + "Duis dolor" + ] + } + }, + { + "message": "mollit dolor do", + "subCategory": "dolor sed", + "code": "consectetur", + "in": "culpa ullamco do nisi", + "context": { + "do5d": [ + "ut pariatur fugiat", + "elit est" + ], + "Lorem_5a": [ + "dolo", + "tempor ipsum do Ut" + ], + "tempor9_e": [ + "nostrud sit sed", + "quis commodo" + ] + } + } + ] + } + delete: + tags: + - Marketing Events API + summary: Disassociate a list from a marketing event + description: >- + Disassociates a list from a marketing event by external account id, + external event id, and ILS list id + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: externalAccountId + in: path + schema: + type: string + required: true + description: >- + (Required) The accountId that is associated with this marketing + event in the external event application. + example: <string> + - name: externalEventId + in: path + schema: + type: string + required: true + description: >- + (Required) The id of the marketing event in the external event + application. + example: <string> + - name: listId + in: path + schema: + type: string + required: true + description: (Required) The ILS ID of the list. + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "esse_0": [ + "<string>", + "<string>" + ], + "euc": [ + "<string>", + "<string>" + ] + }, + "links": { + "ad__0": "<string>" + }, + "errors": [ + { + "message": "Lorem irure", + "subCategory": "non in ipsum in ut", + "code": "mollit dolor", + "in": "do labore nulla", + "context": { + "est_7": [ + "exercitation id adipisicing et", + "Duis dolor" + ] + } + }, + { + "message": "mollit dolor do", + "subCategory": "dolor sed", + "code": "consectetur", + "in": "culpa ullamco do nisi", + "context": { + "do5d": [ + "ut pariatur fugiat", + "elit est" + ], + "Lorem_5a": [ + "dolo", + "tempor ipsum do Ut" + ], + "tempor9_e": [ + "nostrud sit sed", + "quis commodo" + ] + } + } + ] + } + /marketing/v3/marketing-events/associations/{marketingEventId}/lists: + get: + tags: + - Marketing Events API + summary: Get lists associated with a marketing event + description: Gets lists associated with a marketing event by marketing event id + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: marketingEventId + in: path + schema: + type: string + required: true + description: (Required) The internal id of the marketing event in HubSpot. + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - listId: <string> + listVersion: <integer> + name: <string> + objectTypeId: <string> + processingStatus: <string> + processingType: <string> + updatedById: <string> + filtersUpdatedAt: <dateTime> + createdAt: <dateTime> + deletedAt: <dateTime> + size: <long> + createdById: <string> + updatedAt: <dateTime> + - listId: <string> + listVersion: <integer> + name: <string> + objectTypeId: <string> + processingStatus: <string> + processingType: <string> + updatedById: <string> + filtersUpdatedAt: <dateTime> + createdAt: <dateTime> + deletedAt: <dateTime> + size: <long> + createdById: <string> + updatedAt: <dateTime> + total: <integer> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "esse_0": [ + "<string>", + "<string>" + ], + "euc": [ + "<string>", + "<string>" + ] + }, + "links": { + "ad__0": "<string>" + }, + "errors": [ + { + "message": "Lorem irure", + "subCategory": "non in ipsum in ut", + "code": "mollit dolor", + "in": "do labore nulla", + "context": { + "est_7": [ + "exercitation id adipisicing et", + "Duis dolor" + ] + } + }, + { + "message": "mollit dolor do", + "subCategory": "dolor sed", + "code": "consectetur", + "in": "culpa ullamco do nisi", + "context": { + "do5d": [ + "ut pariatur fugiat", + "elit est" + ], + "Lorem_5a": [ + "dolo", + "tempor ipsum do Ut" + ], + "tempor9_e": [ + "nostrud sit sed", + "quis commodo" + ] + } + } + ] + } + /marketing/v3/marketing-events/{objectId}: + get: + tags: + - Marketing Events API + summary: Get Marketing Event by objectId + description: >- + Returns the details of a Marketing Event with the specified objectId, if + it exists. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: objectId + in: path + schema: + type: string + required: true + description: (Required) The internal ID of the marketing event in HubSpot + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + customProperties: + - name: <string> + value: <string> + - name: <string> + value: <string> + eventName: <string> + objectId: <string> + updatedAt: <dateTime> + registrants: <integer> + eventOrganizer: <string> + eventUrl: <string> + attendees: <integer> + appInfo: + id: <string> + name: <string> + eventType: <string> + eventCompleted: <boolean> + endDateTime: <dateTime> + noShows: <integer> + cancellations: <integer> + startDateTime: <dateTime> + eventCancelled: <boolean> + externalEventId: <string> + eventStatus: <string> + eventDescription: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "pariatura0": [ + "<string>", + "<string>" + ], + "et7": [ + "<string>", + "<string>" + ] + }, + "links": { + "cupidatat753": "<string>" + }, + "errors": [ + { + "message": "laboris et", + "subCategory": "fugiat quis consequat exercitat", + "code": "officia minim", + "in": "ut in", + "context": { + "dolore_a": [ + "dolore eiusmod veniam", + "culpa id" + ] + } + }, + { + "message": "ut in nisi", + "subCategory": "elit est do aliqua", + "code": "adipisicing", + "in": "dolor officia esse", + "context": { + "id_c7": [ + "sed amet proident reprehenderit laborum", + "in mollit adipisicing veniam irure" + ], + "eu5": [ + "Ut deserunt amet", + "quis commodo in elit" + ] + } + } + ] + } + delete: + tags: + - Marketing Events API + summary: Delete Marketing Event by objectId + description: >- + Deletes the existing Marketing Event with the specified objectId, if it + exists. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: objectId + in: path + schema: + type: string + required: true + description: (Required) The internal ID of the marketing event in HubSpot + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "pariatura0": [ + "<string>", + "<string>" + ], + "et7": [ + "<string>", + "<string>" + ] + }, + "links": { + "cupidatat753": "<string>" + }, + "errors": [ + { + "message": "laboris et", + "subCategory": "fugiat quis consequat exercitat", + "code": "officia minim", + "in": "ut in", + "context": { + "dolore_a": [ + "dolore eiusmod veniam", + "culpa id" + ] + } + }, + { + "message": "ut in nisi", + "subCategory": "elit est do aliqua", + "code": "adipisicing", + "in": "dolor officia esse", + "context": { + "id_c7": [ + "sed amet proident reprehenderit laborum", + "in mollit adipisicing veniam irure" + ], + "eu5": [ + "Ut deserunt amet", + "quis commodo in elit" + ] + } + } + ] + } + patch: + tags: + - Marketing Events API + summary: Update Marketing Event by objectId + description: >- + Updates the details of an existing Marketing Event identified by its + objectId, if it exists. + requestBody: + content: + application/json: + schema: + type: object + example: + customProperties: + - dataSensitivity: standard + isEncrypted: false + name: ad eu sit + requestId: cillum tempor officia aliqua non + selectedByUser: true + selectedByUserTimestamp: 2439601 + source: SETTINGS + sourceId: voluptate aliquip et veniam + sourceLabel: veniam + sourceMetadata: pariatur et + sourceVid: + - -12162090 + - 31200963 + timestamp: -12349682 + unit: qui tempor ea ut Duis + value: dolor mollit nostrud adipisicing ex + updatedByUserId: 86279783 + persistenceTimestamp: 61652612 + useTimestampAsPersistenceTimestamp: true + isLargeValue: false + - dataSensitivity: high + isEncrypted: false + name: consectetur dolor nostrud eiusmod + requestId: dolor enim velit laboris + selectedByUser: true + selectedByUserTimestamp: 94688975 + source: QUOTAS + sourceId: pariatur ad labore + sourceLabel: eu sed + sourceMetadata: in id incididunt + sourceVid: + - -88053271 + - -57421916 + timestamp: -19651588 + unit: ex + value: magna laborum + updatedByUserId: 77419756 + persistenceTimestamp: -66214616 + useTimestampAsPersistenceTimestamp: true + isLargeValue: false + startDateTime: <dateTime> + eventCancelled: <boolean> + eventOrganizer: <string> + eventUrl: <string> + eventDescription: <string> + eventName: <string> + eventType: <string> + endDateTime: <dateTime> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: objectId + in: path + schema: + type: string + required: true + description: (Required) The internal ID of the marketing event in HubSpot + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + customProperties: + - name: <string> + value: <string> + - name: <string> + value: <string> + eventName: <string> + objectId: <string> + updatedAt: <dateTime> + eventOrganizer: <string> + eventUrl: <string> + appInfo: + id: <string> + name: <string> + eventType: <string> + eventCompleted: <boolean> + endDateTime: <dateTime> + startDateTime: <dateTime> + eventCancelled: <boolean> + eventDescription: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "pariatura0": [ + "<string>", + "<string>" + ], + "et7": [ + "<string>", + "<string>" + ] + }, + "links": { + "cupidatat753": "<string>" + }, + "errors": [ + { + "message": "laboris et", + "subCategory": "fugiat quis consequat exercitat", + "code": "officia minim", + "in": "ut in", + "context": { + "dolore_a": [ + "dolore eiusmod veniam", + "culpa id" + ] + } + }, + { + "message": "ut in nisi", + "subCategory": "elit est do aliqua", + "code": "adipisicing", + "in": "dolor officia esse", + "context": { + "id_c7": [ + "sed amet proident reprehenderit laborum", + "in mollit adipisicing veniam irure" + ], + "eu5": [ + "Ut deserunt amet", + "quis commodo in elit" + ] + } + } + ] + } + /marketing/v3/marketing-events/{objectId}/attendance/{subscriberState}/email-create: + post: + tags: + - Marketing Events API + summary: Record Participants by Email with Marketing Event Object Id + description: >- + Records the participation of multiple HubSpot contacts in a Marketing + Event using their email addresses. + + + If a contact does not exist, it will be automatically created. The + contactProperties field is used exclusively for creating new contacts + and will not update properties of existing contacts. + + + Additional Functionality: + + - Adds a timeline event to the contacts. + + + Allowed Properties: + + For the state "attend": + + - joinedAt + + - leftAt + requestBody: + content: {} + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: objectId + in: path + schema: + type: string + required: true + description: (Required) The internal ID of the marketing event in HubSpot + example: <string> + - name: subscriberState + in: path + schema: + type: string + required: true + description: >- + (Required) The attendance state value. It may be 'register', + 'attend' or 'cancel' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: '1991-04-25T22:37:06.614Z' + results: + - email: et incididunt commodo reprehenderit + vid: -93190574 + - email: dolore aliquip et in + vid: 42263716 + startedAt: '1945-04-19T07:34:28.696Z' + status: CANCELED + numErrors: 97462129 + requestedAt: '1986-02-06T01:58:39.245Z' + links: + exercitation__55: dolor officia consectetur + mollit_589: dolore ut sunt minim + errors: + - category: 'veniam consectetur ' + context: + do_ca: + - in eiusmod l + - ipsum consequat id esse + errors: + - message: ex non + subCategory: aliqua Ut + code: ut sunt eiusmod dolore a + in: elit sunt dolor + context: + adipisicing19f: + - tempor in eiusmod + - ullamco amet aute ipsum consequat + - message: in officia + subCategory: exercitation cupidatat amet + code: dolore magna + in: 'n' + context: + esse1: + - elit s + - id ex et occaecat + links: + Lorem11: consequat aliquip cillum proident occaecat + message: ipsum + status: in Duis qui in + subCategory: {} + id: Duis + - category: eu dolor culpa sunt eiusmod + context: + culpa56: + - Duis qui amet anim + - commodo aliquip ipsum + officia4_: + - exercitation dolor + - ut Lorem aute sit + errors: + - message: irure deserunt dolore + subCategory: aliquip + code: ut + in: anim Lorem + context: + amet_e: + - nostrud Lorem in + - voluptate laborum in + ut7_c: + - labore nisi pariatur Lorem + - aliquip sint + - message: aute culpa eu + subCategory: ut Ut non est laborum + code: do tempor velit + in: sin + context: + laborum65: + - laboris + - nisi + officia_55: + - in + - dolore in + links: + consequat_28: qui culpa + minim6: dolor ullamco commodo + Lorem_f: sint anim sit + message: quis deserunt nulla dolore eu + status: eu cillum reprehenderit anim + subCategory: {} + id: eiusmod sint esse dolor exercitation + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "pariatura0": [ + "<string>", + "<string>" + ], + "et7": [ + "<string>", + "<string>" + ] + }, + "links": { + "cupidatat753": "<string>" + }, + "errors": [ + { + "message": "laboris et", + "subCategory": "fugiat quis consequat exercitat", + "code": "officia minim", + "in": "ut in", + "context": { + "dolore_a": [ + "dolore eiusmod veniam", + "culpa id" + ] + } + }, + { + "message": "ut in nisi", + "subCategory": "elit est do aliqua", + "code": "adipisicing", + "in": "dolor officia esse", + "context": { + "id_c7": [ + "sed amet proident reprehenderit laborum", + "in mollit adipisicing veniam irure" + ], + "eu5": [ + "Ut deserunt amet", + "quis commodo in elit" + ] + } + } + ] + } + /marketing/v3/marketing-events/: + get: + tags: + - Marketing Events API + summary: Get all marketing event + description: >- + Returns all Marketing Events available on the portal, along with their + properties, regardless of whether they were created manually or through + the application. + + + The marketing events returned by this endpoint are sorted by objectId. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: after + in: query + schema: + type: string + description: The cursor indicating the position of the last retrieved item. + example: <string> + - name: limit + in: query + schema: + type: integer + description: >- + The limit for response size. The default value is 10, the max number + is 100 + example: '10' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + customProperties: + - name: <string> + value: <string> + - name: <string> + value: <string> + eventName: <string> + objectId: <string> + updatedAt: <dateTime> + registrants: <integer> + eventOrganizer: <string> + eventUrl: <string> + attendees: <integer> + appInfo: + id: <string> + name: <string> + eventType: <string> + eventCompleted: <boolean> + endDateTime: <dateTime> + noShows: <integer> + cancellations: <integer> + startDateTime: <dateTime> + eventCancelled: <boolean> + externalEventId: <string> + eventStatus: <string> + eventDescription: <string> + - createdAt: <dateTime> + customProperties: + - name: <string> + value: <string> + - name: <string> + value: <string> + eventName: <string> + objectId: <string> + updatedAt: <dateTime> + registrants: <integer> + eventOrganizer: <string> + eventUrl: <string> + attendees: <integer> + appInfo: + id: <string> + name: <string> + eventType: <string> + eventCompleted: <boolean> + endDateTime: <dateTime> + noShows: <integer> + cancellations: <integer> + startDateTime: <dateTime> + eventCancelled: <boolean> + externalEventId: <string> + eventStatus: <string> + eventDescription: <string> + paging: + next: + after: pariatur ea dolore dolor + link: consectetur cillum + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "pariatura0": [ + "<string>", + "<string>" + ], + "et7": [ + "<string>", + "<string>" + ] + }, + "links": { + "cupidatat753": "<string>" + }, + "errors": [ + { + "message": "laboris et", + "subCategory": "fugiat quis consequat exercitat", + "code": "officia minim", + "in": "ut in", + "context": { + "dolore_a": [ + "dolore eiusmod veniam", + "culpa id" + ] + } + }, + { + "message": "ut in nisi", + "subCategory": "elit est do aliqua", + "code": "adipisicing", + "in": "dolor officia esse", + "context": { + "id_c7": [ + "sed amet proident reprehenderit laborum", + "in mollit adipisicing veniam irure" + ], + "eu5": [ + "Ut deserunt amet", + "quis commodo in elit" + ] + } + } + ] + } + /marketing/v3/marketing-events/{objectId}/attendance/{subscriberState}/create: + post: + tags: + - Marketing Events API + summary: Record Participants by ContactId with Marketing Event Object Id + description: >- + Records the participation of multiple HubSpot contacts in a Marketing + Event using their HubSpot contact IDs. + + + Additional Functionality: + + - Adds a timeline event to the contacts. + + + Allowed Properties: + + For the state "attend": + + - joinedAt + + - leftAt + requestBody: + content: {} + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: objectId + in: path + schema: + type: string + required: true + description: (Required) The internal id of the marketing event in HubSpot + example: <string> + - name: subscriberState + in: path + schema: + type: string + required: true + description: >- + (Required) The attendance state value. It may be 'register', + 'attend' or 'cancel' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: '1961-09-14T23:36:23.743Z' + results: + - vid: -15153545 + - vid: 40759015 + startedAt: '1960-09-07T13:42:28.158Z' + status: PROCESSING + numErrors: -94527365 + requestedAt: '2019-07-03T21:36:26.692Z' + links: + anim916: tempor culpa laboris in + dolor8d1: qui et aute + errors: + - category: 'nostrud do ' + context: + ad2: + - dolor in officia + - qui mollit ipsum quis in + errors: + - message: laborum + subCategory: in + code: al + in: consequat tempor labo + context: + id_08: + - dolor labore + - nisi in non ut + dolor_bca: + - dolor mollit sint in aliquip + - pariatur + sint_6c: + - eiusmod irure + - ut + id_a: + - laboris in Ut commodo + - eu quis sint dolore + - message: 'laborum in ' + subCategory: nostrud velit pariatur ex laborum + code: do mollit sed + in: laborum exerc + context: + aliquip_9: + - sunt ad + - ullamco anim + links: + in_a: cu + commodo_7c: fugiat minim adipisicing + message: exercitation anim dolore + status: id adipisicing + subCategory: {} + id: ad qui sit + - category: dolor ad + context: + dolore4: + - elit exercitation + - nostrud dolore eu qui + quicdf: + - veniam quis + - dolor proident + errors: + - message: tempor Excepteur velit sint + subCategory: laborum ad voluptate laboris ad + code: reprehenderit veniam pariatur deserunt + in: dolore velit in + context: + sit4: + - sit incididunt Duis aute cupidatat + - 'ex quis ' + amet6fc: + - veniam cupidatat + - eu + velit_a: + - cillum quis + - veniam + - message: dolor nulla cupidatat + subCategory: do laboris cillum eiusmod + code: amet + in: voluptate et deserunt sit eiusmod + context: + sit_6e: + - commodo in est enim + - veniam + Ut60: + - culpa cillum aute Duis do + - est mi + links: + sed_195: nulla commodo eu + message: nisi exercitation + status: anim + subCategory: {} + id: qui tempor laborum dolore + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "pariatura0": [ + "<string>", + "<string>" + ], + "et7": [ + "<string>", + "<string>" + ] + }, + "links": { + "cupidatat753": "<string>" + }, + "errors": [ + { + "message": "laboris et", + "subCategory": "fugiat quis consequat exercitat", + "code": "officia minim", + "in": "ut in", + "context": { + "dolore_a": [ + "dolore eiusmod veniam", + "culpa id" + ] + } + }, + { + "message": "ut in nisi", + "subCategory": "elit est do aliqua", + "code": "adipisicing", + "in": "dolor officia esse", + "context": { + "id_c7": [ + "sed amet proident reprehenderit laborum", + "in mollit adipisicing veniam irure" + ], + "eu5": [ + "Ut deserunt amet", + "quis commodo in elit" + ] + } + } + ] + } + /marketing/v3/marketing-events/{externalEventId}/identifiers: + get: + tags: + - Marketing Events API + summary: Find Marketing Events by externalEventId + description: >- + This endpoint searches the portal for all Marketing Events whose + externalEventId matches the value provided in the request. + + + It retrieves the objectId and additional event details for each matching + Marketing Event. + + + Since multiple Marketing Events can have the same externalEventId, the + endpoint returns all matching results. + + + Note: Marketing Events become searchable by externalEventId a few + minutes after creation. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: externalEventId + in: path + schema: + type: string + required: true + description: >- + (Required) The id of the marketing event in the external event + application. + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - externalEventId: <string> + marketingEventName: <string> + objectId: <string> + externalAccountId: <string> + appInfo: + id: <string> + name: <string> + - externalEventId: <string> + marketingEventName: <string> + objectId: <string> + externalAccountId: <string> + appInfo: + id: <string> + name: <string> + total: <integer> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "pariatura0": [ + "<string>", + "<string>" + ], + "et7": [ + "<string>", + "<string>" + ] + }, + "links": { + "cupidatat753": "<string>" + }, + "errors": [ + { + "message": "laboris et", + "subCategory": "fugiat quis consequat exercitat", + "code": "officia minim", + "in": "ut in", + "context": { + "dolore_a": [ + "dolore eiusmod veniam", + "culpa id" + ] + } + }, + { + "message": "ut in nisi", + "subCategory": "elit est do aliqua", + "code": "adipisicing", + "in": "dolor officia esse", + "context": { + "id_c7": [ + "sed amet proident reprehenderit laborum", + "in mollit adipisicing veniam irure" + ], + "eu5": [ + "Ut deserunt amet", + "quis commodo in elit" + ] + } + } + ] + } + /marketing/v3/marketing-events/batch/update: + post: + tags: + - Marketing Events API + summary: Update Multiple Marketing Events by ObjectId + description: >- + Updates multiple Marketing Events on the portal based on their objectId, + if they exist. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - customProperties: + - dataSensitivity: high + isEncrypted: true + name: aliqua occae + requestId: aliquip mollit Lorem + selectedByUser: false + selectedByUserTimestamp: 5639591 + source: BOT + sourceId: ex anim + sourceLabel: in Excepteur + sourceMetadata: ea mollit sint + sourceVid: + - -69737229 + - 18188284 + timestamp: 21188866 + unit: incididunt aliquip + value: irure Ut + updatedByUserId: -69233886 + persistenceTimestamp: 24941094 + useTimestampAsPersistenceTimestamp: true + isLargeValue: true + - dataSensitivity: standard + isEncrypted: true + name: anim culpa exercitation cillum eiusmod + requestId: m + selectedByUser: true + selectedByUserTimestamp: -55616552 + source: BIDEN + sourceId: ut + sourceLabel: cupidatat exercitation amet + sourceMetadata: sunt cillum + sourceVid: + - 99614673 + - -94823355 + timestamp: -32241188 + unit: consequat irure proident Excepteur + value: Ut sunt mollit proident + updatedByUserId: 74551606 + persistenceTimestamp: -59836287 + useTimestampAsPersistenceTimestamp: false + isLargeValue: false + objectId: <string> + startDateTime: <dateTime> + eventCancelled: <boolean> + eventOrganizer: <string> + eventUrl: <string> + eventDescription: <string> + eventName: <string> + eventType: <string> + endDateTime: <dateTime> + - customProperties: + - dataSensitivity: high + isEncrypted: true + name: laborum ad aute + requestId: magna nisi dolore in + selectedByUser: false + selectedByUserTimestamp: 92665611 + source: UNKNOWN + sourceId: aliquip sint volupt + sourceLabel: enim officia + sourceMetadata: occaecat pr + sourceVid: + - -93700505 + - 69604251 + timestamp: -98936029 + unit: nulla Duis + value: et reprehenderit exercitation + updatedByUserId: -64777845 + persistenceTimestamp: 36267352 + useTimestampAsPersistenceTimestamp: false + isLargeValue: true + - dataSensitivity: none + isEncrypted: false + name: laboris esse c + requestId: ipsum ut fugiat sunt + selectedByUser: false + selectedByUserTimestamp: -68836466 + source: COMPANY_FAMILIES + sourceId: nostrud consectetur + sourceLabel: magna ex proident + sourceMetadata: laboris exercitation + sourceVid: + - -41934701 + - -79814024 + timestamp: 94328930 + unit: culpa ut aliqua + value: est qui anim ven + updatedByUserId: 78693376 + persistenceTimestamp: 43493151 + useTimestampAsPersistenceTimestamp: true + isLargeValue: true + objectId: <string> + startDateTime: <dateTime> + eventCancelled: <boolean> + eventOrganizer: <string> + eventUrl: <string> + eventDescription: <string> + eventName: <string> + eventType: <string> + endDateTime: <dateTime> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: '1963-01-28T10:39:28.191Z' + customProperties: + - name: quis + value: dolore aliquip Lorem + - name: cillum aliqua + value: et consequat Exce + eventName: ut amet est + objectId: dolor + updatedAt: '1962-11-04T01:27:25.654Z' + eventOrganizer: anim dolor + eventUrl: dolore consequat in + appInfo: + id: aute exercitation + name: laboris ullamco + eventType: sint magna dolore + eventCompleted: true + endDateTime: '1951-02-21T17:24:30.182Z' + startDateTime: '2018-06-19T09:50:18.865Z' + eventCancelled: true + eventDescription: in id sunt mollit + - createdAt: '1957-07-05T07:04:38.576Z' + customProperties: + - name: adipisicing anim + value: sit tempor occaecat + - name: Duis dolor dolore + value: enim consequat magna qui + eventName: 'consequat fugiat ' + objectId: sed consectetur in irure + updatedAt: '1998-08-20T14:36:51.415Z' + eventOrganizer: mollit adipisicing + eventUrl: a + appInfo: + id: deserunt elit quis ex in + name: quis esse amet + eventType: do aute sunt eiusmod + eventCompleted: false + endDateTime: '2001-12-28T18:15:09.040Z' + startDateTime: '1967-10-16T16:51:51.406Z' + eventCancelled: true + eventDescription: Excepteur esse + startedAt: <dateTime> + status: CANCELED + requestedAt: <dateTime> + links: + in_9de: <string> + ut_9e: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: '1976-07-10T17:00:59.628Z' + customProperties: + - name: laboris cillum mollit + value: 'laborum ' + - name: amet dolore commodo et + value: labore nostrud aliquip ex + eventName: culpa Duis laborum + objectId: 'sed elit ' + updatedAt: '1988-07-01T17:27:36.352Z' + eventOrganizer: ut officia + eventUrl: occaecat veniam tempor + appInfo: + id: Excepteur aliqua magna ipsum + name: proident Ut adipisicing ipsum ad + eventType: non cupidatat + eventCompleted: false + endDateTime: '2009-06-04T15:20:38.199Z' + startDateTime: '2024-07-02T10:57:54.385Z' + eventCancelled: false + eventDescription: esse nisi do Lorem dolor + - createdAt: '2019-04-03T23:15:48.683Z' + customProperties: + - name: tempor id + value: ex veniam laborum do + - name: sunt laborum + value: cillum culpa irure + eventName: nisi dolore proident sit minim + objectId: in + updatedAt: '1984-05-16T04:40:09.972Z' + eventOrganizer: irure consequat cill + eventUrl: et est aute in + appInfo: + id: enim + name: exercitation elit + eventType: ut dolore ut nulla + eventCompleted: true + endDateTime: '1958-02-17T20:39:49.064Z' + startDateTime: '1949-09-04T03:14:48.369Z' + eventCancelled: false + eventDescription: Lorem mollit nisi + startedAt: <dateTime> + status: CANCELED + numErrors: <integer> + requestedAt: <dateTime> + links: + dolor5: <string> + sit79: <string> + errors: + - category: cillum + context: + mollit_c: + - ut ut in + - cillum aute nulla dolore mi + errors: + - message: dolor i + subCategory: ma + code: Lorem + in: in deserunt do + context: + eu3: + - id tempor + - deserunt + - message: in ullamco enim exercitation + subCategory: ex eiusmod occaecat veniam + code: sit quis + in: in irure aliqua sed Excepteur + context: + sed37e: + - laborum nulla in tempor + - deserunt sint anim + commodo_c_: + - deserunt in + - ullamco nisi + links: + ipsum614: enim aute + message: officia + status: minim aliquip + subCategory: {} + id: cupidatat velit ex ut + - category: consectetur Lorem do reprehenderit ex + context: + exercitationc2: + - commodo magna + - minim fugiat dolore + errors: + - message: anim mollit amet + subCategory: labore c + code: reprehenderit occaecat sunt consequat ex + in: ex Duis reprehenderit est + context: + sint1: + - nisi in + - officia incididunt + ut3cb: + - et + - mollit + - message: nisi + subCategory: nulla proident sint + code: aute do exercitation + in: ipsum ad sed + context: + Ut_2bc: + - pariatur officia + - magna ut reprehenderit + links: + officia_1b: eiusmod exercitation Ut + sint_5bb: dolore + message: id dolore culpa dolore quis + status: sint sunt nulla et + subCategory: {} + id: Duis + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "cillum_c3": [ + "<string>", + "<string>" + ], + "nulla_89f": [ + "<string>", + "<string>" + ] + }, + "links": { + "do_c1": "<string>", + "elit_ae": "<string>" + }, + "errors": [ + { + "message": "aute sit Ut non magna", + "subCategory": "est irure Excepteur", + "code": "Lorem dolor amet", + "in": "Lorem", + "context": { + "deserunt57f": [ + "ut id", + "enim culpa" + ] + } + }, + { + "message": "amet consectetur Duis dolor", + "subCategory": "dolor ullamco", + "code": "Excepteur et velit nisi", + "in": "nisi eiusmod", + "context": { + "sintfbd": [ + "incididunt in laboris", + "est non nulla ad ea" + ], + "minim_4": [ + "est", + "nostrud" + ] + } + } + ] + } + /marketing/v3/marketing-events/batch/archive: + post: + tags: + - Marketing Events API + summary: Delete Multiple Marketing Events by ObjectId + description: >- + Deletes multiple Marketing Events from the portal based on their + objectId, if they exist. + + + Responses: + + 204: Returned if all specified Marketing Events were successfully + deleted. + + 207: Returned if some objectIds did not correspond to any existing + Marketing Events. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - objectId: <string> + - objectId: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "cillum_c3": [ + "<string>", + "<string>" + ], + "nulla_89f": [ + "<string>", + "<string>" + ] + }, + "links": { + "do_c1": "<string>", + "elit_ae": "<string>" + }, + "errors": [ + { + "message": "aute sit Ut non magna", + "subCategory": "est irure Excepteur", + "code": "Lorem dolor amet", + "in": "Lorem", + "context": { + "deserunt57f": [ + "ut id", + "enim culpa" + ] + } + }, + { + "message": "amet consectetur Duis dolor", + "subCategory": "dolor ullamco", + "code": "Excepteur et velit nisi", + "in": "nisi eiusmod", + "context": { + "sintfbd": [ + "incididunt in laboris", + "est non nulla ad ea" + ], + "minim_4": [ + "est", + "nostrud" + ] + } + } + ] + } + /marketing/v4/email/single-send: + post: + tags: + - Single-Send API > Single_Send + summary: post-/marketing/v4/email/single-send + requestBody: + content: + application/json: + schema: + type: object + example: + emailId: <long> + message: + to: <string> + cc: + - <string> + - <string> + sendId: <string> + bcc: + - <string> + - <string> + replyTo: + - <string> + - <string> + from: <string> + customProperties: + minim_a1: {} + ute03: {} + contactProperties: + sint_870: <string> + quis_c0: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + status: PROCESSING + statusId: <string> + eventId: + created: <dateTime> + id: <uuid> + completedAt: <dateTime> + sendResult: PREVIOUSLY_BOUNCED + requestedAt: <dateTime> + startedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "exercitation92": [ + "<string>", + "<string>" + ], + "Excepteur77e": [ + "<string>", + "<string>" + ], + "irure33": [ + "<string>", + "<string>" + ], + "incididunte": [ + "<string>", + "<string>" + ] + }, + "links": { + "Lorem_cd": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "culpa_9e": [ + "<string>", + "<string>" + ], + "aliqua78": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "occaecat_3e": [ + "<string>", + "<string>" + ] + } + } + ] + } + /marketing/v3/campaigns/: + post: + tags: + - Campaigns API > Basic + summary: Create a campaign + description: >- + Create a campaign with the given properties and return the campaign + object, including the campaignGuid and created properties. + requestBody: + content: + application/json: + schema: + type: object + example: + properties: + enim_fee: <string> + aliquip1: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + nostrudb: <string> + animc23: <string> + updatedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "laborum_e": [ + "<string>", + "<string>" + ] + }, + "links": { + "anim_e": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "amet_8": [ + "<string>", + "<string>" + ], + "occaecat_2": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "enim_acd": [ + "<string>", + "<string>" + ] + } + } + ] + } + get: + tags: + - Campaigns API > Search + summary: Campaign search + description: >- + This endpoint allows users to search for and return a page of campaigns + based on various query parameters. Users can filter by name, sort, and + paginate through the campaigns, as well as control which properties are + returned in the response. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: sort + in: query + schema: + type: string + description: >- + The field by which to sort the results. Allowed values are hs_name, + createdAt, updatedAt. An optional '-' before the property name can + denote descending order + + Default: hs_name + example: <string> + - name: after + in: query + schema: + type: string + description: >- + A cursor for pagination. If provided, the results will start after + the given cursor. + + Example: NTI1Cg%3D%3D + example: <string> + - name: limit + in: query + schema: + type: string + description: >- + The maximum number of results to return. Allowed values range from 1 + to 100 + + Default: 50 + example: <integer> + - name: name + in: query + schema: + type: string + description: >- + A filter to return campaigns whose names contain the specified + substring. This allows partial matching of campaign names, returning + all campaigns that include the given substring in their name. If + this parameter is not provided, the search will return all campaigns + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma-separated list of the properties to be returned in the + response. If any of the specified properties has empty value on the + requested object(s), they will be ignored and not returned in + response. If this parameter is empty, the response will include an + empty properties map + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma-separated list of the properties to be returned in the + response. If any of the specified properties has empty value on the + requested object(s), they will be ignored and not returned in + response. If this parameter is empty, the response will include an + empty properties map + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + mollit_a54: <string> + updatedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + Lorem_9: <string> + exercitation_e4: <string> + ipsume: <string> + updatedAt: <dateTime> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "laborum_e": [ + "<string>", + "<string>" + ] + }, + "links": { + "anim_e": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "amet_8": [ + "<string>", + "<string>" + ], + "occaecat_2": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "enim_acd": [ + "<string>", + "<string>" + ] + } + } + ] + } + /marketing/v3/campaigns/{campaignGuid}: + get: + tags: + - Campaigns API > Basic + summary: Read a campaign + description: >- + Get a campaign identified by a specific campaignGuid with the given + properties. Along with the campaign information, it also returns + information about assets. Depending on the query parameters used, this + can also be used to return information about the corresponding assets' + metrics. Metrics are available only if startDate and endDate are + provided. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: startDate + in: query + schema: + type: string + description: >- + Start date to fetch asset metrics, formatted as YYYY-MM-DD. This + date is used to fetch the metrics associated with the assets for a + specified period. + + If not provided, no asset metrics will be fetched. + example: <string> + - name: endDate + in: query + schema: + type: string + description: |2- + End date to fetch asset metrics, formatted as YYYY-MM-DD. This date is used to fetch the metrics associated with the assets for a specified period. + If not provided, no asset metrics will be fetched. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma-separated list of the properties to be returned in the + response. If any of the specified properties has empty value on the + requested object, they will be ignored and not returned in response. + If this parameter is empty, the response will include an empty + properties map. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma-separated list of the properties to be returned in the + response. If any of the specified properties has empty value on the + requested object, they will be ignored and not returned in response. + If this parameter is empty, the response will include an empty + properties map. + example: <string> + - name: campaignGuid + in: path + schema: + type: string + required: true + description: (Required) Unique identifier for the campaign, formatted as a UUID. + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + assets: + irurea: + results: + - id: <string> + metrics: + culpa9: <number> + incididunt_7: <number> + irurebf: <number> + name: <string> + - id: <string> + metrics: + non__: <number> + name: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + createdAt: <dateTime> + id: <string> + properties: + do49: <string> + updatedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "laborum_e": [ + "<string>", + "<string>" + ] + }, + "links": { + "anim_e": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "amet_8": [ + "<string>", + "<string>" + ], + "occaecat_2": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "enim_acd": [ + "<string>", + "<string>" + ] + } + } + ] + } + delete: + tags: + - Campaigns API > Basic + summary: 'Delete campaign ' + description: >- + Delete a specified campaign from the system. + + This call will return a 204 No Content response regardless of whether + the campaignGuid provided corresponds to an existing campaign or not. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: campaignGuid + in: path + schema: + type: string + required: true + description: (Required) Unique identifier for the campaign, formatted as a UUID. + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "laborum_e": [ + "<string>", + "<string>" + ] + }, + "links": { + "anim_e": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "amet_8": [ + "<string>", + "<string>" + ], + "occaecat_2": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "enim_acd": [ + "<string>", + "<string>" + ] + } + } + ] + } + patch: + tags: + - Campaigns API > Basic + summary: Update campaign + description: > + Perform a partial update of a campaign identified by the specified + campaignGuid. Provided property values will be overwritten. Read-only + and non-existent properties will cause 400 error. + + If an empty string is passed for any property in the Batch Update, it + will reset that property's value. + requestBody: + content: + application/json: + schema: + type: object + example: + properties: + enim_fee: <string> + aliquip1: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: campaignGuid + in: path + schema: + type: string + required: true + description: | + (Required) Unique identifier for the campaign, formatted as a UUID. + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + nostrudb: <string> + animc23: <string> + updatedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "laborum_e": [ + "<string>", + "<string>" + ] + }, + "links": { + "anim_e": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "amet_8": [ + "<string>", + "<string>" + ], + "occaecat_2": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "enim_acd": [ + "<string>", + "<string>" + ] + } + } + ] + } + /marketing/v3/campaigns/batch/read: + post: + tags: + - Campaigns API > Batch + summary: Read a batch of campaigns + description: > + This endpoint reads a batch of campaigns based on the provided input + data and returns the campaigns along with their associated assets. + + The maximum number of items in a batch request is 50. + + The campaigns in the response are not guaranteed to be in the same order + as they were provided in the request. + + If duplicate campaign IDs are provided in the request, duplicates will + be ignored. The response will include only unique IDs and will be + returned without duplicates. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: startDate + in: query + schema: + type: string + description: > + Start date to fetch asset metrics, formatted as YYYY-MM-DD. This + date is used to fetch the metrics associated with the assets for a + specified period. If not provided, no asset metrics will be fetched. + example: <string> + - name: endDate + in: query + schema: + type: string + description: >- + End date to fetch asset metrics, formatted as YYYY-MM-DD. This date + is used to fetch the metrics associated with the assets for a + specified period. If not provided, no asset metrics will be fetched. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma-separated list of the properties to be returned in the + response. If any of the specified properties has empty value on the + requested object(s), they will be ignored and not returned in + response. If this parameter is empty, the response will include an + empty properties map. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma-separated list of the properties to be returned in the + response. If any of the specified properties has empty value on the + requested object(s), they will be ignored and not returned in + response. If this parameter is empty, the response will include an + empty properties map. + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - assets: + dolor_ef8: + results: + - id: <string> + metrics: + ipsum_85: <number> + nullad4: <number> + elitf0: <number> + culpa9e: <number> + name: <string> + - id: <string> + metrics: + incididunt_fc7: <number> + quis_ef: <number> + occaecat_000: <number> + ullamcob: <number> + sint66e: <number> + name: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + createdAt: <dateTime> + id: <string> + properties: + voluptate_1: <string> + updatedAt: <dateTime> + - assets: + ex23: + results: + - id: <string> + metrics: + adipisicing_7: <number> + name: <string> + - id: <string> + metrics: + magnacec: <number> + name: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + labore357: + results: + - id: <string> + metrics: + inec2: <number> + name: <string> + - id: <string> + metrics: + ut7d_: <number> + in_a: <number> + name: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + mollit_130: + results: + - id: <string> + metrics: + sit_9: <number> + name: <string> + - id: <string> + metrics: + aliqua_1c7: <number> + anim_d33: <number> + name: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + createdAt: <dateTime> + id: <string> + properties: + Ut2f9: <string> + tempor158: <string> + aliquaf9: <string> + updatedAt: <dateTime> + startedAt: <dateTime> + status: COMPLETE + requestedAt: <dateTime> + links: + pariatur74: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - assets: + dolore_1b: + results: + - id: <string> + metrics: + eiusmod62e: <number> + do_d5: <number> + name: <string> + - id: <string> + metrics: + incididunt_a9c: <number> + name: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + Loremab: + results: + - id: <string> + metrics: + quie3f: <number> + incididuntb: <number> + veniam__: <number> + name: <string> + - id: <string> + metrics: + Excepteur2: <number> + name: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + createdAt: <dateTime> + id: <string> + properties: + occaecat_7: <string> + cupidatat7: <string> + laborum_9c2: <string> + updatedAt: <dateTime> + - assets: + aute3: + results: + - id: <string> + metrics: + voluptate0: <number> + commodo_5_: <number> + name: <string> + - id: <string> + metrics: + labore_4: <number> + ullamco_ad: <number> + Lorem7: <number> + name: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + createdAt: <dateTime> + id: <string> + properties: + Duis401: <string> + elit8f: <string> + updatedAt: <dateTime> + startedAt: <dateTime> + status: CANCELED + numErrors: <integer> + requestedAt: <dateTime> + links: + fugiatb: <string> + pariaturfc: <string> + dolore5bc: <string> + errors: + - category: <string> + context: + eiusmod_06: + - <string> + - <string> + ex_3: + - <string> + - <string> + irure_3: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + dolorf7: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + culpa6: + - <string> + - <string> + veniamd5: + - <string> + - <string> + links: + incididunt_6: <string> + dolore_ec: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + - category: <string> + context: + incididunt_34: + - <string> + - <string> + eiusmodf8b: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + irure_be: + - <string> + - <string> + est_1: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + sed502: + - <string> + - <string> + links: + ad_5: <string> + elit_5ab: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "laborum_e": [ + "<string>", + "<string>" + ] + }, + "links": { + "anim_e": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "amet_8": [ + "<string>", + "<string>" + ], + "occaecat_2": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "enim_acd": [ + "<string>", + "<string>" + ] + } + } + ] + } + /marketing/v3/campaigns/batch/update: + post: + tags: + - Campaigns API > Batch + summary: Update a batch of campaigns + description: >- + This endpoint updates a batch of campaigns based on the provided input + data. + + The maximum number of items in a batch request is 50. + + If an empty string ("") is passed for any property in the Batch Update, + it will reset that property's value. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + properties: + sed766: <string> + ea364: <string> + - id: <string> + properties: + aliquip_d4d: <string> + veniam_21: <string> + occaecatd91: <string> + elit_c: <string> + proident_c3c: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + occaecat_2de: <string> + deserunt_9c: <string> + updatedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + nisi4: <string> + cupidatatdfa: <string> + updatedAt: <dateTime> + startedAt: <dateTime> + status: PENDING + requestedAt: <dateTime> + links: + aliqua_c7: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + occaecat66: <string> + nostrud_cad: <string> + magnabe2: <string> + suntf8: <string> + est_1: <string> + updatedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + site7: <string> + updatedAt: <dateTime> + startedAt: <dateTime> + status: PROCESSING + numErrors: <integer> + requestedAt: <dateTime> + links: + Duis_6c: <string> + adipisicing4: <string> + aliquip_f4: <string> + errors: + - category: <string> + context: + aliqua_6c: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + consectetur_0: + - <string> + - <string> + nulla2bb: + - <string> + - <string> + incididunt2c: + - <string> + - <string> + commodo16f: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + voluptated: + - <string> + - <string> + cupidatat4: + - <string> + - <string> + links: + eu_2: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + - category: <string> + context: + dolor7df: + - <string> + - <string> + laborum03: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + ea20: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + nostrud_: + - <string> + - <string> + links: + exercitation_1a: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "laborum_e": [ + "<string>", + "<string>" + ] + }, + "links": { + "anim_e": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "amet_8": [ + "<string>", + "<string>" + ], + "occaecat_2": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "enim_acd": [ + "<string>", + "<string>" + ] + } + } + ] + } + /marketing/v3/campaigns/batch/archive: + post: + tags: + - Campaigns API > Batch + summary: Delete a batch of campaigns + description: >- + This endpoint deletes a batch of campaigns. + + The maximum number of items in a batch request is 50. + + The response will always be 204 No Content, regardless of whether the + campaigns exist or not, whether they were successfully deleted or not, + or if only some of the campaigns in the batch were deleted. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "laborum_e": [ + "<string>", + "<string>" + ] + }, + "links": { + "anim_e": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "amet_8": [ + "<string>", + "<string>" + ], + "occaecat_2": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "enim_acd": [ + "<string>", + "<string>" + ] + } + } + ] + } + /marketing/v3/campaigns/batch/create: + post: + tags: + - Campaigns API > Batch + summary: Create a batch of campaigns + description: >- + This endpoint creates a batch of campaigns. The maximum number of items + in a batch request is 50. + + The campaigns in the response are not guaranteed to be in the same order + as they were provided in the request. + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - properties: + veniam_2: <string> + et_6: <string> + - properties: + incb: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + occaecat_2de: <string> + deserunt_9c: <string> + updatedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + nisi4: <string> + cupidatatdfa: <string> + updatedAt: <dateTime> + startedAt: <dateTime> + status: PENDING + requestedAt: <dateTime> + links: + aliqua_c7: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + occaecat66: <string> + nostrud_cad: <string> + magnabe2: <string> + suntf8: <string> + est_1: <string> + updatedAt: <dateTime> + - createdAt: <dateTime> + id: <string> + properties: + site7: <string> + updatedAt: <dateTime> + startedAt: <dateTime> + status: PROCESSING + numErrors: <integer> + requestedAt: <dateTime> + links: + Duis_6c: <string> + adipisicing4: <string> + aliquip_f4: <string> + errors: + - category: <string> + context: + aliqua_6c: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + consectetur_0: + - <string> + - <string> + nulla2bb: + - <string> + - <string> + incididunt2c: + - <string> + - <string> + commodo16f: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + voluptated: + - <string> + - <string> + cupidatat4: + - <string> + - <string> + links: + eu_2: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + - category: <string> + context: + dolor7df: + - <string> + - <string> + laborum03: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + ea20: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + nostrud_: + - <string> + - <string> + links: + exercitation_1a: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "laborum_e": [ + "<string>", + "<string>" + ] + }, + "links": { + "anim_e": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "amet_8": [ + "<string>", + "<string>" + ], + "occaecat_2": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "enim_acd": [ + "<string>", + "<string>" + ] + } + } + ] + } + /marketing/v3/campaigns/{campaignGuid}/reports/metrics: + get: + tags: + - Campaigns API > Reports + summary: | + Get Campaign Metrics + description: >- + This endpoint retrieves key attribution metrics for a specified + campaign, such as sessions, new contacts, and influenced contacts. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: startDate + in: query + schema: + type: string + description: |- + The start date for the report data, formatted as YYYY-MM-DD. + Default value: 2006-01-01 + example: <string> + - name: endDate + in: query + schema: + type: string + description: |- + End date for the report data, formatted as YYYY-MM-DD. + Default value: Current date + example: <string> + - name: campaignGuid + in: path + schema: + type: string + required: true + description: (Required) Unique identifier for the campaign, formatted as a UUID. + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + influencedContacts: <integer> + newContactsFirstTouch: <integer> + newContactsLastTouch: <integer> + sessions: <integer> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "laborum_e": [ + "<string>", + "<string>" + ] + }, + "links": { + "anim_e": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "amet_8": [ + "<string>", + "<string>" + ], + "occaecat_2": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "enim_acd": [ + "<string>", + "<string>" + ] + } + } + ] + } + /marketing/v3/campaigns/{campaignGuid}/reports/revenue: + get: + tags: + - Campaigns API > Reports + summary: Fetch revenue + description: | + Fetch revenue attribution report data for a specified campaign + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: attributionModel + in: query + schema: + type: string + description: >- + Allowed values: LINEAR, FIRST_INTERACTION, LAST_INTERACTION, + FULL_PATH, U_SHAPED, W_SHAPED, TIME_DECAY, J_SHAPED, + INVERSE_J_SHAPED + + Default value: LINEAR + example: <string> + - name: startDate + in: query + schema: + type: string + description: |- + The start date for the report data, formatted as YYYY-MM-DD. + Default value: 2006-01-01 + example: <string> + - name: endDate + in: query + schema: + type: string + description: |- + End date for the report data, formatted as YYYY-MM-DD. + Default value: Current date + example: <string> + - name: campaignGuid + in: path + schema: + type: string + required: true + description: (Required) Unique identifier for the campaign, formatted as a UUID. + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + contactsNumber: <integer> + dealAmount: <number> + dealsNumber: <integer> + revenueAmount: <number> + currencyCode: LYD + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "laborum_e": [ + "<string>", + "<string>" + ] + }, + "links": { + "anim_e": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "amet_8": [ + "<string>", + "<string>" + ], + "occaecat_2": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "enim_acd": [ + "<string>", + "<string>" + ] + } + } + ] + } + /marketing/v3/campaigns/{campaignGuid}/reports/contacts/{contactType}: + get: + tags: + - Campaigns API > Reports + summary: Fetch contact IDs + description: >- + Fetch the list of contact IDs for the specified campaign and contact + type + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: startDate + in: query + schema: + type: string + description: |- + The start date for the report data, formatted as YYYY-MM-DD. + Default value: 2006-01-01 + example: <string> + - name: endDate + in: query + schema: + type: string + description: |- + End date for the report data, formatted as YYYY-MM-DD. + Default value: Current date + example: <string> + - name: limit + in: query + schema: + type: string + description: |- + Limit for the number of contacts to fetch + Default: 100 + example: <integer> + - name: after + in: query + schema: + type: string + description: >- + A cursor for pagination. If provided, the results will start after + the given cursor. + + Example: NTI1Cg%3D%3D + example: <string> + - name: campaignGuid + in: path + schema: + type: string + required: true + description: (Required) Unique identifier for the campaign, formatted as a UUID. + example: <string> + - name: contactType + in: path + schema: + type: string + required: true + description: >- + (Required) The type of metric to filter the influenced contacts. + Allowed values: contactFirstTouch, contactLastTouch, + influencedContacts + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - id: <string> + - id: <string> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "laborum_e": [ + "<string>", + "<string>" + ] + }, + "links": { + "anim_e": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "amet_8": [ + "<string>", + "<string>" + ], + "occaecat_2": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "enim_acd": [ + "<string>", + "<string>" + ] + } + } + ] + } + /marketing/v3/campaigns/{campaignGuid}/assets/{assetType}: + get: + tags: + - Campaigns API > Asset + summary: List assets + description: >- + This endpoint lists all assets of the campaign by asset type. The + assetType parameter is required, and each request can only fetch assets + of a single type. + + Asset metrics can also be fetched along with the assets; they are + available only if start and end dates are provided. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: after + in: query + schema: + type: string + description: >- + A cursor for pagination. If provided, the results will start after + the given cursor. + + Example: NTI1Cg%3D%3D + example: <string> + - name: limit + in: query + schema: + type: string + description: |- + The maximum number of results to return. + Default: 10 + example: <string> + - name: startDate + in: query + schema: + type: string + description: > + Start date to fetch asset metrics, formatted as YYYY-MM-DD. This + date is used to fetch the metrics associated with the assets for a + specified period. + + If not provided, no asset metrics will be fetched. + example: <string> + - name: endDate + in: query + schema: + type: string + description: >- + End date to fetch asset metrics, formatted as YYYY-MM-DD. This date + is used to fetch the metrics associated with the assets for a + specified period. + + If not provided, no asset metrics will be fetched. + example: <string> + - name: campaignGuid + in: path + schema: + type: string + required: true + description: (Required) Unique identifier for the campaign, formatted as a UUID. + example: <string> + - name: assetType + in: path + schema: + type: string + required: true + description: (Required) The type of asset to fetch. + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - id: <string> + metrics: + amet1: <number> + labore5b: <number> + pariatur92: <number> + ullamcob: <number> + name: <string> + - id: <string> + metrics: + sunt_4: <number> + esse859: <number> + name: <string> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "laborum_e": [ + "<string>", + "<string>" + ] + }, + "links": { + "anim_e": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "amet_8": [ + "<string>", + "<string>" + ], + "occaecat_2": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "enim_acd": [ + "<string>", + "<string>" + ] + } + } + ] + } + /marketing/v3/campaigns/{campaignGuid}/assets/{assetType}/{assetId}: + put: + tags: + - Campaigns API > Asset + summary: Add asset association + description: >- + Associate a specified asset with a campaign. + + Important: Currently, only the following asset types can be associated + and disassociated via the API: Forms, Static lists, External website + pages + requestBody: + content: {} + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: campaignGuid + in: path + schema: + type: string + required: true + description: (Required) Unique identifier for the campaign, formatted as a UUID + example: <string> + - name: assetType + in: path + schema: + type: string + required: true + description: >- + (Required) The type of asset + + Important: Currently, only the following asset types are available + for association via the API: FORM, OBJECT_LIST, EXTERNAL_WEB_URL + example: <string> + - name: assetId + in: path + schema: + type: string + required: true + description: (Required) Id of the asset + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "laborum_e": [ + "<string>", + "<string>" + ] + }, + "links": { + "anim_e": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "amet_8": [ + "<string>", + "<string>" + ], + "occaecat_2": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "enim_acd": [ + "<string>", + "<string>" + ] + } + } + ] + } + delete: + tags: + - Campaigns API > Asset + summary: Remove asset association + description: >- + Disassociate a specified asset from a campaign. + + Important: Currently, only the following asset types can be associated + and disassociated via the API: Forms, Static lists, External website + pages + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: campaignGuid + in: path + schema: + type: string + required: true + description: (Required) Unique identifier for the campaign, formatted as a UUID. + example: <string> + - name: assetType + in: path + schema: + type: string + required: true + description: >- + (Required) The type of asset + + Important: Currently, only the following asset types are available + for disassociation via the API: FORM, OBJECT_LIST, EXTERNAL_WEB_URL + example: <string> + - name: assetId + in: path + schema: + type: string + required: true + description: (Required) Id of the asset + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "laborum_e": [ + "<string>", + "<string>" + ] + }, + "links": { + "anim_e": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "amet_8": [ + "<string>", + "<string>" + ], + "occaecat_2": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "enim_acd": [ + "<string>", + "<string>" + ] + } + } + ] + } + /marketing/v3/campaigns/{campaignGuid}/budget/totals: + get: + tags: + - Campaigns API > Budget + summary: Read budget + description: >- + Retrieve detailed information about the budget and spend items for a + specified campaign, including the total budget, total spend, and + remaining budget. + + Budget and Spend items may be returned in any order, but the order field + specifies their sequence based on the creation date. The item with order + 0 is the oldest, and items with higher order values are newer + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: campaignGuid + in: path + schema: + type: string + required: true + description: (Required) Unique identifier for the campaign, formatted as a UUID. + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + budgetItems: + - amount: <number> + createdAt: <integer> + id: <string> + name: <string> + order: <integer> + updatedAt: <integer> + description: <string> + - amount: <number> + createdAt: <integer> + id: <string> + name: <string> + order: <integer> + updatedAt: <integer> + description: <string> + currencyCode: BDT + spendItems: + - amount: <number> + createdAt: <integer> + id: <string> + name: <string> + order: <integer> + updatedAt: <integer> + description: <string> + - amount: <number> + createdAt: <integer> + id: <string> + name: <string> + order: <integer> + updatedAt: <integer> + description: <string> + budgetTotal: <number> + remainingBudget: <number> + spendTotal: <number> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "laborum_e": [ + "<string>", + "<string>" + ] + }, + "links": { + "anim_e": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "amet_8": [ + "<string>", + "<string>" + ], + "occaecat_2": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "enim_acd": [ + "<string>", + "<string>" + ] + } + } + ] + } + /marketing/v3/forms/{formId}: + get: + tags: + - Forms API > Forms + summary: Get a form definition + description: Returns a form based on the form ID provided. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: string + description: Whether to return only results that have been archived. + example: <boolean> + - name: formId + in: path + schema: + type: string + required: true + description: (Required) The unique identifier of the form + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + archived: <boolean> + configuration: + allowLinkToResetKnownValues: <boolean> + archivable: <boolean> + cloneable: <boolean> + createNewContactForNewEmail: <boolean> + editable: <boolean> + language: af + notifyContactOwner: <boolean> + notifyRecipients: + - <string> + - <string> + postSubmitAction: + type: thank_you + value: <string> + prePopulateKnownValues: <boolean> + recaptchaEnabled: <boolean> + lifecycleStages: + - objectTypeId: <string> + value: <string> + - objectTypeId: <string> + value: <string> + createdAt: <dateTime> + displayOptions: + renderRawHtml: <boolean> + style: + backgroundWidth: <string> + fontFamily: <string> + helpTextColor: <string> + helpTextSize: <string> + labelTextColor: <string> + labelTextSize: <string> + legalConsentTextColor: <string> + legalConsentTextSize: <string> + submitAlignment: right + submitColor: <string> + submitFontColor: <string> + submitSize: <string> + submitButtonText: <string> + theme: linear + cssClass: <string> + fieldGroups: + - fields: + - dependentFields: + - dependentCondition: + operator: doesnt_contain + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + - dependentCondition: + operator: not_between + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + fieldType: email + hidden: <boolean> + label: <string> + name: <string> + objectTypeId: <string> + required: <boolean> + validation: + blockedEmailDomains: + - <string> + - <string> + useDefaultBlockList: <boolean> + defaultValue: <string> + description: <string> + placeholder: <string> + - dependentFields: + - dependentCondition: + operator: set_not_all + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + - dependentCondition: + operator: set_eq + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + fieldType: email + hidden: <boolean> + label: <string> + name: <string> + objectTypeId: <string> + required: <boolean> + validation: + blockedEmailDomains: + - <string> + - <string> + useDefaultBlockList: <boolean> + defaultValue: <string> + description: <string> + placeholder: <string> + groupType: progressive + richTextType: text + richText: <string> + - fields: + - dependentFields: + - dependentCondition: + operator: between + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + - dependentCondition: + operator: set_not_any + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + fieldType: email + hidden: <boolean> + label: <string> + name: <string> + objectTypeId: <string> + required: <boolean> + validation: + blockedEmailDomains: + - <string> + - <string> + useDefaultBlockList: <boolean> + defaultValue: <string> + description: <string> + placeholder: <string> + - dependentFields: + - dependentCondition: + operator: set_not_any + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + - dependentCondition: + operator: set_any + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + fieldType: email + hidden: <boolean> + label: <string> + name: <string> + objectTypeId: <string> + required: <boolean> + validation: + blockedEmailDomains: + - <string> + - <string> + useDefaultBlockList: <boolean> + defaultValue: <string> + description: <string> + placeholder: <string> + groupType: progressive + richTextType: image + richText: <string> + formType: hubspot + id: <string> + legalConsentOptions: + type: none + name: <string> + updatedAt: <dateTime> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ad_d": [ + "<string>", + "<string>" + ], + "ut9": [ + "<string>", + "<string>" + ] + }, + "links": { + "ea_7": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "quisb3": [ + "<string>", + "<string>" + ], + "Duis0": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "nisi_fe2": [ + "<string>", + "<string>" + ] + } + } + ] + } + put: + tags: + - Forms API > Forms + summary: Update a form definition + description: Update all fields of a hubspot form definition. + requestBody: + content: + application/json: + schema: + type: object + example: + archived: <boolean> + configuration: + allowLinkToResetKnownValues: <boolean> + archivable: <boolean> + cloneable: <boolean> + createNewContactForNewEmail: <boolean> + editable: <boolean> + language: af + notifyContactOwner: <boolean> + notifyRecipients: + - <string> + - <string> + postSubmitAction: + type: thank_you + value: <string> + prePopulateKnownValues: <boolean> + recaptchaEnabled: <boolean> + lifecycleStages: + - objectTypeId: <string> + value: <string> + - objectTypeId: <string> + value: <string> + createdAt: <dateTime> + displayOptions: + renderRawHtml: <boolean> + style: + backgroundWidth: <string> + fontFamily: <string> + helpTextColor: <string> + helpTextSize: <string> + labelTextColor: <string> + labelTextSize: <string> + legalConsentTextColor: <string> + legalConsentTextSize: <string> + submitAlignment: right + submitColor: <string> + submitFontColor: <string> + submitSize: <string> + submitButtonText: <string> + theme: linear + cssClass: <string> + fieldGroups: + - fields: + - dependentFields: + - dependentCondition: + operator: doesnt_contain + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + - dependentCondition: + operator: not_between + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + fieldType: email + hidden: <boolean> + label: <string> + name: <string> + objectTypeId: <string> + required: <boolean> + validation: + blockedEmailDomains: + - <string> + - <string> + useDefaultBlockList: <boolean> + defaultValue: <string> + description: <string> + placeholder: <string> + - dependentFields: + - dependentCondition: + operator: set_not_all + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + - dependentCondition: + operator: set_eq + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + fieldType: email + hidden: <boolean> + label: <string> + name: <string> + objectTypeId: <string> + required: <boolean> + validation: + blockedEmailDomains: + - <string> + - <string> + useDefaultBlockList: <boolean> + defaultValue: <string> + description: <string> + placeholder: <string> + groupType: progressive + richTextType: text + richText: <string> + - fields: + - dependentFields: + - dependentCondition: + operator: between + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + - dependentCondition: + operator: set_not_any + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + fieldType: email + hidden: <boolean> + label: <string> + name: <string> + objectTypeId: <string> + required: <boolean> + validation: + blockedEmailDomains: + - <string> + - <string> + useDefaultBlockList: <boolean> + defaultValue: <string> + description: <string> + placeholder: <string> + - dependentFields: + - dependentCondition: + operator: set_not_any + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + - dependentCondition: + operator: set_any + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + fieldType: email + hidden: <boolean> + label: <string> + name: <string> + objectTypeId: <string> + required: <boolean> + validation: + blockedEmailDomains: + - <string> + - <string> + useDefaultBlockList: <boolean> + defaultValue: <string> + description: <string> + placeholder: <string> + groupType: progressive + richTextType: image + richText: <string> + formType: hubspot + id: <string> + legalConsentOptions: + type: none + name: <string> + updatedAt: <dateTime> + archivedAt: <dateTime> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: formId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + archived: <boolean> + configuration: + allowLinkToResetKnownValues: <boolean> + archivable: <boolean> + cloneable: <boolean> + createNewContactForNewEmail: <boolean> + editable: <boolean> + language: af + notifyContactOwner: <boolean> + notifyRecipients: + - <string> + - <string> + postSubmitAction: + type: thank_you + value: <string> + prePopulateKnownValues: <boolean> + recaptchaEnabled: <boolean> + lifecycleStages: + - objectTypeId: <string> + value: <string> + - objectTypeId: <string> + value: <string> + createdAt: <dateTime> + displayOptions: + renderRawHtml: <boolean> + style: + backgroundWidth: <string> + fontFamily: <string> + helpTextColor: <string> + helpTextSize: <string> + labelTextColor: <string> + labelTextSize: <string> + legalConsentTextColor: <string> + legalConsentTextSize: <string> + submitAlignment: right + submitColor: <string> + submitFontColor: <string> + submitSize: <string> + submitButtonText: <string> + theme: linear + cssClass: <string> + fieldGroups: + - fields: + - dependentFields: + - dependentCondition: + operator: doesnt_contain + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + - dependentCondition: + operator: not_between + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + fieldType: email + hidden: <boolean> + label: <string> + name: <string> + objectTypeId: <string> + required: <boolean> + validation: + blockedEmailDomains: + - <string> + - <string> + useDefaultBlockList: <boolean> + defaultValue: <string> + description: <string> + placeholder: <string> + - dependentFields: + - dependentCondition: + operator: set_not_all + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + - dependentCondition: + operator: set_eq + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + fieldType: email + hidden: <boolean> + label: <string> + name: <string> + objectTypeId: <string> + required: <boolean> + validation: + blockedEmailDomains: + - <string> + - <string> + useDefaultBlockList: <boolean> + defaultValue: <string> + description: <string> + placeholder: <string> + groupType: progressive + richTextType: text + richText: <string> + - fields: + - dependentFields: + - dependentCondition: + operator: between + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + - dependentCondition: + operator: set_not_any + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + fieldType: email + hidden: <boolean> + label: <string> + name: <string> + objectTypeId: <string> + required: <boolean> + validation: + blockedEmailDomains: + - <string> + - <string> + useDefaultBlockList: <boolean> + defaultValue: <string> + description: <string> + placeholder: <string> + - dependentFields: + - dependentCondition: + operator: set_not_any + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + - dependentCondition: + operator: set_any + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + fieldType: email + hidden: <boolean> + label: <string> + name: <string> + objectTypeId: <string> + required: <boolean> + validation: + blockedEmailDomains: + - <string> + - <string> + useDefaultBlockList: <boolean> + defaultValue: <string> + description: <string> + placeholder: <string> + groupType: progressive + richTextType: image + richText: <string> + formType: hubspot + id: <string> + legalConsentOptions: + type: none + name: <string> + updatedAt: <dateTime> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ad_d": [ + "<string>", + "<string>" + ], + "ut9": [ + "<string>", + "<string>" + ] + }, + "links": { + "ea_7": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "quisb3": [ + "<string>", + "<string>" + ], + "Duis0": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "nisi_fe2": [ + "<string>", + "<string>" + ] + } + } + ] + } + delete: + tags: + - Forms API > Forms + summary: Archive a form definition + description: >- + Archive a form definition. New submissions will not be accepted and the + form definition will be permanently deleted after 3 months. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: formId + in: path + schema: + type: string + required: true + description: (Required) The ID of the form to archive. + example: <string> + responses: + '204': + description: No Content + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + example: {} + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ad_d": [ + "<string>", + "<string>" + ], + "ut9": [ + "<string>", + "<string>" + ] + }, + "links": { + "ea_7": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "quisb3": [ + "<string>", + "<string>" + ], + "Duis0": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "nisi_fe2": [ + "<string>", + "<string>" + ] + } + } + ] + } + patch: + tags: + - Forms API > Forms + summary: Partially update a form definition + description: Update some of the form definition components + requestBody: + content: + application/json: + schema: + type: object + example: + fieldGroups: + - fields: + - dependentFields: + - dependentCondition: + operator: set_all + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + - dependentCondition: + operator: set_not_all + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + fieldType: email + hidden: <boolean> + label: <string> + name: <string> + objectTypeId: <string> + required: <boolean> + validation: + blockedEmailDomains: + - <string> + - <string> + useDefaultBlockList: <boolean> + defaultValue: <string> + description: <string> + placeholder: <string> + - dependentFields: + - dependentCondition: + operator: contains + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + - dependentCondition: + operator: gte + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + fieldType: email + hidden: <boolean> + label: <string> + name: <string> + objectTypeId: <string> + required: <boolean> + validation: + blockedEmailDomains: + - <string> + - <string> + useDefaultBlockList: <boolean> + defaultValue: <string> + description: <string> + placeholder: <string> + groupType: default_group + richTextType: image + richText: <string> + - fields: + - dependentFields: + - dependentCondition: + operator: within_time + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + - dependentCondition: + operator: set_any + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + fieldType: email + hidden: <boolean> + label: <string> + name: <string> + objectTypeId: <string> + required: <boolean> + validation: + blockedEmailDomains: + - <string> + - <string> + useDefaultBlockList: <boolean> + defaultValue: <string> + description: <string> + placeholder: <string> + - dependentFields: + - dependentCondition: + operator: within_time + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + - dependentCondition: + operator: gt + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + fieldType: email + hidden: <boolean> + label: <string> + name: <string> + objectTypeId: <string> + required: <boolean> + validation: + blockedEmailDomains: + - <string> + - <string> + useDefaultBlockList: <boolean> + defaultValue: <string> + description: <string> + placeholder: <string> + groupType: progressive + richTextType: text + richText: <string> + archived: <boolean> + configuration: + allowLinkToResetKnownValues: <boolean> + archivable: <boolean> + cloneable: <boolean> + createNewContactForNewEmail: <boolean> + editable: <boolean> + language: id + notifyContactOwner: <boolean> + notifyRecipients: + - <string> + - <string> + postSubmitAction: + type: redirect_url + value: <string> + prePopulateKnownValues: <boolean> + recaptchaEnabled: <boolean> + lifecycleStages: + - objectTypeId: <string> + value: <string> + - objectTypeId: <string> + value: <string> + name: <string> + legalConsentOptions: + type: none + displayOptions: + renderRawHtml: <boolean> + style: + backgroundWidth: <string> + fontFamily: <string> + helpTextColor: <string> + helpTextSize: <string> + labelTextColor: <string> + labelTextSize: <string> + legalConsentTextColor: <string> + legalConsentTextSize: <string> + submitAlignment: center + submitColor: <string> + submitFontColor: <string> + submitSize: <string> + submitButtonText: <string> + theme: canvas + cssClass: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: formId + in: path + schema: + type: string + required: true + description: (Required) The ID of the form to update. + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + archived: <boolean> + configuration: + allowLinkToResetKnownValues: <boolean> + archivable: <boolean> + cloneable: <boolean> + createNewContactForNewEmail: <boolean> + editable: <boolean> + language: af + notifyContactOwner: <boolean> + notifyRecipients: + - <string> + - <string> + postSubmitAction: + type: thank_you + value: <string> + prePopulateKnownValues: <boolean> + recaptchaEnabled: <boolean> + lifecycleStages: + - objectTypeId: <string> + value: <string> + - objectTypeId: <string> + value: <string> + createdAt: <dateTime> + displayOptions: + renderRawHtml: <boolean> + style: + backgroundWidth: <string> + fontFamily: <string> + helpTextColor: <string> + helpTextSize: <string> + labelTextColor: <string> + labelTextSize: <string> + legalConsentTextColor: <string> + legalConsentTextSize: <string> + submitAlignment: right + submitColor: <string> + submitFontColor: <string> + submitSize: <string> + submitButtonText: <string> + theme: linear + cssClass: <string> + fieldGroups: + - fields: + - dependentFields: + - dependentCondition: + operator: doesnt_contain + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + - dependentCondition: + operator: not_between + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + fieldType: email + hidden: <boolean> + label: <string> + name: <string> + objectTypeId: <string> + required: <boolean> + validation: + blockedEmailDomains: + - <string> + - <string> + useDefaultBlockList: <boolean> + defaultValue: <string> + description: <string> + placeholder: <string> + - dependentFields: + - dependentCondition: + operator: set_not_all + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + - dependentCondition: + operator: set_eq + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + fieldType: email + hidden: <boolean> + label: <string> + name: <string> + objectTypeId: <string> + required: <boolean> + validation: + blockedEmailDomains: + - <string> + - <string> + useDefaultBlockList: <boolean> + defaultValue: <string> + description: <string> + placeholder: <string> + groupType: progressive + richTextType: text + richText: <string> + - fields: + - dependentFields: + - dependentCondition: + operator: between + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + - dependentCondition: + operator: set_not_any + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + fieldType: email + hidden: <boolean> + label: <string> + name: <string> + objectTypeId: <string> + required: <boolean> + validation: + blockedEmailDomains: + - <string> + - <string> + useDefaultBlockList: <boolean> + defaultValue: <string> + description: <string> + placeholder: <string> + - dependentFields: + - dependentCondition: + operator: set_not_any + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + - dependentCondition: + operator: set_any + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + fieldType: email + hidden: <boolean> + label: <string> + name: <string> + objectTypeId: <string> + required: <boolean> + validation: + blockedEmailDomains: + - <string> + - <string> + useDefaultBlockList: <boolean> + defaultValue: <string> + description: <string> + placeholder: <string> + groupType: progressive + richTextType: image + richText: <string> + formType: hubspot + id: <string> + legalConsentOptions: + type: none + name: <string> + updatedAt: <dateTime> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ad_d": [ + "<string>", + "<string>" + ], + "ut9": [ + "<string>", + "<string>" + ] + }, + "links": { + "ea_7": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "quisb3": [ + "<string>", + "<string>" + ], + "Duis0": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "nisi_fe2": [ + "<string>", + "<string>" + ] + } + } + ] + } + /marketing/v3/forms/: + get: + tags: + - Forms API > Forms + summary: Get a list of forms + description: >- + Returns a list of forms based on the search filters. By default, it + returns the first 20 `hubspot` forms + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: limit + in: query + schema: + type: string + description: The maximum number of results to display per page. + example: <integer> + - name: archived + in: query + schema: + type: string + description: Whether to return only results that have been archived. + example: <boolean> + - name: formTypes + in: query + schema: + type: string + description: The form types to be included in the results. + example: captured + - name: formTypes + in: query + schema: + type: string + description: The form types to be included in the results. + example: all + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - archived: <boolean> + configuration: + allowLinkToResetKnownValues: <boolean> + archivable: <boolean> + cloneable: <boolean> + createNewContactForNewEmail: <boolean> + editable: <boolean> + language: sk + notifyContactOwner: <boolean> + notifyRecipients: + - <string> + - <string> + postSubmitAction: + type: thank_you + value: <string> + prePopulateKnownValues: <boolean> + recaptchaEnabled: <boolean> + lifecycleStages: + - objectTypeId: <string> + value: <string> + - objectTypeId: <string> + value: <string> + createdAt: <dateTime> + displayOptions: + renderRawHtml: <boolean> + style: + backgroundWidth: <string> + fontFamily: <string> + helpTextColor: <string> + helpTextSize: <string> + labelTextColor: <string> + labelTextSize: <string> + legalConsentTextColor: <string> + legalConsentTextSize: <string> + submitAlignment: center + submitColor: <string> + submitFontColor: <string> + submitSize: <string> + submitButtonText: <string> + theme: sharp + cssClass: <string> + fieldGroups: + - fields: + - dependentFields: + - dependentCondition: + operator: within_time_reverse + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + - dependentCondition: + operator: contains + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + fieldType: email + hidden: <boolean> + label: <string> + name: <string> + objectTypeId: <string> + required: <boolean> + validation: + blockedEmailDomains: + - <string> + - <string> + useDefaultBlockList: <boolean> + defaultValue: <string> + description: <string> + placeholder: <string> + - dependentFields: + - dependentCondition: + operator: set_all + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + - dependentCondition: + operator: within_time + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + fieldType: email + hidden: <boolean> + label: <string> + name: <string> + objectTypeId: <string> + required: <boolean> + validation: + blockedEmailDomains: + - <string> + - <string> + useDefaultBlockList: <boolean> + defaultValue: <string> + description: <string> + placeholder: <string> + groupType: progressive + richTextType: image + richText: <string> + - fields: + - dependentFields: + - dependentCondition: + operator: set_neq + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + - dependentCondition: + operator: neq + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + fieldType: email + hidden: <boolean> + label: <string> + name: <string> + objectTypeId: <string> + required: <boolean> + validation: + blockedEmailDomains: + - <string> + - <string> + useDefaultBlockList: <boolean> + defaultValue: <string> + description: <string> + placeholder: <string> + - dependentFields: + - dependentCondition: + operator: within_time_reverse + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + - dependentCondition: + operator: not_between + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + fieldType: email + hidden: <boolean> + label: <string> + name: <string> + objectTypeId: <string> + required: <boolean> + validation: + blockedEmailDomains: + - <string> + - <string> + useDefaultBlockList: <boolean> + defaultValue: <string> + description: <string> + placeholder: <string> + groupType: default_group + richTextType: text + richText: <string> + formType: hubspot + id: <string> + legalConsentOptions: + type: none + name: <string> + updatedAt: <dateTime> + archivedAt: <dateTime> + - archived: <boolean> + configuration: + allowLinkToResetKnownValues: <boolean> + archivable: <boolean> + cloneable: <boolean> + createNewContactForNewEmail: <boolean> + editable: <boolean> + language: nl + notifyContactOwner: <boolean> + notifyRecipients: + - <string> + - <string> + postSubmitAction: + type: thank_you + value: <string> + prePopulateKnownValues: <boolean> + recaptchaEnabled: <boolean> + lifecycleStages: + - objectTypeId: <string> + value: <string> + - objectTypeId: <string> + value: <string> + createdAt: <dateTime> + displayOptions: + renderRawHtml: <boolean> + style: + backgroundWidth: <string> + fontFamily: <string> + helpTextColor: <string> + helpTextSize: <string> + labelTextColor: <string> + labelTextSize: <string> + legalConsentTextColor: <string> + legalConsentTextSize: <string> + submitAlignment: center + submitColor: <string> + submitFontColor: <string> + submitSize: <string> + submitButtonText: <string> + theme: legacy + cssClass: <string> + fieldGroups: + - fields: + - dependentFields: + - dependentCondition: + operator: set_all + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + - dependentCondition: + operator: set_eq + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + fieldType: email + hidden: <boolean> + label: <string> + name: <string> + objectTypeId: <string> + required: <boolean> + validation: + blockedEmailDomains: + - <string> + - <string> + useDefaultBlockList: <boolean> + defaultValue: <string> + description: <string> + placeholder: <string> + - dependentFields: + - dependentCondition: + operator: is_not_empty + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + - dependentCondition: + operator: lt + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + fieldType: email + hidden: <boolean> + label: <string> + name: <string> + objectTypeId: <string> + required: <boolean> + validation: + blockedEmailDomains: + - <string> + - <string> + useDefaultBlockList: <boolean> + defaultValue: <string> + description: <string> + placeholder: <string> + groupType: queued + richTextType: text + richText: <string> + - fields: + - dependentFields: + - dependentCondition: + operator: set_all + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + - dependentCondition: + operator: not_between + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + fieldType: email + hidden: <boolean> + label: <string> + name: <string> + objectTypeId: <string> + required: <boolean> + validation: + blockedEmailDomains: + - <string> + - <string> + useDefaultBlockList: <boolean> + defaultValue: <string> + description: <string> + placeholder: <string> + - dependentFields: + - dependentCondition: + operator: doesnt_contain + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + - dependentCondition: + operator: gte + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + fieldType: email + hidden: <boolean> + label: <string> + name: <string> + objectTypeId: <string> + required: <boolean> + validation: + blockedEmailDomains: + - <string> + - <string> + useDefaultBlockList: <boolean> + defaultValue: <string> + description: <string> + placeholder: <string> + groupType: queued + richTextType: text + richText: <string> + formType: hubspot + id: <string> + legalConsentOptions: + type: none + name: <string> + updatedAt: <dateTime> + archivedAt: <dateTime> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ad_d": [ + "<string>", + "<string>" + ], + "ut9": [ + "<string>", + "<string>" + ] + }, + "links": { + "ea_7": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "quisb3": [ + "<string>", + "<string>" + ], + "Duis0": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "nisi_fe2": [ + "<string>", + "<string>" + ] + } + } + ] + } + post: + tags: + - Forms API > Forms + summary: Create a form + description: Add a new `hubspot` form + requestBody: + content: + application/json: + schema: + type: object + example: + archived: <boolean> + configuration: + allowLinkToResetKnownValues: <boolean> + archivable: <boolean> + cloneable: <boolean> + createNewContactForNewEmail: <boolean> + editable: <boolean> + language: fr + notifyContactOwner: <boolean> + notifyRecipients: + - <string> + - <string> + postSubmitAction: + type: redirect_url + value: <string> + prePopulateKnownValues: <boolean> + recaptchaEnabled: <boolean> + lifecycleStages: + - objectTypeId: <string> + value: <string> + - objectTypeId: <string> + value: <string> + createdAt: <dateTime> + displayOptions: + renderRawHtml: <boolean> + style: + backgroundWidth: <string> + fontFamily: <string> + helpTextColor: <string> + helpTextSize: <string> + labelTextColor: <string> + labelTextSize: <string> + legalConsentTextColor: <string> + legalConsentTextSize: <string> + submitAlignment: center + submitColor: <string> + submitFontColor: <string> + submitSize: <string> + submitButtonText: <string> + theme: legacy + cssClass: <string> + fieldGroups: + - fields: + - dependentFields: + - dependentCondition: + operator: set_any + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + - dependentCondition: + operator: between + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + fieldType: email + hidden: <boolean> + label: <string> + name: <string> + objectTypeId: <string> + required: <boolean> + validation: + blockedEmailDomains: + - <string> + - <string> + useDefaultBlockList: <boolean> + defaultValue: <string> + description: <string> + placeholder: <string> + - dependentFields: + - dependentCondition: + operator: lt + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + - dependentCondition: + operator: neq + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + fieldType: email + hidden: <boolean> + label: <string> + name: <string> + objectTypeId: <string> + required: <boolean> + validation: + blockedEmailDomains: + - <string> + - <string> + useDefaultBlockList: <boolean> + defaultValue: <string> + description: <string> + placeholder: <string> + groupType: default_group + richTextType: image + richText: <string> + - fields: + - dependentFields: + - dependentCondition: + operator: str_ends_with + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + - dependentCondition: + operator: set_not_all + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + fieldType: email + hidden: <boolean> + label: <string> + name: <string> + objectTypeId: <string> + required: <boolean> + validation: + blockedEmailDomains: + - <string> + - <string> + useDefaultBlockList: <boolean> + defaultValue: <string> + description: <string> + placeholder: <string> + - dependentFields: + - dependentCondition: + operator: gte + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + - dependentCondition: + operator: gte + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + fieldType: email + hidden: <boolean> + label: <string> + name: <string> + objectTypeId: <string> + required: <boolean> + validation: + blockedEmailDomains: + - <string> + - <string> + useDefaultBlockList: <boolean> + defaultValue: <string> + description: <string> + placeholder: <string> + groupType: default_group + richTextType: image + richText: <string> + formType: hubspot + legalConsentOptions: + type: none + name: <string> + updatedAt: <dateTime> + archivedAt: <dateTime> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + archived: <boolean> + configuration: + allowLinkToResetKnownValues: <boolean> + archivable: <boolean> + cloneable: <boolean> + createNewContactForNewEmail: <boolean> + editable: <boolean> + language: af + notifyContactOwner: <boolean> + notifyRecipients: + - <string> + - <string> + postSubmitAction: + type: thank_you + value: <string> + prePopulateKnownValues: <boolean> + recaptchaEnabled: <boolean> + lifecycleStages: + - objectTypeId: <string> + value: <string> + - objectTypeId: <string> + value: <string> + createdAt: <dateTime> + displayOptions: + renderRawHtml: <boolean> + style: + backgroundWidth: <string> + fontFamily: <string> + helpTextColor: <string> + helpTextSize: <string> + labelTextColor: <string> + labelTextSize: <string> + legalConsentTextColor: <string> + legalConsentTextSize: <string> + submitAlignment: right + submitColor: <string> + submitFontColor: <string> + submitSize: <string> + submitButtonText: <string> + theme: linear + cssClass: <string> + fieldGroups: + - fields: + - dependentFields: + - dependentCondition: + operator: doesnt_contain + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + - dependentCondition: + operator: not_between + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + fieldType: email + hidden: <boolean> + label: <string> + name: <string> + objectTypeId: <string> + required: <boolean> + validation: + blockedEmailDomains: + - <string> + - <string> + useDefaultBlockList: <boolean> + defaultValue: <string> + description: <string> + placeholder: <string> + - dependentFields: + - dependentCondition: + operator: set_not_all + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + - dependentCondition: + operator: set_eq + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + fieldType: email + hidden: <boolean> + label: <string> + name: <string> + objectTypeId: <string> + required: <boolean> + validation: + blockedEmailDomains: + - <string> + - <string> + useDefaultBlockList: <boolean> + defaultValue: <string> + description: <string> + placeholder: <string> + groupType: progressive + richTextType: text + richText: <string> + - fields: + - dependentFields: + - dependentCondition: + operator: between + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + - dependentCondition: + operator: set_not_any + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + fieldType: email + hidden: <boolean> + label: <string> + name: <string> + objectTypeId: <string> + required: <boolean> + validation: + blockedEmailDomains: + - <string> + - <string> + useDefaultBlockList: <boolean> + defaultValue: <string> + description: <string> + placeholder: <string> + - dependentFields: + - dependentCondition: + operator: set_not_any + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + - dependentCondition: + operator: set_any + rangeEnd: <string> + rangeStart: <string> + value: <string> + values: + - <string> + - <string> + dependentField: + value: >- + <Circular reference to + #/components/schemas/EmailField detected> + fieldType: email + hidden: <boolean> + label: <string> + name: <string> + objectTypeId: <string> + required: <boolean> + validation: + blockedEmailDomains: + - <string> + - <string> + useDefaultBlockList: <boolean> + defaultValue: <string> + description: <string> + placeholder: <string> + groupType: progressive + richTextType: image + richText: <string> + formType: hubspot + id: <string> + legalConsentOptions: + type: none + name: <string> + updatedAt: <dateTime> + archivedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "ad_d": [ + "<string>", + "<string>" + ], + "ut9": [ + "<string>", + "<string>" + ] + }, + "links": { + "ea_7": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "quisb3": [ + "<string>", + "<string>" + ], + "Duis0": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "nisi_fe2": [ + "<string>", + "<string>" + ] + } + } + ] + } diff --git a/server/node-service/src/plugins/hubspot/specsV4/Settings API Collections.json b/server/node-service/src/plugins/hubspot/specsV4/Settings API Collections.json new file mode 100644 index 000000000..6cf366d8d --- /dev/null +++ b/server/node-service/src/plugins/hubspot/specsV4/Settings API Collections.json @@ -0,0 +1,4000 @@ +openapi: 3.0.0 +info: + title: Settings API Collections + description: >- + **Users API:** Use this API to fetch information about users in the account, + along with updating their working hours, timezone, additional phone number, + and job title properties. + + + **Business Units API:** The following endpoint provides information about + [business + units](https://knowledge.hubspot.com/account-settings/manage-brands-with-business-unit) + tied to a user. This may also include information about + [logos](https://knowledge.hubspot.com/account-settings/edit-your-logo-favicon-and-brand-colors). + + **User Provisioning API:** This API can be used to manage the users on an + account and manage the permission sets of those users. + + + **Currencies API:** This API can manage the currencies used in your HubSpot + account, including setting your account's company currency, creating + additional currencies, and updating currency exchange rates. + + + **Fork the collections using Run in Postman:** + + + [<img src="https://run.pstmn.io/button.svg" alt="Run In + Postman">](https://app.getpostman.com/run-collection/26126890-177e1ace-347d-481b-9d2a-af2aada9cee8?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D26126890-177e1ace-347d-481b-9d2a-af2aada9cee8%26entityType%3Dcollection%26workspaceId%3Dd7645f33-539d-49c6-9e0c-efa6faae355d) + version: 1.0.0 +servers: + - url: http://{{baseurl}} +components: + securitySchemes: + apikeyAuth: + type: http + scheme: apikey + oauth2Auth: + type: http + scheme: oauth2 +tags: + - name: Business Unit API + description: "The following endpoint provides information about\_[business units](https://knowledge.hubspot.com/account-settings/manage-brands-with-business-unit)\_tied to a user. This may also include information about\_[logos](https://knowledge.hubspot.com/account-settings/edit-your-logo-favicon-and-brand-colors).\n\n**Please note:**\_the business units API currently only supports retrieving business unit data and does\_not\_support associating assests with a business unit, nor creating a new business unit.\n\n## Get business units tied to a user\n\nTo get the business units that a user has access to, you can make a\_`GET`\_request to\n\n`/business-units/v3/business-units/user/{userId}`\n\nThe following is an example of what the response body should include:\n\n```\n// Example GET request to /business-units/v3/business-units/user/{userId}\n{\n \"logoMetadata\": {\n \"logoAltText\": \"logo sample text\",\n \"resizedUrl\": \"sillystring\",\n \"logoUrl\": \"examplelogourl.com\"\n },\n \"name\": \"sample business unit name\",\n \"id\": \"101\"\n}\n\n ```" + - name: Business Unit API > Business Unit + - name: User Provisioning API + description: >- + Use the user provisioning API to create and manage users in the account, + along with their permissions. You can also set user `firstName` and + `lastName` properties through this API. + + + To retrieve and update other user information, such as their job title and + working hours, use the [users + API](https://developers.hubspot.com/docs/api/crm/users) instead. + + + ## Specifying a user + + + When specifying a user with the `userId` path parameter, you can either + use the user's ID or the user's email. Specifying based on the user's ID + is the default behavior but if you want to use the user's email, you can + use the query parameter `idProperty` to set that. + + + The following `GET` request is fetching a user with the email + [<i>myUser@gmail.com</i>](https://mailto:myUser@gmail.com)_:_ + + + `https://api.hubspot.com/settings/v3/users/myUser@gmail.com?idProperty=EMAIL` + + + You can set the `idProperty` query parameter in any endpoint that takes in + `userId` as a path parameter. + + + ## Permission Sets + + + HubSpot accounts can define permission sets to easily manage multiple + users' permissions at once. Once you've created a role and specified + certain permissions for it, you can then assign new and existing users the + role to grant them the same permissions. Permission sets that have paid + seats attached to them can only be modified by applications that have the + `billing-write` scope. + + + The following is an example of a role definition for a user: + + + ``` + + // Example specification of a role definition + + { + "id": "1234", + "name": "a new role", + "requiresBillingWrite": false + } + + ``` + + Note that permission sets must be [created in the + app](https://knowledge.hubspot.com/settings/create-roles) before + attempting to assign them to users. + - name: User Provisioning API > Teams + - name: User Provisioning API > Roles + - name: User Provisioning API > Users + - name: Users API + description: "Use the user provisioning API to create and manage users in the account, along with their permissions. You can also set user\_`firstName`\_and\_`lastName`\_properties through this API.\_\n\nTo retrieve and update other user information, such as their job title and working hours, use the\_[users API](https://developers.hubspot.com/docs/api/crm/users)\_instead.\n\n## Specifying a user\n\nWhen specifying a user with the\_`userId`\_path parameter, you can either use the user's ID or the user's email. Specifying based on the user's ID is the default behavior but if you want to use the user's email, you can use the query parameter\_`idProperty`\_to set that.\n\nThe following\_`GET`\_request is fetching a user with the email\__myUser@gmail.com:_\n\n`https://api.hubspot.com/settings/v3/users/myUser@gmail.com?idProperty=EMAIL`\n\nYou can set the\_`idProperty`\_query parameter in any endpoint that takes in\_`userId`\_as a path parameter.\n\n## Permission Sets\n\nHubSpot accounts can define permission sets to easily manage multiple users' permissions at once. Once you've created a role and specified certain permissions for it, you can then assign new and existing users the role to grant them the same permissions. Permission sets that have paid seats attached to them can only be modified by applications that have the\_`billing-write`\_scope.\n\nThe following is an example of a role definition for a user:\n\n```\n// Example specification of a role definition\n{\n \"id\": \"1234\",\n \"name\": \"a new role\",\n \"requiresBillingWrite\": false\n}\n\n ```\n\nNote that permission sets must be\_[created in the app](https://knowledge.hubspot.com/settings/create-roles)\_before attempting to assign them to users." + - name: Users API > Batch + - name: Users API > Basic + - name: Users API > Search + - name: Currencies API + description: "With the currencies API, you can manage the currencies used in your HubSpot account, including setting your account's company currency, creating additional currencies, and updating currency exchange rates. Learn more about\_[adding and editing currencies within HubSpot.](https://knowledge.hubspot.com/deals/add-and-edit-your-account-currencies)\n\n## Supported currencies\n\nOnly certain currencies are supported for use in HubSpot. To retrieve a list of HubSpot's supported currencies and their codes, make a\_`GET`\_request to\_`/settings/v3/currencies/codes`.\n\nYou can use any of the returned codes as values for the\_`currencyCode`,\_`fromCurrencyCode`, and\_`toCurrencyCode`\_properties.\n\n## Add account currencies and set exchange rates\n\nDepending on your HubSpot subscription, you can add additional currencies for use in your account, and set their exchange rates compared to your company currency. Learn more about the number of currencies you can have in your account in the\_[HubSpot Product & Services Catalog.](https://legal.hubspot.com/hubspot-product-and-services-catalog)\n\nTo add a currency and set the exchange rate, or add a new exchange rate for an existing currency, make a\_`POST`\_request to\_`/settings/v3/currencies/exchange-rates`. In your request, the following fields are required:\n\n- `fromCurrencyCode`: the currency code of the currency you want to add to your account. This must be one of HubSpot's supported currency codes.\n \n- `conversionRate`: the exchange rate from the additional currency to your company currency. The value must be greater than 0 and can contain up to 6 decimal values (e.g.,\_`1.36`). Any values with more than 6 decimal places will be rounded (e.g.,\_`1.2345678`\_becomes\_`1.234568`).\n \n\nYou can also include a timestamp using the following field:\n\n- `effectiveAt`: the date and time the exchange rate takes effect. Values can be in either\_[long date ](https://www.jarte.com/help_new/date_and_time_formats.html)\_or\_[ISO 8601](https://developers.hubspot.com/docs/api/faq#timestamps)\_format." + - name: Currencies API > Currency +paths: + /business-units/v3/business-units/user/{userId}: + get: + tags: + - Business Unit API > Business Unit + summary: Get Business Units for a user + description: >- + Get Business Units identified by `userId`. The `userId` refers to the + user’s ID. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: properties + in: query + schema: + type: string + description: >- + The names of properties to optionally include in the response body. + The only valid value is `logoMetadata`. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + The names of properties to optionally include in the response body. + The only valid value is `logoMetadata`. + example: <string> + - name: name + in: query + schema: + type: string + description: >- + The names of Business Units to retrieve. If empty or not provided, + then all associated Business Units will be returned. + example: <string> + - name: name + in: query + schema: + type: string + description: >- + The names of Business Units to retrieve. If empty or not provided, + then all associated Business Units will be returned. + example: <string> + - name: userId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - id: <string> + name: <string> + logoMetadata: + logoUrl: <string> + logoAltText: <string> + resizedUrl: <string> + - id: <string> + name: <string> + logoMetadata: + logoUrl: <string> + logoAltText: <string> + resizedUrl: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "reprehenderit_57c": [ + "<string>", + "<string>" + ], + "consectetur3f": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "in_f": [ + "<string>", + "<string>" + ], + "in_4c": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "occaecat_a8a": [ + "<string>", + "<string>" + ], + "voluptate_a8": [ + "<string>", + "<string>" + ] + }, + "links": { + "elit_2e": "<string>", + "ipsum_bf": "<string>" + } + } + /settings/v3/users/teams: + get: + tags: + - User Provisioning API > Teams + summary: See details about this account's teams + description: View teams for this account + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - id: <string> + name: <string> + secondaryUserIds: + - <string> + - <string> + userIds: + - <string> + - <string> + - id: <string> + name: <string> + secondaryUserIds: + - <string> + - <string> + userIds: + - <string> + - <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "etff": [ + "<string>", + "<string>" + ], + "dolor_c36": [ + "<string>", + "<string>" + ], + "minim_5b": [ + "<string>", + "<string>" + ] + }, + "links": { + "est_11": "<string>", + "minim29": "<string>", + "sitd0": "<string>", + "est_063": "<string>", + "cillum_0": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "culpaae": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "officia0d": [ + "<string>", + "<string>" + ] + } + } + ] + } + /settings/v3/users/roles: + get: + tags: + - User Provisioning API > Roles + summary: Retrieves the roles on an account + description: Retrieves the roles on an account + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - id: <string> + name: <string> + requiresBillingWrite: <boolean> + - id: <string> + name: <string> + requiresBillingWrite: <boolean> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "etff": [ + "<string>", + "<string>" + ], + "dolor_c36": [ + "<string>", + "<string>" + ], + "minim_5b": [ + "<string>", + "<string>" + ] + }, + "links": { + "est_11": "<string>", + "minim29": "<string>", + "sitd0": "<string>", + "est_063": "<string>", + "cillum_0": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "culpaae": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "officia0d": [ + "<string>", + "<string>" + ] + } + } + ] + } + /settings/v3/users/: + get: + tags: + - User Provisioning API > Users + summary: Retrieves a list of users from an account + description: Retrieves a list of users from an account + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: limit + in: query + schema: + type: string + description: The number of users to retrieve + example: <integer> + - name: after + in: query + schema: + type: string + description: >- + Results will display maximum 100 users per page. Additional results + will be on the next page. + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - email: <string> + id: <string> + primaryTeamId: <string> + roleIds: + - <string> + - <string> + sendWelcomeEmail: <boolean> + roleId: <string> + secondaryTeamIds: + - <string> + - <string> + superAdmin: <boolean> + - email: <string> + id: <string> + primaryTeamId: <string> + roleIds: + - <string> + - <string> + sendWelcomeEmail: <boolean> + roleId: <string> + secondaryTeamIds: + - <string> + - <string> + superAdmin: <boolean> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "etff": [ + "<string>", + "<string>" + ], + "dolor_c36": [ + "<string>", + "<string>" + ], + "minim_5b": [ + "<string>", + "<string>" + ] + }, + "links": { + "est_11": "<string>", + "minim29": "<string>", + "sitd0": "<string>", + "est_063": "<string>", + "cillum_0": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "culpaae": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "officia0d": [ + "<string>", + "<string>" + ] + } + } + ] + } + post: + tags: + - User Provisioning API > Users + summary: Adds a user + description: >- + New users will only have minimal permissions, which is contacts-base. A + welcome email will prompt them to set a password and log in to HubSpot. + requestBody: + content: + application/json: + schema: + type: object + example: + email: <string> + primaryTeamId: <string> + sendWelcomeEmail: <boolean> + roleId: <string> + secondaryTeamIds: + - <string> + - <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + email: <string> + id: <string> + primaryTeamId: <string> + roleIds: + - <string> + - <string> + sendWelcomeEmail: <boolean> + roleId: <string> + secondaryTeamIds: + - <string> + - <string> + superAdmin: <boolean> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "etff": [ + "<string>", + "<string>" + ], + "dolor_c36": [ + "<string>", + "<string>" + ], + "minim_5b": [ + "<string>", + "<string>" + ] + }, + "links": { + "est_11": "<string>", + "minim29": "<string>", + "sitd0": "<string>", + "est_063": "<string>", + "cillum_0": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "culpaae": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "officia0d": [ + "<string>", + "<string>" + ] + } + } + ] + } + /settings/v3/users/{userId}: + get: + tags: + - User Provisioning API > Users + summary: Retrieves a user + description: >- + Retrieves a user identified by `userId`. `userId` refers to the user's + ID by default, or optionally email as specified by the `IdProperty` + query param. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: idProperty + in: query + schema: + type: string + description: >- + The name of a property with unique user values. Valid values are + `USER_ID`(default) or `EMAIL` + example: <string> + - name: userId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + email: <string> + id: <string> + primaryTeamId: <string> + roleIds: + - <string> + - <string> + sendWelcomeEmail: <boolean> + roleId: <string> + secondaryTeamIds: + - <string> + - <string> + superAdmin: <boolean> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "etff": [ + "<string>", + "<string>" + ], + "dolor_c36": [ + "<string>", + "<string>" + ], + "minim_5b": [ + "<string>", + "<string>" + ] + }, + "links": { + "est_11": "<string>", + "minim29": "<string>", + "sitd0": "<string>", + "est_063": "<string>", + "cillum_0": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "culpaae": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "officia0d": [ + "<string>", + "<string>" + ] + } + } + ] + } + put: + tags: + - User Provisioning API > Users + summary: Modifies a user + description: >- + Modifies a user identified by `userId`. `userId` refers to the user's ID + by default, or optionally email as specified by the `IdProperty` query + param. + requestBody: + content: + application/json: + schema: + type: object + example: + primaryTeamId: <string> + roleId: <string> + secondaryTeamIds: + - <string> + - <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: idProperty + in: query + schema: + type: string + description: >- + The name of a property with unique user values. Valid values are + `USER_ID`(default) or `EMAIL` + example: <string> + - name: userId + in: path + schema: + type: string + required: true + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + email: <string> + id: <string> + primaryTeamId: <string> + roleIds: + - <string> + - <string> + sendWelcomeEmail: <boolean> + roleId: <string> + secondaryTeamIds: + - <string> + - <string> + superAdmin: <boolean> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "etff": [ + "<string>", + "<string>" + ], + "dolor_c36": [ + "<string>", + "<string>" + ], + "minim_5b": [ + "<string>", + "<string>" + ] + }, + "links": { + "est_11": "<string>", + "minim29": "<string>", + "sitd0": "<string>", + "est_063": "<string>", + "cillum_0": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "culpaae": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "officia0d": [ + "<string>", + "<string>" + ] + } + } + ] + } + delete: + tags: + - User Provisioning API > Users + summary: Removes a user + description: >- + Removes a user identified by `userId`. `userId` refers to the user's ID + by default, or optionally email as specified by the `IdProperty` query + param. + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: idProperty + in: query + schema: + type: string + description: >- + The name of a property with unique user values. Valid values are + `USER_ID`(default) or `EMAIL` + example: <string> + - name: userId + in: path + schema: + type: string + required: true + example: <string> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "etff": [ + "<string>", + "<string>" + ], + "dolor_c36": [ + "<string>", + "<string>" + ], + "minim_5b": [ + "<string>", + "<string>" + ] + }, + "links": { + "est_11": "<string>", + "minim29": "<string>", + "sitd0": "<string>", + "est_063": "<string>", + "cillum_0": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "culpaae": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "officia0d": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/users/batch/read: + post: + tags: + - Users API > Batch + summary: Read a batch of users by internal ID, or unique property values + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + properties: + - <string> + - <string> + propertiesWithHistory: + - <string> + - <string> + idProperty: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + Ut_e9: <string> + commodo_d2_: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + velit_a8: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + fugiat_2: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + magna_273: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + sunt_3: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + startedAt: <dateTime> + status: PENDING + requestedAt: <dateTime> + links: + commodo_c: <string> + mollit__8a: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - createdAt: <dateTime> + id: <string> + properties: + sunt_c1c: <string> + in_2: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + voluptate0dd: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + aute_e2c: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + tempor_b2: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + esse5: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + sit7_: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + do_9d2: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + startedAt: <dateTime> + status: COMPLETE + numErrors: <integer> + requestedAt: <dateTime> + links: + laborum_0: <string> + errors: + - category: <string> + context: + sunt_49_: + - <string> + - <string> + Lorem13e: + - <string> + - <string> + irureb5f: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + consectetur_c09: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + commodo_9b3: + - <string> + - <string> + links: + ex2ca: <string> + voluptate6: <string> + occaecat__: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + - category: <string> + context: + irure_f6d: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + sit_9: + - <string> + - <string> + ullamco_0c: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + sit_3: + - <string> + - <string> + links: + Lorem_c_: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "quif7e": [ + "<string>", + "<string>" + ], + "incididunt_0": [ + "<string>", + "<string>" + ], + "quis2c": [ + "<string>", + "<string>" + ], + "anim__f5": [ + "<string>", + "<string>" + ] + }, + "links": { + "magna_187": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "minim8": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "nisi_d0": [ + "<string>", + "<string>" + ], + "sit3e": [ + "<string>", + "<string>" + ], + "eu_9e6": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/users/{userId}: + get: + tags: + - Users API > Basic + summary: Read + description: >- + Read an Object identified by `{userId}`. `{userId}` refers to the + internal object ID by default, or optionally any unique property value + as specified by the `idProperty` query param. Control what is returned + via the `properties` query param. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + - name: idProperty + in: query + schema: + type: string + description: The name of a property whose values are unique for this object type + example: <string> + - name: userId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + properties: + aliqua_2: <string> + voluptate57f: <string> + est_96: <string> + updatedAt: <dateTime> + associations: + sed_59: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + enim_4e: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + pariatur7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + tempord: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + qui_b: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "quif7e": [ + "<string>", + "<string>" + ], + "incididunt_0": [ + "<string>", + "<string>" + ], + "quis2c": [ + "<string>", + "<string>" + ], + "anim__f5": [ + "<string>", + "<string>" + ] + }, + "links": { + "magna_187": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "minim8": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "nisi_d0": [ + "<string>", + "<string>" + ], + "sit3e": [ + "<string>", + "<string>" + ], + "eu_9e6": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/users: + get: + tags: + - Users API > Basic + summary: List + description: >- + Read a page of users. Control what is returned via the `properties` + query param. + security: + - oauth2Auth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: limit + in: query + schema: + type: integer + description: The maximum number of results to display per page. + example: '10' + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: properties + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned in the + response. If any of the specified properties are not present on the + requested object(s), they will be ignored. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: propertiesWithHistory + in: query + schema: + type: string + description: >- + A comma separated list of the properties to be returned along with + their history of previous values. If any of the specified properties + are not present on the requested object(s), they will be ignored. + Usage of this parameter will reduce the maximum number of objects + that can be read by a single request. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: associations + in: query + schema: + type: string + description: >- + A comma separated list of object types to retrieve associated IDs + for. If any of the specified associations do not exist, they will be + ignored. + example: <string> + - name: archived + in: query + schema: + type: boolean + description: Whether to return only results that have been archived. + example: 'false' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + dolor_8: <string> + updatedAt: <dateTime> + associations: + Loremf6: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + sed_1: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + anim_ed0: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + laboris_88: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + sint6: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + tempor7f7: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + laborum2b: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + deserunt0_f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + et79: <string> + est5: <string> + cillum81: <string> + updatedAt: <dateTime> + associations: + magnaf: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + officia_f2: + results: + - id: <string> + type: <string> + - id: <string> + type: <string> + paging: + next: + after: <string> + link: <string> + prev: + before: <string> + link: <string> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + sit235: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + quib17: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "quif7e": [ + "<string>", + "<string>" + ], + "incididunt_0": [ + "<string>", + "<string>" + ], + "quis2c": [ + "<string>", + "<string>" + ], + "anim__f5": [ + "<string>", + "<string>" + ] + }, + "links": { + "magna_187": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "minim8": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "nisi_d0": [ + "<string>", + "<string>" + ], + "sit3e": [ + "<string>", + "<string>" + ], + "eu_9e6": [ + "<string>", + "<string>" + ] + } + } + ] + } + /crm/v3/objects/users/search: + post: + tags: + - Users API > Search + summary: post-/crm/v3/objects/users/search + requestBody: + content: + application/json: + schema: + type: object + example: + after: <string> + filterGroups: + - filters: + - operator: GT + propertyName: <string> + highValue: <string> + values: + - <string> + - <string> + value: <string> + - operator: BETWEEN + propertyName: <string> + highValue: <string> + values: + - <string> + - <string> + value: <string> + - filters: + - operator: LTE + propertyName: <string> + highValue: <string> + values: + - <string> + - <string> + value: <string> + - operator: EQ + propertyName: <string> + highValue: <string> + values: + - <string> + - <string> + value: <string> + limit: <integer> + properties: + - <string> + - <string> + sorts: + - <string> + - <string> + query: <string> + security: + - oauth2Auth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - createdAt: <dateTime> + id: <string> + properties: + enime: <string> + ipsumb: <string> + Ut_55: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + amet_93f: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - createdAt: <dateTime> + id: <string> + properties: + amet_6: <string> + adipisicing767: <string> + updatedAt: <dateTime> + archived: <boolean> + archivedAt: <dateTime> + propertiesWithHistory: + irure39c: + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + - sourceType: <string> + timestamp: <dateTime> + value: <string> + sourceId: <string> + sourceLabel: <string> + updatedByUserId: <integer> + total: <integer> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "quif7e": [ + "<string>", + "<string>" + ], + "incididunt_0": [ + "<string>", + "<string>" + ], + "quis2c": [ + "<string>", + "<string>" + ], + "anim__f5": [ + "<string>", + "<string>" + ] + }, + "links": { + "magna_187": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "minim8": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "nisi_d0": [ + "<string>", + "<string>" + ], + "sit3e": [ + "<string>", + "<string>" + ], + "eu_9e6": [ + "<string>", + "<string>" + ] + } + } + ] + } + /settings/v3/currencies/exchange-rates: + get: + tags: + - Currencies API > Currency + summary: get-/settings/v3/currencies/exchange-rates + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: limit + in: query + schema: + type: integer + description: The maximum number of results to display per page. + example: '100' + - name: after + in: query + schema: + type: string + description: >- + The paging cursor token of the last successfully read resource will + be returned as the `paging.next.after` JSON property of a paged + response containing more results. + example: <string> + - name: fromCurrencyCode + in: query + schema: + type: string + example: CZK + - name: toCurrencyCode + in: query + schema: + type: string + example: CZK + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - conversionRate: <number> + createdAt: <dateTime> + effectiveAt: <dateTime> + fromCurrencyCode: SVC + id: <string> + toCurrencyCode: HTG + updatedAt: <dateTime> + visibleInUI: <boolean> + - conversionRate: <number> + createdAt: <dateTime> + effectiveAt: <dateTime> + fromCurrencyCode: XPT + id: <string> + toCurrencyCode: TTD + updatedAt: <dateTime> + visibleInUI: <boolean> + paging: + next: + after: <string> + link: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "dolor_1_f": [ + "<string>", + "<string>" + ], + "velit_c": [ + "<string>", + "<string>" + ] + }, + "links": { + "est_c62": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "qui_d": [ + "<string>", + "<string>" + ], + "sed_5e8": [ + "<string>", + "<string>" + ], + "adff": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "consequat_1": [ + "<string>", + "<string>" + ] + } + } + ] + } + post: + tags: + - Currencies API > Currency + summary: post-/settings/v3/currencies/exchange-rates + requestBody: + content: + application/json: + schema: + type: object + example: + conversionRate: <number> + fromCurrencyCode: VUV + effectiveAt: <dateTime> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + conversionRate: <number> + createdAt: <dateTime> + effectiveAt: <dateTime> + fromCurrencyCode: XPF + id: <string> + toCurrencyCode: BOB + updatedAt: <dateTime> + visibleInUI: <boolean> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "dolor_1_f": [ + "<string>", + "<string>" + ], + "velit_c": [ + "<string>", + "<string>" + ] + }, + "links": { + "est_c62": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "qui_d": [ + "<string>", + "<string>" + ], + "sed_5e8": [ + "<string>", + "<string>" + ], + "adff": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "consequat_1": [ + "<string>", + "<string>" + ] + } + } + ] + } + /settings/v3/currencies/codes: + get: + tags: + - Currencies API > Currency + summary: get-/settings/v3/currencies/codes + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - currencyCode: <string> + currencyName: <string> + - currencyCode: <string> + currencyName: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "dolor_1_f": [ + "<string>", + "<string>" + ], + "velit_c": [ + "<string>", + "<string>" + ] + }, + "links": { + "est_c62": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "qui_d": [ + "<string>", + "<string>" + ], + "sed_5e8": [ + "<string>", + "<string>" + ], + "adff": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "consequat_1": [ + "<string>", + "<string>" + ] + } + } + ] + } + /settings/v3/currencies/company-currency: + get: + tags: + - Currencies API > Currency + summary: get-/settings/v3/currencies/company-currency + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "dolor_1_f": [ + "<string>", + "<string>" + ], + "velit_c": [ + "<string>", + "<string>" + ] + }, + "links": { + "est_c62": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "qui_d": [ + "<string>", + "<string>" + ], + "sed_5e8": [ + "<string>", + "<string>" + ], + "adff": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "consequat_1": [ + "<string>", + "<string>" + ] + } + } + ] + } + put: + tags: + - Currencies API > Currency + summary: put-/settings/v3/currencies/company-currency + requestBody: + content: + application/json: + schema: + type: object + example: + currencyCode: KGS + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "dolor_1_f": [ + "<string>", + "<string>" + ], + "velit_c": [ + "<string>", + "<string>" + ] + }, + "links": { + "est_c62": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "qui_d": [ + "<string>", + "<string>" + ], + "sed_5e8": [ + "<string>", + "<string>" + ], + "adff": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "consequat_1": [ + "<string>", + "<string>" + ] + } + } + ] + } + /settings/v3/currencies/exchange-rates/batch/update: + post: + tags: + - Currencies API > Currency + summary: post-/settings/v3/currencies/exchange-rates/batch/update + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - conversionRate: <number> + id: <string> + effectiveAt: <dateTime> + - conversionRate: <number> + id: <string> + effectiveAt: <dateTime> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - conversionRate: <number> + createdAt: <dateTime> + effectiveAt: <dateTime> + fromCurrencyCode: NZD + id: <string> + toCurrencyCode: AOA + updatedAt: <dateTime> + visibleInUI: <boolean> + - conversionRate: <number> + createdAt: <dateTime> + effectiveAt: <dateTime> + fromCurrencyCode: KRW + id: <string> + toCurrencyCode: BOV + updatedAt: <dateTime> + visibleInUI: <boolean> + startedAt: <dateTime> + status: PROCESSING + requestedAt: <dateTime> + links: + reprehenderitc4_: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - conversionRate: <number> + createdAt: <dateTime> + effectiveAt: <dateTime> + fromCurrencyCode: CVE + id: <string> + toCurrencyCode: USD + updatedAt: <dateTime> + visibleInUI: <boolean> + - conversionRate: <number> + createdAt: <dateTime> + effectiveAt: <dateTime> + fromCurrencyCode: KZT + id: <string> + toCurrencyCode: TND + updatedAt: <dateTime> + visibleInUI: <boolean> + startedAt: <dateTime> + status: PENDING + numErrors: <integer> + requestedAt: <dateTime> + links: + suntf: <string> + errors: + - category: <string> + context: + veniam_4d: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + consecteturc6: + - <string> + - <string> + veniam40: + - <string> + - <string> + enime6_: + - <string> + - <string> + laboris_65: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + est671: + - <string> + - <string> + adipisicingb88: + - <string> + - <string> + sed_260: + - <string> + - <string> + links: + cupidatat_ed: <string> + in_c: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + - category: <string> + context: + ipsum_1: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + Excepteur6: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + veniame0: + - <string> + - <string> + pariatur_b: + - <string> + - <string> + Lorem_2f: + - <string> + - <string> + officia82: + - <string> + - <string> + proident_99: + - <string> + - <string> + links: + enime: <string> + ullamco881: <string> + nullac3: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "dolor_1_f": [ + "<string>", + "<string>" + ], + "velit_c": [ + "<string>", + "<string>" + ] + }, + "links": { + "est_c62": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "qui_d": [ + "<string>", + "<string>" + ], + "sed_5e8": [ + "<string>", + "<string>" + ], + "adff": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "consequat_1": [ + "<string>", + "<string>" + ] + } + } + ] + } + /settings/v3/currencies/exchange-rates/current: + get: + tags: + - Currencies API > Currency + summary: get-/settings/v3/currencies/exchange-rates/current + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - conversionRate: <number> + createdAt: <dateTime> + effectiveAt: <dateTime> + fromCurrencyCode: GIP + id: <string> + toCurrencyCode: GBP + updatedAt: <dateTime> + visibleInUI: <boolean> + - conversionRate: <number> + createdAt: <dateTime> + effectiveAt: <dateTime> + fromCurrencyCode: QAR + id: <string> + toCurrencyCode: MZN + updatedAt: <dateTime> + visibleInUI: <boolean> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "dolor_1_f": [ + "<string>", + "<string>" + ], + "velit_c": [ + "<string>", + "<string>" + ] + }, + "links": { + "est_c62": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "qui_d": [ + "<string>", + "<string>" + ], + "sed_5e8": [ + "<string>", + "<string>" + ], + "adff": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "consequat_1": [ + "<string>", + "<string>" + ] + } + } + ] + } + /settings/v3/currencies/exchange-rates/update-visibility: + post: + tags: + - Currencies API > Currency + summary: post-/settings/v3/currencies/exchange-rates/update-visibility + requestBody: + content: + application/json: + schema: + type: object + example: + fromCurrencyCode: ANG + toCurrencyCode: CZK + visibleInUI: <boolean> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: '*/*' + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "dolor_1_f": [ + "<string>", + "<string>" + ], + "velit_c": [ + "<string>", + "<string>" + ] + }, + "links": { + "est_c62": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "qui_d": [ + "<string>", + "<string>" + ], + "sed_5e8": [ + "<string>", + "<string>" + ], + "adff": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "consequat_1": [ + "<string>", + "<string>" + ] + } + } + ] + } + /settings/v3/currencies/exchange-rates/{exchangeRateId}: + get: + tags: + - Currencies API > Currency + summary: get-/settings/v3/currencies/exchange-rates/{exchange Rate Id} + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: exchangeRateId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + conversionRate: <number> + createdAt: <dateTime> + effectiveAt: <dateTime> + fromCurrencyCode: XPF + id: <string> + toCurrencyCode: BOB + updatedAt: <dateTime> + visibleInUI: <boolean> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "dolor_1_f": [ + "<string>", + "<string>" + ], + "velit_c": [ + "<string>", + "<string>" + ] + }, + "links": { + "est_c62": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "qui_d": [ + "<string>", + "<string>" + ], + "sed_5e8": [ + "<string>", + "<string>" + ], + "adff": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "consequat_1": [ + "<string>", + "<string>" + ] + } + } + ] + } + patch: + tags: + - Currencies API > Currency + summary: patch-/settings/v3/currencies/exchange-rates/{exchange Rate Id} + requestBody: + content: + application/json: + schema: + type: object + example: + conversionRate: <number> + effectiveAt: <dateTime> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: exchangeRateId + in: path + schema: + type: string + required: true + description: '(Required) ' + example: <string> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + conversionRate: <number> + createdAt: <dateTime> + effectiveAt: <dateTime> + fromCurrencyCode: XPF + id: <string> + toCurrencyCode: BOB + updatedAt: <dateTime> + visibleInUI: <boolean> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "dolor_1_f": [ + "<string>", + "<string>" + ], + "velit_c": [ + "<string>", + "<string>" + ] + }, + "links": { + "est_c62": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "qui_d": [ + "<string>", + "<string>" + ], + "sed_5e8": [ + "<string>", + "<string>" + ], + "adff": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "consequat_1": [ + "<string>", + "<string>" + ] + } + } + ] + } + /settings/v3/currencies/exchange-rates/batch/create: + post: + tags: + - Currencies API > Currency + summary: post-/settings/v3/currencies/exchange-rates/batch/create + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - conversionRate: <number> + fromCurrencyCode: MNT + effectiveAt: <dateTime> + - conversionRate: <number> + fromCurrencyCode: NZD + effectiveAt: <dateTime> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - conversionRate: <number> + createdAt: <dateTime> + effectiveAt: <dateTime> + fromCurrencyCode: NZD + id: <string> + toCurrencyCode: AOA + updatedAt: <dateTime> + visibleInUI: <boolean> + - conversionRate: <number> + createdAt: <dateTime> + effectiveAt: <dateTime> + fromCurrencyCode: KRW + id: <string> + toCurrencyCode: BOV + updatedAt: <dateTime> + visibleInUI: <boolean> + startedAt: <dateTime> + status: PROCESSING + requestedAt: <dateTime> + links: + reprehenderitc4_: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - conversionRate: <number> + createdAt: <dateTime> + effectiveAt: <dateTime> + fromCurrencyCode: CVE + id: <string> + toCurrencyCode: USD + updatedAt: <dateTime> + visibleInUI: <boolean> + - conversionRate: <number> + createdAt: <dateTime> + effectiveAt: <dateTime> + fromCurrencyCode: KZT + id: <string> + toCurrencyCode: TND + updatedAt: <dateTime> + visibleInUI: <boolean> + startedAt: <dateTime> + status: PENDING + numErrors: <integer> + requestedAt: <dateTime> + links: + suntf: <string> + errors: + - category: <string> + context: + veniam_4d: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + consecteturc6: + - <string> + - <string> + veniam40: + - <string> + - <string> + enime6_: + - <string> + - <string> + laboris_65: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + est671: + - <string> + - <string> + adipisicingb88: + - <string> + - <string> + sed_260: + - <string> + - <string> + links: + cupidatat_ed: <string> + in_c: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + - category: <string> + context: + ipsum_1: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + Excepteur6: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + veniame0: + - <string> + - <string> + pariatur_b: + - <string> + - <string> + Lorem_2f: + - <string> + - <string> + officia82: + - <string> + - <string> + proident_99: + - <string> + - <string> + links: + enime: <string> + ullamco881: <string> + nullac3: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "dolor_1_f": [ + "<string>", + "<string>" + ], + "velit_c": [ + "<string>", + "<string>" + ] + }, + "links": { + "est_c62": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "qui_d": [ + "<string>", + "<string>" + ], + "sed_5e8": [ + "<string>", + "<string>" + ], + "adff": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "consequat_1": [ + "<string>", + "<string>" + ] + } + } + ] + } + /settings/v3/currencies/exchange-rates/batch/read: + post: + tags: + - Currencies API > Currency + summary: post-/settings/v3/currencies/exchange-rates/batch/read + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - id: <string> + - id: <string> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - conversionRate: <number> + createdAt: <dateTime> + effectiveAt: <dateTime> + fromCurrencyCode: NZD + id: <string> + toCurrencyCode: AOA + updatedAt: <dateTime> + visibleInUI: <boolean> + - conversionRate: <number> + createdAt: <dateTime> + effectiveAt: <dateTime> + fromCurrencyCode: KRW + id: <string> + toCurrencyCode: BOV + updatedAt: <dateTime> + visibleInUI: <boolean> + startedAt: <dateTime> + status: PROCESSING + requestedAt: <dateTime> + links: + reprehenderitc4_: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - conversionRate: <number> + createdAt: <dateTime> + effectiveAt: <dateTime> + fromCurrencyCode: CVE + id: <string> + toCurrencyCode: USD + updatedAt: <dateTime> + visibleInUI: <boolean> + - conversionRate: <number> + createdAt: <dateTime> + effectiveAt: <dateTime> + fromCurrencyCode: KZT + id: <string> + toCurrencyCode: TND + updatedAt: <dateTime> + visibleInUI: <boolean> + startedAt: <dateTime> + status: PENDING + numErrors: <integer> + requestedAt: <dateTime> + links: + suntf: <string> + errors: + - category: <string> + context: + veniam_4d: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + consecteturc6: + - <string> + - <string> + veniam40: + - <string> + - <string> + enime6_: + - <string> + - <string> + laboris_65: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + est671: + - <string> + - <string> + adipisicingb88: + - <string> + - <string> + sed_260: + - <string> + - <string> + links: + cupidatat_ed: <string> + in_c: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + - category: <string> + context: + ipsum_1: + - <string> + - <string> + errors: + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + Excepteur6: + - <string> + - <string> + - message: <string> + subCategory: <string> + code: <string> + in: <string> + context: + veniame0: + - <string> + - <string> + pariatur_b: + - <string> + - <string> + Lorem_2f: + - <string> + - <string> + officia82: + - <string> + - <string> + proident_99: + - <string> + - <string> + links: + enime: <string> + ullamco881: <string> + nullac3: <string> + message: <string> + status: <string> + subCategory: {} + id: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "context": { + "dolor_1_f": [ + "<string>", + "<string>" + ], + "velit_c": [ + "<string>", + "<string>" + ] + }, + "links": { + "est_c62": "<string>" + }, + "errors": [ + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "qui_d": [ + "<string>", + "<string>" + ], + "sed_5e8": [ + "<string>", + "<string>" + ], + "adff": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "subCategory": "<string>", + "code": "<string>", + "in": "<string>", + "context": { + "consequat_1": [ + "<string>", + "<string>" + ] + } + } + ] + } diff --git a/server/node-service/src/plugins/hubspot/specsV4/Webhooks API Collections.json b/server/node-service/src/plugins/hubspot/specsV4/Webhooks API Collections.json new file mode 100644 index 000000000..09ba33634 --- /dev/null +++ b/server/node-service/src/plugins/hubspot/specsV4/Webhooks API Collections.json @@ -0,0 +1,1252 @@ +openapi: 3.0.0 +info: + title: Webhooks API Collections + description: >- + The Webhooks API allows you to subscribe to events happening in a HubSpot + account with your integration installed. Rather than making an API call when + an event happens in a connected account, HubSpot can send an HTTP request to + an endpoint you configure. You can configure subscribed events in your app’s + settings or using the endpoints detailed below. Webhooks can be more + scalable than regularly polling for changes, especially for apps with a + large install base. + + + Using the Webhooks API requires the following: + + + - You must set up a HubSpot app to use webhooks by subscribing to the events + you want to be notified about, and by specifying a URL to send those + notifications. See the [prerequisites + documentation](https://developers.hubspot.com/docs/faq/integration-platform-api-requirements) + for more details about creating an app. + + - You must deploy a publicly available and secure (HTTPS) endpoint for that + URL that can handle the webhook payloads specified in this documentation. + + + Webhooks are set up for a [HubSpot + app](https://developers.hubspot.com/docs/faq/how-do-i-create-an-app-in-hubspot), + not individual accounts. Any account that install your app by going through + the [OAuth + flow](https://developers.hubspot.com/docs/methods/oauth2/initiate-oauth-integration) + will be subscribed to its webhook subscriptions. + + + You can subscribe to CRM object events, which includes contacts, companies, + deals, tickets, products and line items, as well as conversations events. + + + **Fork the collections using Run in Postman:** + + + [<img src="https://run.pstmn.io/button.svg" alt="Run In + Postman">](https://app.getpostman.com/run-collection/26126890-83294135-c996-4e81-8491-4cef2c52eab8?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D26126890-83294135-c996-4e81-8491-4cef2c52eab8%26entityType%3Dcollection%26workspaceId%3Dd7645f33-539d-49c6-9e0c-efa6faae355d) + version: 1.0.0 +servers: + - url: http://{{baseurl}} +components: + securitySchemes: + apikeyAuth: + type: http + scheme: apikey +tags: + - name: Webhooks API + description: >- + Provides a way for apps to subscribe to certain change events in HubSpot. + Once configured, apps will receive event payloads containing details about + the changes at a specified target URL. There can only be one target URL + for receiving event notifications per app. + - name: Webhooks API > Settings + - name: Webhooks API > Subscriptions +paths: + /webhooks/v3/{appId}/settings: + get: + tags: + - Webhooks API > Settings + summary: get-/webhooks/v3/{app Id}/settings get All + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: appId + in: path + schema: + type: string + required: true + example: <integer> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + targetUrl: <string> + throttling: + maxConcurrentRequests: <integer> + period: ROLLING_MINUTE + updatedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "nisi2": [ + "<string>", + "<string>" + ], + "nisi_bd0": [ + "<string>", + "<string>" + ], + "ad_a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "nisidf": [ + "<string>", + "<string>" + ], + "amet73d": [ + "<string>", + "<string>" + ], + "in9e": [ + "<string>", + "<string>" + ], + "Lorem_b47": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ipsum_d00": [ + "<string>", + "<string>" + ] + }, + "links": { + "velit__8d": "<string>", + "amet8b": "<string>" + } + } + put: + tags: + - Webhooks API > Settings + summary: put-/webhooks/v3/{app Id}/settings configure + requestBody: + content: + application/json: + schema: + type: object + example: + targetUrl: <string> + throttling: + maxConcurrentRequests: <integer> + period: ROLLING_MINUTE + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: appId + in: path + schema: + type: string + required: true + example: <integer> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + createdAt: <dateTime> + targetUrl: <string> + throttling: + maxConcurrentRequests: <integer> + period: ROLLING_MINUTE + updatedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "nisi2": [ + "<string>", + "<string>" + ], + "nisi_bd0": [ + "<string>", + "<string>" + ], + "ad_a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "nisidf": [ + "<string>", + "<string>" + ], + "amet73d": [ + "<string>", + "<string>" + ], + "in9e": [ + "<string>", + "<string>" + ], + "Lorem_b47": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ipsum_d00": [ + "<string>", + "<string>" + ] + }, + "links": { + "velit__8d": "<string>", + "amet8b": "<string>" + } + } + delete: + tags: + - Webhooks API > Settings + summary: delete-/webhooks/v3/{app Id}/settings clear + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: appId + in: path + schema: + type: string + required: true + example: <integer> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "nisi2": [ + "<string>", + "<string>" + ], + "nisi_bd0": [ + "<string>", + "<string>" + ], + "ad_a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "nisidf": [ + "<string>", + "<string>" + ], + "amet73d": [ + "<string>", + "<string>" + ], + "in9e": [ + "<string>", + "<string>" + ], + "Lorem_b47": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ipsum_d00": [ + "<string>", + "<string>" + ] + }, + "links": { + "velit__8d": "<string>", + "amet8b": "<string>" + } + } + /webhooks/v3/{appId}/subscriptions/{subscriptionId}: + get: + tags: + - Webhooks API > Subscriptions + summary: get-/webhooks/v3/{app Id}/subscriptions/{subscription Id} get By Id + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: appId + in: path + schema: + type: string + required: true + example: <integer> + - name: subscriptionId + in: path + schema: + type: string + required: true + example: <integer> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + active: <boolean> + createdAt: <dateTime> + eventType: deal.propertyChange + id: <string> + propertyName: <string> + updatedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "nisi2": [ + "<string>", + "<string>" + ], + "nisi_bd0": [ + "<string>", + "<string>" + ], + "ad_a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "nisidf": [ + "<string>", + "<string>" + ], + "amet73d": [ + "<string>", + "<string>" + ], + "in9e": [ + "<string>", + "<string>" + ], + "Lorem_b47": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ipsum_d00": [ + "<string>", + "<string>" + ] + }, + "links": { + "velit__8d": "<string>", + "amet8b": "<string>" + } + } + delete: + tags: + - Webhooks API > Subscriptions + summary: delete-/webhooks/v3/{app Id}/subscriptions/{subscription Id} archive + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: '*/*' + - name: appId + in: path + schema: + type: string + required: true + example: <integer> + - name: subscriptionId + in: path + schema: + type: string + required: true + example: <integer> + responses: + '204': + description: No Content + content: + text/plain: + schema: + type: string + example: null + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "nisi2": [ + "<string>", + "<string>" + ], + "nisi_bd0": [ + "<string>", + "<string>" + ], + "ad_a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "nisidf": [ + "<string>", + "<string>" + ], + "amet73d": [ + "<string>", + "<string>" + ], + "in9e": [ + "<string>", + "<string>" + ], + "Lorem_b47": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ipsum_d00": [ + "<string>", + "<string>" + ] + }, + "links": { + "velit__8d": "<string>", + "amet8b": "<string>" + } + } + patch: + tags: + - Webhooks API > Subscriptions + summary: patch-/webhooks/v3/{app Id}/subscriptions/{subscription Id} update + requestBody: + content: + application/json: + schema: + type: object + example: + active: <boolean> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: appId + in: path + schema: + type: string + required: true + example: <integer> + - name: subscriptionId + in: path + schema: + type: string + required: true + example: <integer> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + active: <boolean> + createdAt: <dateTime> + eventType: deal.propertyChange + id: <string> + propertyName: <string> + updatedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "nisi2": [ + "<string>", + "<string>" + ], + "nisi_bd0": [ + "<string>", + "<string>" + ], + "ad_a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "nisidf": [ + "<string>", + "<string>" + ], + "amet73d": [ + "<string>", + "<string>" + ], + "in9e": [ + "<string>", + "<string>" + ], + "Lorem_b47": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ipsum_d00": [ + "<string>", + "<string>" + ] + }, + "links": { + "velit__8d": "<string>", + "amet8b": "<string>" + } + } + /webhooks/v3/{appId}/subscriptions: + get: + tags: + - Webhooks API > Subscriptions + summary: get-/webhooks/v3/{app Id}/subscriptions get All + security: + - apikeyAuth: [] + parameters: + - name: Accept + in: header + schema: + type: string + example: application/json + - name: appId + in: path + schema: + type: string + required: true + example: <integer> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + results: + - active: <boolean> + createdAt: <dateTime> + eventType: deal.restore + id: <string> + propertyName: <string> + updatedAt: <dateTime> + - active: <boolean> + createdAt: <dateTime> + eventType: line_item.restore + id: <string> + propertyName: <string> + updatedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "nisi2": [ + "<string>", + "<string>" + ], + "nisi_bd0": [ + "<string>", + "<string>" + ], + "ad_a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "nisidf": [ + "<string>", + "<string>" + ], + "amet73d": [ + "<string>", + "<string>" + ], + "in9e": [ + "<string>", + "<string>" + ], + "Lorem_b47": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ipsum_d00": [ + "<string>", + "<string>" + ] + }, + "links": { + "velit__8d": "<string>", + "amet8b": "<string>" + } + } + post: + tags: + - Webhooks API > Subscriptions + summary: post-/webhooks/v3/{app Id}/subscriptions create + requestBody: + content: + application/json: + schema: + type: object + example: + eventType: conversation.newMessage + propertyName: <string> + active: <boolean> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: appId + in: path + schema: + type: string + required: true + example: <integer> + responses: + '201': + description: Created + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + active: <boolean> + createdAt: <dateTime> + eventType: deal.propertyChange + id: <string> + propertyName: <string> + updatedAt: <dateTime> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "nisi2": [ + "<string>", + "<string>" + ], + "nisi_bd0": [ + "<string>", + "<string>" + ], + "ad_a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "nisidf": [ + "<string>", + "<string>" + ], + "amet73d": [ + "<string>", + "<string>" + ], + "in9e": [ + "<string>", + "<string>" + ], + "Lorem_b47": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ipsum_d00": [ + "<string>", + "<string>" + ] + }, + "links": { + "velit__8d": "<string>", + "amet8b": "<string>" + } + } + /webhooks/v3/{appId}/subscriptions/batch/update: + post: + tags: + - Webhooks API > Subscriptions + summary: post-/webhooks/v3/{app Id}/subscriptions/batch/update update Batch + requestBody: + content: + application/json: + schema: + type: object + example: + inputs: + - active: <boolean> + id: <integer> + - active: <boolean> + id: <integer> + security: + - apikeyAuth: [] + parameters: + - name: Content-Type + in: header + schema: + type: string + example: application/json + - name: Accept + in: header + schema: + type: string + example: application/json + - name: appId + in: path + schema: + type: string + required: true + example: <integer> + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - active: <boolean> + createdAt: <dateTime> + eventType: conversation.privacyDeletion + id: <string> + propertyName: <string> + updatedAt: <dateTime> + - active: <boolean> + createdAt: <dateTime> + eventType: ticket.creation + id: <string> + propertyName: <string> + updatedAt: <dateTime> + startedAt: <dateTime> + status: PROCESSING + requestedAt: <dateTime> + links: + in_4ae: <string> + voluptate_e: <string> + id4: <string> + '207': + description: Multi-Status (WebDAV) (RFC 4918) + headers: + Content-Type: + schema: + type: string + example: application/json + content: + application/json: + schema: + type: object + example: + completedAt: <dateTime> + results: + - active: <boolean> + createdAt: <dateTime> + eventType: conversation.privacyDeletion + id: <string> + propertyName: <string> + updatedAt: <dateTime> + - active: <boolean> + createdAt: <dateTime> + eventType: line_item.propertyChange + id: <string> + propertyName: <string> + updatedAt: <dateTime> + startedAt: <dateTime> + status: COMPLETE + numErrors: <integer> + errors: + - category: <string> + context: + velit5: + - <string> + - <string> + nulla9: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + consequat_ee: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + sunt_9: + - <string> + - <string> + deserunt_1: + - <string> + - <string> + et__b: + - <string> + - <string> + links: + eu7f: <string> + exd: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + - category: <string> + context: + sed_0_: + - <string> + - <string> + errors: + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + ut_9: + - <string> + - <string> + qui9: + - <string> + - <string> + minim_c5: + - <string> + - <string> + - message: <string> + in: <string> + code: <string> + subCategory: <string> + context: + culpa_c2: + - <string> + - <string> + enim7e_: + - <string> + - <string> + links: + aliquip14: <string> + doloreb: <string> + sit_12: <string> + Duis_81d: <string> + message: <string> + status: <string> + id: <string> + subCategory: {} + requestedAt: <dateTime> + links: + est__e: <string> + esse_5: <string> + inb9: <string> + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: '*/*' + content: + text/plain: + schema: + type: string + example: |- + { + "category": "<string>", + "correlationId": "<uuid>", + "message": "<string>", + "subCategory": "<string>", + "errors": [ + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "nisi2": [ + "<string>", + "<string>" + ], + "nisi_bd0": [ + "<string>", + "<string>" + ], + "ad_a": [ + "<string>", + "<string>" + ] + } + }, + { + "message": "<string>", + "in": "<string>", + "code": "<string>", + "subCategory": "<string>", + "context": { + "nisidf": [ + "<string>", + "<string>" + ], + "amet73d": [ + "<string>", + "<string>" + ], + "in9e": [ + "<string>", + "<string>" + ], + "Lorem_b47": [ + "<string>", + "<string>" + ] + } + } + ], + "context": { + "ipsum_d00": [ + "<string>", + "<string>" + ] + }, + "links": { + "velit__8d": "<string>", + "amet8b": "<string>" + } + } diff --git a/server/node-service/src/plugins/index.ts b/server/node-service/src/plugins/index.ts index fb25955de..9855390f7 100644 --- a/server/node-service/src/plugins/index.ts +++ b/server/node-service/src/plugins/index.ts @@ -45,6 +45,7 @@ import serpApiPlugin from "./serpApi"; import carboneIoPlugin from "./carboneIo"; import boomiPlugin from "./boomi"; import eodhdApiPlugin from "./eodhdApi"; +// import hubspotPlugin from "./hubspot"; let plugins: (DataSourcePlugin | DataSourcePluginFactory)[] = [ @@ -109,6 +110,7 @@ let plugins: (DataSourcePlugin | DataSourcePluginFactory)[] = [ // CRM frontPlugin, + // hubspotPlugin, // E-commerce stripePlugin, diff --git a/server/node-service/src/static/plugin-icons/hubspot.svg b/server/node-service/src/static/plugin-icons/hubspot.svg new file mode 100644 index 000000000..4ab207374 --- /dev/null +++ b/server/node-service/src/static/plugin-icons/hubspot.svg @@ -0,0 +1 @@ +<svg xmlns="http://www.w3.org/2000/svg" shape-rendering="geometricPrecision" text-rendering="geometricPrecision" image-rendering="optimizeQuality" fill-rule="evenodd" clip-rule="evenodd" viewBox="0 0 489 511.8"><path fill="#FF7A59" fill-rule="nonzero" d="M375.25 168.45V107.5c16.43-7.68 26.97-24.15 27.08-42.29V63.8c0-25.95-21.05-46.99-47-46.99h-1.37c-25.95 0-46.99 21.04-46.99 46.99v1.41a46.985 46.985 0 0027.29 42.3v60.94c-23.13 3.53-44.98 13.18-63.19 27.84L103.88 66.16c1.19-4.29 1.83-8.73 1.89-13.17v-.11C105.77 23.68 82.09 0 52.88 0 23.68 0 0 23.68 0 52.88c0 29.18 23.64 52.85 52.81 52.89 9.17-.08 18.16-2.59 26.06-7.23l164.62 128.07a133.501 133.501 0 00-22.16 73.61c0 27.39 8.46 54.17 24.18 76.58l-50.06 50.06a43.926 43.926 0 00-12.43-1.81c-23.96 0-43.38 19.42-43.38 43.37 0 23.96 19.42 43.38 43.38 43.38 23.95 0 43.37-19.42 43.37-43.38v-.13a41.81 41.81 0 00-2.02-12.5l49.52-49.56a133.687 133.687 0 0081.54 27.78c73.76 0 133.57-59.81 133.57-133.57 0-66.05-48.3-122.2-113.61-132.06l-.14.07zm-20.39 200.4c-36.79-1.52-65.85-31.79-65.85-68.62 0-35.43 26.97-65.06 62.23-68.38h3.62c35.8 2.73 63.46 32.58 63.46 68.48 0 35.91-27.66 65.76-63.45 68.48l-.01.04zm0 0z"/></svg> \ No newline at end of file diff --git a/server/node-service/yarn.lock b/server/node-service/yarn.lock index f61d4ea81..14c3ac76c 100644 --- a/server/node-service/yarn.lock +++ b/server/node-service/yarn.lock @@ -4946,8 +4946,8 @@ __metadata: linkType: hard "ali-oss@npm:^6.20.0": - version: 6.21.0 - resolution: "ali-oss@npm:6.21.0" + version: 6.22.0 + resolution: "ali-oss@npm:6.22.0" dependencies: address: ^1.2.2 agentkeepalive: ^3.4.1 @@ -4974,7 +4974,7 @@ __metadata: urllib: ^2.44.0 utility: ^1.18.0 xml2js: ^0.6.2 - checksum: 26424e96c4a927e08d6aa9480a0f9db6da00b0188a7a45672f3244344f5cf6ff81aee72a8e46dcd240c98f168d09e2853ac84ae9e5764bc673b4d959a11a5e51 + checksum: 7120edb25dc92311b25a9dd782b7482a4a6d835a5cf212a6f57f6d3df153f9e09a6317a8b2bedad04b7e343a8e1be057bc032779ec06ef6df353f2a02cdf235c languageName: node linkType: hard @@ -5890,25 +5890,25 @@ __metadata: languageName: node linkType: hard -"cross-spawn@npm:^7.0.0": - version: 7.0.6 - resolution: "cross-spawn@npm:7.0.6" +"cross-spawn@npm:^7.0.3": + version: 7.0.3 + resolution: "cross-spawn@npm:7.0.3" dependencies: path-key: ^3.1.0 shebang-command: ^2.0.0 which: ^2.0.1 - checksum: 8d306efacaf6f3f60e0224c287664093fa9185680b2d195852ba9a863f85d02dcc737094c6e512175f8ee0161f9b87c73c6826034c2422e39de7d6569cf4503b + checksum: 671cc7c7288c3a8406f3c69a3ae2fc85555c04169e9d611def9a675635472614f1c0ed0ef80955d5b6d4e724f6ced67f0ad1bb006c2ea643488fcfef994d7f52 languageName: node linkType: hard -"cross-spawn@npm:^7.0.3": - version: 7.0.3 - resolution: "cross-spawn@npm:7.0.3" +"cross-spawn@npm:^7.0.6": + version: 7.0.6 + resolution: "cross-spawn@npm:7.0.6" dependencies: path-key: ^3.1.0 shebang-command: ^2.0.0 which: ^2.0.1 - checksum: 671cc7c7288c3a8406f3c69a3ae2fc85555c04169e9d611def9a675635472614f1c0ed0ef80955d5b6d4e724f6ced67f0ad1bb006c2ea643488fcfef994d7f52 + checksum: 8d306efacaf6f3f60e0224c287664093fa9185680b2d195852ba9a863f85d02dcc737094c6e512175f8ee0161f9b87c73c6826034c2422e39de7d6569cf4503b languageName: node linkType: hard @@ -6735,12 +6735,12 @@ __metadata: linkType: hard "foreground-child@npm:^3.1.0": - version: 3.3.0 - resolution: "foreground-child@npm:3.3.0" + version: 3.3.1 + resolution: "foreground-child@npm:3.3.1" dependencies: - cross-spawn: ^7.0.0 + cross-spawn: ^7.0.6 signal-exit: ^4.0.1 - checksum: 1989698488f725b05b26bc9afc8a08f08ec41807cd7b92ad85d96004ddf8243fd3e79486b8348c64a3011ae5cc2c9f0936af989e1f28339805d8bc178a75b451 + checksum: b2c1a6fc0bf0233d645d9fefdfa999abf37db1b33e5dab172b3cbfb0662b88bfbd2c9e7ab853533d199050ec6b65c03fcf078fc212d26e4990220e98c6930eef languageName: node linkType: hard @@ -8931,8 +8931,8 @@ __metadata: linkType: hard "minipass-fetch@npm:^4.0.0": - version: 4.0.0 - resolution: "minipass-fetch@npm:4.0.0" + version: 4.0.1 + resolution: "minipass-fetch@npm:4.0.1" dependencies: encoding: ^0.1.13 minipass: ^7.0.3 @@ -8941,7 +8941,7 @@ __metadata: dependenciesMeta: encoding: optional: true - checksum: 7d59a31011ab9e4d1af6562dd4c4440e425b2baf4c5edbdd2e22fb25a88629e1cdceca39953ff209da504a46021df520f18fd9a519f36efae4750ff724ddadea + checksum: 3dfca705ce887ca9ff14d73e8d8593996dea1a1ecd8101fdbb9c10549d1f9670bc8fb66ad0192769ead4c2dc01b4f9ca1cf567ded365adff17827a303b948140 languageName: node linkType: hard