img:first-child]:pt-0 data-[size=sm]:gap-3 data-[size=sm]:py-3 data-[size=sm]:has-data-[slot=card-footer]:pb-0 *:[img:first-child]:rounded-t-xl *:[img:last-child]:rounded-b-xl",
+ className
+ )}
+ {...props}
+ />
+ )
+}
+
+function CardHeader({ className, ...props }: React.ComponentProps<"div">) {
+ return (
+
+ )
+}
+
+function CardTitle({ className, ...props }: React.ComponentProps<"div">) {
+ return (
+
+ )
+}
+
+function CardDescription({ className, ...props }: React.ComponentProps<"div">) {
+ return (
+
+ )
+}
+
+function CardAction({ className, ...props }: React.ComponentProps<"div">) {
+ return (
+
+ )
+}
+
+function CardContent({ className, ...props }: React.ComponentProps<"div">) {
+ return (
+
+ )
+}
+
+function CardFooter({ className, ...props }: React.ComponentProps<"div">) {
+ return (
+
+ )
+}
+
+export {
+ Card,
+ CardHeader,
+ CardFooter,
+ CardTitle,
+ CardAction,
+ CardDescription,
+ CardContent,
+}
diff --git a/dalim-app/src/components/ui/dialog.tsx b/dalim-app/src/components/ui/dialog.tsx
new file mode 100644
index 0000000..014f5aa
--- /dev/null
+++ b/dalim-app/src/components/ui/dialog.tsx
@@ -0,0 +1,160 @@
+"use client"
+
+import * as React from "react"
+import { Dialog as DialogPrimitive } from "@base-ui/react/dialog"
+
+import { cn } from "@/lib/utils"
+import { Button } from "@/components/ui/button"
+import { XIcon } from "lucide-react"
+
+function Dialog({ ...props }: DialogPrimitive.Root.Props) {
+ return
+}
+
+function DialogTrigger({ ...props }: DialogPrimitive.Trigger.Props) {
+ return
+}
+
+function DialogPortal({ ...props }: DialogPrimitive.Portal.Props) {
+ return
+}
+
+function DialogClose({ ...props }: DialogPrimitive.Close.Props) {
+ return
+}
+
+function DialogOverlay({
+ className,
+ ...props
+}: DialogPrimitive.Backdrop.Props) {
+ return (
+
+ )
+}
+
+function DialogContent({
+ className,
+ children,
+ showCloseButton = true,
+ ...props
+}: DialogPrimitive.Popup.Props & {
+ showCloseButton?: boolean
+}) {
+ return (
+
+
+
+ {children}
+ {showCloseButton && (
+
+ }
+ >
+
+ Close
+
+ )}
+
+
+ )
+}
+
+function DialogHeader({ className, ...props }: React.ComponentProps<"div">) {
+ return (
+
+ )
+}
+
+function DialogFooter({
+ className,
+ showCloseButton = false,
+ children,
+ ...props
+}: React.ComponentProps<"div"> & {
+ showCloseButton?: boolean
+}) {
+ return (
+
+ {children}
+ {showCloseButton && (
+ }>
+ Close
+
+ )}
+
+ )
+}
+
+function DialogTitle({ className, ...props }: DialogPrimitive.Title.Props) {
+ return (
+
+ )
+}
+
+function DialogDescription({
+ className,
+ ...props
+}: DialogPrimitive.Description.Props) {
+ return (
+
+ )
+}
+
+export {
+ Dialog,
+ DialogClose,
+ DialogContent,
+ DialogDescription,
+ DialogFooter,
+ DialogHeader,
+ DialogOverlay,
+ DialogPortal,
+ DialogTitle,
+ DialogTrigger,
+}
diff --git a/dalim-app/src/components/ui/dropdown-menu.tsx b/dalim-app/src/components/ui/dropdown-menu.tsx
new file mode 100644
index 0000000..9d5ebbd
--- /dev/null
+++ b/dalim-app/src/components/ui/dropdown-menu.tsx
@@ -0,0 +1,268 @@
+"use client"
+
+import * as React from "react"
+import { Menu as MenuPrimitive } from "@base-ui/react/menu"
+
+import { cn } from "@/lib/utils"
+import { ChevronRightIcon, CheckIcon } from "lucide-react"
+
+function DropdownMenu({ ...props }: MenuPrimitive.Root.Props) {
+ return
+}
+
+function DropdownMenuPortal({ ...props }: MenuPrimitive.Portal.Props) {
+ return
+}
+
+function DropdownMenuTrigger({ ...props }: MenuPrimitive.Trigger.Props) {
+ return
+}
+
+function DropdownMenuContent({
+ align = "start",
+ alignOffset = 0,
+ side = "bottom",
+ sideOffset = 4,
+ className,
+ ...props
+}: MenuPrimitive.Popup.Props &
+ Pick<
+ MenuPrimitive.Positioner.Props,
+ "align" | "alignOffset" | "side" | "sideOffset"
+ >) {
+ return (
+
+
+
+
+
+ )
+}
+
+function DropdownMenuGroup({ ...props }: MenuPrimitive.Group.Props) {
+ return
+}
+
+function DropdownMenuLabel({
+ className,
+ inset,
+ ...props
+}: MenuPrimitive.GroupLabel.Props & {
+ inset?: boolean
+}) {
+ return (
+
+ )
+}
+
+function DropdownMenuItem({
+ className,
+ inset,
+ variant = "default",
+ ...props
+}: MenuPrimitive.Item.Props & {
+ inset?: boolean
+ variant?: "default" | "destructive"
+}) {
+ return (
+
+ )
+}
+
+function DropdownMenuSub({ ...props }: MenuPrimitive.SubmenuRoot.Props) {
+ return
+}
+
+function DropdownMenuSubTrigger({
+ className,
+ inset,
+ children,
+ ...props
+}: MenuPrimitive.SubmenuTrigger.Props & {
+ inset?: boolean
+}) {
+ return (
+
+ {children}
+
+
+ )
+}
+
+function DropdownMenuSubContent({
+ align = "start",
+ alignOffset = -3,
+ side = "right",
+ sideOffset = 0,
+ className,
+ ...props
+}: React.ComponentProps
) {
+ return (
+
+ )
+}
+
+function DropdownMenuCheckboxItem({
+ className,
+ children,
+ checked,
+ inset,
+ ...props
+}: MenuPrimitive.CheckboxItem.Props & {
+ inset?: boolean
+}) {
+ return (
+
+
+
+
+
+
+ {children}
+
+ )
+}
+
+function DropdownMenuRadioGroup({ ...props }: MenuPrimitive.RadioGroup.Props) {
+ return (
+
+ )
+}
+
+function DropdownMenuRadioItem({
+ className,
+ children,
+ inset,
+ ...props
+}: MenuPrimitive.RadioItem.Props & {
+ inset?: boolean
+}) {
+ return (
+
+
+
+
+
+
+ {children}
+
+ )
+}
+
+function DropdownMenuSeparator({
+ className,
+ ...props
+}: MenuPrimitive.Separator.Props) {
+ return (
+
+ )
+}
+
+function DropdownMenuShortcut({
+ className,
+ ...props
+}: React.ComponentProps<"span">) {
+ return (
+
+ )
+}
+
+export {
+ DropdownMenu,
+ DropdownMenuPortal,
+ DropdownMenuTrigger,
+ DropdownMenuContent,
+ DropdownMenuGroup,
+ DropdownMenuLabel,
+ DropdownMenuItem,
+ DropdownMenuCheckboxItem,
+ DropdownMenuRadioGroup,
+ DropdownMenuRadioItem,
+ DropdownMenuSeparator,
+ DropdownMenuShortcut,
+ DropdownMenuSub,
+ DropdownMenuSubTrigger,
+ DropdownMenuSubContent,
+}
diff --git a/dalim-app/src/components/ui/input.tsx b/dalim-app/src/components/ui/input.tsx
new file mode 100644
index 0000000..7d21bab
--- /dev/null
+++ b/dalim-app/src/components/ui/input.tsx
@@ -0,0 +1,20 @@
+import * as React from "react"
+import { Input as InputPrimitive } from "@base-ui/react/input"
+
+import { cn } from "@/lib/utils"
+
+function Input({ className, type, ...props }: React.ComponentProps<"input">) {
+ return (
+
+ )
+}
+
+export { Input }
diff --git a/dalim-app/src/components/ui/scroll-area.tsx b/dalim-app/src/components/ui/scroll-area.tsx
new file mode 100644
index 0000000..84c1e9f
--- /dev/null
+++ b/dalim-app/src/components/ui/scroll-area.tsx
@@ -0,0 +1,55 @@
+"use client"
+
+import * as React from "react"
+import { ScrollArea as ScrollAreaPrimitive } from "@base-ui/react/scroll-area"
+
+import { cn } from "@/lib/utils"
+
+function ScrollArea({
+ className,
+ children,
+ ...props
+}: ScrollAreaPrimitive.Root.Props) {
+ return (
+
+
+ {children}
+
+
+
+
+ )
+}
+
+function ScrollBar({
+ className,
+ orientation = "vertical",
+ ...props
+}: ScrollAreaPrimitive.Scrollbar.Props) {
+ return (
+
+
+
+ )
+}
+
+export { ScrollArea, ScrollBar }
diff --git a/dalim-app/src/components/ui/separator.tsx b/dalim-app/src/components/ui/separator.tsx
new file mode 100644
index 0000000..6e1369e
--- /dev/null
+++ b/dalim-app/src/components/ui/separator.tsx
@@ -0,0 +1,25 @@
+"use client"
+
+import { Separator as SeparatorPrimitive } from "@base-ui/react/separator"
+
+import { cn } from "@/lib/utils"
+
+function Separator({
+ className,
+ orientation = "horizontal",
+ ...props
+}: SeparatorPrimitive.Props) {
+ return (
+
+ )
+}
+
+export { Separator }
diff --git a/dalim-app/src/components/ui/sheet.tsx b/dalim-app/src/components/ui/sheet.tsx
new file mode 100644
index 0000000..78c0a76
--- /dev/null
+++ b/dalim-app/src/components/ui/sheet.tsx
@@ -0,0 +1,138 @@
+"use client"
+
+import * as React from "react"
+import { Dialog as SheetPrimitive } from "@base-ui/react/dialog"
+
+import { cn } from "@/lib/utils"
+import { Button } from "@/components/ui/button"
+import { XIcon } from "lucide-react"
+
+function Sheet({ ...props }: SheetPrimitive.Root.Props) {
+ return
+}
+
+function SheetTrigger({ ...props }: SheetPrimitive.Trigger.Props) {
+ return
+}
+
+function SheetClose({ ...props }: SheetPrimitive.Close.Props) {
+ return
+}
+
+function SheetPortal({ ...props }: SheetPrimitive.Portal.Props) {
+ return
+}
+
+function SheetOverlay({ className, ...props }: SheetPrimitive.Backdrop.Props) {
+ return (
+
+ )
+}
+
+function SheetContent({
+ className,
+ children,
+ side = "right",
+ showCloseButton = true,
+ ...props
+}: SheetPrimitive.Popup.Props & {
+ side?: "top" | "right" | "bottom" | "left"
+ showCloseButton?: boolean
+}) {
+ return (
+
+
+
+ {children}
+ {showCloseButton && (
+
+ }
+ >
+
+ Close
+
+ )}
+
+
+ )
+}
+
+function SheetHeader({ className, ...props }: React.ComponentProps<"div">) {
+ return (
+
+ )
+}
+
+function SheetFooter({ className, ...props }: React.ComponentProps<"div">) {
+ return (
+
+ )
+}
+
+function SheetTitle({ className, ...props }: SheetPrimitive.Title.Props) {
+ return (
+
+ )
+}
+
+function SheetDescription({
+ className,
+ ...props
+}: SheetPrimitive.Description.Props) {
+ return (
+
+ )
+}
+
+export {
+ Sheet,
+ SheetTrigger,
+ SheetClose,
+ SheetContent,
+ SheetHeader,
+ SheetFooter,
+ SheetTitle,
+ SheetDescription,
+}
diff --git a/dalim-app/src/components/ui/skeleton.tsx b/dalim-app/src/components/ui/skeleton.tsx
new file mode 100644
index 0000000..0118624
--- /dev/null
+++ b/dalim-app/src/components/ui/skeleton.tsx
@@ -0,0 +1,13 @@
+import { cn } from "@/lib/utils"
+
+function Skeleton({ className, ...props }: React.ComponentProps<"div">) {
+ return (
+
+ )
+}
+
+export { Skeleton }
diff --git a/dalim-app/src/components/ui/tooltip.tsx b/dalim-app/src/components/ui/tooltip.tsx
new file mode 100644
index 0000000..69e8a82
--- /dev/null
+++ b/dalim-app/src/components/ui/tooltip.tsx
@@ -0,0 +1,66 @@
+"use client"
+
+import { Tooltip as TooltipPrimitive } from "@base-ui/react/tooltip"
+
+import { cn } from "@/lib/utils"
+
+function TooltipProvider({
+ delay = 0,
+ ...props
+}: TooltipPrimitive.Provider.Props) {
+ return (
+
+ )
+}
+
+function Tooltip({ ...props }: TooltipPrimitive.Root.Props) {
+ return
+}
+
+function TooltipTrigger({ ...props }: TooltipPrimitive.Trigger.Props) {
+ return
+}
+
+function TooltipContent({
+ className,
+ side = "top",
+ sideOffset = 4,
+ align = "center",
+ alignOffset = 0,
+ children,
+ ...props
+}: TooltipPrimitive.Popup.Props &
+ Pick<
+ TooltipPrimitive.Positioner.Props,
+ "align" | "alignOffset" | "side" | "sideOffset"
+ >) {
+ return (
+
+
+
+ {children}
+
+
+
+
+ )
+}
+
+export { Tooltip, TooltipTrigger, TooltipContent, TooltipProvider }
diff --git a/dalim-app/src/hooks/use-dalim.ts b/dalim-app/src/hooks/use-dalim.ts
new file mode 100644
index 0000000..793ff02
--- /dev/null
+++ b/dalim-app/src/hooks/use-dalim.ts
@@ -0,0 +1,189 @@
+"use client";
+
+import { useQuery, useMutation, useQueryClient } from "@tanstack/react-query";
+import type {
+ Project,
+ Folder,
+ Asset,
+ Collection,
+ Workflow,
+ Approval,
+ ProcessMonitorEntry,
+ DistributionChannel,
+ DistributionJob,
+ PagingResponse,
+ SearchResponse,
+} from "@/lib/dalim-types";
+
+async function fetchAPI(url: string): Promise {
+ const res = await fetch(url);
+ if (!res.ok) throw new Error(`API error: ${res.status}`);
+ return res.json();
+}
+
+export function useProjects(limit = 20) {
+ return useQuery({
+ queryKey: ["projects", limit],
+ queryFn: () =>
+ fetchAPI>(`/api/projects?limit=${limit}`),
+ });
+}
+
+export function useProject(id: string) {
+ return useQuery({
+ queryKey: ["project", id],
+ queryFn: () => fetchAPI(`/api/projects/${id}`),
+ enabled: !!id,
+ });
+}
+
+export function useAssets(limit = 24) {
+ return useQuery({
+ queryKey: ["assets", limit],
+ queryFn: () =>
+ fetchAPI>(`/api/assets?limit=${limit}`),
+ });
+}
+
+export function useAsset(id: string) {
+ return useQuery({
+ queryKey: ["asset", id],
+ queryFn: () => fetchAPI(`/api/assets/${id}`),
+ enabled: !!id,
+ });
+}
+
+export function useSearch(query: string, limit = 24) {
+ return useQuery({
+ queryKey: ["search", query, limit],
+ queryFn: () =>
+ fetchAPI(
+ `/api/search?q=${encodeURIComponent(query)}&limit=${limit}`
+ ),
+ enabled: query.length > 0,
+ });
+}
+
+export function useWorkflows(limit = 20) {
+ return useQuery({
+ queryKey: ["workflows", limit],
+ queryFn: () =>
+ fetchAPI>(`/api/workflows?limit=${limit}`),
+ });
+}
+
+export function useApprovals(limit = 20) {
+ return useQuery({
+ queryKey: ["approvals", limit],
+ queryFn: () =>
+ fetchAPI>(`/api/approvals?limit=${limit}`),
+ });
+}
+
+export function useCollections(limit = 20) {
+ return useQuery({
+ queryKey: ["collections", limit],
+ queryFn: () =>
+ fetchAPI>(`/api/collections?limit=${limit}`),
+ });
+}
+
+export function useProcesses(limit = 20) {
+ return useQuery({
+ queryKey: ["processes", limit],
+ queryFn: () =>
+ fetchAPI>(
+ `/api/processes?limit=${limit}`
+ ),
+ });
+}
+
+// === Phase 2: Project detail & folder browsing ===
+
+export function useProjectFolders(projectId: string) {
+ return useQuery({
+ queryKey: ["project-folders", projectId],
+ queryFn: () => fetchAPI(`/api/projects/${projectId}/folders`),
+ enabled: !!projectId,
+ });
+}
+
+export function useProjectAssets(
+ projectId: string,
+ folderId?: string,
+ limit = 24
+) {
+ return useQuery({
+ queryKey: ["project-assets", projectId, folderId, limit],
+ queryFn: () => {
+ const params = new URLSearchParams({ limit: String(limit) });
+ if (folderId) params.set("folderId", folderId);
+ return fetchAPI>(
+ `/api/projects/${projectId}/assets?${params}`
+ );
+ },
+ enabled: !!projectId,
+ });
+}
+
+export function useFolderAssets(folderId: string, limit = 24) {
+ return useQuery({
+ queryKey: ["folder-assets", folderId, limit],
+ queryFn: () =>
+ fetchAPI>(
+ `/api/folders/${folderId}/assets?limit=${limit}`
+ ),
+ enabled: !!folderId,
+ });
+}
+
+export function useFolder(id: string) {
+ return useQuery({
+ queryKey: ["folder", id],
+ queryFn: () => fetchAPI(`/api/folders/${id}`),
+ enabled: !!id,
+ });
+}
+
+// === Distribution / Send-to ===
+
+export function useChannels() {
+ return useQuery({
+ queryKey: ["channels"],
+ queryFn: () => fetchAPI("/api/channels"),
+ });
+}
+
+export function useDistributionJobs(assetId?: string) {
+ return useQuery({
+ queryKey: ["distribution-jobs", assetId],
+ queryFn: () => {
+ const params = assetId ? `?assetId=${assetId}` : "";
+ return fetchAPI(`/api/distribution${params}`);
+ },
+ });
+}
+
+export function useSendToChannel() {
+ const queryClient = useQueryClient();
+ return useMutation({
+ mutationFn: async ({
+ assetId,
+ channelId,
+ }: {
+ assetId: string;
+ channelId: string;
+ }) => {
+ const res = await fetch("/api/distribution", {
+ method: "POST",
+ headers: { "Content-Type": "application/json" },
+ body: JSON.stringify({ assetId, channelId }),
+ });
+ if (!res.ok) throw new Error("Failed to send");
+ return res.json() as Promise;
+ },
+ onSuccess: () => {
+ queryClient.invalidateQueries({ queryKey: ["distribution-jobs"] });
+ },
+ });
+}
diff --git a/dalim-app/src/lib/dalim-client.ts b/dalim-app/src/lib/dalim-client.ts
new file mode 100644
index 0000000..44b11cc
--- /dev/null
+++ b/dalim-app/src/lib/dalim-client.ts
@@ -0,0 +1,68 @@
+import { GraphQLClient } from "graphql-request";
+
+interface TokenResponse {
+ access_token: string;
+ token_type: string;
+ expires_in: number;
+}
+
+let cachedToken: string | null = null;
+let tokenExpiry: number = 0;
+
+function isMockMode(): boolean {
+ return process.env.DALIM_MOCK_MODE === "true";
+}
+
+async function getAccessToken(): Promise {
+ if (cachedToken && Date.now() < tokenExpiry) {
+ return cachedToken;
+ }
+
+ const tokenUrl = process.env.DALIM_TOKEN_URL!;
+ const response = await fetch(tokenUrl, {
+ method: "POST",
+ headers: { "Content-Type": "application/x-www-form-urlencoded" },
+ body: new URLSearchParams({
+ grant_type: "password",
+ client_id: process.env.DALIM_CLIENT_ID!,
+ client_secret: process.env.DALIM_CLIENT_SECRET!,
+ username: process.env.DALIM_USERNAME!,
+ password: process.env.DALIM_PASSWORD!,
+ }),
+ });
+
+ if (!response.ok) {
+ throw new Error(`Token request failed: ${response.status} ${response.statusText}`);
+ }
+
+ const data: TokenResponse = await response.json();
+ cachedToken = data.access_token;
+ // Expire 60 seconds early to avoid edge cases
+ tokenExpiry = Date.now() + (data.expires_in - 60) * 1000;
+
+ return cachedToken;
+}
+
+export function getDalimClient(): GraphQLClient {
+ const url = process.env.DALIM_GRAPHQL_URL!;
+ return new GraphQLClient(url);
+}
+
+export async function dalimQuery(
+ query: string,
+ variables?: Record
+): Promise {
+ if (isMockMode()) {
+ throw new Error("MOCK_MODE: Use dalimMockQuery instead");
+ }
+
+ const token = await getAccessToken();
+ const client = getDalimClient();
+
+ return client.request(query, variables, {
+ Authorization: `Bearer ${token}`,
+ "Content-Type": "application/json",
+ });
+}
+
+export { isMockMode };
diff --git a/dalim-app/src/lib/dalim-queries.ts b/dalim-app/src/lib/dalim-queries.ts
new file mode 100644
index 0000000..9474417
--- /dev/null
+++ b/dalim-app/src/lib/dalim-queries.ts
@@ -0,0 +1,223 @@
+// GraphQL query strings for Dalim ES FUSiON API
+// Reference: ../docs/dalim-api-reference.md
+
+export const QUERIES = {
+ // === System ===
+ whoami: `query { whoami { login firstName lastName email } }`,
+
+ serverInformation: `query { serverInformation { version build } }`,
+
+ // === Projects ===
+ projects: `
+ query projects($filter: iFilter, $limit: Int, $cursor: ID) {
+ projects(filter: $filter, limit: $limit, cursor: $cursor) {
+ items {
+ id
+ name
+ description
+ status
+ creationDate
+ lastModificationDate
+ customer { id name }
+ }
+ cursor
+ totalCount
+ }
+ }
+ `,
+
+ projectById: `
+ query projectById($id: [ID!]!) {
+ projectById(id: $id) {
+ id
+ name
+ description
+ status
+ creationDate
+ lastModificationDate
+ customer { id name }
+ metadatas { name value }
+ }
+ }
+ `,
+
+ // === Folders ===
+ folders: `
+ query folders($filter: iFilter, $limit: Int, $cursor: ID) {
+ folders(filter: $filter, limit: $limit, cursor: $cursor) {
+ items {
+ id
+ name
+ path
+ creationDate
+ volume { id name }
+ }
+ cursor
+ totalCount
+ }
+ }
+ `,
+
+ folderById: `
+ query folderById($id: [ID!]!) {
+ folderById(id: $id) {
+ id
+ name
+ path
+ creationDate
+ volume { id name }
+ }
+ }
+ `,
+
+ // === Assets ===
+ assets: `
+ query assets($filter: iFilter, $limit: Int, $cursor: ID, $orderBy: iOrderBy) {
+ assets(filter: $filter, limit: $limit, cursor: $cursor, orderBy: $orderBy) {
+ items {
+ id
+ name
+ description
+ creationDate
+ lastModificationDate
+ currentRevision
+ mimeType
+ fileSize
+ status
+ folder { id name }
+ project { id name }
+ }
+ cursor
+ totalCount
+ }
+ }
+ `,
+
+ assetById: `
+ query assetById($id: [ID!]!) {
+ assetById(id: $id) {
+ id
+ name
+ description
+ creationDate
+ lastModificationDate
+ currentRevision
+ mimeType
+ fileSize
+ status
+ folder { id name path }
+ project { id name }
+ metadatas { name value }
+ }
+ }
+ `,
+
+ // === Search ===
+ search: `
+ query search($filter: iSearchFilter!, $facets: [String!]!, $limit: Int, $cursor: ID) {
+ search(filter: $filter, facets: $facets, limit: $limit, cursor: $cursor) {
+ items {
+ id
+ name
+ description
+ type
+ mimeType
+ creationDate
+ lastModificationDate
+ }
+ totalCount
+ cursor
+ facets { name values { value count } }
+ }
+ }
+ `,
+
+ // === Workflows ===
+ workflows: `
+ query workflows($filter: iFilter, $limit: Int, $cursor: ID) {
+ workflows(filter: $filter, limit: $limit, cursor: $cursor) {
+ items {
+ id
+ name
+ description
+ revision
+ }
+ cursor
+ totalCount
+ }
+ }
+ `,
+
+ workflowsByEntity: `
+ query workflowsByEntity($entityId: ID!) {
+ workflowsByEntity(entityId: $entityId) {
+ id
+ name
+ revision
+ }
+ }
+ `,
+
+ // === Approvals ===
+ approvals: `
+ query approvals($filter: iFilter, $limit: Int, $cursor: ID) {
+ approvals(filter: $filter, limit: $limit, cursor: $cursor) {
+ items {
+ id
+ status
+ entity { id name type }
+ approver { id login firstName lastName }
+ level
+ }
+ cursor
+ totalCount
+ }
+ }
+ `,
+
+ // === Collections ===
+ collections: `
+ query collections($filter: iFilter, $limit: Int, $cursor: ID) {
+ collections(filter: $filter, limit: $limit, cursor: $cursor) {
+ items {
+ id
+ name
+ description
+ creationDate
+ }
+ cursor
+ totalCount
+ }
+ }
+ `,
+
+ collectionById: `
+ query collectionById($id: [ID!]!) {
+ collectionById(id: $id) {
+ id
+ name
+ description
+ creationDate
+ }
+ }
+ `,
+
+ // === Process Monitoring ===
+ processMonitoring: `
+ query processMonitoring($filter: iFilter, $limit: Int, $cursor: ID) {
+ processMonitoring(filter: $filter, limit: $limit, cursor: $cursor) {
+ items {
+ id
+ name
+ status
+ progress
+ startDate
+ endDate
+ entity { id name type }
+ }
+ cursor
+ totalCount
+ }
+ }
+ `,
+} as const;
diff --git a/dalim-app/src/lib/dalim-service.ts b/dalim-app/src/lib/dalim-service.ts
new file mode 100644
index 0000000..a2062a2
--- /dev/null
+++ b/dalim-app/src/lib/dalim-service.ts
@@ -0,0 +1,351 @@
+// Unified service layer — returns mock or real data based on DALIM_MOCK_MODE
+
+import { isMockMode, dalimQuery } from "./dalim-client";
+import { QUERIES } from "./dalim-queries";
+import {
+ mockProjects,
+ mockFolders,
+ mockAssets,
+ mockCollections,
+ mockWorkflows,
+ mockApprovals,
+ mockProcesses,
+ mockChannels,
+ mockDistributionJobs,
+ folderProjectMap,
+} from "./mock/data";
+import type {
+ Project,
+ Folder,
+ Asset,
+ Collection,
+ Workflow,
+ Approval,
+ ProcessMonitorEntry,
+ DistributionChannel,
+ DistributionJob,
+ PagingResponse,
+ SearchResponse,
+} from "./dalim-types";
+
+// === Projects ===
+
+export async function getProjects(
+ limit = 20,
+ cursor?: string
+): Promise> {
+ if (isMockMode()) {
+ return {
+ items: mockProjects,
+ cursor: null,
+ totalCount: mockProjects.length,
+ };
+ }
+ const data = await dalimQuery<{ projects: PagingResponse }>(
+ QUERIES.projects,
+ { limit, cursor }
+ );
+ return data.projects;
+}
+
+export async function getProjectById(id: string): Promise {
+ if (isMockMode()) {
+ return mockProjects.find((p) => p.id === id) ?? null;
+ }
+ const data = await dalimQuery<{ projectById: Project[] }>(
+ QUERIES.projectById,
+ { id: [id] }
+ );
+ return data.projectById?.[0] ?? null;
+}
+
+// === Folders ===
+
+export async function getFolders(
+ limit = 20,
+ cursor?: string
+): Promise> {
+ if (isMockMode()) {
+ return {
+ items: mockFolders,
+ cursor: null,
+ totalCount: mockFolders.length,
+ };
+ }
+ const data = await dalimQuery<{ folders: PagingResponse }>(
+ QUERIES.folders,
+ { limit, cursor }
+ );
+ return data.folders;
+}
+
+// === Assets ===
+
+export async function getAssets(
+ limit = 24,
+ cursor?: string,
+ filter?: Record
+): Promise> {
+ if (isMockMode()) {
+ return {
+ items: mockAssets,
+ cursor: null,
+ totalCount: mockAssets.length,
+ };
+ }
+ const data = await dalimQuery<{ assets: PagingResponse }>(
+ QUERIES.assets,
+ { limit, cursor, filter }
+ );
+ return data.assets;
+}
+
+export async function getAssetById(id: string): Promise {
+ if (isMockMode()) {
+ return mockAssets.find((a) => a.id === id) ?? null;
+ }
+ const data = await dalimQuery<{ assetById: Asset[] }>(
+ QUERIES.assetById,
+ { id: [id] }
+ );
+ return data.assetById?.[0] ?? null;
+}
+
+// === Search ===
+
+export async function searchAssets(
+ query: string,
+ facets: string[] = [],
+ limit = 24,
+ cursor?: string
+): Promise {
+ if (isMockMode()) {
+ const filtered = mockAssets.filter(
+ (a) =>
+ a.name.toLowerCase().includes(query.toLowerCase()) ||
+ a.description?.toLowerCase().includes(query.toLowerCase())
+ );
+ return {
+ items: filtered.map((a) => ({
+ id: a.id,
+ name: a.name,
+ description: a.description,
+ type: "Asset",
+ mimeType: a.mimeType,
+ creationDate: a.creationDate,
+ lastModificationDate: a.lastModificationDate,
+ })),
+ totalCount: filtered.length,
+ cursor: null,
+ facets: [
+ {
+ name: "mimeType",
+ values: [
+ { value: "application/pdf", count: 3 },
+ { value: "image/tiff", count: 1 },
+ { value: "application/illustrator", count: 1 },
+ ],
+ },
+ {
+ name: "status",
+ values: [
+ { value: "APPROVED", count: 3 },
+ { value: "IN_REVIEW", count: 2 },
+ { value: "PENDING", count: 2 },
+ ],
+ },
+ ],
+ };
+ }
+ const data = await dalimQuery<{ search: SearchResponse }>(QUERIES.search, {
+ filter: { query },
+ facets,
+ limit,
+ cursor,
+ });
+ return data.search;
+}
+
+// === Workflows ===
+
+export async function getWorkflows(
+ limit = 20,
+ cursor?: string
+): Promise> {
+ if (isMockMode()) {
+ return {
+ items: mockWorkflows,
+ cursor: null,
+ totalCount: mockWorkflows.length,
+ };
+ }
+ const data = await dalimQuery<{ workflows: PagingResponse }>(
+ QUERIES.workflows,
+ { limit, cursor }
+ );
+ return data.workflows;
+}
+
+// === Approvals ===
+
+export async function getApprovals(
+ limit = 20,
+ cursor?: string
+): Promise> {
+ if (isMockMode()) {
+ return {
+ items: mockApprovals,
+ cursor: null,
+ totalCount: mockApprovals.length,
+ };
+ }
+ const data = await dalimQuery<{ approvals: PagingResponse }>(
+ QUERIES.approvals,
+ { limit, cursor }
+ );
+ return data.approvals;
+}
+
+// === Processes ===
+
+export async function getProcesses(
+ limit = 20,
+ cursor?: string
+): Promise> {
+ if (isMockMode()) {
+ return {
+ items: mockProcesses,
+ cursor: null,
+ totalCount: mockProcesses.length,
+ };
+ }
+ const data = await dalimQuery<{
+ processMonitoring: PagingResponse;
+ }>(QUERIES.processMonitoring, { limit, cursor });
+ return data.processMonitoring;
+}
+
+// === Collections ===
+
+export async function getCollections(
+ limit = 20,
+ cursor?: string
+): Promise> {
+ if (isMockMode()) {
+ return {
+ items: mockCollections,
+ cursor: null,
+ totalCount: mockCollections.length,
+ };
+ }
+ const data = await dalimQuery<{ collections: PagingResponse }>(
+ QUERIES.collections,
+ { limit, cursor }
+ );
+ return data.collections;
+}
+
+// === Project-specific queries ===
+
+export async function getFoldersByProject(
+ projectId: string
+): Promise {
+ if (isMockMode()) {
+ const folderIds = Object.entries(folderProjectMap)
+ .filter(([, pId]) => pId === projectId)
+ .map(([fId]) => fId);
+ return mockFolders.filter((f) => folderIds.includes(f.id));
+ }
+ // Real API: use folders query with project filter
+ const data = await dalimQuery<{ folders: PagingResponse }>(
+ QUERIES.folders,
+ { filter: { projectId }, limit: 100 }
+ );
+ return data.folders.items;
+}
+
+export async function getAssetsByProject(
+ projectId: string,
+ folderId?: string,
+ limit = 24,
+ cursor?: string
+): Promise> {
+ if (isMockMode()) {
+ let filtered = mockAssets.filter((a) => a.project?.id === projectId);
+ if (folderId) {
+ filtered = filtered.filter((a) => a.folder?.id === folderId);
+ }
+ return { items: filtered, cursor: null, totalCount: filtered.length };
+ }
+ const filter: Record = { projectId };
+ if (folderId) filter.folderId = folderId;
+ const data = await dalimQuery<{ assets: PagingResponse }>(
+ QUERIES.assets,
+ { filter, limit, cursor }
+ );
+ return data.assets;
+}
+
+export async function getAssetsByFolder(
+ folderId: string,
+ limit = 24,
+ cursor?: string
+): Promise> {
+ if (isMockMode()) {
+ const filtered = mockAssets.filter((a) => a.folder?.id === folderId);
+ return { items: filtered, cursor: null, totalCount: filtered.length };
+ }
+ const data = await dalimQuery<{ assets: PagingResponse }>(
+ QUERIES.assets,
+ { filter: { folderId }, limit, cursor }
+ );
+ return data.assets;
+}
+
+export async function getFolderById(id: string): Promise {
+ if (isMockMode()) {
+ return mockFolders.find((f) => f.id === id) ?? null;
+ }
+ const data = await dalimQuery<{ folderById: Folder[] }>(
+ QUERIES.folderById,
+ { id: [id] }
+ );
+ return data.folderById?.[0] ?? null;
+}
+
+// === Distribution Channels ===
+
+export async function getChannels(): Promise {
+ // Mock-only for now — real API would use a custom integration layer
+ return mockChannels;
+}
+
+export async function getDistributionJobs(
+ assetId?: string
+): Promise {
+ let jobs = mockDistributionJobs;
+ if (assetId) {
+ jobs = jobs.filter((j) => j.assetId === assetId);
+ }
+ return jobs;
+}
+
+export async function sendToChannel(
+ assetId: string,
+ channelId: string
+): Promise {
+ const asset = mockAssets.find((a) => a.id === assetId);
+ const channel = mockChannels.find((c) => c.id === channelId);
+ const job: DistributionJob = {
+ id: `DJ${Date.now()}`,
+ assetId,
+ assetName: asset?.name ?? assetId,
+ channelId,
+ channelName: channel?.name ?? channelId,
+ status: "queued",
+ initiatedBy: "dporter",
+ initiatedAt: new Date().toISOString(),
+ };
+ mockDistributionJobs.push(job);
+ return job;
+}
diff --git a/dalim-app/src/lib/dalim-types.ts b/dalim-app/src/lib/dalim-types.ts
new file mode 100644
index 0000000..c672fc6
--- /dev/null
+++ b/dalim-app/src/lib/dalim-types.ts
@@ -0,0 +1,148 @@
+// TypeScript types for Dalim ES FUSiON API responses
+
+export interface PagingResponse {
+ items: T[];
+ cursor: string | null;
+ totalCount: number;
+}
+
+export interface FacetValue {
+ value: string;
+ count: number;
+}
+
+export interface Facet {
+ name: string;
+ values: FacetValue[];
+}
+
+// === Core Entities ===
+
+export interface Project {
+ id: string;
+ name: string;
+ description?: string;
+ status?: string;
+ creationDate?: string;
+ lastModificationDate?: string;
+ customer?: { id: string; name: string };
+ metadatas?: MetadataValue[];
+}
+
+export interface Folder {
+ id: string;
+ name: string;
+ path?: string;
+ creationDate?: string;
+ volume?: { id: string; name: string };
+}
+
+export interface Asset {
+ id: string;
+ name: string;
+ description?: string;
+ creationDate?: string;
+ lastModificationDate?: string;
+ currentRevision?: number;
+ mimeType?: string;
+ fileSize?: number;
+ status?: string;
+ folder?: { id: string; name: string; path?: string };
+ project?: { id: string; name: string };
+ metadatas?: MetadataValue[];
+}
+
+export interface MetadataValue {
+ name: string;
+ value: string;
+}
+
+export interface Collection {
+ id: string;
+ name: string;
+ description?: string;
+ creationDate?: string;
+}
+
+// === Workflow & Approval ===
+
+export interface Workflow {
+ id: string;
+ name: string;
+ description?: string;
+ revision?: number;
+}
+
+export interface Approval {
+ id: string;
+ status: string;
+ entity: { id: string; name: string; type: string };
+ approver: { id: string; login: string; firstName: string; lastName: string };
+ level: number;
+}
+
+export interface ProcessMonitorEntry {
+ id: string;
+ name: string;
+ status: string;
+ progress?: number;
+ startDate?: string;
+ endDate?: string;
+ entity?: { id: string; name: string; type: string };
+}
+
+// === Search ===
+
+export interface SearchResult {
+ id: string;
+ name: string;
+ description?: string;
+ type: string;
+ mimeType?: string;
+ creationDate?: string;
+ lastModificationDate?: string;
+}
+
+export interface SearchResponse {
+ items: SearchResult[];
+ totalCount: number;
+ cursor: string | null;
+ facets: Facet[];
+}
+
+// === Distribution / Send-to Destinations ===
+
+export interface DistributionChannel {
+ id: string;
+ name: string;
+ category: "pim" | "social" | "web" | "instore" | "print" | "advertising" | "google";
+ icon: string;
+ description: string;
+ status: "connected" | "available" | "coming_soon";
+}
+
+export interface DistributionJob {
+ id: string;
+ assetId: string;
+ assetName: string;
+ channelId: string;
+ channelName: string;
+ status: "queued" | "processing" | "completed" | "failed";
+ initiatedBy: string;
+ initiatedAt: string;
+ completedAt?: string;
+}
+
+// === Auth ===
+
+export interface WhoAmI {
+ login: string;
+ firstName: string;
+ lastName: string;
+ email: string;
+}
+
+export interface ServerInfo {
+ version: string;
+ build: string;
+}
diff --git a/dalim-app/src/lib/mock/data.ts b/dalim-app/src/lib/mock/data.ts
new file mode 100644
index 0000000..e710fd1
--- /dev/null
+++ b/dalim-app/src/lib/mock/data.ts
@@ -0,0 +1,305 @@
+import type {
+ Project,
+ Folder,
+ Asset,
+ Collection,
+ Workflow,
+ Approval,
+ ProcessMonitorEntry,
+ SearchResult,
+ DistributionChannel,
+ DistributionJob,
+} from "@/lib/dalim-types";
+
+// === Mock Projects ===
+export const mockProjects: Project[] = [
+ {
+ id: "P001",
+ name: "Spring Campaign 2024",
+ description: "Marketing assets for spring product launch",
+ status: "ACTIVE",
+ creationDate: "2024-01-15T10:00:00Z",
+ lastModificationDate: "2024-03-20T14:30:00Z",
+ customer: { id: "C001", name: "Acme Corp" },
+ },
+ {
+ id: "P002",
+ name: "Product Packaging v3",
+ description: "Updated packaging design files for Q2 release",
+ status: "ACTIVE",
+ creationDate: "2024-02-01T09:00:00Z",
+ lastModificationDate: "2024-03-18T11:00:00Z",
+ customer: { id: "C001", name: "Acme Corp" },
+ },
+ {
+ id: "P003",
+ name: "Annual Report 2023",
+ description: "Corporate annual report design and print files",
+ status: "COMPLETED",
+ creationDate: "2023-11-01T08:00:00Z",
+ lastModificationDate: "2024-01-10T16:00:00Z",
+ customer: { id: "C002", name: "Global Industries" },
+ },
+ {
+ id: "P004",
+ name: "Website Rebrand",
+ description: "New brand identity assets for website refresh",
+ status: "ACTIVE",
+ creationDate: "2024-03-01T10:00:00Z",
+ lastModificationDate: "2024-03-25T09:00:00Z",
+ customer: { id: "C003", name: "TechStart Inc" },
+ },
+ {
+ id: "P005",
+ name: "Trade Show Materials",
+ description: "Booth graphics, brochures, and digital displays",
+ status: "IN_REVIEW",
+ creationDate: "2024-02-15T14:00:00Z",
+ lastModificationDate: "2024-03-22T10:00:00Z",
+ customer: { id: "C002", name: "Global Industries" },
+ },
+];
+
+// === Folder → Project mapping ===
+export const folderProjectMap: Record = {
+ F001: "P001", F002: "P001", F003: "P001",
+ F004: "P002", F005: "P002",
+ F006: "P003", F007: "P004", F008: "P004",
+ F009: "P005", F010: "P005",
+};
+
+// === Mock Folders ===
+export const mockFolders: Folder[] = [
+ { id: "F001", name: "Print Ready", path: "/Spring Campaign 2024/Print Ready", creationDate: "2024-01-15T10:00:00Z" },
+ { id: "F002", name: "Digital", path: "/Spring Campaign 2024/Digital", creationDate: "2024-01-15T10:00:00Z" },
+ { id: "F003", name: "Photography", path: "/Spring Campaign 2024/Photography", creationDate: "2024-01-20T09:00:00Z" },
+ { id: "F004", name: "Artwork", path: "/Product Packaging v3/Artwork", creationDate: "2024-02-01T09:00:00Z" },
+ { id: "F005", name: "Proofs", path: "/Product Packaging v3/Proofs", creationDate: "2024-02-05T11:00:00Z" },
+ { id: "F006", name: "Final Files", path: "/Annual Report 2023/Final Files", creationDate: "2023-12-01T09:00:00Z" },
+ { id: "F007", name: "Logos", path: "/Website Rebrand/Logos", creationDate: "2024-03-01T10:00:00Z" },
+ { id: "F008", name: "Style Guide", path: "/Website Rebrand/Style Guide", creationDate: "2024-03-02T10:00:00Z" },
+ { id: "F009", name: "Booth Graphics", path: "/Trade Show Materials/Booth Graphics", creationDate: "2024-02-15T14:00:00Z" },
+ { id: "F010", name: "Brochures", path: "/Trade Show Materials/Brochures", creationDate: "2024-02-15T14:00:00Z" },
+];
+
+// === Mock Assets ===
+export const mockAssets: Asset[] = [
+ {
+ id: "A001",
+ name: "hero-banner-spring-v3.pdf",
+ description: "Main hero banner for spring campaign landing page",
+ creationDate: "2024-01-20T10:00:00Z",
+ lastModificationDate: "2024-03-15T14:30:00Z",
+ currentRevision: 3,
+ mimeType: "application/pdf",
+ fileSize: 4500000,
+ status: "APPROVED",
+ folder: { id: "F001", name: "Print Ready", path: "/Spring Campaign 2024/Print Ready" },
+ project: { id: "P001", name: "Spring Campaign 2024" },
+ },
+ {
+ id: "A002",
+ name: "product-shot-01.tif",
+ description: "Main product photography - front angle",
+ creationDate: "2024-02-10T09:00:00Z",
+ lastModificationDate: "2024-03-10T11:00:00Z",
+ currentRevision: 1,
+ mimeType: "image/tiff",
+ fileSize: 85000000,
+ status: "APPROVED",
+ folder: { id: "F003", name: "Photography" },
+ project: { id: "P001", name: "Spring Campaign 2024" },
+ },
+ {
+ id: "A003",
+ name: "packaging-front-v2.ai",
+ description: "Front panel design for primary packaging",
+ creationDate: "2024-02-05T14:00:00Z",
+ lastModificationDate: "2024-03-20T16:00:00Z",
+ currentRevision: 2,
+ mimeType: "application/illustrator",
+ fileSize: 12000000,
+ status: "IN_REVIEW",
+ folder: { id: "F004", name: "Artwork" },
+ project: { id: "P002", name: "Product Packaging v3" },
+ },
+ {
+ id: "A004",
+ name: "social-media-kit.zip",
+ description: "Complete social media asset package - all sizes",
+ creationDate: "2024-03-01T10:00:00Z",
+ lastModificationDate: "2024-03-18T15:00:00Z",
+ currentRevision: 1,
+ mimeType: "application/zip",
+ fileSize: 25000000,
+ status: "PENDING",
+ folder: { id: "F002", name: "Digital" },
+ project: { id: "P001", name: "Spring Campaign 2024" },
+ },
+ {
+ id: "A005",
+ name: "annual-report-final.indd",
+ description: "Final InDesign file for annual report",
+ creationDate: "2023-12-15T09:00:00Z",
+ lastModificationDate: "2024-01-08T14:00:00Z",
+ currentRevision: 5,
+ mimeType: "application/x-indesign",
+ fileSize: 150000000,
+ status: "APPROVED",
+ folder: { id: "F001", name: "Print Ready" },
+ project: { id: "P003", name: "Annual Report 2023" },
+ },
+ {
+ id: "A006",
+ name: "booth-backdrop-3m.pdf",
+ description: "3-meter booth backdrop for trade show",
+ creationDate: "2024-02-20T11:00:00Z",
+ lastModificationDate: "2024-03-22T09:00:00Z",
+ currentRevision: 2,
+ mimeType: "application/pdf",
+ fileSize: 35000000,
+ status: "IN_REVIEW",
+ folder: { id: "F005", name: "Proofs" },
+ project: { id: "P005", name: "Trade Show Materials" },
+ },
+ {
+ id: "A007",
+ name: "logo-rebrand-primary.svg",
+ description: "New primary logo - full color",
+ creationDate: "2024-03-05T10:00:00Z",
+ lastModificationDate: "2024-03-25T08:00:00Z",
+ currentRevision: 4,
+ mimeType: "image/svg+xml",
+ fileSize: 45000,
+ status: "APPROVED",
+ folder: { id: "F002", name: "Digital" },
+ project: { id: "P004", name: "Website Rebrand" },
+ },
+ {
+ id: "A008",
+ name: "brochure-trifold-v1.pdf",
+ description: "Tri-fold brochure for trade show distribution",
+ creationDate: "2024-03-10T14:00:00Z",
+ lastModificationDate: "2024-03-21T16:00:00Z",
+ currentRevision: 1,
+ mimeType: "application/pdf",
+ fileSize: 8500000,
+ status: "PENDING",
+ folder: { id: "F005", name: "Proofs" },
+ project: { id: "P005", name: "Trade Show Materials" },
+ },
+];
+
+// === Mock Collections ===
+export const mockCollections: Collection[] = [
+ { id: "COL001", name: "Approved for Print", description: "All assets approved for print production", creationDate: "2024-01-01T00:00:00Z" },
+ { id: "COL002", name: "Brand Guidelines", description: "Core brand identity assets and guidelines", creationDate: "2024-01-01T00:00:00Z" },
+ { id: "COL003", name: "Q2 Deliverables", description: "All deliverables due in Q2 2024", creationDate: "2024-03-01T00:00:00Z" },
+];
+
+// === Mock Workflows ===
+export const mockWorkflows: Workflow[] = [
+ { id: "W001", name: "Print Approval", description: "Standard print approval workflow — preflight, color check, sign-off", revision: 1 },
+ { id: "W002", name: "Digital Review", description: "Digital asset review and approval for web & app", revision: 2 },
+ { id: "W003", name: "Packaging QC", description: "Quality control for packaging files — dielines, barcode verification", revision: 1 },
+ { id: "W004", name: "Send to Social Platforms", description: "Distribute approved assets to Meta, TikTok, LinkedIn", revision: 3 },
+ { id: "W005", name: "Send to PIM", description: "Sync product images and data sheets to Stibo STEP", revision: 2 },
+ { id: "W006", name: "Send to Google Platforms", description: "Push creatives to Google Ads, Performance Max, CM360, YouTube", revision: 1 },
+ { id: "W007", name: "In-Store Distribution", description: "Distribute to ESL, in-store TV, POP displays, and digital screens", revision: 1 },
+ { id: "W008", name: "Send to E-Commerce", description: "Publish product assets to website, mobile app, and PWA storefront", revision: 4 },
+ { id: "W009", name: "Print Fulfillment", description: "Send to print production — flyers, catalogues, large-format", revision: 2 },
+ { id: "W010", name: "Programmatic Distribution", description: "Push ad creatives to DV360 and Trade Desk campaigns", revision: 1 },
+];
+
+// === Mock Approvals ===
+export const mockApprovals: Approval[] = [
+ {
+ id: "AP001",
+ status: "PENDING",
+ entity: { id: "A003", name: "packaging-front-v2.ai", type: "Asset" },
+ approver: { id: "U001", login: "jsmith", firstName: "John", lastName: "Smith" },
+ level: 1,
+ },
+ {
+ id: "AP002",
+ status: "PENDING",
+ entity: { id: "A006", name: "booth-backdrop-3m.pdf", type: "Asset" },
+ approver: { id: "U002", login: "mwilson", firstName: "Maria", lastName: "Wilson" },
+ level: 1,
+ },
+ {
+ id: "AP003",
+ status: "APPROVED",
+ entity: { id: "A001", name: "hero-banner-spring-v3.pdf", type: "Asset" },
+ approver: { id: "U001", login: "jsmith", firstName: "John", lastName: "Smith" },
+ level: 2,
+ },
+ {
+ id: "AP004",
+ status: "PENDING",
+ entity: { id: "A008", name: "brochure-trifold-v1.pdf", type: "Asset" },
+ approver: { id: "U003", login: "dporter", firstName: "Dave", lastName: "Porter" },
+ level: 1,
+ },
+];
+
+// === Mock Distribution Channels (from MMS Tech Architecture) ===
+export const mockChannels: DistributionChannel[] = [
+ { id: "CH01", name: "PIM (Stibo STEP)", category: "pim", icon: "database", description: "Product Information Management — sync product data & assets", status: "connected" },
+ { id: "CH02", name: "Website (Unified Platform)", category: "web", icon: "globe", description: "MediaMarkt.es web storefront", status: "connected" },
+ { id: "CH03", name: "Mobile App", category: "web", icon: "smartphone", description: "MediaMarkt mobile app (Unified Platform)", status: "connected" },
+ { id: "CH04", name: "E-Commerce (Shop/PWA)", category: "web", icon: "shopping-cart", description: "Consumer web shop & progressive web app", status: "connected" },
+ { id: "CH05", name: "Meta (Facebook & Instagram)", category: "social", icon: "facebook", description: "Publish to Facebook & Instagram feeds, stories, and ads", status: "connected" },
+ { id: "CH06", name: "TikTok", category: "social", icon: "video", description: "Push creative assets to TikTok Ads Manager", status: "connected" },
+ { id: "CH07", name: "LinkedIn", category: "social", icon: "linkedin", description: "Distribute to LinkedIn company page & ad campaigns", status: "available" },
+ { id: "CH08", name: "Google Ads & Performance Max", category: "google", icon: "google", description: "Google Ads, Performance Max, CM360, YouTube", status: "connected" },
+ { id: "CH09", name: "YouTube", category: "google", icon: "youtube", description: "Upload video assets to YouTube channels", status: "available" },
+ { id: "CH10", name: "Electronic Shelf Labels (Pricer)", category: "instore", icon: "tag", description: "Push pricing & product images to in-store ESL", status: "connected" },
+ { id: "CH11", name: "In-Store TV", category: "instore", icon: "monitor", description: "Digital signage content for in-store TV screens", status: "connected" },
+ { id: "CH12", name: "In-Store Screens (Digital)", category: "instore", icon: "layout", description: "Interactive in-store display screens", status: "available" },
+ { id: "CH13", name: "In-Store POP", category: "instore", icon: "printer", description: "Point-of-purchase materials & signage", status: "available" },
+ { id: "CH14", name: "Print Fulfillment", category: "print", icon: "printer", description: "Flyers, catalogues, and print production", status: "connected" },
+ { id: "CH15", name: "Customer Comms Hub", category: "advertising", icon: "mail", description: "Email, SMS, and push notifications (Unified Platform)", status: "connected" },
+ { id: "CH16", name: "Programmatic (DV360 / Trade Desk)", category: "advertising", icon: "target", description: "Programmatic display & video advertising", status: "connected" },
+ { id: "CH17", name: "Retail Media & Marketplace", category: "advertising", icon: "store", description: "Retail media network and marketplace listings", status: "coming_soon" },
+];
+
+// === Mock Distribution Jobs ===
+export const mockDistributionJobs: DistributionJob[] = [
+ { id: "DJ01", assetId: "A001", assetName: "hero-banner-spring-v3.pdf", channelId: "CH02", channelName: "Website (Unified Platform)", status: "completed", initiatedBy: "jsmith", initiatedAt: "2024-03-20T14:00:00Z", completedAt: "2024-03-20T14:02:30Z" },
+ { id: "DJ02", assetId: "A001", assetName: "hero-banner-spring-v3.pdf", channelId: "CH05", channelName: "Meta (Facebook & Instagram)", status: "completed", initiatedBy: "jsmith", initiatedAt: "2024-03-20T14:05:00Z", completedAt: "2024-03-20T14:06:15Z" },
+ { id: "DJ03", assetId: "A007", assetName: "logo-rebrand-primary.svg", channelId: "CH01", channelName: "PIM (Stibo STEP)", status: "processing", initiatedBy: "mwilson", initiatedAt: "2024-03-25T09:00:00Z" },
+ { id: "DJ04", assetId: "A003", assetName: "packaging-front-v2.ai", channelId: "CH14", channelName: "Print Fulfillment", status: "queued", initiatedBy: "dporter", initiatedAt: "2024-03-22T10:30:00Z" },
+ { id: "DJ05", assetId: "A004", assetName: "social-media-kit.zip", channelId: "CH06", channelName: "TikTok", status: "completed", initiatedBy: "mwilson", initiatedAt: "2024-03-18T16:00:00Z", completedAt: "2024-03-18T16:01:45Z" },
+ { id: "DJ06", assetId: "A006", assetName: "booth-backdrop-3m.pdf", channelId: "CH11", channelName: "In-Store TV", status: "failed", initiatedBy: "jsmith", initiatedAt: "2024-03-22T11:00:00Z" },
+ { id: "DJ07", assetId: "A007", assetName: "logo-rebrand-primary.svg", channelId: "CH08", channelName: "Google Ads & Performance Max", status: "processing", initiatedBy: "mwilson", initiatedAt: "2024-03-25T09:05:00Z" },
+ { id: "DJ08", assetId: "A002", assetName: "product-shot-01.tif", channelId: "CH10", channelName: "Electronic Shelf Labels (Pricer)", status: "completed", initiatedBy: "dporter", initiatedAt: "2024-03-15T10:00:00Z", completedAt: "2024-03-15T10:00:45Z" },
+];
+
+// === Mock Processes ===
+export const mockProcesses: ProcessMonitorEntry[] = [
+ {
+ id: "PR001",
+ name: "Preflight Check",
+ status: "COMPLETED",
+ progress: 100,
+ startDate: "2024-03-20T14:00:00Z",
+ endDate: "2024-03-20T14:02:00Z",
+ entity: { id: "A001", name: "hero-banner-spring-v3.pdf", type: "Asset" },
+ },
+ {
+ id: "PR002",
+ name: "Color Conversion",
+ status: "IN_PROGRESS",
+ progress: 65,
+ startDate: "2024-03-22T10:00:00Z",
+ entity: { id: "A003", name: "packaging-front-v2.ai", type: "Asset" },
+ },
+ {
+ id: "PR003",
+ name: "PDF Export",
+ status: "QUEUED",
+ progress: 0,
+ entity: { id: "A006", name: "booth-backdrop-3m.pdf", type: "Asset" },
+ },
+];
diff --git a/dalim-app/src/lib/utils.ts b/dalim-app/src/lib/utils.ts
new file mode 100644
index 0000000..bd0c391
--- /dev/null
+++ b/dalim-app/src/lib/utils.ts
@@ -0,0 +1,6 @@
+import { clsx, type ClassValue } from "clsx"
+import { twMerge } from "tailwind-merge"
+
+export function cn(...inputs: ClassValue[]) {
+ return twMerge(clsx(inputs))
+}
diff --git a/dalim-app/tsconfig.json b/dalim-app/tsconfig.json
new file mode 100644
index 0000000..cf9c65d
--- /dev/null
+++ b/dalim-app/tsconfig.json
@@ -0,0 +1,34 @@
+{
+ "compilerOptions": {
+ "target": "ES2017",
+ "lib": ["dom", "dom.iterable", "esnext"],
+ "allowJs": true,
+ "skipLibCheck": true,
+ "strict": true,
+ "noEmit": true,
+ "esModuleInterop": true,
+ "module": "esnext",
+ "moduleResolution": "bundler",
+ "resolveJsonModule": true,
+ "isolatedModules": true,
+ "jsx": "react-jsx",
+ "incremental": true,
+ "plugins": [
+ {
+ "name": "next"
+ }
+ ],
+ "paths": {
+ "@/*": ["./src/*"]
+ }
+ },
+ "include": [
+ "next-env.d.ts",
+ "**/*.ts",
+ "**/*.tsx",
+ ".next/types/**/*.ts",
+ ".next/dev/types/**/*.ts",
+ "**/*.mts"
+ ],
+ "exclude": ["node_modules"]
+}
diff --git a/docs/api_parsed.json b/docs/api_parsed.json
new file mode 100644
index 0000000..37524eb
--- /dev/null
+++ b/docs/api_parsed.json
@@ -0,0 +1,10815 @@
+{
+ "operations": [
+ {
+ "name": "activities",
+ "type": "query",
+ "description": "List of topLevel activities",
+ "response_type": "[Activity!]",
+ "arguments": [
+ {
+ "name": "type",
+ "type": "ActivityType",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "Default = {property : \"name\", direction : ASC}",
+ "required": false
+ }
+ ],
+ "example_query": "query activities( $type: ActivityType, $orderBy: iOrderBy ) { activities( type: $type, orderBy: $orderBy ) { id name bypassed icon color category } }",
+ "example_variables": "{\"type\": \"InputFile\", \"orderBy\": {\"property\": \"name\", \"direction\": \"ASC\"}}",
+ "example_response": "{ \"data\": { \"activities\": [ { \"id\": 4, \"name\": \"abc123\", \"bypassed\": false, \"icon\": \"4\", \"color\": \"abc123\", \"category\": \"xyz789\" } ] } }"
+ },
+ {
+ "name": "activityById",
+ "type": "query",
+ "description": "Activity by Id",
+ "response_type": "[Activity!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query activityById($id: [ID!]!) { activityById(id: $id) { id name bypassed icon color category } }",
+ "example_variables": "{\"id\": [4]}",
+ "example_response": "{ \"data\": { \"activityById\": [ { \"id\": \"4\", \"name\": \"abc123\", \"bypassed\": false, \"icon\": 4, \"color\": \"xyz789\", \"category\": \"xyz789\" } ] } }"
+ },
+ {
+ "name": "activityIconById",
+ "type": "query",
+ "description": "",
+ "response_type": "[ActivityIcon!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query activityIconById($id: [ID!]!) { activityIconById(id: $id) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationUser { ...UserFragment } creationDate } }",
+ "example_variables": "{\"id\": [4]}",
+ "example_response": "{ \"data\": { \"activityIconById\": [ { \"id\": \"4\", \"name\": \"xyz789\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\" } ] } }"
+ },
+ {
+ "name": "activityIcons",
+ "type": "query",
+ "description": "Retrieve Activity Icon",
+ "response_type": "an ActivityIconPagingResponse!",
+ "arguments": [
+ {
+ "name": "filter",
+ "type": "iFilter",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "limit",
+ "type": "Int",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "cursor",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "Default = {property : \"id\", direction : ASC}",
+ "required": false
+ }
+ ],
+ "example_query": "query activityIcons( $filter: iFilter, $limit: Int, $cursor: ID, $orderBy: iOrderBy ) { activityIcons( filter: $filter, limit: $limit, cursor: $cursor, orderBy: $orderBy ) { lowerCursor upperCursor hasMoreItems objectList { ...ActivityIconFragment } } }",
+ "example_variables": "{ \"filter\": iFilter, \"limit\": 123, \"cursor\": 4, \"orderBy\": {\"property\": \"id\", \"direction\": \"ASC\"} }",
+ "example_response": "{ \"data\": { \"activityIcons\": { \"lowerCursor\": 4, \"upperCursor\": \"4\", \"hasMoreItems\": true, \"objectList\": [ActivityIcon] } } }"
+ },
+ {
+ "name": "activityPresets",
+ "type": "query",
+ "description": "List of activity presets",
+ "response_type": "[Activity!]",
+ "arguments": [
+ {
+ "name": "type",
+ "type": "ActivityType",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "name",
+ "type": "String",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "Default = {property : \"name\", direction : ASC}",
+ "required": false
+ }
+ ],
+ "example_query": "query activityPresets( $type: ActivityType, $name: String, $orderBy: iOrderBy ) { activityPresets( type: $type, name: $name, orderBy: $orderBy ) { id name bypassed icon color category } }",
+ "example_variables": "{ \"type\": \"InputFile\", \"name\": \"abc123\", \"orderBy\": {\"property\": \"name\", \"direction\": \"ASC\"} }",
+ "example_response": "{ \"data\": { \"activityPresets\": [ { \"id\": 4, \"name\": \"xyz789\", \"bypassed\": false, \"icon\": 4, \"color\": \"xyz789\", \"category\": \"xyz789\" } ] } }"
+ },
+ {
+ "name": "activityVariables",
+ "type": "query",
+ "description": "Retrieve variables names depending on WorkflowableTypeName",
+ "response_type": "[String]",
+ "arguments": [
+ {
+ "name": "scope",
+ "type": "WorkflowableTypeName!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query activityVariables($scope: WorkflowableTypeName!) { activityVariables(scope: $scope) }",
+ "example_variables": "{\"scope\": \"Folder\"}",
+ "example_response": "{\"data\": {\"activityVariables\": [\"abc123\"]}}"
+ },
+ {
+ "name": "annotationStatusById",
+ "type": "query",
+ "description": "",
+ "response_type": "[AnnotationStatus!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query annotationStatusById($id: [ID!]!) { annotationStatusById(id: $id) { id lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } color icon isActive order translations } }",
+ "example_variables": "{\"id\": [\"4\"]}",
+ "example_response": "{ \"data\": { \"annotationStatusById\": [ { \"id\": \"4\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"color\": \"xyz789\", \"icon\": \"xyz789\", \"isActive\": true, \"order\": 123, \"translations\": {} } ] } }"
+ },
+ {
+ "name": "annotationStatuses",
+ "type": "query",
+ "description": "",
+ "response_type": "[AnnotationStatus!]",
+ "arguments": [
+ {
+ "name": "onlyActive",
+ "type": "Boolean",
+ "description": "Default = true",
+ "required": false
+ }
+ ],
+ "example_query": "query annotationStatuses($onlyActive: Boolean) { annotationStatuses(onlyActive: $onlyActive) { id lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } color icon isActive order translations } }",
+ "example_variables": "{\"onlyActive\": true}",
+ "example_response": "{ \"data\": { \"annotationStatuses\": [ { \"id\": 4, \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"color\": \"xyz789\", \"icon\": \"abc123\", \"isActive\": false, \"order\": 123, \"translations\": {} } ] } }"
+ },
+ {
+ "name": "anyCollections",
+ "type": "query",
+ "description": "Returns the paginated list of any top-level collections (Smart Collections and Collections).",
+ "response_type": "an AnyCollectionPagingResponse!",
+ "arguments": [
+ {
+ "name": "filter",
+ "type": "iFilter",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "limit",
+ "type": "Int",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "cursor",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "Default = {property : \"id\", direction : ASC}",
+ "required": false
+ }
+ ],
+ "example_query": "query anyCollections( $filter: iFilter, $limit: Int, $cursor: ID, $orderBy: iOrderBy ) { anyCollections( filter: $filter, limit: $limit, cursor: $cursor, orderBy: $orderBy ) { lowerCursor upperCursor hasMoreItems objectList { ...AnyCollectionFragment } } }",
+ "example_variables": "{ \"filter\": iFilter, \"limit\": 123, \"cursor\": 4, \"orderBy\": {\"property\": \"id\", \"direction\": \"ASC\"} }",
+ "example_response": "{ \"data\": { \"anyCollections\": { \"lowerCursor\": \"4\", \"upperCursor\": \"4\", \"hasMoreItems\": false, \"objectList\": [AnyCollection] } } }"
+ },
+ {
+ "name": "approvals",
+ "type": "query",
+ "description": "Retrieve objects to approve by the current logged user",
+ "response_type": "an ApprovalPagingResponse!",
+ "arguments": [
+ {
+ "name": "limit",
+ "type": "Int",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "cursor",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "Default = {property : \"id\", direction : ASC}",
+ "required": false
+ },
+ {
+ "name": "exclude",
+ "type": "[ApprovableTypeName!]",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query approvals( $limit: Int, $cursor: ID, $orderBy: iOrderBy, $exclude: [ApprovableTypeName!] ) { approvals( limit: $limit, cursor: $cursor, orderBy: $orderBy, exclude: $exclude ) { lowerCursor upperCursor hasMoreItems objectList { ...WithApprovalFragment } } }",
+ "example_variables": "{ \"limit\": 123, \"cursor\": \"4\", \"orderBy\": {\"property\": \"id\", \"direction\": \"ASC\"}, \"exclude\": [\"Project\"] }",
+ "example_response": "{ \"data\": { \"approvals\": { \"lowerCursor\": \"4\", \"upperCursor\": 4, \"hasMoreItems\": false, \"objectList\": [WithApproval] } } }"
+ },
+ {
+ "name": "approvalsByUser",
+ "type": "query",
+ "description": "Retrieve objects to approve for a specific user",
+ "response_type": "an ApprovalPagingResponse!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "limit",
+ "type": "Int",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "cursor",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "Default = {property : \"id\", direction : ASC}",
+ "required": false
+ },
+ {
+ "name": "exclude",
+ "type": "[ApprovableTypeName!]",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query approvalsByUser( $id: ID!, $limit: Int, $cursor: ID, $orderBy: iOrderBy, $exclude: [ApprovableTypeName!] ) { approvalsByUser( id: $id, limit: $limit, cursor: $cursor, orderBy: $orderBy, exclude: $exclude ) { lowerCursor upperCursor hasMoreItems objectList { ...WithApprovalFragment } } }",
+ "example_variables": "{ \"id\": \"4\", \"limit\": 987, \"cursor\": \"4\", \"orderBy\": {\"property\": \"id\", \"direction\": \"ASC\"}, \"exclude\": [\"Project\"] }",
+ "example_response": "{ \"data\": { \"approvalsByUser\": { \"lowerCursor\": 4, \"upperCursor\": 4, \"hasMoreItems\": true, \"objectList\": [WithApproval] } } }"
+ },
+ {
+ "name": "assetById",
+ "type": "query",
+ "description": "Retrieve Assets by ID or [ID]",
+ "response_type": "[Asset!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query assetById($id: [ID!]!) { assetById(id: $id) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } trashDate trashUser { ...UserFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } status approvalSummary approvalStatus { ...ApprovalActivityStatusFragment } approvals { ...ApprovalCycleFragment } workflowName isAlias processes { ...ProcessFragment } uuid priority isCheckedOut checkedOutBy { ...UserFragment } privateWorkingRevision isArchived archiveId colorSpace { ...ColorSpaceFragment } viewingCondition { ...ViewingConditionFragment } project { ...ProjectFragment } parents { ...ContainerFragment } numberOfRevisions expirationDate medias { ...MediaFragment } notes { ...NoteFragment } relationFrom { ...RelationFragment } relationTo { ...RelationFragment } accessControls } }",
+ "example_variables": "{\"id\": [4]}",
+ "example_response": "{ \"data\": { \"assetById\": [ { \"id\": 4, \"name\": \"xyz789\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"trashDate\": \"2007-12-03T10:15:30Z\", \"trashUser\": User, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"status\": [\"ACTIVE\"], \"approvalSummary\": \"NONE\", \"approvalStatus\": [ApprovalActivityStatus], \"approvals\": [ApprovalCycle], \"workflowName\": \"abc123\", \"isAlias\": false, \"processes\": [Process], \"uuid\": \"abc123\", \"priority\": 987, \"isCheckedOut\": false, \"checkedOutBy\": User, \"privateWorkingRevision\": 987, \"isArchived\": true, \"archiveId\": 4, \"colorSpace\": ColorSpace, \"viewingCondition\": ViewingCondition, \"project\": Project, \"parents\": [Container], \"numberOfRevisions\": 987, \"expirationDate\": \"2007-12-03T10:15:30Z\", \"medias\": [Media], \"notes\": [Note], \"relationFrom\": [Relation], \"relationTo\": [Relation], \"accessControls\": {} } ] } }"
+ },
+ {
+ "name": "assets",
+ "type": "query",
+ "description": "Retrieve Assets by filter",
+ "response_type": "an AssetPagingResponse!",
+ "arguments": [
+ {
+ "name": "filter",
+ "type": "iFilter",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "limit",
+ "type": "Int",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "cursor",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "Default = {property : \"id\", direction : ASC}",
+ "required": false
+ }
+ ],
+ "example_query": "query assets( $filter: iFilter, $limit: Int, $cursor: ID, $orderBy: iOrderBy ) { assets( filter: $filter, limit: $limit, cursor: $cursor, orderBy: $orderBy ) { lowerCursor upperCursor hasMoreItems objectList { ...AssetFragment } } }",
+ "example_variables": "{ \"filter\": iFilter, \"limit\": 987, \"cursor\": 4, \"orderBy\": {\"property\": \"id\", \"direction\": \"ASC\"} }",
+ "example_response": "{ \"data\": { \"assets\": { \"lowerCursor\": \"4\", \"upperCursor\": \"4\", \"hasMoreItems\": false, \"objectList\": [Asset] } } }"
+ },
+ {
+ "name": "authentications",
+ "type": "query",
+ "description": "",
+ "response_type": "[Authentication!]!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "query authentications($id: ID) { authentications(id: $id) { id type name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } authorizationURL tokenURL clientId isActive samlSetup { ...SAMLSetupFragment } } }",
+ "example_variables": "{\"id\": \"4\"}",
+ "example_response": "{ \"data\": { \"authentications\": [ { \"id\": \"4\", \"type\": \"INTERNAL\", \"name\": \"abc123\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"authorizationURL\": \"http://www.test.com/\", \"tokenURL\": \"http://www.test.com/\", \"clientId\": \"4\", \"isActive\": true, \"samlSetup\": SAMLSetup } ] } }"
+ },
+ {
+ "name": "checkVolumeConnectivity",
+ "type": "query",
+ "description": "check connectivity of a volume to it's storage location or server",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query checkVolumeConnectivity($id: ID!) { checkVolumeConnectivity(id: $id) }",
+ "example_variables": "{\"id\": 4}",
+ "example_response": "{\"data\": {\"checkVolumeConnectivity\": true}}"
+ },
+ {
+ "name": "clientApplications",
+ "type": "query",
+ "description": "",
+ "response_type": "[ClientApplication!]!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "query clientApplications($id: ID) { clientApplications(id: $id) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } allowIntrospection maxQueryDepth redirectURL secret schema defaultTokenDuration algorithm { ...JWTAlgorithmFragment } } }",
+ "example_variables": "{\"id\": \"4\"}",
+ "example_response": "{ \"data\": { \"clientApplications\": [ { \"id\": 4, \"name\": \"xyz789\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"allowIntrospection\": false, \"maxQueryDepth\": 123, \"redirectURL\": \"http://www.test.com/\", \"secret\": \"abc123\", \"schema\": [\"ADMIN\"], \"defaultTokenDuration\": {}, \"algorithm\": JWTAlgorithm } ] } }"
+ },
+ {
+ "name": "closeDialogueConnection",
+ "type": "query",
+ "description": "Close a Dialogue connection",
+ "response_type": "an ID!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query closeDialogueConnection($id: ID!) { closeDialogueConnection(id: $id) }",
+ "example_variables": "{\"id\": \"4\"}",
+ "example_response": "{\"data\": {\"closeDialogueConnection\": 4}}"
+ },
+ {
+ "name": "collectionById",
+ "type": "query",
+ "description": "Retrieve Collections by ID or [ID]",
+ "response_type": "[Collection!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query collectionById($id: [ID!]!) { collectionById(id: $id) { id name description color lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } trashDate trashUser { ...UserFragment } icon lName translations children { ...PagingResponseFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } readOnly accessControlList { ...AccessControlListFragment } path { ...CollectionFragment } parents { ...ContainerFragment } destination { ...EntityFragment } } }",
+ "example_variables": "{\"id\": [\"4\"]}",
+ "example_response": "{ \"data\": { \"collectionById\": [ { \"id\": \"4\", \"name\": \"xyz789\", \"description\": \"abc123\", \"color\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"trashDate\": \"2007-12-03T10:15:30Z\", \"trashUser\": User, \"icon\": 4, \"lName\": \"xyz789\", \"translations\": {}, \"children\": PagingResponse, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"readOnly\": false, \"accessControlList\": AccessControlList, \"path\": [Collection], \"parents\": [Container], \"destination\": Entity } ] } }"
+ },
+ {
+ "name": "collections",
+ "type": "query",
+ "description": "Returns the paginated list of top-level collections.",
+ "response_type": "a CollectionPagingResponse!",
+ "arguments": [
+ {
+ "name": "filter",
+ "type": "iFilter",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "limit",
+ "type": "Int",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "cursor",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "Default = {property : \"id\", direction : ASC}",
+ "required": false
+ }
+ ],
+ "example_query": "query collections( $filter: iFilter, $limit: Int, $cursor: ID, $orderBy: iOrderBy ) { collections( filter: $filter, limit: $limit, cursor: $cursor, orderBy: $orderBy ) { lowerCursor upperCursor hasMoreItems objectList { ...CollectionFragment } } }",
+ "example_variables": "{ \"filter\": iFilter, \"limit\": 123, \"cursor\": 4, \"orderBy\": {\"property\": \"id\", \"direction\": \"ASC\"} }",
+ "example_response": "{ \"data\": { \"collections\": { \"lowerCursor\": 4, \"upperCursor\": \"4\", \"hasMoreItems\": false, \"objectList\": [Collection] } } }"
+ },
+ {
+ "name": "colorSpaceById",
+ "type": "query",
+ "description": "",
+ "response_type": "[ColorSpace!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query colorSpaceById($id: [ID!]!) { colorSpaceById(id: $id) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } parents { ...ContainerFragment } colorEngine blackPointCompensation mixedWorkingSpace { ...ICCDestinationSelectionFragment } mixedVectorInput { ...ICCSourceSelectionFragment } mixedRasterInput { ...ICCSourceSelectionFragment } rgbWorkingSpace { ...ICCDestinationSelectionFragment } cmykWorkingSpace { ...ICCDestinationSelectionFragment } grayWorkingSpace { ...ICCDestinationSelectionFragment } } }",
+ "example_variables": "{\"id\": [4]}",
+ "example_response": "{ \"data\": { \"colorSpaceById\": [ { \"id\": 4, \"name\": \"xyz789\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"parents\": [Container], \"colorEngine\": \"ADOBE_ACE\", \"blackPointCompensation\": false, \"mixedWorkingSpace\": ICCDestinationSelection, \"mixedVectorInput\": ICCSourceSelection, \"mixedRasterInput\": ICCSourceSelection, \"rgbWorkingSpace\": ICCDestinationSelection, \"cmykWorkingSpace\": ICCDestinationSelection, \"grayWorkingSpace\": ICCDestinationSelection } ] } }"
+ },
+ {
+ "name": "colorSpaces",
+ "type": "query",
+ "description": "",
+ "response_type": "a ColorSpacePagingResponse!",
+ "arguments": [
+ {
+ "name": "limit",
+ "type": "Int",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "cursor",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "Default = {property : \"name\", direction : ASC}",
+ "required": false
+ }
+ ],
+ "example_query": "query colorSpaces( $limit: Int, $cursor: ID, $orderBy: iOrderBy ) { colorSpaces( limit: $limit, cursor: $cursor, orderBy: $orderBy ) { lowerCursor upperCursor hasMoreItems objectList { ...ColorSpaceFragment } } }",
+ "example_variables": "{ \"limit\": 987, \"cursor\": \"4\", \"orderBy\": {\"property\": \"name\", \"direction\": \"ASC\"} }",
+ "example_response": "{ \"data\": { \"colorSpaces\": { \"lowerCursor\": 4, \"upperCursor\": \"4\", \"hasMoreItems\": false, \"objectList\": [ColorSpace] } } }"
+ },
+ {
+ "name": "customerById",
+ "type": "query",
+ "description": "Retrieve Customers by ID or [ID]",
+ "response_type": "[Customer!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query customerById($id: [ID!]!) { customerById(id: $id) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } sites defaultSite defaultProjectTemplate { ...ProjectTemplateFragment } projectTemplates { ...ProjectTemplateFragment } code phone phone2 www fax shippingAddress { ...AddressFragment } billingAddress { ...AddressFragment } organization { ...OrganizationFragment } children { ...PagingResponseFragment } emailTemplates { ...EmailTemplateFragment } notificationTemplates { ...NotificationTemplateFragment } securityConfiguration { ...SecurityConfigurationFragment } notifications { ...NotificationFragment } } }",
+ "example_variables": "{\"id\": [4]}",
+ "example_response": "{ \"data\": { \"customerById\": [ { \"id\": 4, \"name\": \"abc123\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"sites\": [\"abc123\"], \"defaultSite\": \"xyz789\", \"defaultProjectTemplate\": ProjectTemplate, \"projectTemplates\": [ProjectTemplate], \"code\": \"xyz789\", \"phone\": \"abc123\", \"phone2\": \"abc123\", \"www\": \"xyz789\", \"fax\": \"abc123\", \"shippingAddress\": Address, \"billingAddress\": Address, \"organization\": Organization, \"children\": PagingResponse, \"emailTemplates\": [EmailTemplate], \"notificationTemplates\": [NotificationTemplate], \"securityConfiguration\": SecurityConfiguration, \"notifications\": [Notification] } ] } }"
+ },
+ {
+ "name": "customers",
+ "type": "query",
+ "description": "Retrieve Customers by filter",
+ "response_type": "a CustomerPagingResponse!",
+ "arguments": [
+ {
+ "name": "filter",
+ "type": "iFilter",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "limit",
+ "type": "Int",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "cursor",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "Default = {property : \"id\", direction : ASC}",
+ "required": false
+ }
+ ],
+ "example_query": "query customers( $filter: iFilter, $limit: Int, $cursor: ID, $orderBy: iOrderBy ) { customers( filter: $filter, limit: $limit, cursor: $cursor, orderBy: $orderBy ) { lowerCursor upperCursor hasMoreItems objectList { ...CustomerFragment } } }",
+ "example_variables": "{ \"filter\": iFilter, \"limit\": 123, \"cursor\": 4, \"orderBy\": {\"property\": \"id\", \"direction\": \"ASC\"} }",
+ "example_response": "{ \"data\": { \"customers\": { \"lowerCursor\": \"4\", \"upperCursor\": 4, \"hasMoreItems\": false, \"objectList\": [Customer] } } }"
+ },
+ {
+ "name": "densitometer",
+ "type": "query",
+ "description": "Read the color value at a certain position",
+ "response_type": "a DensitometerValues",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "parameters",
+ "type": "iDensitometerParams!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query densitometer( $id: ID!, $parameters: iDensitometerParams! ) { densitometer( id: $id, parameters: $parameters ) { rgb values { ...ColorValueFragment } } }",
+ "example_variables": "{ \"id\": \"4\", \"parameters\": iDensitometerParams }",
+ "example_response": "{ \"data\": { \"densitometer\": { \"rgb\": \"xyz789\", \"values\": [ColorValue] } } }"
+ },
+ {
+ "name": "dialogueConnections",
+ "type": "query",
+ "description": "List open connections optionally to a single Asset with id/revision.",
+ "response_type": "[DialogueConnection!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "revision",
+ "type": "Int",
+ "description": "Default = 0",
+ "required": false
+ },
+ {
+ "name": "pageNumber",
+ "type": "Int",
+ "description": "Default = 1",
+ "required": false
+ }
+ ],
+ "example_query": "query dialogueConnections( $id: ID, $revision: Int, $pageNumber: Int ) { dialogueConnections( id: $id, revision: $revision, pageNumber: $pageNumber ) { id media { ...MediaFragment } pageNumber creationUser { ...UserFragment } host colorSettings { ...ColorSettingsFragment } } }",
+ "example_variables": "{\"id\": \"4\", \"revision\": 0, \"pageNumber\": 1}",
+ "example_response": "{ \"data\": { \"dialogueConnections\": [ { \"id\": \"4\", \"media\": Media, \"pageNumber\": 987, \"creationUser\": User, \"host\": \"abc123\", \"colorSettings\": ColorSettings } ] } }"
+ },
+ {
+ "name": "downloadAsset",
+ "type": "query",
+ "description": "Stream an Asset",
+ "response_type": "a Stream",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "revision",
+ "type": "Int",
+ "description": "Default = 0",
+ "required": false
+ }
+ ],
+ "example_query": "query downloadAsset( $id: ID!, $revision: Int ) { downloadAsset( id: $id, revision: $revision ) }",
+ "example_variables": "{\"id\": \"4\", \"revision\": 0}",
+ "example_response": "{\"data\": {\"downloadAsset\": Stream}}"
+ },
+ {
+ "name": "downloadAssetWithNotes",
+ "type": "query",
+ "description": "Download one Asset or a .zip of several Assets with notes translated to PDF annotations",
+ "response_type": "a Stream",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "contentDisposition",
+ "type": "ContentDisposition",
+ "description": "Default = ATTACHMENT",
+ "required": false
+ },
+ {
+ "name": "display",
+ "type": "iDownloadDisplay",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "query downloadAssetWithNotes( $id: [ID!]!, $contentDisposition: ContentDisposition, $display: iDownloadDisplay ) { downloadAssetWithNotes( id: $id, contentDisposition: $contentDisposition, display: $display ) }",
+ "example_variables": "{ \"id\": [\"4\"], \"contentDisposition\": \"ATTACHMENT\", \"display\": iDownloadDisplay }",
+ "example_response": "{\"data\": {\"downloadAssetWithNotes\": Stream}}"
+ },
+ {
+ "name": "dumpText",
+ "type": "query",
+ "description": "Dump the text contained in the document",
+ "response_type": "[TextPage!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query dumpText($id: ID!) { dumpText(id: $id) { box paragraphs { ...TextParagraphFragment } } }",
+ "example_variables": "{\"id\": 4}",
+ "example_response": "{ \"data\": { \"dumpText\": [ {\"box\": [123.45], \"paragraphs\": [TextParagraph]} ] } }"
+ },
+ {
+ "name": "editIccContext",
+ "type": "query",
+ "description": "Setup ICC context",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "parameters",
+ "type": "iSimulationContext",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "query editIccContext( $id: ID!, $parameters: iSimulationContext ) { editIccContext( id: $id, parameters: $parameters ) }",
+ "example_variables": "{\"id\": 4, \"parameters\": iSimulationContext}",
+ "example_response": "{\"data\": {\"editIccContext\": true}}"
+ },
+ {
+ "name": "emailTemplateById",
+ "type": "query",
+ "description": "",
+ "response_type": "[EmailTemplate!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query emailTemplateById($id: [ID!]!) { emailTemplateById(id: $id) { id name description parentEntity { ...WithEmailTemplateFragment } emailParts attachPreview attachPreviewsIfMultipage attachCurrentFile attachHistoryReportAllRevisions attachHistoryReportCurrentRevision attachNoteReportAllRevisions attachNoteReportCurrentRevision attachPreflightReport lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } } }",
+ "example_variables": "{\"id\": [4]}",
+ "example_response": "{ \"data\": { \"emailTemplateById\": [ { \"id\": \"4\", \"name\": \"xyz789\", \"description\": \"xyz789\", \"parentEntity\": WithEmailTemplate, \"emailParts\": {}, \"attachPreview\": true, \"attachPreviewsIfMultipage\": true, \"attachCurrentFile\": false, \"attachHistoryReportAllRevisions\": true, \"attachHistoryReportCurrentRevision\": false, \"attachNoteReportAllRevisions\": true, \"attachNoteReportCurrentRevision\": false, \"attachPreflightReport\": false, \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User } ] } }"
+ },
+ {
+ "name": "emailTemplates",
+ "type": "query",
+ "description": "Returns an EmailTemplatePagingResponse!",
+ "response_type": "an EmailTemplatePagingResponse!",
+ "arguments": [
+ {
+ "name": "filter",
+ "type": "iFilter",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "limit",
+ "type": "Int",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "cursor",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "Default = {property : \"id\", direction : ASC}",
+ "required": false
+ }
+ ],
+ "example_query": "query emailTemplates( $filter: iFilter, $limit: Int, $cursor: ID, $orderBy: iOrderBy ) { emailTemplates( filter: $filter, limit: $limit, cursor: $cursor, orderBy: $orderBy ) { lowerCursor upperCursor hasMoreItems objectList { ...EmailTemplateFragment } } }",
+ "example_variables": "{ \"filter\": iFilter, \"limit\": 123, \"cursor\": \"4\", \"orderBy\": {\"property\": \"id\", \"direction\": \"ASC\"} }",
+ "example_response": "{ \"data\": { \"emailTemplates\": { \"lowerCursor\": 4, \"upperCursor\": 4, \"hasMoreItems\": false, \"objectList\": [EmailTemplate] } } }"
+ },
+ {
+ "name": "entityByPath",
+ "type": "query",
+ "description": "",
+ "response_type": "[EntityPath!]",
+ "arguments": [
+ {
+ "name": "path",
+ "type": "[String!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "type",
+ "type": "FileableTypeName!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query entityByPath( $path: [String!]!, $type: FileableTypeName! ) { entityByPath( path: $path, type: $type ) { entity { ...EntityFragment } path } }",
+ "example_variables": "{\"path\": [\"xyz789\"], \"type\": \"Folder\"}",
+ "example_response": "{ \"data\": { \"entityByPath\": [ { \"entity\": Entity, \"path\": \"xyz789\" } ] } }"
+ },
+ {
+ "name": "exportData",
+ "type": "query",
+ "description": "**Export the given object(s) in an .es file",
+ "response_type": "a Stream",
+ "arguments": [
+ {
+ "name": "toExport",
+ "type": "[iExport!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "name",
+ "type": "String",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "category",
+ "type": "String",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "comment",
+ "type": "String",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "query exportData( $toExport: [iExport!]!, $name: String, $category: String, $comment: String ) { exportData( toExport: $toExport, name: $name, category: $category, comment: $comment ) }",
+ "example_variables": "{ \"toExport\": [iExport], \"name\": \"xyz789\", \"category\": \"xyz789\", \"comment\": \"abc123\" }",
+ "example_response": "{\"data\": {\"exportData\": Stream}}"
+ },
+ {
+ "name": "folderById",
+ "type": "query",
+ "description": "Retrieve Folders by ID or [ID]. Use triggerMonitoring to override volume monitorOnBrowse setting, determining whether or not Folder contents should be updated based on disk content.",
+ "response_type": "[Folder!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "triggerMonitoring",
+ "type": "Boolean",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "query folderById( $id: [ID!]!, $triggerMonitoring: Boolean ) { folderById( id: $id, triggerMonitoring: $triggerMonitoring ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } trashDate trashUser { ...UserFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } readOnly productionSettings { ...ProductionSettingsFragment } processes { ...ProcessFragment } accessControlList { ...AccessControlListFragment } children { ...PagingResponseFragment } project { ...ProjectFragment } parents { ...ContainerFragment } path { ...FolderFragment } color icon } }",
+ "example_variables": "{\"id\": [4], \"triggerMonitoring\": true}",
+ "example_response": "{ \"data\": { \"folderById\": [ { \"id\": \"4\", \"name\": \"abc123\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"trashDate\": \"2007-12-03T10:15:30Z\", \"trashUser\": User, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"readOnly\": false, \"productionSettings\": ProductionSettings, \"processes\": [Process], \"accessControlList\": AccessControlList, \"children\": PagingResponse, \"project\": Project, \"parents\": [Container], \"path\": [Folder], \"color\": \"xyz789\", \"icon\": 4 } ] } }"
+ },
+ {
+ "name": "folders",
+ "type": "query",
+ "description": "Returns the paginated list of top-level folders.Use triggerMonitoring to override volume monitorOnBrowse setting",
+ "response_type": "a FolderPagingResponse!",
+ "arguments": [
+ {
+ "name": "triggerMonitoring",
+ "type": "Boolean",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "filter",
+ "type": "iFilter",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "limit",
+ "type": "Int",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "cursor",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "Default = {property : \"id\", direction : ASC}",
+ "required": false
+ }
+ ],
+ "example_query": "query folders( $triggerMonitoring: Boolean, $filter: iFilter, $limit: Int, $cursor: ID, $orderBy: iOrderBy ) { folders( triggerMonitoring: $triggerMonitoring, filter: $filter, limit: $limit, cursor: $cursor, orderBy: $orderBy ) { lowerCursor upperCursor hasMoreItems objectList { ...FolderFragment } } }",
+ "example_variables": "{ \"triggerMonitoring\": false, \"filter\": iFilter, \"limit\": 987, \"cursor\": \"4\", \"orderBy\": {\"property\": \"id\", \"direction\": \"ASC\"} }",
+ "example_response": "{ \"data\": { \"folders\": { \"lowerCursor\": \"4\", \"upperCursor\": \"4\", \"hasMoreItems\": false, \"objectList\": [Folder] } } }"
+ },
+ {
+ "name": "gamutCheck",
+ "type": "query",
+ "description": "Compute the area where the color are out of gamut according to the monitor or to a simulation profile of a portion of a document defined by parameters of input iGamutCheckParams The response is a png image (Warning it is not a JSON response)",
+ "response_type": "a Stream",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "parameters",
+ "type": "iGamutCheckParams!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query gamutCheck( $id: ID!, $parameters: iGamutCheckParams! ) { gamutCheck( id: $id, parameters: $parameters ) }",
+ "example_variables": "{ \"id\": \"4\", \"parameters\": iGamutCheckParams }",
+ "example_response": "{\"data\": {\"gamutCheck\": Stream}}"
+ },
+ {
+ "name": "gamutWarning",
+ "type": "query",
+ "description": "Return true if the document is viewed out of gamut",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "parameters",
+ "type": "iGamutWarningParams!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query gamutWarning( $id: ID!, $parameters: iGamutWarningParams! ) { gamutWarning( id: $id, parameters: $parameters ) }",
+ "example_variables": "{ \"id\": \"4\", \"parameters\": iGamutWarningParams }",
+ "example_response": "{\"data\": {\"gamutWarning\": true}}"
+ },
+ {
+ "name": "get2FAQRCode",
+ "type": "query",
+ "description": "Return the Authenticator QR code",
+ "response_type": "a Stream",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "id of the user",
+ "required": true
+ }
+ ],
+ "example_query": "query get2FAQRCode($id: ID!) { get2FAQRCode(id: $id) }",
+ "example_variables": "{\"id\": 4}",
+ "example_response": "{\"data\": {\"get2FAQRCode\": Stream}}"
+ },
+ {
+ "name": "getCorsSetting",
+ "type": "query",
+ "description": "",
+ "response_type": "a CorsSetting!",
+ "arguments": [],
+ "example_query": "query getCorsSetting { getCorsSetting { enableCors allowedOrigins allowedMethods allowedHeaders exposedHeaders preflightMaxAge } }",
+ "example_variables": "",
+ "example_response": "{ \"data\": { \"getCorsSetting\": { \"enableCors\": true, \"allowedOrigins\": [\"xyz789\"], \"allowedMethods\": [\"xyz789\"], \"allowedHeaders\": [\"abc123\"], \"exposedHeaders\": [\"abc123\"], \"preflightMaxAge\": 123 } } }"
+ },
+ {
+ "name": "getEventLogs",
+ "type": "query",
+ "description": "",
+ "response_type": "a LogResponse",
+ "arguments": [
+ {
+ "name": "limit",
+ "type": "Int",
+ "description": "Default = 1000",
+ "required": false
+ },
+ {
+ "name": "cursor",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "filter",
+ "type": "iLogFilter",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "query getEventLogs( $limit: Int, $cursor: ID, $filter: iLogFilter ) { getEventLogs( limit: $limit, cursor: $cursor, filter: $filter ) { upperCursor hasMoreItems objectList { ...EventLogFragment } } }",
+ "example_variables": "{ \"limit\": 1000, \"cursor\": \"4\", \"filter\": iLogFilter }",
+ "example_response": "{ \"data\": { \"getEventLogs\": { \"upperCursor\": 4, \"hasMoreItems\": true, \"objectList\": [EventLog] } } }"
+ },
+ {
+ "name": "getFileContent",
+ "type": "query",
+ "description": "-------- Deprecated ---------",
+ "response_type": "a String",
+ "arguments": [
+ {
+ "name": "from",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "path",
+ "type": "String!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query getFileContent( $from: String!, $path: String! ) { getFileContent( from: $from, path: $path ) }",
+ "example_variables": "{ \"from\": \"abc123\", \"path\": \"abc123\" }",
+ "example_response": "{\"data\": {\"getFileContent\": \"xyz789\"}}"
+ },
+ {
+ "name": "getImportConflicts",
+ "type": "query",
+ "description": "** Retrieve the objects to import that conflicts with existing one for a given ImportedFile",
+ "response_type": "[ImportedInfo!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query getImportConflicts($id: ID!) { getImportConflicts(id: $id) { name type translatedType userName } }",
+ "example_variables": "{\"id\": 4}",
+ "example_response": "{ \"data\": { \"getImportConflicts\": [ { \"name\": \"xyz789\", \"type\": \"xyz789\", \"translatedType\": \"abc123\", \"userName\": \"xyz789\" } ] } }"
+ },
+ {
+ "name": "getImportInfo",
+ "type": "query",
+ "description": "** Retrieve the objects to import for a given ImportedFile",
+ "response_type": "[ImportedInfo!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query getImportInfo($id: ID!) { getImportInfo(id: $id) { name type translatedType userName } }",
+ "example_variables": "{\"id\": \"4\"}",
+ "example_response": "{ \"data\": { \"getImportInfo\": [ { \"name\": \"xyz789\", \"type\": \"xyz789\", \"translatedType\": \"xyz789\", \"userName\": \"xyz789\" } ] } }"
+ },
+ {
+ "name": "getLogLevel",
+ "type": "query",
+ "description": "Return the current log level",
+ "response_type": "a LogLevel!",
+ "arguments": [],
+ "example_query": "query getLogLevel { getLogLevel }",
+ "example_variables": "",
+ "example_response": "{\"data\": {\"getLogLevel\": \"ALL\"}}"
+ },
+ {
+ "name": "getLogQueries",
+ "type": "query",
+ "description": "Return if the server logs queries",
+ "response_type": "a Boolean!",
+ "arguments": [],
+ "example_query": "query getLogQueries { getLogQueries }",
+ "example_variables": "",
+ "example_response": "{\"data\": {\"getLogQueries\": true}}"
+ },
+ {
+ "name": "getMaxQueryComplexity",
+ "type": "query",
+ "description": "",
+ "response_type": "an Int!",
+ "arguments": [],
+ "example_query": "query getMaxQueryComplexity { getMaxQueryComplexity }",
+ "example_variables": "",
+ "example_response": "{\"data\": {\"getMaxQueryComplexity\": 123}}"
+ },
+ {
+ "name": "getMaxQuerySize",
+ "type": "query",
+ "description": "",
+ "response_type": "an Int!",
+ "arguments": [],
+ "example_query": "query getMaxQuerySize { getMaxQuerySize }",
+ "example_variables": "",
+ "example_response": "{\"data\": {\"getMaxQuerySize\": 123}}"
+ },
+ {
+ "name": "getMaxTopLevelFieldCount",
+ "type": "query",
+ "description": "",
+ "response_type": "an Int!",
+ "arguments": [],
+ "example_query": "query getMaxTopLevelFieldCount { getMaxTopLevelFieldCount }",
+ "example_variables": "",
+ "example_response": "{\"data\": {\"getMaxTopLevelFieldCount\": 123}}"
+ },
+ {
+ "name": "getNotes",
+ "type": "query",
+ "description": "Returns [Note]!",
+ "response_type": "[Note]!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "The id(s) of the objects : Asset, Project, Media",
+ "required": true
+ },
+ {
+ "name": "noteIds",
+ "type": "[ID!]",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query getNotes( $id: [ID!]!, $noteIds: [ID!] ) { getNotes( id: $id, noteIds: $noteIds ) { id type objectOwnerId pageNumber lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } attachments { ...AttachmentFragment } checkable status { ...AnnotationStatusFragment } collapsed seenBy { ...UserFragment } replies { ...NoteReplyFragment } content originalContent stylizedContent positionX positionY positionZ anchorX anchorY anchorZ tx ty proofReadingMark { ...ProofReadingMarkFragment } path selectable startTime endTime } }",
+ "example_variables": "{ \"id\": [\"4\"], \"noteIds\": [\"4\"] }",
+ "example_response": "{ \"data\": { \"getNotes\": [ { \"id\": 4, \"type\": \"Note\", \"objectOwnerId\": 4, \"pageNumber\": {}, \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"attachments\": [Attachment], \"checkable\": true, \"status\": AnnotationStatus, \"collapsed\": false, \"seenBy\": [User], \"replies\": [NoteReply], \"content\": \"abc123\", \"originalContent\": \"xyz789\", \"stylizedContent\": \"abc123\", \"positionX\": 123.45, \"positionY\": 123.45, \"positionZ\": 987.65, \"anchorX\": 123.45, \"anchorY\": 123.45, \"anchorZ\": 123.45, \"tx\": 123.45, \"ty\": 987.65, \"proofReadingMark\": ProofReadingMark, \"path\": \"xyz789\", \"selectable\": false, \"startTime\": 123.45, \"endTime\": 123.45 } ] } }"
+ },
+ {
+ "name": "getProperties",
+ "type": "query",
+ "description": "Read all configuration properties of a particular category",
+ "response_type": "[ConfigProperty!]!",
+ "arguments": [
+ {
+ "name": "category",
+ "type": "String!",
+ "description": "category: The considered category",
+ "required": true
+ }
+ ],
+ "example_query": "query getProperties($category: String!) { getProperties(category: $category) { id category name value } }",
+ "example_variables": "{\"category\": \"abc123\"}",
+ "example_response": "{ \"data\": { \"getProperties\": [ { \"id\": \"4\", \"category\": \"xyz789\", \"name\": \"abc123\", \"value\": \"xyz789\" } ] } }"
+ },
+ {
+ "name": "getProperty",
+ "type": "query",
+ "description": "Read a configuration property",
+ "response_type": "a ConfigProperty",
+ "arguments": [
+ {
+ "name": "category",
+ "type": "String!",
+ "description": "The category to which belongs the property to retrieve",
+ "required": true
+ },
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "The name of the property to retrieve",
+ "required": true
+ },
+ {
+ "name": "defaultValue",
+ "type": "String",
+ "description": "A default value if the property is not yet defined",
+ "required": false
+ }
+ ],
+ "example_query": "query getProperty( $category: String!, $name: String!, $defaultValue: String ) { getProperty( category: $category, name: $name, defaultValue: $defaultValue ) { id category name value } }",
+ "example_variables": "{ \"category\": \"xyz789\", \"name\": \"abc123\", \"defaultValue\": \"xyz789\" }",
+ "example_response": "{ \"data\": { \"getProperty\": { \"id\": \"4\", \"category\": \"xyz789\", \"name\": \"abc123\", \"value\": \"xyz789\" } } }"
+ },
+ {
+ "name": "getReportURL",
+ "type": "query",
+ "description": "",
+ "response_type": "a String",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "type",
+ "type": "ReportType!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iReportSetup",
+ "description": "Default = {mode : relative, timeUnit : minute, time : 15}",
+ "required": false
+ }
+ ],
+ "example_query": "query getReportURL( $id: ID!, $type: ReportType!, $setup: iReportSetup ) { getReportURL( id: $id, type: $type, setup: $setup ) }",
+ "example_variables": "{ \"id\": 4, \"type\": \"dashboard\", \"setup\": {\"mode\": \"relative\", \"timeUnit\": \"minute\", \"time\": 15} }",
+ "example_response": "{\"data\": {\"getReportURL\": \"xyz789\"}}"
+ },
+ {
+ "name": "getSchemaExtensions",
+ "type": "query",
+ "description": "",
+ "response_type": "[SchemaExtension!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "query getSchemaExtensions( $id: [ID!], $orderBy: iOrderBy ) { getSchemaExtensions( id: $id, orderBy: $orderBy ) { id type executionType name newOperation operations script securityRole usableInSharing } }",
+ "example_variables": "{\"id\": [4], \"orderBy\": iOrderBy}",
+ "example_response": "{ \"data\": { \"getSchemaExtensions\": [ { \"id\": \"4\", \"type\": \"QUERY\", \"executionType\": \"GRAPHQL\", \"name\": \"abc123\", \"newOperation\": \"xyz789\", \"operations\": [\"abc123\"], \"script\": \"abc123\", \"securityRole\": \"ADMIN\", \"usableInSharing\": true } ] } }"
+ },
+ {
+ "name": "getSecret2FAKey",
+ "type": "query",
+ "description": "Return the Authenticator secret key",
+ "response_type": "a String!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "id of the user",
+ "required": true
+ }
+ ],
+ "example_query": "query getSecret2FAKey($id: ID!) { getSecret2FAKey(id: $id) }",
+ "example_variables": "{\"id\": 4}",
+ "example_response": "{\"data\": {\"getSecret2FAKey\": \"abc123\"}}"
+ },
+ {
+ "name": "getSharing",
+ "type": "query",
+ "description": "to retrieve the current sharing when logged in from a sharing key",
+ "response_type": "a Sharing",
+ "arguments": [],
+ "example_query": "query getSharing { getSharing { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } key hasPinCode type startDate endDate isActive owner { ...UserFragment } entities { ...PagingResponseFragment } securityProfile { ...SecurityProfileFragment } } }",
+ "example_variables": "",
+ "example_response": "{ \"data\": { \"getSharing\": { \"id\": \"4\", \"name\": \"xyz789\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"key\": \"abc123\", \"hasPinCode\": true, \"type\": \"xyz789\", \"startDate\": \"2007-12-03T10:15:30Z\", \"endDate\": \"2007-12-03T10:15:30Z\", \"isActive\": false, \"owner\": User, \"entities\": PagingResponse, \"securityProfile\": SecurityProfile } } }"
+ },
+ {
+ "name": "getUIFileContent",
+ "type": "query",
+ "description": "",
+ "response_type": "a String",
+ "arguments": [
+ {
+ "name": "from",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "path",
+ "type": "String!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query getUIFileContent( $from: String!, $path: String! ) { getUIFileContent( from: $from, path: $path ) }",
+ "example_variables": "{ \"from\": \"abc123\", \"path\": \"xyz789\" }",
+ "example_response": "{\"data\": {\"getUIFileContent\": \"xyz789\"}}"
+ },
+ {
+ "name": "getUIFiles",
+ "type": "query",
+ "description": "",
+ "response_type": "[UIProjectFile!]",
+ "arguments": [
+ {
+ "name": "from",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "path",
+ "type": "String",
+ "description": "Default = \"/\"",
+ "required": false
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "query getUIFiles( $from: String!, $path: String, $orderBy: iOrderBy ) { getUIFiles( from: $from, path: $path, orderBy: $orderBy ) { isFolder name path id description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } uiProject { ...UIProjectFragment } labels mimeType metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } translations } }",
+ "example_variables": "{ \"from\": \"xyz789\", \"path\": \"/\", \"orderBy\": iOrderBy }",
+ "example_response": "{ \"data\": { \"getUIFiles\": [ { \"isFolder\": true, \"name\": \"xyz789\", \"path\": \"xyz789\", \"id\": \"4\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"uiProject\": UIProject, \"labels\": [\"xyz789\"], \"mimeType\": \"xyz789\", \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"translations\": {} } ] } }"
+ },
+ {
+ "name": "getUIFilesByFilter",
+ "type": "query",
+ "description": "",
+ "response_type": "[UIProjectFile!]",
+ "arguments": [
+ {
+ "name": "from",
+ "type": "String",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "filter",
+ "type": "iFilter!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "query getUIFilesByFilter( $from: String, $filter: iFilter!, $orderBy: iOrderBy ) { getUIFilesByFilter( from: $from, filter: $filter, orderBy: $orderBy ) { isFolder name path id description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } uiProject { ...UIProjectFragment } labels mimeType metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } translations } }",
+ "example_variables": "{ \"from\": \"xyz789\", \"filter\": iFilter, \"orderBy\": iOrderBy }",
+ "example_response": "{ \"data\": { \"getUIFilesByFilter\": [ { \"isFolder\": false, \"name\": \"xyz789\", \"path\": \"xyz789\", \"id\": \"4\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"uiProject\": UIProject, \"labels\": [\"xyz789\"], \"mimeType\": \"abc123\", \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"translations\": {} } ] } }"
+ },
+ {
+ "name": "getUIProjectFiles",
+ "type": "query",
+ "description": "",
+ "response_type": "[UIProjectFile!]",
+ "arguments": [
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "path",
+ "type": "String",
+ "description": "Default = \"/\"",
+ "required": false
+ }
+ ],
+ "example_query": "query getUIProjectFiles( $name: String!, $path: String ) { getUIProjectFiles( name: $name, path: $path ) { isFolder name path id description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } uiProject { ...UIProjectFragment } labels mimeType metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } translations } }",
+ "example_variables": "{\"name\": \"abc123\", \"path\": \"/\"}",
+ "example_response": "{ \"data\": { \"getUIProjectFiles\": [ { \"isFolder\": true, \"name\": \"abc123\", \"path\": \"abc123\", \"id\": 4, \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"uiProject\": UIProject, \"labels\": [\"xyz789\"], \"mimeType\": \"xyz789\", \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"translations\": {} } ] } }"
+ },
+ {
+ "name": "getUIProjects",
+ "type": "query",
+ "description": "",
+ "response_type": "[UIProject!]",
+ "arguments": [
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "query getUIProjects($orderBy: iOrderBy) { getUIProjects(orderBy: $orderBy) { name id description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } type icon labels translations } }",
+ "example_variables": "{\"orderBy\": iOrderBy}",
+ "example_response": "{ \"data\": { \"getUIProjects\": [ { \"name\": \"abc123\", \"id\": 4, \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"type\": \"xyz789\", \"icon\": \"xyz789\", \"labels\": [\"xyz789\"], \"translations\": {} } ] } }"
+ },
+ {
+ "name": "getUIProjectsByFilter",
+ "type": "query",
+ "description": "",
+ "response_type": "[UIProject!]",
+ "arguments": [
+ {
+ "name": "filter",
+ "type": "iFilter!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "query getUIProjectsByFilter( $filter: iFilter!, $orderBy: iOrderBy ) { getUIProjectsByFilter( filter: $filter, orderBy: $orderBy ) { name id description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } type icon labels translations } }",
+ "example_variables": "{ \"filter\": iFilter, \"orderBy\": iOrderBy }",
+ "example_response": "{ \"data\": { \"getUIProjectsByFilter\": [ { \"name\": \"xyz789\", \"id\": 4, \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"type\": \"xyz789\", \"icon\": \"xyz789\", \"labels\": [\"abc123\"], \"translations\": {} } ] } }"
+ },
+ {
+ "name": "getUIProjectsByName",
+ "type": "query",
+ "description": "",
+ "response_type": "an UIProject",
+ "arguments": [
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "query getUIProjectsByName( $name: String!, $orderBy: iOrderBy ) { getUIProjectsByName( name: $name, orderBy: $orderBy ) { name id description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } type icon labels translations } }",
+ "example_variables": "{ \"name\": \"xyz789\", \"orderBy\": iOrderBy }",
+ "example_response": "{ \"data\": { \"getUIProjectsByName\": { \"name\": \"abc123\", \"id\": \"4\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"type\": \"xyz789\", \"icon\": \"xyz789\", \"labels\": [\"xyz789\"], \"translations\": {} } } }"
+ },
+ {
+ "name": "getUIProjectsByType",
+ "type": "query",
+ "description": "",
+ "response_type": "[UIProject!]",
+ "arguments": [
+ {
+ "name": "type",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "query getUIProjectsByType( $type: String!, $orderBy: iOrderBy ) { getUIProjectsByType( type: $type, orderBy: $orderBy ) { name id description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } type icon labels translations } }",
+ "example_variables": "{ \"type\": \"xyz789\", \"orderBy\": iOrderBy }",
+ "example_response": "{ \"data\": { \"getUIProjectsByType\": [ { \"name\": \"xyz789\", \"id\": 4, \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"type\": \"xyz789\", \"icon\": \"abc123\", \"labels\": [\"xyz789\"], \"translations\": {} } ] } }"
+ },
+ {
+ "name": "groupById",
+ "type": "query",
+ "description": "Retrieve group by id",
+ "response_type": "[Group!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query groupById($id: [ID!]!) { groupById(id: $id) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } isSystem metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } children { ...PagingResponseFragment } organization { ...OrganizationFragment } customers { ...CustomerPagingResponseFragment } } }",
+ "example_variables": "{\"id\": [\"4\"]}",
+ "example_response": "{ \"data\": { \"groupById\": [ { \"id\": 4, \"name\": \"abc123\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"isSystem\": true, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"children\": PagingResponse, \"organization\": Organization, \"customers\": CustomerPagingResponse } ] } }"
+ },
+ {
+ "name": "groups",
+ "type": "query",
+ "description": "Retrieve visible groups by the current logged user",
+ "response_type": "a GroupPagingResponse!",
+ "arguments": [
+ {
+ "name": "filter",
+ "type": "iFilter",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "limit",
+ "type": "Int",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "cursor",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "Default = {property : \"id\", direction : ASC}",
+ "required": false
+ }
+ ],
+ "example_query": "query groups( $filter: iFilter, $limit: Int, $cursor: ID, $orderBy: iOrderBy ) { groups( filter: $filter, limit: $limit, cursor: $cursor, orderBy: $orderBy ) { lowerCursor upperCursor hasMoreItems objectList { ...GroupFragment } } }",
+ "example_variables": "{ \"filter\": iFilter, \"limit\": 123, \"cursor\": 4, \"orderBy\": {\"property\": \"id\", \"direction\": \"ASC\"} }",
+ "example_response": "{ \"data\": { \"groups\": { \"lowerCursor\": \"4\", \"upperCursor\": 4, \"hasMoreItems\": false, \"objectList\": [Group] } } }"
+ },
+ {
+ "name": "hostById",
+ "type": "query",
+ "description": "Get host(s) based on ID",
+ "response_type": "[Host!]!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query hostById($id: [ID!]!) { hostById(id: $id) { id url } }",
+ "example_variables": "{\"id\": [4]}",
+ "example_response": "{ \"data\": { \"hostById\": [ { \"id\": \"4\", \"url\": \"xyz789\" } ] } }"
+ },
+ {
+ "name": "hostFoldersByPath",
+ "type": "query",
+ "description": "**List folders in a host **",
+ "response_type": "[String!]!",
+ "arguments": [
+ {
+ "name": "path",
+ "type": "String",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "hostId",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query hostFoldersByPath( $path: String, $hostId: ID! ) { hostFoldersByPath( path: $path, hostId: $hostId ) }",
+ "example_variables": "{\"path\": \"xyz789\", \"hostId\": 4}",
+ "example_response": "{\"data\": {\"hostFoldersByPath\": [\"abc123\"]}}"
+ },
+ {
+ "name": "hosts",
+ "type": "query",
+ "description": "List all hosts",
+ "response_type": "[Host!]!",
+ "arguments": [],
+ "example_query": "query hosts { hosts { id url } }",
+ "example_variables": "",
+ "example_response": "{ \"data\": { \"hosts\": [ { \"id\": \"4\", \"url\": \"xyz789\" } ] } }"
+ },
+ {
+ "name": "iccProfileById",
+ "type": "query",
+ "description": "",
+ "response_type": "[IccProfile!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query iccProfileById($id: [ID!]!) { iccProfileById(id: $id) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } type colorSpace1 colorSpace2 creator fileSize url } }",
+ "example_variables": "{\"id\": [4]}",
+ "example_response": "{ \"data\": { \"iccProfileById\": [ { \"id\": 4, \"name\": \"xyz789\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"type\": \"abc123\", \"colorSpace1\": \"xyz789\", \"colorSpace2\": \"abc123\", \"creator\": \"xyz789\", \"fileSize\": {}, \"url\": \"http://www.test.com/\" } ] } }"
+ },
+ {
+ "name": "iccProfileByName",
+ "type": "query",
+ "description": "",
+ "response_type": "an IccProfile!",
+ "arguments": [
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query iccProfileByName($name: String!) { iccProfileByName(name: $name) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } type colorSpace1 colorSpace2 creator fileSize url } }",
+ "example_variables": "{\"name\": \"abc123\"}",
+ "example_response": "{ \"data\": { \"iccProfileByName\": { \"id\": \"4\", \"name\": \"abc123\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"type\": \"xyz789\", \"colorSpace1\": \"abc123\", \"colorSpace2\": \"abc123\", \"creator\": \"abc123\", \"fileSize\": {}, \"url\": \"http://www.test.com/\" } } }"
+ },
+ {
+ "name": "iccProfiles",
+ "type": "query",
+ "description": "",
+ "response_type": "an IccProfilePagingResponse!",
+ "arguments": [
+ {
+ "name": "limit",
+ "type": "Int",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "cursor",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "Default = {property : \"name\", direction : ASC}",
+ "required": false
+ },
+ {
+ "name": "type",
+ "type": "[ICCProfileType]",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "query iccProfiles( $limit: Int, $cursor: ID, $orderBy: iOrderBy, $type: [ICCProfileType] ) { iccProfiles( limit: $limit, cursor: $cursor, orderBy: $orderBy, type: $type ) { lowerCursor upperCursor hasMoreItems objectList { ...IccProfileFragment } } }",
+ "example_variables": "{ \"limit\": 123, \"cursor\": \"4\", \"orderBy\": {\"property\": \"name\", \"direction\": \"ASC\"}, \"type\": [\"RGB\"] }",
+ "example_response": "{ \"data\": { \"iccProfiles\": { \"lowerCursor\": \"4\", \"upperCursor\": 4, \"hasMoreItems\": true, \"objectList\": [IccProfile] } } }"
+ },
+ {
+ "name": "importedFiles",
+ "type": "query",
+ "description": "**Get the list of files that have been imported",
+ "response_type": "[ImportedFile!]!",
+ "arguments": [],
+ "example_query": "query importedFiles { importedFiles { id name category fileSize comment creationDate lastImportDate } }",
+ "example_variables": "",
+ "example_response": "{ \"data\": { \"importedFiles\": [ { \"id\": \"4\", \"name\": \"abc123\", \"category\": \"xyz789\", \"fileSize\": 987, \"comment\": \"abc123\", \"creationDate\": \"2007-12-03T10:15:30Z\", \"lastImportDate\": \"2007-12-03T10:15:30Z\" } ] } }"
+ },
+ {
+ "name": "inkById",
+ "type": "query",
+ "description": "",
+ "response_type": "[Ink!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query inkById($id: [ID!]!) { inkById(id: $id) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } printable opacity order group cyan magenta yellow black rgb } }",
+ "example_variables": "{\"id\": [4]}",
+ "example_response": "{ \"data\": { \"inkById\": [ { \"id\": 4, \"name\": \"abc123\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"printable\": true, \"opacity\": 987.65, \"order\": 987, \"group\": \"xyz789\", \"cyan\": 987.65, \"magenta\": 123.45, \"yellow\": 123.45, \"black\": 987.65, \"rgb\": \"abc123\" } ] } }"
+ },
+ {
+ "name": "inkByName",
+ "type": "query",
+ "description": "",
+ "response_type": "an Ink!",
+ "arguments": [
+ {
+ "name": "name",
+ "type": "String",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "query inkByName($name: String) { inkByName(name: $name) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } printable opacity order group cyan magenta yellow black rgb } }",
+ "example_variables": "{\"name\": \"xyz789\"}",
+ "example_response": "{ \"data\": { \"inkByName\": { \"id\": \"4\", \"name\": \"abc123\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"printable\": true, \"opacity\": 123.45, \"order\": 123, \"group\": \"xyz789\", \"cyan\": 123.45, \"magenta\": 123.45, \"yellow\": 123.45, \"black\": 123.45, \"rgb\": \"xyz789\" } } }"
+ },
+ {
+ "name": "inkCoverage",
+ "type": "query",
+ "description": "Compute the ink coverage of a portion of a document defined by parameters of input iInkCoverageParams The response is a png image (Warning it is not a JSON response contentType='image/png')",
+ "response_type": "a Stream",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "parameters",
+ "type": "iInkCoverageParams!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query inkCoverage( $id: ID!, $parameters: iInkCoverageParams! ) { inkCoverage( id: $id, parameters: $parameters ) }",
+ "example_variables": "{\"id\": 4, \"parameters\": iInkCoverageParams}",
+ "example_response": "{\"data\": {\"inkCoverage\": Stream}}"
+ },
+ {
+ "name": "inks",
+ "type": "query",
+ "description": "",
+ "response_type": "an InkPagingResponse!",
+ "arguments": [
+ {
+ "name": "limit",
+ "type": "Int",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "cursor",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "Default = {property : \"name\", direction : ASC}",
+ "required": false
+ }
+ ],
+ "example_query": "query inks( $limit: Int, $cursor: ID, $orderBy: iOrderBy ) { inks( limit: $limit, cursor: $cursor, orderBy: $orderBy ) { lowerCursor upperCursor hasMoreItems objectList { ...InkFragment } } }",
+ "example_variables": "{ \"limit\": 123, \"cursor\": \"4\", \"orderBy\": {\"property\": \"name\", \"direction\": \"ASC\"} }",
+ "example_response": "{ \"data\": { \"inks\": { \"lowerCursor\": \"4\", \"upperCursor\": 4, \"hasMoreItems\": true, \"objectList\": [Ink] } } }"
+ },
+ {
+ "name": "inputChannelById",
+ "type": "query",
+ "description": "",
+ "response_type": "[InputChannel!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query inputChannelById($id: [ID!]!) { inputChannelById(id: $id) { id name description ruleSets { ...InputRuleSetFragment } pipes { ...InputPipeFragment } } }",
+ "example_variables": "{\"id\": [\"4\"]}",
+ "example_response": "{ \"data\": { \"inputChannelById\": [ { \"id\": \"4\", \"name\": \"abc123\", \"description\": \"xyz789\", \"ruleSets\": [InputRuleSet], \"pipes\": [InputPipe] } ] } }"
+ },
+ {
+ "name": "inputChannels",
+ "type": "query",
+ "description": "",
+ "response_type": "an InputChannelPagingResponse!",
+ "arguments": [
+ {
+ "name": "filter",
+ "type": "iFilter",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "limit",
+ "type": "Int",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "cursor",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "Default = {property : \"id\", direction : ASC}",
+ "required": false
+ }
+ ],
+ "example_query": "query inputChannels( $filter: iFilter, $limit: Int, $cursor: ID, $orderBy: iOrderBy ) { inputChannels( filter: $filter, limit: $limit, cursor: $cursor, orderBy: $orderBy ) { lowerCursor upperCursor hasMoreItems objectList { ...InputChannelFragment } } }",
+ "example_variables": "{ \"filter\": iFilter, \"limit\": 987, \"cursor\": \"4\", \"orderBy\": {\"property\": \"id\", \"direction\": \"ASC\"} }",
+ "example_response": "{ \"data\": { \"inputChannels\": { \"lowerCursor\": \"4\", \"upperCursor\": \"4\", \"hasMoreItems\": false, \"objectList\": [InputChannel] } } }"
+ },
+ {
+ "name": "inputRuleSetById",
+ "type": "query",
+ "description": "",
+ "response_type": "[InputRuleSet!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query inputRuleSetById($id: [ID!]!) { inputRuleSetById(id: $id) { id name description rules { ...InputRuleFragment } } }",
+ "example_variables": "{\"id\": [\"4\"]}",
+ "example_response": "{ \"data\": { \"inputRuleSetById\": [ { \"id\": \"4\", \"name\": \"abc123\", \"description\": \"xyz789\", \"rules\": [InputRule] } ] } }"
+ },
+ {
+ "name": "inputRuleSets",
+ "type": "query",
+ "description": "",
+ "response_type": "an InputRuleSetPagingResponse!",
+ "arguments": [
+ {
+ "name": "filter",
+ "type": "iFilter",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "limit",
+ "type": "Int",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "cursor",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "Default = {property : \"id\", direction : ASC}",
+ "required": false
+ }
+ ],
+ "example_query": "query inputRuleSets( $filter: iFilter, $limit: Int, $cursor: ID, $orderBy: iOrderBy ) { inputRuleSets( filter: $filter, limit: $limit, cursor: $cursor, orderBy: $orderBy ) { lowerCursor upperCursor hasMoreItems objectList { ...InputRuleSetFragment } } }",
+ "example_variables": "{ \"filter\": iFilter, \"limit\": 123, \"cursor\": \"4\", \"orderBy\": {\"property\": \"id\", \"direction\": \"ASC\"} }",
+ "example_response": "{ \"data\": { \"inputRuleSets\": { \"lowerCursor\": 4, \"upperCursor\": \"4\", \"hasMoreItems\": false, \"objectList\": [InputRuleSet] } } }"
+ },
+ {
+ "name": "layoutById",
+ "type": "query",
+ "description": "Retrieve Layout by ID or [ID]",
+ "response_type": "[Layout!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query layoutById($id: [ID!]!) { layoutById(id: $id) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } type applyTo priority layout translations icon } }",
+ "example_variables": "{\"id\": [\"4\"]}",
+ "example_response": "{ \"data\": { \"layoutById\": [ { \"id\": 4, \"name\": \"abc123\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"type\": \"ENTITY\", \"applyTo\": [\"Folder\"], \"priority\": 987, \"layout\": {}, \"translations\": {}, \"icon\": \"4\" } ] } }"
+ },
+ {
+ "name": "layouts",
+ "type": "query",
+ "description": "Retrieve Layouts",
+ "response_type": "a LayoutPagingResponse!",
+ "arguments": [
+ {
+ "name": "filter",
+ "type": "iFilter",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "limit",
+ "type": "Int",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "cursor",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "Default = {property : \"id\", direction : ASC}",
+ "required": false
+ }
+ ],
+ "example_query": "query layouts( $filter: iFilter, $limit: Int, $cursor: ID, $orderBy: iOrderBy ) { layouts( filter: $filter, limit: $limit, cursor: $cursor, orderBy: $orderBy ) { lowerCursor upperCursor hasMoreItems objectList { ...LayoutFragment } } }",
+ "example_variables": "{ \"filter\": iFilter, \"limit\": 987, \"cursor\": 4, \"orderBy\": {\"property\": \"id\", \"direction\": \"ASC\"} }",
+ "example_response": "{ \"data\": { \"layouts\": { \"lowerCursor\": \"4\", \"upperCursor\": 4, \"hasMoreItems\": true, \"objectList\": [Layout] } } }"
+ },
+ {
+ "name": "metadataDefinitionById",
+ "type": "query",
+ "description": "",
+ "response_type": "[MetadataDefinition!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query metadataDefinitionById($id: [ID!]!) { metadataDefinitionById(id: $id) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } nameSpace { ...MetadataNameSpaceFragment } type cardinality struct { ...MetadataDefinitionFragment } lName translations searchable availableInLayout saveInXmp required unique editable dictionary { ...DictionaryFragment } minRange maxRange minChar maxChar regex defaultValue } }",
+ "example_variables": "{\"id\": [\"4\"]}",
+ "example_response": "{ \"data\": { \"metadataDefinitionById\": [ { \"id\": 4, \"name\": \"xyz789\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"nameSpace\": MetadataNameSpace, \"type\": \"BOOLEAN\", \"cardinality\": \"SINGLE\", \"struct\": [MetadataDefinition], \"lName\": \"abc123\", \"translations\": {}, \"searchable\": true, \"availableInLayout\": true, \"saveInXmp\": true, \"required\": true, \"unique\": false, \"editable\": true, \"dictionary\": Dictionary, \"minRange\": Number, \"maxRange\": Number, \"minChar\": Number, \"maxChar\": Number, \"regex\": \"abc123\", \"defaultValue\": {} } ] } }"
+ },
+ {
+ "name": "metadataDefinitionByRef",
+ "type": "query",
+ "description": "",
+ "response_type": "[MetadataDefinition!]",
+ "arguments": [
+ {
+ "name": "ref",
+ "type": "[String!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query metadataDefinitionByRef($ref: [String!]!) { metadataDefinitionByRef(ref: $ref) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } nameSpace { ...MetadataNameSpaceFragment } type cardinality struct { ...MetadataDefinitionFragment } lName translations searchable availableInLayout saveInXmp required unique editable dictionary { ...DictionaryFragment } minRange maxRange minChar maxChar regex defaultValue } }",
+ "example_variables": "{\"ref\": [\"abc123\"]}",
+ "example_response": "{ \"data\": { \"metadataDefinitionByRef\": [ { \"id\": \"4\", \"name\": \"abc123\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"nameSpace\": MetadataNameSpace, \"type\": \"BOOLEAN\", \"cardinality\": \"SINGLE\", \"struct\": [MetadataDefinition], \"lName\": \"xyz789\", \"translations\": {}, \"searchable\": true, \"availableInLayout\": false, \"saveInXmp\": true, \"required\": true, \"unique\": true, \"editable\": false, \"dictionary\": Dictionary, \"minRange\": Number, \"maxRange\": Number, \"minChar\": Number, \"maxChar\": Number, \"regex\": \"xyz789\", \"defaultValue\": {} } ] } }"
+ },
+ {
+ "name": "myProofReadingMarks",
+ "type": "query",
+ "description": "Returns a ProofReadingMarkPagingResponse!",
+ "response_type": "a ProofReadingMarkPagingResponse!",
+ "arguments": [
+ {
+ "name": "filter",
+ "type": "iFilter",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "limit",
+ "type": "Int",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "cursor",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "Default = {property : \"id\", direction : ASC}",
+ "required": false
+ }
+ ],
+ "example_query": "query myProofReadingMarks( $filter: iFilter, $limit: Int, $cursor: ID, $orderBy: iOrderBy ) { myProofReadingMarks( filter: $filter, limit: $limit, cursor: $cursor, orderBy: $orderBy ) { lowerCursor upperCursor hasMoreItems objectList { ...ProofReadingMarkFragment } } }",
+ "example_variables": "{ \"filter\": iFilter, \"limit\": 123, \"cursor\": \"4\", \"orderBy\": {\"property\": \"id\", \"direction\": \"ASC\"} }",
+ "example_response": "{ \"data\": { \"myProofReadingMarks\": { \"lowerCursor\": \"4\", \"upperCursor\": \"4\", \"hasMoreItems\": false, \"objectList\": [ProofReadingMark] } } }"
+ },
+ {
+ "name": "myProofReadingMarksById",
+ "type": "query",
+ "description": "Returns [ProofReadingMark!]",
+ "response_type": "[ProofReadingMark!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query myProofReadingMarksById($id: [ID!]!) { myProofReadingMarksById(id: $id) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationUser { ...UserFragment } creationDate comment autoSetNoteContent isGlobal imageWidth imageHeight proofReadingMarkImage { ...ProofReadingMarkImageFragment } parents { ...ContainerFragment } } }",
+ "example_variables": "{\"id\": [4]}",
+ "example_response": "{ \"data\": { \"myProofReadingMarksById\": [ { \"id\": \"4\", \"name\": \"abc123\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"comment\": {}, \"autoSetNoteContent\": false, \"isGlobal\": false, \"imageWidth\": 987.65, \"imageHeight\": 123.45, \"proofReadingMarkImage\": ProofReadingMarkImage, \"parents\": [Container] } ] } }"
+ },
+ {
+ "name": "mySharing",
+ "type": "query",
+ "description": "",
+ "response_type": "a SharingResponse!",
+ "arguments": [
+ {
+ "name": "limit",
+ "type": "Int",
+ "description": "Default = 1000",
+ "required": false
+ },
+ {
+ "name": "cursor",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "Default = {property : \"id\", direction : ASC}",
+ "required": false
+ }
+ ],
+ "example_query": "query mySharing( $limit: Int, $cursor: ID, $orderBy: iOrderBy ) { mySharing( limit: $limit, cursor: $cursor, orderBy: $orderBy ) { lowerCursor upperCursor hasMoreItems objectList { ...SharingFragment } } }",
+ "example_variables": "{ \"limit\": 1000, \"cursor\": \"4\", \"orderBy\": {\"property\": \"id\", \"direction\": \"ASC\"} }",
+ "example_response": "{ \"data\": { \"mySharing\": { \"lowerCursor\": \"4\", \"upperCursor\": \"4\", \"hasMoreItems\": false, \"objectList\": [Sharing] } } }"
+ },
+ {
+ "name": "myWebAuthnRegistrations",
+ "type": "query",
+ "description": "",
+ "response_type": "a WebAuthnPagingResponse!",
+ "arguments": [
+ {
+ "name": "filter",
+ "type": "iFilter",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "limit",
+ "type": "Int",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "cursor",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "Default = {property : \"id\", direction : ASC}",
+ "required": false
+ }
+ ],
+ "example_query": "query myWebAuthnRegistrations( $filter: iFilter, $limit: Int, $cursor: ID, $orderBy: iOrderBy ) { myWebAuthnRegistrations( filter: $filter, limit: $limit, cursor: $cursor, orderBy: $orderBy ) { lowerCursor upperCursor hasMoreItems objectList { ...WebAuthnRegistrationFragment } } }",
+ "example_variables": "{ \"filter\": iFilter, \"limit\": 123, \"cursor\": 4, \"orderBy\": {\"property\": \"id\", \"direction\": \"ASC\"} }",
+ "example_response": "{ \"data\": { \"myWebAuthnRegistrations\": { \"lowerCursor\": 4, \"upperCursor\": 4, \"hasMoreItems\": true, \"objectList\": [WebAuthnRegistration] } } }"
+ },
+ {
+ "name": "nameSpaceDefinitionById",
+ "type": "query",
+ "description": "",
+ "response_type": "[MetadataNameSpace!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query nameSpaceDefinitionById($id: [ID!]!) { nameSpaceDefinitionById(id: $id) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } uri prefix metadataDefs { ...MetadataDefinitionFragment } lName translations searchable availableInLayout saveInXmp } }",
+ "example_variables": "{\"id\": [4]}",
+ "example_response": "{ \"data\": { \"nameSpaceDefinitionById\": [ { \"id\": 4, \"name\": \"abc123\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"uri\": \"http://www.test.com/\", \"prefix\": \"xyz789\", \"metadataDefs\": [MetadataDefinition], \"lName\": \"xyz789\", \"translations\": {}, \"searchable\": true, \"availableInLayout\": false, \"saveInXmp\": false } ] } }"
+ },
+ {
+ "name": "nameSpaceDefinitionByPrefix",
+ "type": "query",
+ "description": "",
+ "response_type": "[MetadataNameSpace!]",
+ "arguments": [
+ {
+ "name": "prefix",
+ "type": "[String!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query nameSpaceDefinitionByPrefix($prefix: [String!]!) { nameSpaceDefinitionByPrefix(prefix: $prefix) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } uri prefix metadataDefs { ...MetadataDefinitionFragment } lName translations searchable availableInLayout saveInXmp } }",
+ "example_variables": "{\"prefix\": [\"xyz789\"]}",
+ "example_response": "{ \"data\": { \"nameSpaceDefinitionByPrefix\": [ { \"id\": 4, \"name\": \"xyz789\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"uri\": \"http://www.test.com/\", \"prefix\": \"abc123\", \"metadataDefs\": [MetadataDefinition], \"lName\": \"abc123\", \"translations\": {}, \"searchable\": false, \"availableInLayout\": false, \"saveInXmp\": true } ] } }"
+ },
+ {
+ "name": "nameSpaceDefinitionByURI",
+ "type": "query",
+ "description": "",
+ "response_type": "[MetadataNameSpace!]",
+ "arguments": [
+ {
+ "name": "uri",
+ "type": "[URL!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query nameSpaceDefinitionByURI($uri: [URL!]!) { nameSpaceDefinitionByURI(uri: $uri) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } uri prefix metadataDefs { ...MetadataDefinitionFragment } lName translations searchable availableInLayout saveInXmp } }",
+ "example_variables": "{\"uri\": [\"http://www.test.com/\"]}",
+ "example_response": "{ \"data\": { \"nameSpaceDefinitionByURI\": [ { \"id\": \"4\", \"name\": \"abc123\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"uri\": \"http://www.test.com/\", \"prefix\": \"xyz789\", \"metadataDefs\": [MetadataDefinition], \"lName\": \"abc123\", \"translations\": {}, \"searchable\": false, \"availableInLayout\": false, \"saveInXmp\": true } ] } }"
+ },
+ {
+ "name": "nameSpaceDefinitions",
+ "type": "query",
+ "description": "",
+ "response_type": "[MetadataNameSpace!]",
+ "arguments": [],
+ "example_query": "query nameSpaceDefinitions { nameSpaceDefinitions { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } uri prefix metadataDefs { ...MetadataDefinitionFragment } lName translations searchable availableInLayout saveInXmp } }",
+ "example_variables": "",
+ "example_response": "{ \"data\": { \"nameSpaceDefinitions\": [ { \"id\": 4, \"name\": \"xyz789\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"uri\": \"http://www.test.com/\", \"prefix\": \"xyz789\", \"metadataDefs\": [MetadataDefinition], \"lName\": \"abc123\", \"translations\": {}, \"searchable\": true, \"availableInLayout\": true, \"saveInXmp\": true } ] } }"
+ },
+ {
+ "name": "namedSearchFilterById",
+ "type": "query",
+ "description": "",
+ "response_type": "[NamedSearchFilter!]!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query namedSearchFilterById($id: [ID!]!) { namedSearchFilterById(id: $id) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } filter { ...SearchFilterFragment } } }",
+ "example_variables": "{\"id\": [4]}",
+ "example_response": "{ \"data\": { \"namedSearchFilterById\": [ { \"id\": \"4\", \"name\": \"xyz789\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"filter\": SearchFilter } ] } }"
+ },
+ {
+ "name": "namedSearchFilterByName",
+ "type": "query",
+ "description": "",
+ "response_type": "[NamedSearchFilter!]!",
+ "arguments": [
+ {
+ "name": "name",
+ "type": "[String!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query namedSearchFilterByName($name: [String!]!) { namedSearchFilterByName(name: $name) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } filter { ...SearchFilterFragment } } }",
+ "example_variables": "{\"name\": [\"abc123\"]}",
+ "example_response": "{ \"data\": { \"namedSearchFilterByName\": [ { \"id\": \"4\", \"name\": \"abc123\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"filter\": SearchFilter } ] } }"
+ },
+ {
+ "name": "namedSearchFilters",
+ "type": "query",
+ "description": "",
+ "response_type": "[NamedSearchFilter!]!",
+ "arguments": [],
+ "example_query": "query namedSearchFilters { namedSearchFilters { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } filter { ...SearchFilterFragment } } }",
+ "example_variables": "",
+ "example_response": "{ \"data\": { \"namedSearchFilters\": [ { \"id\": 4, \"name\": \"abc123\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"filter\": SearchFilter } ] } }"
+ },
+ {
+ "name": "noteReport",
+ "type": "query",
+ "description": "**Generate a Report for one or several Asset(s) **",
+ "response_type": "a Stream",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "contentDisposition",
+ "type": "ContentDisposition",
+ "description": "Default = ATTACHMENT",
+ "required": false
+ },
+ {
+ "name": "display",
+ "type": "iReportDisplay",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "query noteReport( $id: [ID!]!, $contentDisposition: ContentDisposition, $display: iReportDisplay ) { noteReport( id: $id, contentDisposition: $contentDisposition, display: $display ) }",
+ "example_variables": "{ \"id\": [\"4\"], \"contentDisposition\": \"ATTACHMENT\", \"display\": iReportDisplay }",
+ "example_response": "{\"data\": {\"noteReport\": Stream}}"
+ },
+ {
+ "name": "notificationSender",
+ "type": "query",
+ "description": "",
+ "response_type": "a Boolean",
+ "arguments": [],
+ "example_query": "query notificationSender { notificationSender }",
+ "example_variables": "",
+ "example_response": "{\"data\": {\"notificationSender\": true}}"
+ },
+ {
+ "name": "notificationTemplateById",
+ "type": "query",
+ "description": "",
+ "response_type": "[NotificationTemplate!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query notificationTemplateById($id: [ID!]!) { notificationTemplateById(id: $id) { id name event { ... on ApprovalNotificationTemplateEvent { ...ApprovalNotificationTemplateEventFragment } ... on MilestoneNotificationTemplateEvent { ...MilestoneNotificationTemplateEventFragment } ... on BaseNotificationTemplateEvent { ...BaseNotificationTemplateEventFragment } } emailTemplate { ...EmailTemplateFragment } parentEntity { ...WithEmailTemplateFragment } lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } } }",
+ "example_variables": "{\"id\": [4]}",
+ "example_response": "{ \"data\": { \"notificationTemplateById\": [ { \"id\": \"4\", \"name\": \"abc123\", \"event\": ApprovalNotificationTemplateEvent, \"emailTemplate\": EmailTemplate, \"parentEntity\": WithEmailTemplate, \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User } ] } }"
+ },
+ {
+ "name": "notificationTemplates",
+ "type": "query",
+ "description": "",
+ "response_type": "a NotificationTemplatePagingResponse!",
+ "arguments": [
+ {
+ "name": "filter",
+ "type": "iFilter",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "limit",
+ "type": "Int",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "cursor",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "Default = {property : \"id\", direction : ASC}",
+ "required": false
+ }
+ ],
+ "example_query": "query notificationTemplates( $filter: iFilter, $limit: Int, $cursor: ID, $orderBy: iOrderBy ) { notificationTemplates( filter: $filter, limit: $limit, cursor: $cursor, orderBy: $orderBy ) { lowerCursor upperCursor hasMoreItems objectList { ...NotificationTemplateFragment } } }",
+ "example_variables": "{ \"filter\": iFilter, \"limit\": 123, \"cursor\": \"4\", \"orderBy\": {\"property\": \"id\", \"direction\": \"ASC\"} }",
+ "example_response": "{ \"data\": { \"notificationTemplates\": { \"lowerCursor\": 4, \"upperCursor\": \"4\", \"hasMoreItems\": true, \"objectList\": [NotificationTemplate] } } }"
+ },
+ {
+ "name": "notifications",
+ "type": "query",
+ "description": "Retrieve the notifications of a given type",
+ "response_type": "[Notification!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "iNotifiableID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "onlyEnabled",
+ "type": "Boolean",
+ "description": "Default = false",
+ "required": false
+ }
+ ],
+ "example_query": "query notifications( $id: iNotifiableID!, $onlyEnabled: Boolean ) { notifications( id: $id, onlyEnabled: $onlyEnabled ) { id event } }",
+ "example_variables": "{\"id\": iNotifiableID, \"onlyEnabled\": false}",
+ "example_response": "{ \"data\": { \"notifications\": [ { \"id\": \"4\", \"event\": \"PROJECT_CREATION\" } ] } }"
+ },
+ {
+ "name": "openDialogueConnection",
+ "type": "query",
+ "description": "Open a Dialogue connection to a document",
+ "response_type": "a DialogueConnection!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "revision",
+ "type": "Int",
+ "description": "Default = 0",
+ "required": false
+ },
+ {
+ "name": "pageNumber",
+ "type": "Int",
+ "description": "Default = 1",
+ "required": false
+ }
+ ],
+ "example_query": "query openDialogueConnection( $id: ID!, $revision: Int, $pageNumber: Int ) { openDialogueConnection( id: $id, revision: $revision, pageNumber: $pageNumber ) { id media { ...MediaFragment } pageNumber creationUser { ...UserFragment } host colorSettings { ...ColorSettingsFragment } } }",
+ "example_variables": "{\"id\": \"4\", \"revision\": 0, \"pageNumber\": 1}",
+ "example_response": "{ \"data\": { \"openDialogueConnection\": { \"id\": 4, \"media\": Media, \"pageNumber\": 123, \"creationUser\": User, \"host\": \"xyz789\", \"colorSettings\": ColorSettings } } }"
+ },
+ {
+ "name": "organizationById",
+ "type": "query",
+ "description": "",
+ "response_type": "[Organization!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query organizationById($id: [ID!]!) { organizationById(id: $id) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } children { ...PagingResponseFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } phone phone2 www fax shippingAddress { ...AddressFragment } billingAddress { ...AddressFragment } organization { ...OrganizationFragment } customers { ...CustomerFragment } emailTemplates { ...EmailTemplateFragment } notificationTemplates { ...NotificationTemplateFragment } ldapConfiguration { ...LDAPConfigurationFragment } applySecurityConfigToSubOrganization securityConfiguration { ...SecurityConfigurationFragment } notifications { ...NotificationFragment } } }",
+ "example_variables": "{\"id\": [\"4\"]}",
+ "example_response": "{ \"data\": { \"organizationById\": [ { \"id\": 4, \"name\": \"xyz789\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"children\": PagingResponse, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"phone\": \"xyz789\", \"phone2\": \"abc123\", \"www\": \"abc123\", \"fax\": \"abc123\", \"shippingAddress\": Address, \"billingAddress\": Address, \"organization\": Organization, \"customers\": [Customer], \"emailTemplates\": [EmailTemplate], \"notificationTemplates\": [NotificationTemplate], \"ldapConfiguration\": LDAPConfiguration, \"applySecurityConfigToSubOrganization\": true, \"securityConfiguration\": SecurityConfiguration, \"notifications\": [Notification] } ] } }"
+ },
+ {
+ "name": "organizations",
+ "type": "query",
+ "description": "Retrieve visible organizations by the current logged user",
+ "response_type": "an OrganizationPagingResponse!",
+ "arguments": [
+ {
+ "name": "limit",
+ "type": "Int",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "cursor",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "Default = {property : \"id\", direction : ASC}",
+ "required": false
+ }
+ ],
+ "example_query": "query organizations( $limit: Int, $cursor: ID, $orderBy: iOrderBy ) { organizations( limit: $limit, cursor: $cursor, orderBy: $orderBy ) { lowerCursor upperCursor hasMoreItems objectList { ...OrganizationFragment } } }",
+ "example_variables": "{\"limit\": 987, \"cursor\": 4, \"orderBy\": {\"property\": \"id\", \"direction\": \"ASC\"}}",
+ "example_response": "{ \"data\": { \"organizations\": { \"lowerCursor\": 4, \"upperCursor\": 4, \"hasMoreItems\": true, \"objectList\": [Organization] } } }"
+ },
+ {
+ "name": "organizationsByFilter",
+ "type": "query",
+ "description": "",
+ "response_type": "an OrganizationPagingResponse!",
+ "arguments": [
+ {
+ "name": "filter",
+ "type": "iFilter",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "limit",
+ "type": "Int",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "cursor",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "Default = {property : \"id\", direction : ASC}",
+ "required": false
+ }
+ ],
+ "example_query": "query organizationsByFilter( $filter: iFilter, $limit: Int, $cursor: ID, $orderBy: iOrderBy ) { organizationsByFilter( filter: $filter, limit: $limit, cursor: $cursor, orderBy: $orderBy ) { lowerCursor upperCursor hasMoreItems objectList { ...OrganizationFragment } } }",
+ "example_variables": "{ \"filter\": iFilter, \"limit\": 987, \"cursor\": \"4\", \"orderBy\": {\"property\": \"id\", \"direction\": \"ASC\"} }",
+ "example_response": "{ \"data\": { \"organizationsByFilter\": { \"lowerCursor\": 4, \"upperCursor\": \"4\", \"hasMoreItems\": false, \"objectList\": [Organization] } } }"
+ },
+ {
+ "name": "outputChannelById",
+ "type": "query",
+ "description": "Get output channel(s) based on ID",
+ "response_type": "[OutputChannel!]!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query outputChannelById($id: [ID!]!) { outputChannelById(id: $id) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } isActive } }",
+ "example_variables": "{\"id\": [\"4\"]}",
+ "example_response": "{ \"data\": { \"outputChannelById\": [ { \"id\": \"4\", \"name\": \"abc123\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"isActive\": false } ] } }"
+ },
+ {
+ "name": "outputChannelGroupById",
+ "type": "query",
+ "description": "Get output channel group(s) based on ID",
+ "response_type": "[OutputChannelGroup!]!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query outputChannelGroupById($id: [ID!]!) { outputChannelGroupById(id: $id) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } outputChannels { ...OutputChannelFragment } } }",
+ "example_variables": "{\"id\": [4]}",
+ "example_response": "{ \"data\": { \"outputChannelGroupById\": [ { \"id\": 4, \"name\": \"xyz789\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"outputChannels\": [OutputChannel] } ] } }"
+ },
+ {
+ "name": "outputChannelGroups",
+ "type": "query",
+ "description": "Get output channel groups",
+ "response_type": "an OutputChannelGroupPagingResponse!",
+ "arguments": [
+ {
+ "name": "limit",
+ "type": "Int",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "cursor",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "Default = {property : \"id\", direction : ASC}",
+ "required": false
+ }
+ ],
+ "example_query": "query outputChannelGroups( $limit: Int, $cursor: ID, $orderBy: iOrderBy ) { outputChannelGroups( limit: $limit, cursor: $cursor, orderBy: $orderBy ) { lowerCursor upperCursor hasMoreItems objectList { ...OutputChannelGroupFragment } } }",
+ "example_variables": "{ \"limit\": 123, \"cursor\": \"4\", \"orderBy\": {\"property\": \"id\", \"direction\": \"ASC\"} }",
+ "example_response": "{ \"data\": { \"outputChannelGroups\": { \"lowerCursor\": \"4\", \"upperCursor\": 4, \"hasMoreItems\": true, \"objectList\": [OutputChannelGroup] } } }"
+ },
+ {
+ "name": "participantsByRoleFilter",
+ "type": "query",
+ "description": "Retrieve visible participants that can use the given role in production list",
+ "response_type": "[Participant!]",
+ "arguments": [
+ {
+ "name": "role",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "onlyParticipantsWithActor",
+ "type": "Boolean",
+ "description": "Default = false",
+ "required": false
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "query participantsByRoleFilter( $role: ID!, $onlyParticipantsWithActor: Boolean, $orderBy: iOrderBy ) { participantsByRoleFilter( role: $role, onlyParticipantsWithActor: $onlyParticipantsWithActor, orderBy: $orderBy ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } } }",
+ "example_variables": "{ \"role\": 4, \"onlyParticipantsWithActor\": false, \"orderBy\": iOrderBy }",
+ "example_response": "{ \"data\": { \"participantsByRoleFilter\": [ { \"id\": \"4\", \"name\": \"xyz789\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User } ] } }"
+ },
+ {
+ "name": "preflightReport",
+ "type": "query",
+ "description": "**Generate a Preflight report for one or several Asset(s) or Media(s) **",
+ "response_type": "a Stream",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "contentDisposition",
+ "type": "ContentDisposition",
+ "description": "Default = ATTACHMENT",
+ "required": false
+ },
+ {
+ "name": "reportFormat",
+ "type": "PreflightReportFormat",
+ "description": "Default = PDF",
+ "required": false
+ }
+ ],
+ "example_query": "query preflightReport( $id: [ID!]!, $contentDisposition: ContentDisposition, $reportFormat: PreflightReportFormat ) { preflightReport( id: $id, contentDisposition: $contentDisposition, reportFormat: $reportFormat ) }",
+ "example_variables": "{ \"id\": [\"4\"], \"contentDisposition\": \"ATTACHMENT\", \"reportFormat\": \"PDF\" }",
+ "example_response": "{\"data\": {\"preflightReport\": Stream}}"
+ },
+ {
+ "name": "processById",
+ "type": "query",
+ "description": "Retrieve Processes by ID or [ID]",
+ "response_type": "[Process!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query processById($id: [ID!]!) { processById(id: $id) { id priority status virtualStatus startTime steps { ...ActivityInstanceFragment } workflow { ...WorkflowFragment } stages { ...StageFragment } object { ...EntityFragment } } }",
+ "example_variables": "{\"id\": [\"4\"]}",
+ "example_response": "{ \"data\": { \"processById\": [ { \"id\": 4, \"priority\": 987, \"status\": \"Created\", \"virtualStatus\": \"xyz789\", \"startTime\": \"2007-12-03T10:15:30Z\", \"steps\": [ActivityInstance], \"workflow\": Workflow, \"stages\": [Stage], \"object\": Entity } ] } }"
+ },
+ {
+ "name": "processMonitoring",
+ "type": "query",
+ "description": "Workflow activity",
+ "response_type": "a MonitoringPagingResponse!",
+ "arguments": [
+ {
+ "name": "scope",
+ "type": "[WorkflowableTypeName!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "workflow",
+ "type": "String",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "systemProcesses",
+ "type": "Boolean",
+ "description": "Default = false",
+ "required": false
+ },
+ {
+ "name": "userActionProcesses",
+ "type": "Boolean",
+ "description": "Default = false",
+ "required": false
+ },
+ {
+ "name": "heldStatus",
+ "type": "Boolean",
+ "description": "Default = true",
+ "required": false
+ },
+ {
+ "name": "limit",
+ "type": "Int",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "cursor",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "Default = {property : \"id\", direction : DESC}",
+ "required": false
+ }
+ ],
+ "example_query": "query processMonitoring( $scope: [WorkflowableTypeName!]!, $workflow: String, $systemProcesses: Boolean, $userActionProcesses: Boolean, $heldStatus: Boolean, $limit: Int, $cursor: ID, $orderBy: iOrderBy ) { processMonitoring( scope: $scope, workflow: $workflow, systemProcesses: $systemProcesses, userActionProcesses: $userActionProcesses, heldStatus: $heldStatus, limit: $limit, cursor: $cursor, orderBy: $orderBy ) { lowerCursor upperCursor hasMoreItems objectList { ...ActivityInstanceFragment } } }",
+ "example_variables": "{ \"scope\": [\"Folder\"], \"workflow\": \"abc123\", \"systemProcesses\": false, \"userActionProcesses\": false, \"heldStatus\": true, \"limit\": 123, \"cursor\": \"4\", \"orderBy\": {\"property\": \"id\", \"direction\": \"DESC\"} }",
+ "example_response": "{ \"data\": { \"processMonitoring\": { \"lowerCursor\": 4, \"upperCursor\": 4, \"hasMoreItems\": true, \"objectList\": [ActivityInstance] } } }"
+ },
+ {
+ "name": "processes",
+ "type": "query",
+ "description": "Retrieve Processes by filter",
+ "response_type": "a ProcessPagingResponse!",
+ "arguments": [
+ {
+ "name": "filter",
+ "type": "iFilter",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "limit",
+ "type": "Int",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "cursor",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "Default = {property : \"id\", direction : ASC}",
+ "required": false
+ }
+ ],
+ "example_query": "query processes( $filter: iFilter, $limit: Int, $cursor: ID, $orderBy: iOrderBy ) { processes( filter: $filter, limit: $limit, cursor: $cursor, orderBy: $orderBy ) { lowerCursor upperCursor hasMoreItems objectList { ...ProcessFragment } } }",
+ "example_variables": "{ \"filter\": iFilter, \"limit\": 987, \"cursor\": \"4\", \"orderBy\": {\"property\": \"id\", \"direction\": \"ASC\"} }",
+ "example_response": "{ \"data\": { \"processes\": { \"lowerCursor\": 4, \"upperCursor\": \"4\", \"hasMoreItems\": true, \"objectList\": [Process] } } }"
+ },
+ {
+ "name": "projectById",
+ "type": "query",
+ "description": "Retrieve Projects by ID or [ID]",
+ "response_type": "[Project!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query projectById($id: [ID!]!) { projectById(id: $id) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } trashDate trashUser { ...UserFragment } endDate metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } status workflowName approvalStatus { ...ApprovalActivityStatusFragment } approvalSummary approvals { ...ApprovalCycleFragment } assetApprovals { ...ApprovalCycleFragment } children { ...PagingResponseFragment } assetWorkflow { ...WorkflowFragment } processes { ...ProcessFragment } projectTemplate { ...ProjectTemplateFragment } priority colorSpace { ...ColorSpaceFragment } viewingCondition { ...ViewingConditionFragment } reversedView customer { ...CustomerFragment } parents { ...ContainerFragment } mainAsset { ...AssetFragment } siteId productionParticipants { ...ProductionParticipantFragment } notes { ...NoteFragment } trimmedHeight trimmedWidth nbPages accessControls deadlines { ...ProjectDeadlineFragment } } }",
+ "example_variables": "{\"id\": [4]}",
+ "example_response": "{ \"data\": { \"projectById\": [ { \"id\": 4, \"name\": \"abc123\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"trashDate\": \"2007-12-03T10:15:30Z\", \"trashUser\": User, \"endDate\": \"2007-12-03T10:15:30Z\", \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"status\": [\"ACTIVE\"], \"workflowName\": \"abc123\", \"approvalStatus\": [ApprovalActivityStatus], \"approvalSummary\": \"NONE\", \"approvals\": [ApprovalCycle], \"assetApprovals\": [ApprovalCycle], \"children\": PagingResponse, \"assetWorkflow\": Workflow, \"processes\": [Process], \"projectTemplate\": ProjectTemplate, \"priority\": 123, \"colorSpace\": ColorSpace, \"viewingCondition\": ViewingCondition, \"reversedView\": true, \"customer\": Customer, \"parents\": [Container], \"mainAsset\": Asset, \"siteId\": 4, \"productionParticipants\": [ProductionParticipant], \"notes\": [Note], \"trimmedHeight\": 987.65, \"trimmedWidth\": 987.65, \"nbPages\": 123, \"accessControls\": {}, \"deadlines\": [ProjectDeadline] } ] } }"
+ },
+ {
+ "name": "projectFolderById",
+ "type": "query",
+ "description": "Returns ProjectFolders by their IDs TODO Change security role",
+ "response_type": "[ProjectFolder!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query projectFolderById($id: [ID!]!) { projectFolderById(id: $id) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } trashDate trashUser { ...UserFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } readOnly productionSettings { ...ProductionSettingsFragment } processes { ...ProcessFragment } accessControlList { ...AccessControlListFragment } children { ...PagingResponseFragment } project { ...ProjectFragment } parents { ...ContainerFragment } path { ...ProjectFolderFragment } color icon } }",
+ "example_variables": "{\"id\": [4]}",
+ "example_response": "{ \"data\": { \"projectFolderById\": [ { \"id\": 4, \"name\": \"xyz789\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"trashDate\": \"2007-12-03T10:15:30Z\", \"trashUser\": User, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"readOnly\": false, \"productionSettings\": ProductionSettings, \"processes\": [Process], \"accessControlList\": AccessControlList, \"children\": PagingResponse, \"project\": Project, \"parents\": [Container], \"path\": [ProjectFolder], \"color\": \"xyz789\", \"icon\": \"4\" } ] } }"
+ },
+ {
+ "name": "projectTemplateById",
+ "type": "query",
+ "description": "Retrieve Project Templates by ID or [ID]",
+ "response_type": "[ProjectTemplate!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query projectTemplateById($id: [ID!]!) { projectTemplateById(id: $id) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } friendlyName priority colorSpace { ...ColorSpaceFragment } viewingCondition { ...ViewingConditionFragment } assetWorkflow { ...WorkflowFragment } projectWorkflow { ...WorkflowFragment } productionParticipants { ...ProductionParticipantFragment } assetApprovals { ...ApprovalCycleFragment } projectApprovals { ...ApprovalCycleFragment } deadlines { ...ProjectDeadlineFragment } skipWeekend } }",
+ "example_variables": "{\"id\": [\"4\"]}",
+ "example_response": "{ \"data\": { \"projectTemplateById\": [ { \"id\": 4, \"name\": \"xyz789\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"friendlyName\": \"xyz789\", \"priority\": 987, \"colorSpace\": ColorSpace, \"viewingCondition\": ViewingCondition, \"assetWorkflow\": Workflow, \"projectWorkflow\": Workflow, \"productionParticipants\": [ProductionParticipant], \"assetApprovals\": [ApprovalCycle], \"projectApprovals\": [ApprovalCycle], \"deadlines\": [ProjectDeadline], \"skipWeekend\": true } ] } }"
+ },
+ {
+ "name": "projectTemplates",
+ "type": "query",
+ "description": "Retrieve Project Templates",
+ "response_type": "a ProjectTemplateResponse!",
+ "arguments": [
+ {
+ "name": "filter",
+ "type": "iFilter",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "limit",
+ "type": "Int",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "cursor",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "Default = {property : \"id\", direction : ASC}",
+ "required": false
+ }
+ ],
+ "example_query": "query projectTemplates( $filter: iFilter, $limit: Int, $cursor: ID, $orderBy: iOrderBy ) { projectTemplates( filter: $filter, limit: $limit, cursor: $cursor, orderBy: $orderBy ) { lowerCursor upperCursor hasMoreItems objectList { ...ProjectTemplateFragment } } }",
+ "example_variables": "{ \"filter\": iFilter, \"limit\": 123, \"cursor\": 4, \"orderBy\": {\"property\": \"id\", \"direction\": \"ASC\"} }",
+ "example_response": "{ \"data\": { \"projectTemplates\": { \"lowerCursor\": 4, \"upperCursor\": 4, \"hasMoreItems\": true, \"objectList\": [ProjectTemplate] } } }"
+ },
+ {
+ "name": "projects",
+ "type": "query",
+ "description": "Retrieve Projects by filter",
+ "response_type": "a ProjectPagingResponse!",
+ "arguments": [
+ {
+ "name": "filter",
+ "type": "iFilter",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "limit",
+ "type": "Int",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "cursor",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "Default = {property : \"id\", direction : ASC}",
+ "required": false
+ }
+ ],
+ "example_query": "query projects( $filter: iFilter, $limit: Int, $cursor: ID, $orderBy: iOrderBy ) { projects( filter: $filter, limit: $limit, cursor: $cursor, orderBy: $orderBy ) { lowerCursor upperCursor hasMoreItems objectList { ...ProjectFragment } } }",
+ "example_variables": "{ \"filter\": iFilter, \"limit\": 123, \"cursor\": \"4\", \"orderBy\": {\"property\": \"id\", \"direction\": \"ASC\"} }",
+ "example_response": "{ \"data\": { \"projects\": { \"lowerCursor\": 4, \"upperCursor\": 4, \"hasMoreItems\": true, \"objectList\": [Project] } } }"
+ },
+ {
+ "name": "proofReadingMarks",
+ "type": "query",
+ "description": "Returns a ProofReadingMarkPagingResponse!",
+ "response_type": "a ProofReadingMarkPagingResponse!",
+ "arguments": [
+ {
+ "name": "filter",
+ "type": "iFilter",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "limit",
+ "type": "Int",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "cursor",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "Default = {property : \"id\", direction : ASC}",
+ "required": false
+ }
+ ],
+ "example_query": "query proofReadingMarks( $filter: iFilter, $limit: Int, $cursor: ID, $orderBy: iOrderBy ) { proofReadingMarks( filter: $filter, limit: $limit, cursor: $cursor, orderBy: $orderBy ) { lowerCursor upperCursor hasMoreItems objectList { ...ProofReadingMarkFragment } } }",
+ "example_variables": "{ \"filter\": iFilter, \"limit\": 987, \"cursor\": 4, \"orderBy\": {\"property\": \"id\", \"direction\": \"ASC\"} }",
+ "example_response": "{ \"data\": { \"proofReadingMarks\": { \"lowerCursor\": 4, \"upperCursor\": \"4\", \"hasMoreItems\": true, \"objectList\": [ProofReadingMark] } } }"
+ },
+ {
+ "name": "proofReadingMarksById",
+ "type": "query",
+ "description": "Returns [ProofReadingMark!]",
+ "response_type": "[ProofReadingMark!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query proofReadingMarksById($id: [ID!]!) { proofReadingMarksById(id: $id) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationUser { ...UserFragment } creationDate comment autoSetNoteContent isGlobal imageWidth imageHeight proofReadingMarkImage { ...ProofReadingMarkImageFragment } parents { ...ContainerFragment } } }",
+ "example_variables": "{\"id\": [\"4\"]}",
+ "example_response": "{ \"data\": { \"proofReadingMarksById\": [ { \"id\": \"4\", \"name\": \"xyz789\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"comment\": {}, \"autoSetNoteContent\": true, \"isGlobal\": false, \"imageWidth\": 987.65, \"imageHeight\": 987.65, \"proofReadingMarkImage\": ProofReadingMarkImage, \"parents\": [Container] } ] } }"
+ },
+ {
+ "name": "queryStatistics",
+ "type": "query",
+ "description": "Return the current query' statistics",
+ "response_type": "[QueryStatistic!]!",
+ "arguments": [],
+ "example_query": "query queryStatistics { queryStatistics { query count averageDuration minDuration maxDuration totalDuration operations { ...OperationStatisticFragment } } }",
+ "example_variables": "",
+ "example_response": "{ \"data\": { \"queryStatistics\": [ { \"query\": \"abc123\", \"count\": 123, \"averageDuration\": {}, \"minDuration\": {}, \"maxDuration\": {}, \"totalDuration\": {}, \"operations\": [OperationStatistic] } ] } }"
+ },
+ {
+ "name": "rasterize",
+ "type": "query",
+ "description": "Rendering of a portion of a document defined by parameters of input iRasterizeParams The response is a jpeg image (Warning it is not a JSON response contentType='image/jpeg')",
+ "response_type": "a Stream",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "parameters",
+ "type": "iRasterizeParams!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query rasterize( $id: ID!, $parameters: iRasterizeParams! ) { rasterize( id: $id, parameters: $parameters ) }",
+ "example_variables": "{\"id\": 4, \"parameters\": iRasterizeParams}",
+ "example_response": "{\"data\": {\"rasterize\": Stream}}"
+ },
+ {
+ "name": "readBarCode",
+ "type": "query",
+ "description": "Read a Barcode in the area defined by it's coordinates (in pt)",
+ "response_type": "[BarCode!]!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "x0",
+ "type": "Float!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "y0",
+ "type": "Float!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "x1",
+ "type": "Float!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "y1",
+ "type": "Float!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query readBarCode( $id: ID!, $x0: Float!, $y0: Float!, $x1: Float!, $y1: Float! ) { readBarCode( id: $id, x0: $x0, y0: $y0, x1: $x1, y1: $y1 ) { x0 y0 x1 y1 type value } }",
+ "example_variables": "{\"id\": 4, \"x0\": 987.65, \"y0\": 123.45, \"x1\": 987.65, \"y1\": 987.65}",
+ "example_response": "{ \"data\": { \"readBarCode\": [ { \"x0\": 123.45, \"y0\": 123.45, \"x1\": 123.45, \"y1\": 123.45, \"type\": \"abc123\", \"value\": \"xyz789\" } ] } }"
+ },
+ {
+ "name": "reports",
+ "type": "query",
+ "description": "",
+ "response_type": "[Report!]",
+ "arguments": [
+ {
+ "name": "type",
+ "type": "ReportType",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "query reports($type: ReportType) { reports(type: $type) { id type title description } }",
+ "example_variables": "{\"type\": \"dashboard\"}",
+ "example_response": "{ \"data\": { \"reports\": [ { \"id\": \"4\", \"type\": \"dashboard\", \"title\": \"abc123\", \"description\": \"abc123\" } ] } }"
+ },
+ {
+ "name": "roleById",
+ "type": "query",
+ "description": "Retrieve role by id",
+ "response_type": "[Role!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query roleById($id: [ID!]!) { roleById(id: $id) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } notifications { ...NotificationFragment } } }",
+ "example_variables": "{\"id\": [4]}",
+ "example_response": "{ \"data\": { \"roleById\": [ { \"id\": \"4\", \"name\": \"xyz789\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"notifications\": [Notification] } ] } }"
+ },
+ {
+ "name": "roles",
+ "type": "query",
+ "description": "Retrieve visible roles by the current logged user",
+ "response_type": "a RolePagingResponse!",
+ "arguments": [
+ {
+ "name": "filter",
+ "type": "iFilter",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "limit",
+ "type": "Int",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "cursor",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "Default = {property : \"id\", direction : ASC}",
+ "required": false
+ }
+ ],
+ "example_query": "query roles( $filter: iFilter, $limit: Int, $cursor: ID, $orderBy: iOrderBy ) { roles( filter: $filter, limit: $limit, cursor: $cursor, orderBy: $orderBy ) { lowerCursor upperCursor hasMoreItems objectList { ...RoleFragment } } }",
+ "example_variables": "{ \"filter\": iFilter, \"limit\": 123, \"cursor\": \"4\", \"orderBy\": {\"property\": \"id\", \"direction\": \"ASC\"} }",
+ "example_response": "{ \"data\": { \"roles\": { \"lowerCursor\": \"4\", \"upperCursor\": \"4\", \"hasMoreItems\": true, \"objectList\": [Role] } } }"
+ },
+ {
+ "name": "search",
+ "type": "query",
+ "description": "",
+ "response_type": "a SearchResponse",
+ "arguments": [
+ {
+ "name": "filter",
+ "type": "iSearchFilter!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "facets",
+ "type": "[String!]",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "limit",
+ "type": "Int",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "cursor",
+ "type": "ID",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "query search( $filter: iSearchFilter!, $facets: [String!], $limit: Int, $cursor: ID ) { search( filter: $filter, facets: $facets, limit: $limit, cursor: $cursor ) { upperCursor hasMoreItems objectList { ...EntityFragment } scores facets { ...FacetFragment } } }",
+ "example_variables": "{ \"filter\": iSearchFilter, \"facets\": [\"abc123\"], \"limit\": 987, \"cursor\": 4 }",
+ "example_response": "{ \"data\": { \"search\": { \"upperCursor\": \"4\", \"hasMoreItems\": false, \"objectList\": [Entity], \"scores\": [987.65], \"facets\": [Facet] } } }"
+ },
+ {
+ "name": "searchBySmartCollection",
+ "type": "query",
+ "description": "",
+ "response_type": "a SearchResponse",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "filter",
+ "type": "iSearchFilter!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "facets",
+ "type": "[String!]",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "limit",
+ "type": "Int",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "cursor",
+ "type": "ID",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "query searchBySmartCollection( $id: ID!, $filter: iSearchFilter!, $facets: [String!], $limit: Int, $cursor: ID ) { searchBySmartCollection( id: $id, filter: $filter, facets: $facets, limit: $limit, cursor: $cursor ) { upperCursor hasMoreItems objectList { ...EntityFragment } scores facets { ...FacetFragment } } }",
+ "example_variables": "{ \"id\": \"4\", \"filter\": iSearchFilter, \"facets\": [\"xyz789\"], \"limit\": 123, \"cursor\": 4 }",
+ "example_response": "{ \"data\": { \"searchBySmartCollection\": { \"upperCursor\": \"4\", \"hasMoreItems\": true, \"objectList\": [Entity], \"scores\": [123.45], \"facets\": [Facet] } } }"
+ },
+ {
+ "name": "securityProfileById",
+ "type": "query",
+ "description": "Retrieve SecurityProfile by id",
+ "response_type": "[SecurityProfile!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query securityProfileById($id: [ID!]!) { securityProfileById(id: $id) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } properties { ...SecurityPropertyFragment } } }",
+ "example_variables": "{\"id\": [\"4\"]}",
+ "example_response": "{ \"data\": { \"securityProfileById\": [ { \"id\": \"4\", \"name\": \"abc123\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"properties\": [SecurityProperty] } ] } }"
+ },
+ {
+ "name": "securityProfiles",
+ "type": "query",
+ "description": "Retrieve SecurityProfile by filter",
+ "response_type": "a SecurityProfilePagingResponse!",
+ "arguments": [
+ {
+ "name": "filter",
+ "type": "iFilter",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "limit",
+ "type": "Int",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "cursor",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "Default = {property : \"id\", direction : ASC}",
+ "required": false
+ }
+ ],
+ "example_query": "query securityProfiles( $filter: iFilter, $limit: Int, $cursor: ID, $orderBy: iOrderBy ) { securityProfiles( filter: $filter, limit: $limit, cursor: $cursor, orderBy: $orderBy ) { lowerCursor upperCursor hasMoreItems objectList { ...SecurityProfileFragment } } }",
+ "example_variables": "{ \"filter\": iFilter, \"limit\": 123, \"cursor\": \"4\", \"orderBy\": {\"property\": \"id\", \"direction\": \"ASC\"} }",
+ "example_response": "{ \"data\": { \"securityProfiles\": { \"lowerCursor\": 4, \"upperCursor\": \"4\", \"hasMoreItems\": true, \"objectList\": [SecurityProfile] } } }"
+ },
+ {
+ "name": "securityRoles",
+ "type": "query",
+ "description": "List all SecurityRoles",
+ "response_type": "[SecurityRoleDefinition!]!",
+ "arguments": [],
+ "example_query": "query securityRoles { securityRoles { role requires } }",
+ "example_variables": "",
+ "example_response": "{\"data\": {\"securityRoles\": [{\"role\": \"ADMIN\", \"requires\": [\"ADMIN\"]}]}}"
+ },
+ {
+ "name": "send2FAQRCodeByEmail",
+ "type": "query",
+ "description": "send the Authenticator QR code to the user per email",
+ "response_type": "a Boolean",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "id of the user",
+ "required": true
+ }
+ ],
+ "example_query": "query send2FAQRCodeByEmail($id: ID!) { send2FAQRCodeByEmail(id: $id) }",
+ "example_variables": "{\"id\": 4}",
+ "example_response": "{\"data\": {\"send2FAQRCodeByEmail\": false}}"
+ },
+ {
+ "name": "serverInformation",
+ "type": "query",
+ "description": "",
+ "response_type": "a ServerInformation!",
+ "arguments": [],
+ "example_query": "query serverInformation { serverInformation { guiClientId authorizationURL accessTokenURL authenticationKeys } }",
+ "example_variables": "",
+ "example_response": "{ \"data\": { \"serverInformation\": { \"guiClientId\": \"abc123\", \"authorizationURL\": \"http://www.test.com/\", \"accessTokenURL\": \"http://www.test.com/\", \"authenticationKeys\": [\"4\"] } } }"
+ },
+ {
+ "name": "servlets",
+ "type": "query",
+ "description": "List all registered servlet's name",
+ "response_type": "[String!]",
+ "arguments": [],
+ "example_query": "query servlets { servlets }",
+ "example_variables": "",
+ "example_response": "{\"data\": {\"servlets\": [\"xyz789\"]}}"
+ },
+ {
+ "name": "sharingById",
+ "type": "query",
+ "description": "",
+ "response_type": "[Sharing!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query sharingById($id: [ID!]!) { sharingById(id: $id) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } key hasPinCode type startDate endDate isActive owner { ...UserFragment } entities { ...PagingResponseFragment } securityProfile { ...SecurityProfileFragment } } }",
+ "example_variables": "{\"id\": [\"4\"]}",
+ "example_response": "{ \"data\": { \"sharingById\": [ { \"id\": \"4\", \"name\": \"abc123\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"key\": \"abc123\", \"hasPinCode\": true, \"type\": \"abc123\", \"startDate\": \"2007-12-03T10:15:30Z\", \"endDate\": \"2007-12-03T10:15:30Z\", \"isActive\": false, \"owner\": User, \"entities\": PagingResponse, \"securityProfile\": SecurityProfile } ] } }"
+ },
+ {
+ "name": "sharingByUser",
+ "type": "query",
+ "description": "here Name or ID for the users?",
+ "response_type": "a SharingResponse!",
+ "arguments": [
+ {
+ "name": "user",
+ "type": "[String!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "limit",
+ "type": "Int",
+ "description": "Default = 1000",
+ "required": false
+ },
+ {
+ "name": "cursor",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "Default = {property : \"id\", direction : ASC}",
+ "required": false
+ }
+ ],
+ "example_query": "query sharingByUser( $user: [String!]!, $limit: Int, $cursor: ID, $orderBy: iOrderBy ) { sharingByUser( user: $user, limit: $limit, cursor: $cursor, orderBy: $orderBy ) { lowerCursor upperCursor hasMoreItems objectList { ...SharingFragment } } }",
+ "example_variables": "{ \"user\": [\"xyz789\"], \"limit\": 1000, \"cursor\": \"4\", \"orderBy\": {\"property\": \"id\", \"direction\": \"ASC\"} }",
+ "example_response": "{ \"data\": { \"sharingByUser\": { \"lowerCursor\": \"4\", \"upperCursor\": \"4\", \"hasMoreItems\": true, \"objectList\": [Sharing] } } }"
+ },
+ {
+ "name": "sharings",
+ "type": "query",
+ "description": "",
+ "response_type": "a SharingResponse!",
+ "arguments": [
+ {
+ "name": "limit",
+ "type": "Int",
+ "description": "Default = 1000",
+ "required": false
+ },
+ {
+ "name": "cursor",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "Default = {property : \"id\", direction : ASC}",
+ "required": false
+ }
+ ],
+ "example_query": "query sharings( $limit: Int, $cursor: ID, $orderBy: iOrderBy ) { sharings( limit: $limit, cursor: $cursor, orderBy: $orderBy ) { lowerCursor upperCursor hasMoreItems objectList { ...SharingFragment } } }",
+ "example_variables": "{\"limit\": 1000, \"cursor\": 4, \"orderBy\": {\"property\": \"id\", \"direction\": \"ASC\"}}",
+ "example_response": "{ \"data\": { \"sharings\": { \"lowerCursor\": \"4\", \"upperCursor\": \"4\", \"hasMoreItems\": false, \"objectList\": [Sharing] } } }"
+ },
+ {
+ "name": "smartCollectionById",
+ "type": "query",
+ "description": "Retrieve Smart Collection by ID or [ID]",
+ "response_type": "[SmartCollection!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query smartCollectionById($id: [ID!]!) { smartCollectionById(id: $id) { id name description color lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } trashDate trashUser { ...UserFragment } icon lName translations children { ...PagingResponseFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } readOnly accessControlList { ...AccessControlListFragment } searchProperties { ...SmartCollectionSearchPropertiesFragment } } }",
+ "example_variables": "{\"id\": [\"4\"]}",
+ "example_response": "{ \"data\": { \"smartCollectionById\": [ { \"id\": \"4\", \"name\": \"abc123\", \"description\": \"abc123\", \"color\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"trashDate\": \"2007-12-03T10:15:30Z\", \"trashUser\": User, \"icon\": 4, \"lName\": \"xyz789\", \"translations\": {}, \"children\": PagingResponse, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"readOnly\": true, \"accessControlList\": AccessControlList, \"searchProperties\": SmartCollectionSearchProperties } ] } }"
+ },
+ {
+ "name": "smartCollections",
+ "type": "query",
+ "description": "Returns the paginated list of smart collections.",
+ "response_type": "a SmartCollectionPagingResponse!",
+ "arguments": [
+ {
+ "name": "filter",
+ "type": "iFilter",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "limit",
+ "type": "Int",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "cursor",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "Default = {property : \"id\", direction : ASC}",
+ "required": false
+ }
+ ],
+ "example_query": "query smartCollections( $filter: iFilter, $limit: Int, $cursor: ID, $orderBy: iOrderBy ) { smartCollections( filter: $filter, limit: $limit, cursor: $cursor, orderBy: $orderBy ) { lowerCursor upperCursor hasMoreItems objectList { ...SmartCollectionFragment } } }",
+ "example_variables": "{ \"filter\": iFilter, \"limit\": 987, \"cursor\": 4, \"orderBy\": {\"property\": \"id\", \"direction\": \"ASC\"} }",
+ "example_response": "{ \"data\": { \"smartCollections\": { \"lowerCursor\": \"4\", \"upperCursor\": 4, \"hasMoreItems\": true, \"objectList\": [SmartCollection] } } }"
+ },
+ {
+ "name": "streamAttachment",
+ "type": "query",
+ "description": "",
+ "response_type": "a Stream",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "contentDisposition",
+ "type": "ContentDisposition",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "query streamAttachment( $id: ID!, $contentDisposition: ContentDisposition ) { streamAttachment( id: $id, contentDisposition: $contentDisposition ) }",
+ "example_variables": "{\"id\": \"4\", \"contentDisposition\": \"INLINE\"}",
+ "example_response": "{\"data\": {\"streamAttachment\": Stream}}"
+ },
+ {
+ "name": "streamFile",
+ "type": "query",
+ "description": "Stream a subFile of an Asset",
+ "response_type": "a Stream",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "type",
+ "type": "FileType!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "revision",
+ "type": "Int",
+ "description": "Default = 0",
+ "required": false
+ },
+ {
+ "name": "pageNumber",
+ "type": "Int",
+ "description": "Default = 1",
+ "required": false
+ },
+ {
+ "name": "preferredResolution",
+ "type": "Int",
+ "description": "Default = 0",
+ "required": false
+ }
+ ],
+ "example_query": "query streamFile( $id: ID!, $type: FileType!, $revision: Int, $pageNumber: Int, $preferredResolution: Int ) { streamFile( id: $id, type: $type, revision: $revision, pageNumber: $pageNumber, preferredResolution: $preferredResolution ) }",
+ "example_variables": "{ \"id\": 4, \"type\": \"MAIN\", \"revision\": 0, \"pageNumber\": 1, \"preferredResolution\": 0 }",
+ "example_response": "{\"data\": {\"streamFile\": Stream}}"
+ },
+ {
+ "name": "streamPreflightPreview",
+ "type": "query",
+ "description": "Retrieve the preview of a given page of the preflight report",
+ "response_type": "a Stream",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "pageNumber",
+ "type": "Int",
+ "description": "Default = 1",
+ "required": false
+ }
+ ],
+ "example_query": "query streamPreflightPreview( $id: ID!, $pageNumber: Int ) { streamPreflightPreview( id: $id, pageNumber: $pageNumber ) }",
+ "example_variables": "{\"id\": 4, \"pageNumber\": 1}",
+ "example_response": "{\"data\": {\"streamPreflightPreview\": Stream}}"
+ },
+ {
+ "name": "streamUIFileContent",
+ "type": "query",
+ "description": "",
+ "response_type": "a Stream",
+ "arguments": [
+ {
+ "name": "from",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "path",
+ "type": "String!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query streamUIFileContent( $from: String!, $path: String! ) { streamUIFileContent( from: $from, path: $path ) }",
+ "example_variables": "{ \"from\": \"abc123\", \"path\": \"xyz789\" }",
+ "example_response": "{\"data\": {\"streamUIFileContent\": Stream}}"
+ },
+ {
+ "name": "synSetById",
+ "type": "query",
+ "description": "",
+ "response_type": "[SynSet!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query synSetById($id: [ID!]!) { synSetById(id: $id) { id uri label creationDate glosses sentences words { ...WordFragment } hyponyms { ...SynSetFragment } hypernyms { ...SynSetFragment } } }",
+ "example_variables": "{\"id\": [4]}",
+ "example_response": "{ \"data\": { \"synSetById\": [ { \"id\": 4, \"uri\": \"http://www.test.com/\", \"label\": \"xyz789\", \"creationDate\": \"2007-12-03T10:15:30Z\", \"glosses\": {}, \"sentences\": [{}], \"words\": [Word], \"hyponyms\": [SynSet], \"hypernyms\": [SynSet] } ] } }"
+ },
+ {
+ "name": "synSetByLabel",
+ "type": "query",
+ "description": "",
+ "response_type": "[SynSet!]",
+ "arguments": [
+ {
+ "name": "label",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query synSetByLabel($label: [ID!]!) { synSetByLabel(label: $label) { id uri label creationDate glosses sentences words { ...WordFragment } hyponyms { ...SynSetFragment } hypernyms { ...SynSetFragment } } }",
+ "example_variables": "{\"label\": [\"4\"]}",
+ "example_response": "{ \"data\": { \"synSetByLabel\": [ { \"id\": \"4\", \"uri\": \"http://www.test.com/\", \"label\": \"abc123\", \"creationDate\": \"2007-12-03T10:15:30Z\", \"glosses\": {}, \"sentences\": [{}], \"words\": [Word], \"hyponyms\": [SynSet], \"hypernyms\": [SynSet] } ] } }"
+ },
+ {
+ "name": "synSetByURI",
+ "type": "query",
+ "description": "",
+ "response_type": "[SynSet!]",
+ "arguments": [
+ {
+ "name": "uri",
+ "type": "[URL!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query synSetByURI($uri: [URL!]!) { synSetByURI(uri: $uri) { id uri label creationDate glosses sentences words { ...WordFragment } hyponyms { ...SynSetFragment } hypernyms { ...SynSetFragment } } }",
+ "example_variables": "{\"uri\": [\"http://www.test.com/\"]}",
+ "example_response": "{ \"data\": { \"synSetByURI\": [ { \"id\": 4, \"uri\": \"http://www.test.com/\", \"label\": \"xyz789\", \"creationDate\": \"2007-12-03T10:15:30Z\", \"glosses\": {}, \"sentences\": [{}], \"words\": [Word], \"hyponyms\": [SynSet], \"hypernyms\": [SynSet] } ] } }"
+ },
+ {
+ "name": "thesaurus",
+ "type": "query",
+ "description": "",
+ "response_type": "[Thesaurus!]!",
+ "arguments": [],
+ "example_query": "query thesaurus { thesaurus { id uri label lastModificationDate creationDate version langs titles descriptions topLevels { ...SynSetFragment } } }",
+ "example_variables": "",
+ "example_response": "{ \"data\": { \"thesaurus\": [ { \"id\": 4, \"uri\": \"http://www.test.com/\", \"label\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"creationDate\": \"2007-12-03T10:15:30Z\", \"version\": \"xyz789\", \"langs\": [\"ar\"], \"titles\": {}, \"descriptions\": {}, \"topLevels\": [SynSet] } ] } }"
+ },
+ {
+ "name": "thesaurusById",
+ "type": "query",
+ "description": "",
+ "response_type": "[Thesaurus!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query thesaurusById($id: [ID!]!) { thesaurusById(id: $id) { id uri label lastModificationDate creationDate version langs titles descriptions topLevels { ...SynSetFragment } } }",
+ "example_variables": "{\"id\": [\"4\"]}",
+ "example_response": "{ \"data\": { \"thesaurusById\": [ { \"id\": 4, \"uri\": \"http://www.test.com/\", \"label\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"creationDate\": \"2007-12-03T10:15:30Z\", \"version\": \"xyz789\", \"langs\": [\"ar\"], \"titles\": {}, \"descriptions\": {}, \"topLevels\": [SynSet] } ] } }"
+ },
+ {
+ "name": "thesaurusByLabel",
+ "type": "query",
+ "description": "",
+ "response_type": "[Thesaurus!]",
+ "arguments": [
+ {
+ "name": "label",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query thesaurusByLabel($label: [ID!]!) { thesaurusByLabel(label: $label) { id uri label lastModificationDate creationDate version langs titles descriptions topLevels { ...SynSetFragment } } }",
+ "example_variables": "{\"label\": [\"4\"]}",
+ "example_response": "{ \"data\": { \"thesaurusByLabel\": [ { \"id\": \"4\", \"uri\": \"http://www.test.com/\", \"label\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"creationDate\": \"2007-12-03T10:15:30Z\", \"version\": \"abc123\", \"langs\": [\"ar\"], \"titles\": {}, \"descriptions\": {}, \"topLevels\": [SynSet] } ] } }"
+ },
+ {
+ "name": "thesaurusByURI",
+ "type": "query",
+ "description": "",
+ "response_type": "[Thesaurus!]",
+ "arguments": [
+ {
+ "name": "uri",
+ "type": "[URL!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query thesaurusByURI($uri: [URL!]!) { thesaurusByURI(uri: $uri) { id uri label lastModificationDate creationDate version langs titles descriptions topLevels { ...SynSetFragment } } }",
+ "example_variables": "{\"uri\": [\"http://www.test.com/\"]}",
+ "example_response": "{ \"data\": { \"thesaurusByURI\": [ { \"id\": \"4\", \"uri\": \"http://www.test.com/\", \"label\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"creationDate\": \"2007-12-03T10:15:30Z\", \"version\": \"abc123\", \"langs\": [\"ar\"], \"titles\": {}, \"descriptions\": {}, \"topLevels\": [SynSet] } ] } }"
+ },
+ {
+ "name": "trashedObjects",
+ "type": "query",
+ "description": "",
+ "response_type": "a TrashablePagingResponse!",
+ "arguments": [
+ {
+ "name": "hideIfParentIsTrashed",
+ "type": "Boolean",
+ "description": "Default = true",
+ "required": false
+ },
+ {
+ "name": "filter",
+ "type": "iFilter",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "limit",
+ "type": "Int",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "cursor",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "Default = {property : \"id\", direction : ASC}",
+ "required": false
+ }
+ ],
+ "example_query": "query trashedObjects( $hideIfParentIsTrashed: Boolean, $filter: iFilter, $limit: Int, $cursor: ID, $orderBy: iOrderBy ) { trashedObjects( hideIfParentIsTrashed: $hideIfParentIsTrashed, filter: $filter, limit: $limit, cursor: $cursor, orderBy: $orderBy ) { lowerCursor upperCursor hasMoreItems objectList { ...TrashableFragment } } }",
+ "example_variables": "{ \"hideIfParentIsTrashed\": true, \"filter\": iFilter, \"limit\": 987, \"cursor\": 4, \"orderBy\": {\"property\": \"id\", \"direction\": \"ASC\"} }",
+ "example_response": "{ \"data\": { \"trashedObjects\": { \"lowerCursor\": \"4\", \"upperCursor\": 4, \"hasMoreItems\": false, \"objectList\": [Trashable] } } }"
+ },
+ {
+ "name": "userActionById",
+ "type": "query",
+ "description": "Get user action(s) based on ID",
+ "response_type": "[UserAction!]!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query userActionById($id: [ID!]!) { userActionById(id: $id) { id description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } applyTo context enableGrouping assetMimeTypes script icon translations productionParticipants { ...ProductionParticipantFragment } workflow { ...WorkflowFragment } destination destinationCollection } }",
+ "example_variables": "{\"id\": [\"4\"]}",
+ "example_response": "{ \"data\": { \"userActionById\": [ { \"id\": 4, \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"applyTo\": \"Folder\", \"context\": \"ORIGINAL_FILE\", \"enableGrouping\": false, \"assetMimeTypes\": [\"abc123\"], \"script\": \"abc123\", \"icon\": \"xyz789\", \"translations\": {}, \"productionParticipants\": [ProductionParticipant], \"workflow\": Workflow, \"destination\": \"WORKFLOW_DRIVEN\", \"destinationCollection\": \"abc123\" } ] } }"
+ },
+ {
+ "name": "userActionIconNames",
+ "type": "query",
+ "description": "** List the names of all uploaded user action icons **",
+ "response_type": "[String!]!",
+ "arguments": [],
+ "example_query": "query userActionIconNames { userActionIconNames }",
+ "example_variables": "",
+ "example_response": "{ \"data\": { \"userActionIconNames\": [\"abc123\"] } }"
+ },
+ {
+ "name": "userActionInstancesById",
+ "type": "query",
+ "description": "** Get user action instance(s) by id **",
+ "response_type": "[UserActionInstance!]!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query userActionInstancesById($id: [ID!]!) { userActionInstancesById(id: $id) { id userAction { ...UserActionFragment } user { ...UserFragment } status startDate source { ...EntityFragment } result { ...EntityFragment } } }",
+ "example_variables": "{\"id\": [4]}",
+ "example_response": "{ \"data\": { \"userActionInstancesById\": [ { \"id\": \"4\", \"userAction\": UserAction, \"user\": User, \"status\": \"Created\", \"startDate\": \"2007-12-03T10:15:30Z\", \"source\": [Entity], \"result\": [Entity] } ] } }"
+ },
+ {
+ "name": "userActionInstancesByUser",
+ "type": "query",
+ "description": "** Get user action instance(s) executed by the specified user**",
+ "response_type": "[UserActionInstance!]!",
+ "arguments": [
+ {
+ "name": "user",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query userActionInstancesByUser($user: [ID!]!) { userActionInstancesByUser(user: $user) { id userAction { ...UserActionFragment } user { ...UserFragment } status startDate source { ...EntityFragment } result { ...EntityFragment } } }",
+ "example_variables": "{\"user\": [4]}",
+ "example_response": "{ \"data\": { \"userActionInstancesByUser\": [ { \"id\": \"4\", \"userAction\": UserAction, \"user\": User, \"status\": \"Created\", \"startDate\": \"2007-12-03T10:15:30Z\", \"source\": [Entity], \"result\": [Entity] } ] } }"
+ },
+ {
+ "name": "userActions",
+ "type": "query",
+ "description": "List all user actions",
+ "response_type": "[UserAction!]!",
+ "arguments": [
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "query userActions($orderBy: iOrderBy) { userActions(orderBy: $orderBy) { id description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } applyTo context enableGrouping assetMimeTypes script icon translations productionParticipants { ...ProductionParticipantFragment } workflow { ...WorkflowFragment } destination destinationCollection } }",
+ "example_variables": "{\"orderBy\": iOrderBy}",
+ "example_response": "{ \"data\": { \"userActions\": [ { \"id\": 4, \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"applyTo\": \"Folder\", \"context\": \"ORIGINAL_FILE\", \"enableGrouping\": false, \"assetMimeTypes\": [\"abc123\"], \"script\": \"xyz789\", \"icon\": \"xyz789\", \"translations\": {}, \"productionParticipants\": [ProductionParticipant], \"workflow\": Workflow, \"destination\": \"WORKFLOW_DRIVEN\", \"destinationCollection\": \"xyz789\" } ] } }"
+ },
+ {
+ "name": "userById",
+ "type": "query",
+ "description": "Retrieve user by id",
+ "response_type": "[User!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query userById($id: [ID!]!) { userById(id: $id) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } login userCanLog lang dateFormat unitResolution unitLength color image use2FA channel2FA sessionTimeout workCapacity workCapacityUnit firstName lastName email title company phone phone2 homePhone fax mobilePhone department address { ...AddressFragment } organization { ...OrganizationFragment } groups { ...GroupFragment } roles { ...RoleFragment } defaultProfile { ...UserSecurityProfileFragment } availableProfiles { ...UserSecurityProfileFragment } notifications { ...NotificationFragment } } }",
+ "example_variables": "{\"id\": [\"4\"]}",
+ "example_response": "{ \"data\": { \"userById\": [ { \"id\": \"4\", \"name\": \"abc123\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"login\": \"abc123\", \"userCanLog\": true, \"lang\": \"ar\", \"dateFormat\": \"abc123\", \"unitResolution\": \"xyz789\", \"unitLength\": \"xyz789\", \"color\": \"xyz789\", \"image\": \"xyz789\", \"use2FA\": true, \"channel2FA\": \"AUTHENTICATOR\", \"sessionTimeout\": 123, \"workCapacity\": \"abc123\", \"workCapacityUnit\": \"xyz789\", \"firstName\": \"xyz789\", \"lastName\": \"abc123\", \"email\": \"abc123\", \"title\": \"abc123\", \"company\": \"xyz789\", \"phone\": \"abc123\", \"phone2\": \"xyz789\", \"homePhone\": \"xyz789\", \"fax\": \"abc123\", \"mobilePhone\": \"xyz789\", \"department\": \"xyz789\", \"address\": Address, \"organization\": Organization, \"groups\": [Group], \"roles\": [Role], \"defaultProfile\": UserSecurityProfile, \"availableProfiles\": [UserSecurityProfile], \"notifications\": [Notification] } ] } }"
+ },
+ {
+ "name": "userConnectionByClientId",
+ "type": "query",
+ "description": "",
+ "response_type": "[UserConnection!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query userConnectionByClientId($id: [ID!]) { userConnectionByClientId(id: $id) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } user { ...UserFragment } securityProfile { ...UserSecurityProfileFragment } expirationDate clientApplication { ...ClientApplicationFragment } authentication { ...AuthenticationFragment } sharing { ...SharingFragment } } }",
+ "example_variables": "{\"id\": [4]}",
+ "example_response": "{ \"data\": { \"userConnectionByClientId\": [ { \"id\": 4, \"name\": \"xyz789\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"user\": User, \"securityProfile\": UserSecurityProfile, \"expirationDate\": \"2007-12-03T10:15:30Z\", \"clientApplication\": ClientApplication, \"authentication\": Authentication, \"sharing\": Sharing } ] } }"
+ },
+ {
+ "name": "userConnectionById",
+ "type": "query",
+ "description": "",
+ "response_type": "[UserConnection!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query userConnectionById($id: [ID!]) { userConnectionById(id: $id) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } user { ...UserFragment } securityProfile { ...UserSecurityProfileFragment } expirationDate clientApplication { ...ClientApplicationFragment } authentication { ...AuthenticationFragment } sharing { ...SharingFragment } } }",
+ "example_variables": "{\"id\": [4]}",
+ "example_response": "{ \"data\": { \"userConnectionById\": [ { \"id\": \"4\", \"name\": \"xyz789\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"user\": User, \"securityProfile\": UserSecurityProfile, \"expirationDate\": \"2007-12-03T10:15:30Z\", \"clientApplication\": ClientApplication, \"authentication\": Authentication, \"sharing\": Sharing } ] } }"
+ },
+ {
+ "name": "userConnections",
+ "type": "query",
+ "description": "",
+ "response_type": "a UserConnectionPagingResponse",
+ "arguments": [
+ {
+ "name": "filter",
+ "type": "iFilter",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "limit",
+ "type": "Int",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "cursor",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "Default = {property : \"id\", direction : ASC}",
+ "required": false
+ }
+ ],
+ "example_query": "query userConnections( $filter: iFilter, $limit: Int, $cursor: ID, $orderBy: iOrderBy ) { userConnections( filter: $filter, limit: $limit, cursor: $cursor, orderBy: $orderBy ) { lowerCursor upperCursor hasMoreItems objectList { ...UserConnectionFragment } } }",
+ "example_variables": "{ \"filter\": iFilter, \"limit\": 987, \"cursor\": \"4\", \"orderBy\": {\"property\": \"id\", \"direction\": \"ASC\"} }",
+ "example_response": "{ \"data\": { \"userConnections\": { \"lowerCursor\": 4, \"upperCursor\": 4, \"hasMoreItems\": false, \"objectList\": [UserConnection] } } }"
+ },
+ {
+ "name": "userNotifications",
+ "type": "query",
+ "description": "Retrieve the notifications of the current user",
+ "response_type": "[Notification!]",
+ "arguments": [
+ {
+ "name": "onlyEnabled",
+ "type": "Boolean",
+ "description": "Default = false",
+ "required": false
+ }
+ ],
+ "example_query": "query userNotifications($onlyEnabled: Boolean) { userNotifications(onlyEnabled: $onlyEnabled) { id event } }",
+ "example_variables": "{\"onlyEnabled\": false}",
+ "example_response": "{ \"data\": { \"userNotifications\": [ { \"id\": \"4\", \"event\": \"PROJECT_CREATION\" } ] } }"
+ },
+ {
+ "name": "userPreference",
+ "type": "query",
+ "description": "",
+ "response_type": "[UserPreference]",
+ "arguments": [
+ {
+ "name": "name",
+ "type": "[String!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query userPreference($name: [String!]!) { userPreference(name: $name) { id name value } }",
+ "example_variables": "{\"name\": [\"abc123\"]}",
+ "example_response": "{ \"data\": { \"userPreference\": [ { \"id\": 4, \"name\": \"abc123\", \"value\": 4 } ] } }"
+ },
+ {
+ "name": "users",
+ "type": "query",
+ "description": "Retrieve visible users by the current logged user",
+ "response_type": "a UserPagingResponse!",
+ "arguments": [
+ {
+ "name": "filter",
+ "type": "iFilter",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "limit",
+ "type": "Int",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "cursor",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "Default = {property : \"id\", direction : ASC}",
+ "required": false
+ }
+ ],
+ "example_query": "query users( $filter: iFilter, $limit: Int, $cursor: ID, $orderBy: iOrderBy ) { users( filter: $filter, limit: $limit, cursor: $cursor, orderBy: $orderBy ) { lowerCursor upperCursor hasMoreItems objectList { ...UserFragment } } }",
+ "example_variables": "{ \"filter\": iFilter, \"limit\": 123, \"cursor\": 4, \"orderBy\": {\"property\": \"id\", \"direction\": \"ASC\"} }",
+ "example_response": "{ \"data\": { \"users\": { \"lowerCursor\": \"4\", \"upperCursor\": \"4\", \"hasMoreItems\": true, \"objectList\": [User] } } }"
+ },
+ {
+ "name": "viewingConditionById",
+ "type": "query",
+ "description": "",
+ "response_type": "[ViewingCondition!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query viewingConditionById($id: [ID!]!) { viewingConditionById(id: $id) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } parents { ...ContainerFragment } renderingIntent gamutCheck profile rgb { ...WorkingSpaceSimulationFragment } cmyk { ...WorkingSpaceSimulationFragment } gray { ...WorkingSpaceSimulationFragment } useCloseLoop closeLoop { ...CloseLoopParamsFragment } } }",
+ "example_variables": "{\"id\": [\"4\"]}",
+ "example_response": "{ \"data\": { \"viewingConditionById\": [ { \"id\": \"4\", \"name\": \"xyz789\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"parents\": [Container], \"renderingIntent\": \"PaperWhite\", \"gamutCheck\": true, \"profile\": \"abc123\", \"rgb\": WorkingSpaceSimulation, \"cmyk\": WorkingSpaceSimulation, \"gray\": WorkingSpaceSimulation, \"useCloseLoop\": true, \"closeLoop\": CloseLoopParams } ] } }"
+ },
+ {
+ "name": "viewingConditions",
+ "type": "query",
+ "description": "",
+ "response_type": "a ViewingConditionPagingResponse!",
+ "arguments": [
+ {
+ "name": "limit",
+ "type": "Int",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "cursor",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "Default = {property : \"name\", direction : ASC}",
+ "required": false
+ }
+ ],
+ "example_query": "query viewingConditions( $limit: Int, $cursor: ID, $orderBy: iOrderBy ) { viewingConditions( limit: $limit, cursor: $cursor, orderBy: $orderBy ) { lowerCursor upperCursor hasMoreItems objectList { ...ViewingConditionFragment } } }",
+ "example_variables": "{ \"limit\": 987, \"cursor\": \"4\", \"orderBy\": {\"property\": \"name\", \"direction\": \"ASC\"} }",
+ "example_response": "{ \"data\": { \"viewingConditions\": { \"lowerCursor\": 4, \"upperCursor\": 4, \"hasMoreItems\": true, \"objectList\": [ViewingCondition] } } }"
+ },
+ {
+ "name": "volumeById",
+ "type": "query",
+ "description": "Get volume(s) based on ID",
+ "response_type": "[Volume!]!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query volumeById($id: [ID!]!) { volumeById(id: $id) { id group access reference path nfsAlias smbAlias protocol server userName port } }",
+ "example_variables": "{\"id\": [4]}",
+ "example_response": "{ \"data\": { \"volumeById\": [ { \"id\": \"4\", \"group\": \"ATTACHMENT\", \"access\": \"DISABLED\", \"reference\": \"abc123\", \"path\": \"abc123\", \"nfsAlias\": \"abc123\", \"smbAlias\": \"abc123\", \"protocol\": \"FILE\", \"server\": \"xyz789\", \"userName\": \"xyz789\", \"port\": 123 } ] } }"
+ },
+ {
+ "name": "volumes",
+ "type": "query",
+ "description": "List all volumes",
+ "response_type": "[Volume!]!",
+ "arguments": [],
+ "example_query": "query volumes { volumes { id group access reference path nfsAlias smbAlias protocol server userName port } }",
+ "example_variables": "",
+ "example_response": "{ \"data\": { \"volumes\": [ { \"id\": \"4\", \"group\": \"ATTACHMENT\", \"access\": \"DISABLED\", \"reference\": \"xyz789\", \"path\": \"xyz789\", \"nfsAlias\": \"abc123\", \"smbAlias\": \"abc123\", \"protocol\": \"FILE\", \"server\": \"abc123\", \"userName\": \"abc123\", \"port\": 987 } ] } }"
+ },
+ {
+ "name": "webAuthnRegistrations",
+ "type": "query",
+ "description": "List all Webauthn registration of all users visible by the logged one.",
+ "response_type": "a WebAuthnPagingResponse!",
+ "arguments": [
+ {
+ "name": "filter",
+ "type": "iFilter",
+ "description": "applicable filter",
+ "required": false
+ },
+ {
+ "name": "limit",
+ "type": "Int",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "cursor",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "Default = {property : \"id\", direction : ASC}",
+ "required": false
+ }
+ ],
+ "example_query": "query webAuthnRegistrations( $filter: iFilter, $limit: Int, $cursor: ID, $orderBy: iOrderBy ) { webAuthnRegistrations( filter: $filter, limit: $limit, cursor: $cursor, orderBy: $orderBy ) { lowerCursor upperCursor hasMoreItems objectList { ...WebAuthnRegistrationFragment } } }",
+ "example_variables": "{ \"filter\": iFilter, \"limit\": 987, \"cursor\": \"4\", \"orderBy\": {\"property\": \"id\", \"direction\": \"ASC\"} }",
+ "example_response": "{ \"data\": { \"webAuthnRegistrations\": { \"lowerCursor\": \"4\", \"upperCursor\": 4, \"hasMoreItems\": false, \"objectList\": [WebAuthnRegistration] } } }"
+ },
+ {
+ "name": "whoami",
+ "type": "query",
+ "description": "",
+ "response_type": "a Whoami!",
+ "arguments": [],
+ "example_query": "query whoami { whoami { id user { ...UserFragment } securityProfile { ...UserSecurityProfileFragment } } }",
+ "example_variables": "",
+ "example_response": "{ \"data\": { \"whoami\": { \"id\": \"4\", \"user\": User, \"securityProfile\": UserSecurityProfile } } }"
+ },
+ {
+ "name": "workflowEngine",
+ "type": "query",
+ "description": "Retrieve Workflow Engine infos",
+ "response_type": "a WorkflowEngine!",
+ "arguments": [
+ {
+ "name": "url",
+ "type": "URL!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query workflowEngine($url: URL!) { workflowEngine(url: $url) { url id capacity running activities { ...ActivityEngineFragment } activityTemplates { ...ActivityEngineTemplateFragment } } }",
+ "example_variables": "{\"url\": \"http://www.test.com/\"}",
+ "example_response": "{ \"data\": { \"workflowEngine\": { \"url\": \"http://www.test.com/\", \"id\": \"4\", \"capacity\": 123, \"running\": 987, \"activities\": [ActivityEngine], \"activityTemplates\": [ActivityEngineTemplate] } } }"
+ },
+ {
+ "name": "workflows",
+ "type": "query",
+ "description": "Retrieve Workflows by filter",
+ "response_type": "a WorkflowPagingResponse!",
+ "arguments": [
+ {
+ "name": "filter",
+ "type": "iFilter",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "limit",
+ "type": "Int",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "cursor",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "orderBy",
+ "type": "iOrderBy",
+ "description": "Default = {property : \"id\", direction : ASC}",
+ "required": false
+ }
+ ],
+ "example_query": "query workflows( $filter: iFilter, $limit: Int, $cursor: ID, $orderBy: iOrderBy ) { workflows( filter: $filter, limit: $limit, cursor: $cursor, orderBy: $orderBy ) { lowerCursor upperCursor hasMoreItems objectList { ...WorkflowFragment } } }",
+ "example_variables": "{ \"filter\": iFilter, \"limit\": 987, \"cursor\": 4, \"orderBy\": {\"property\": \"id\", \"direction\": \"ASC\"} }",
+ "example_response": "{ \"data\": { \"workflows\": { \"lowerCursor\": \"4\", \"upperCursor\": 4, \"hasMoreItems\": true, \"objectList\": [Workflow] } } }"
+ },
+ {
+ "name": "workflowsByEntity",
+ "type": "query",
+ "description": "",
+ "response_type": "[Workflow!]",
+ "arguments": [
+ {
+ "name": "entityId",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "wflName",
+ "type": "[String!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query workflowsByEntity( $entityId: ID!, $wflName: [String!]! ) { workflowsByEntity( entityId: $entityId, wflName: $wflName ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } priority applyOn activities { ...ActivityFragment } links { ...LinkFragment } layout { ...WorkflowLayoutFragment } parameters { ...MetadataValueFragment } onFailed { ...FailHandlerFragment } onCompletedRetention onFailedRetention } }",
+ "example_variables": "{\"entityId\": 4, \"wflName\": [\"xyz789\"]}",
+ "example_response": "{ \"data\": { \"workflowsByEntity\": [ { \"id\": \"4\", \"name\": \"xyz789\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"priority\": 123, \"applyOn\": \"Folder\", \"activities\": [Activity], \"links\": [Link], \"layout\": WorkflowLayout, \"parameters\": [MetadataValue], \"onFailed\": FailHandler, \"onCompletedRetention\": 123, \"onFailedRetention\": 123 } ] } }"
+ },
+ {
+ "name": "workflowsById",
+ "type": "query",
+ "description": "Retrieve Workflows by ID or [ID]",
+ "response_type": "[Workflow!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "query workflowsById($id: [ID!]!) { workflowsById(id: $id) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } priority applyOn activities { ...ActivityFragment } links { ...LinkFragment } layout { ...WorkflowLayoutFragment } parameters { ...MetadataValueFragment } onFailed { ...FailHandlerFragment } onCompletedRetention onFailedRetention } }",
+ "example_variables": "{\"id\": [4]}",
+ "example_response": "{ \"data\": { \"workflowsById\": [ { \"id\": 4, \"name\": \"abc123\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"priority\": 987, \"applyOn\": \"Folder\", \"activities\": [Activity], \"links\": [Link], \"layout\": WorkflowLayout, \"parameters\": [MetadataValue], \"onFailed\": FailHandler, \"onCompletedRetention\": 123, \"onFailedRetention\": 123 } ] } }"
+ },
+ {
+ "name": "workflowsByName",
+ "type": "query",
+ "description": "Retrieve Workflows by name or [name] When revision is not defined returns the current revision, when revision is 0 returns all workflows with this name",
+ "response_type": "[Workflow!]",
+ "arguments": [
+ {
+ "name": "name",
+ "type": "[String!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "revision",
+ "type": "Int",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "query workflowsByName( $name: [String!]!, $revision: Int ) { workflowsByName( name: $name, revision: $revision ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } priority applyOn activities { ...ActivityFragment } links { ...LinkFragment } layout { ...WorkflowLayoutFragment } parameters { ...MetadataValueFragment } onFailed { ...FailHandlerFragment } onCompletedRetention onFailedRetention } }",
+ "example_variables": "{\"name\": [\"xyz789\"], \"revision\": 123}",
+ "example_response": "{ \"data\": { \"workflowsByName\": [ { \"id\": \"4\", \"name\": \"xyz789\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"priority\": 987, \"applyOn\": \"Folder\", \"activities\": [Activity], \"links\": [Link], \"layout\": WorkflowLayout, \"parameters\": [MetadataValue], \"onFailed\": FailHandler, \"onCompletedRetention\": 123, \"onFailedRetention\": 987 } ] } }"
+ },
+ {
+ "name": "addCustomerToGroup",
+ "type": "mutation",
+ "description": "**Add one or many Customers to one group.",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "to",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation addCustomerToGroup( $id: [ID!]!, $to: ID! ) { addCustomerToGroup( id: $id, to: $to ) }",
+ "example_variables": "{\"id\": [\"4\"], \"to\": 4}",
+ "example_response": "{\"data\": {\"addCustomerToGroup\": true}}"
+ },
+ {
+ "name": "addCustomerToOrganization",
+ "type": "mutation",
+ "description": "**Add one or many Customers to one Organization.",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "to",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation addCustomerToOrganization( $id: [ID!]!, $to: ID! ) { addCustomerToOrganization( id: $id, to: $to ) }",
+ "example_variables": "{\"id\": [4], \"to\": 4}",
+ "example_response": "{\"data\": {\"addCustomerToOrganization\": false}}"
+ },
+ {
+ "name": "addNoteAttachment",
+ "type": "mutation",
+ "description": "If a rank is specified the attachment will be added to the reply of the given rank If an attachment ID is specified, the existing attachment will be added to the note, only if the note has no current attachments.If no attachment ID is specified, the given files will be added to the note.If neither is secified, nothing will be done",
+ "response_type": "a Note!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "rank",
+ "type": "Long",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "files",
+ "type": "[Upload!]",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "attachment",
+ "type": "ID",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation addNoteAttachment( $id: ID!, $rank: Long, $files: [Upload!], $attachment: ID ) { addNoteAttachment( id: $id, rank: $rank, files: $files, attachment: $attachment ) { id type objectOwnerId pageNumber lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } attachments { ...AttachmentFragment } checkable status { ...AnnotationStatusFragment } collapsed seenBy { ...UserFragment } replies { ...NoteReplyFragment } content originalContent stylizedContent positionX positionY positionZ anchorX anchorY anchorZ tx ty proofReadingMark { ...ProofReadingMarkFragment } path selectable startTime endTime } }",
+ "example_variables": "{ \"id\": \"4\", \"rank\": {}, \"files\": [Upload], \"attachment\": 4 }",
+ "example_response": "{ \"data\": { \"addNoteAttachment\": { \"id\": \"4\", \"type\": \"Note\", \"objectOwnerId\": \"4\", \"pageNumber\": {}, \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"attachments\": [Attachment], \"checkable\": true, \"status\": AnnotationStatus, \"collapsed\": true, \"seenBy\": [User], \"replies\": [NoteReply], \"content\": \"abc123\", \"originalContent\": \"xyz789\", \"stylizedContent\": \"xyz789\", \"positionX\": 987.65, \"positionY\": 987.65, \"positionZ\": 123.45, \"anchorX\": 123.45, \"anchorY\": 123.45, \"anchorZ\": 987.65, \"tx\": 987.65, \"ty\": 123.45, \"proofReadingMark\": ProofReadingMark, \"path\": \"xyz789\", \"selectable\": true, \"startTime\": 123.45, \"endTime\": 987.65 } } }"
+ },
+ {
+ "name": "addObjectToCollection",
+ "type": "mutation",
+ "description": "To add an object in a Collection",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "class",
+ "type": "CollectionableTypeName!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "to",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation addObjectToCollection( $id: [ID!]!, $class: CollectionableTypeName!, $to: ID! ) { addObjectToCollection( id: $id, class: $class, to: $to ) }",
+ "example_variables": "{\"id\": [4], \"class\": \"ColorSpace\", \"to\": 4}",
+ "example_response": "{\"data\": {\"addObjectToCollection\": true}}"
+ },
+ {
+ "name": "addProfileToUser",
+ "type": "mutation",
+ "description": "Add one or many SecurityProfiles to one or many Users",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "to",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation addProfileToUser( $id: [ID!]!, $to: [ID!]! ) { addProfileToUser( id: $id, to: $to ) }",
+ "example_variables": "{\"id\": [\"4\"], \"to\": [4]}",
+ "example_response": "{\"data\": {\"addProfileToUser\": true}}"
+ },
+ {
+ "name": "addRoleToUser",
+ "type": "mutation",
+ "description": "Add one or many Role(s) to one or many User(s)",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "to",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation addRoleToUser( $id: [ID!]!, $to: [ID!]! ) { addRoleToUser( id: $id, to: $to ) }",
+ "example_variables": "{\"id\": [\"4\"], \"to\": [4]}",
+ "example_response": "{\"data\": {\"addRoleToUser\": true}}"
+ },
+ {
+ "name": "addUserToGroup",
+ "type": "mutation",
+ "description": "Add one or many Users to one or many Groups that are not System Groups. All the Users provided will be added to each Groups provided",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "to",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation addUserToGroup( $id: [ID!]!, $to: [ID!]! ) { addUserToGroup( id: $id, to: $to ) }",
+ "example_variables": "{\"id\": [\"4\"], \"to\": [4]}",
+ "example_response": "{\"data\": {\"addUserToGroup\": false}}"
+ },
+ {
+ "name": "approve",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "The id(s) of the request approval(s) to approve",
+ "required": true
+ },
+ {
+ "name": "comment",
+ "type": "String",
+ "description": "The comment associated to the approve action",
+ "required": false
+ },
+ {
+ "name": "checkViewingCondition",
+ "type": "Boolean",
+ "description": "Specify if the viewing condition should be checked or not. Default = true",
+ "required": false
+ }
+ ],
+ "example_query": "mutation approve( $id: [ID!]!, $comment: String, $checkViewingCondition: Boolean ) { approve( id: $id, comment: $comment, checkViewingCondition: $checkViewingCondition ) }",
+ "example_variables": "{ \"id\": [4], \"comment\": \"xyz789\", \"checkViewingCondition\": true }",
+ "example_response": "{\"data\": {\"approve\": true}}"
+ },
+ {
+ "name": "approveObject",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "The id(s) of the object(s) to approve",
+ "required": true
+ },
+ {
+ "name": "comment",
+ "type": "String",
+ "description": "The comment associated to the approve action",
+ "required": false
+ },
+ {
+ "name": "checkViewingCondition",
+ "type": "Boolean",
+ "description": "Specify if the viewing condition should be checked or not. Default = true",
+ "required": false
+ }
+ ],
+ "example_query": "mutation approveObject( $id: [ID!]!, $comment: String, $checkViewingCondition: Boolean ) { approveObject( id: $id, comment: $comment, checkViewingCondition: $checkViewingCondition ) }",
+ "example_variables": "{ \"id\": [4], \"comment\": \"xyz789\", \"checkViewingCondition\": true }",
+ "example_response": "{\"data\": {\"approveObject\": false}}"
+ },
+ {
+ "name": "cancelCheckOutAsset",
+ "type": "mutation",
+ "description": "To cancel the checkout of an Asset",
+ "response_type": "[Asset!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation cancelCheckOutAsset($id: [ID!]!) { cancelCheckOutAsset(id: $id) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } trashDate trashUser { ...UserFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } status approvalSummary approvalStatus { ...ApprovalActivityStatusFragment } approvals { ...ApprovalCycleFragment } workflowName isAlias processes { ...ProcessFragment } uuid priority isCheckedOut checkedOutBy { ...UserFragment } privateWorkingRevision isArchived archiveId colorSpace { ...ColorSpaceFragment } viewingCondition { ...ViewingConditionFragment } project { ...ProjectFragment } parents { ...ContainerFragment } numberOfRevisions expirationDate medias { ...MediaFragment } notes { ...NoteFragment } relationFrom { ...RelationFragment } relationTo { ...RelationFragment } accessControls } }",
+ "example_variables": "{\"id\": [4]}",
+ "example_response": "{ \"data\": { \"cancelCheckOutAsset\": [ { \"id\": \"4\", \"name\": \"abc123\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"trashDate\": \"2007-12-03T10:15:30Z\", \"trashUser\": User, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"status\": [\"ACTIVE\"], \"approvalSummary\": \"NONE\", \"approvalStatus\": [ApprovalActivityStatus], \"approvals\": [ApprovalCycle], \"workflowName\": \"abc123\", \"isAlias\": false, \"processes\": [Process], \"uuid\": \"xyz789\", \"priority\": 987, \"isCheckedOut\": true, \"checkedOutBy\": User, \"privateWorkingRevision\": 987, \"isArchived\": false, \"archiveId\": \"4\", \"colorSpace\": ColorSpace, \"viewingCondition\": ViewingCondition, \"project\": Project, \"parents\": [Container], \"numberOfRevisions\": 123, \"expirationDate\": \"2007-12-03T10:15:30Z\", \"medias\": [Media], \"notes\": [Note], \"relationFrom\": [Relation], \"relationTo\": [Relation], \"accessControls\": {} } ] } }"
+ },
+ {
+ "name": "cancelProcess",
+ "type": "mutation",
+ "description": "To cancel a workflow",
+ "response_type": "[Process!]!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation cancelProcess($id: [ID!]) { cancelProcess(id: $id) { id priority status virtualStatus startTime steps { ...ActivityInstanceFragment } workflow { ...WorkflowFragment } stages { ...StageFragment } object { ...EntityFragment } } }",
+ "example_variables": "{\"id\": [4]}",
+ "example_response": "{ \"data\": { \"cancelProcess\": [ { \"id\": \"4\", \"priority\": 987, \"status\": \"Created\", \"virtualStatus\": \"xyz789\", \"startTime\": \"2007-12-03T10:15:30Z\", \"steps\": [ActivityInstance], \"workflow\": Workflow, \"stages\": [Stage], \"object\": Entity } ] } }"
+ },
+ {
+ "name": "changeMyPassword",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "oldPassword",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "newPassword",
+ "type": "String!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation changeMyPassword( $oldPassword: String!, $newPassword: String! ) { changeMyPassword( oldPassword: $oldPassword, newPassword: $newPassword ) }",
+ "example_variables": "{ \"oldPassword\": \"xyz789\", \"newPassword\": \"xyz789\" }",
+ "example_response": "{\"data\": {\"changeMyPassword\": true}}"
+ },
+ {
+ "name": "changeMyProfile",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a JSON!",
+ "arguments": [
+ {
+ "name": "withSecurityProfile",
+ "type": "String!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation changeMyProfile($withSecurityProfile: String!) { changeMyProfile(withSecurityProfile: $withSecurityProfile) }",
+ "example_variables": "{\"withSecurityProfile\": \"xyz789\"}",
+ "example_response": "{\"data\": {\"changeMyProfile\": {}}}"
+ },
+ {
+ "name": "changeProcessPriority",
+ "type": "mutation",
+ "description": "To change the priority of a workflow",
+ "response_type": "[Process!]!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "priority",
+ "type": "Int!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation changeProcessPriority( $id: [ID!]!, $priority: Int! ) { changeProcessPriority( id: $id, priority: $priority ) { id priority status virtualStatus startTime steps { ...ActivityInstanceFragment } workflow { ...WorkflowFragment } stages { ...StageFragment } object { ...EntityFragment } } }",
+ "example_variables": "{\"id\": [\"4\"], \"priority\": 123}",
+ "example_response": "{ \"data\": { \"changeProcessPriority\": [ { \"id\": \"4\", \"priority\": 123, \"status\": \"Created\", \"virtualStatus\": \"abc123\", \"startTime\": \"2007-12-03T10:15:30Z\", \"steps\": [ActivityInstance], \"workflow\": Workflow, \"stages\": [Stage], \"object\": Entity } ] } }"
+ },
+ {
+ "name": "changeUser",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a User!",
+ "arguments": [
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation changeUser($name: String!) { changeUser(name: $name) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } login userCanLog lang dateFormat unitResolution unitLength color image use2FA channel2FA sessionTimeout workCapacity workCapacityUnit firstName lastName email title company phone phone2 homePhone fax mobilePhone department address { ...AddressFragment } organization { ...OrganizationFragment } groups { ...GroupFragment } roles { ...RoleFragment } defaultProfile { ...UserSecurityProfileFragment } availableProfiles { ...UserSecurityProfileFragment } notifications { ...NotificationFragment } } }",
+ "example_variables": "{\"name\": \"abc123\"}",
+ "example_response": "{ \"data\": { \"changeUser\": { \"id\": \"4\", \"name\": \"abc123\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"login\": \"xyz789\", \"userCanLog\": true, \"lang\": \"ar\", \"dateFormat\": \"xyz789\", \"unitResolution\": \"abc123\", \"unitLength\": \"abc123\", \"color\": \"xyz789\", \"image\": \"abc123\", \"use2FA\": true, \"channel2FA\": \"AUTHENTICATOR\", \"sessionTimeout\": 123, \"workCapacity\": \"xyz789\", \"workCapacityUnit\": \"xyz789\", \"firstName\": \"abc123\", \"lastName\": \"xyz789\", \"email\": \"xyz789\", \"title\": \"abc123\", \"company\": \"abc123\", \"phone\": \"xyz789\", \"phone2\": \"abc123\", \"homePhone\": \"abc123\", \"fax\": \"abc123\", \"mobilePhone\": \"abc123\", \"department\": \"xyz789\", \"address\": Address, \"organization\": Organization, \"groups\": [Group], \"roles\": [Role], \"defaultProfile\": UserSecurityProfile, \"availableProfiles\": [UserSecurityProfile], \"notifications\": [Notification] } } }"
+ },
+ {
+ "name": "checkInAsset",
+ "type": "mutation",
+ "description": "To checkin a new version of an Asset",
+ "response_type": "an Asset!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "file",
+ "type": "Upload",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "comment",
+ "type": "String",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "asRevision",
+ "type": "RevisioningState",
+ "description": "Default = MINOR",
+ "required": false
+ }
+ ],
+ "example_query": "mutation checkInAsset( $id: ID!, $file: Upload, $comment: String, $asRevision: RevisioningState ) { checkInAsset( id: $id, file: $file, comment: $comment, asRevision: $asRevision ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } trashDate trashUser { ...UserFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } status approvalSummary approvalStatus { ...ApprovalActivityStatusFragment } approvals { ...ApprovalCycleFragment } workflowName isAlias processes { ...ProcessFragment } uuid priority isCheckedOut checkedOutBy { ...UserFragment } privateWorkingRevision isArchived archiveId colorSpace { ...ColorSpaceFragment } viewingCondition { ...ViewingConditionFragment } project { ...ProjectFragment } parents { ...ContainerFragment } numberOfRevisions expirationDate medias { ...MediaFragment } notes { ...NoteFragment } relationFrom { ...RelationFragment } relationTo { ...RelationFragment } accessControls } }",
+ "example_variables": "{ \"id\": 4, \"file\": Upload, \"comment\": \"abc123\", \"asRevision\": \"MINOR\" }",
+ "example_response": "{ \"data\": { \"checkInAsset\": { \"id\": 4, \"name\": \"abc123\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"trashDate\": \"2007-12-03T10:15:30Z\", \"trashUser\": User, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"status\": [\"ACTIVE\"], \"approvalSummary\": \"NONE\", \"approvalStatus\": [ApprovalActivityStatus], \"approvals\": [ApprovalCycle], \"workflowName\": \"abc123\", \"isAlias\": true, \"processes\": [Process], \"uuid\": \"xyz789\", \"priority\": 123, \"isCheckedOut\": true, \"checkedOutBy\": User, \"privateWorkingRevision\": 987, \"isArchived\": true, \"archiveId\": 4, \"colorSpace\": ColorSpace, \"viewingCondition\": ViewingCondition, \"project\": Project, \"parents\": [Container], \"numberOfRevisions\": 123, \"expirationDate\": \"2007-12-03T10:15:30Z\", \"medias\": [Media], \"notes\": [Note], \"relationFrom\": [Relation], \"relationTo\": [Relation], \"accessControls\": {} } } }"
+ },
+ {
+ "name": "checkOutAsset",
+ "type": "mutation",
+ "description": "To checkOut the Asset(s) with Id or Ids",
+ "response_type": "[Asset!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation checkOutAsset($id: [ID!]!) { checkOutAsset(id: $id) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } trashDate trashUser { ...UserFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } status approvalSummary approvalStatus { ...ApprovalActivityStatusFragment } approvals { ...ApprovalCycleFragment } workflowName isAlias processes { ...ProcessFragment } uuid priority isCheckedOut checkedOutBy { ...UserFragment } privateWorkingRevision isArchived archiveId colorSpace { ...ColorSpaceFragment } viewingCondition { ...ViewingConditionFragment } project { ...ProjectFragment } parents { ...ContainerFragment } numberOfRevisions expirationDate medias { ...MediaFragment } notes { ...NoteFragment } relationFrom { ...RelationFragment } relationTo { ...RelationFragment } accessControls } }",
+ "example_variables": "{\"id\": [\"4\"]}",
+ "example_response": "{ \"data\": { \"checkOutAsset\": [ { \"id\": 4, \"name\": \"abc123\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"trashDate\": \"2007-12-03T10:15:30Z\", \"trashUser\": User, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"status\": [\"ACTIVE\"], \"approvalSummary\": \"NONE\", \"approvalStatus\": [ApprovalActivityStatus], \"approvals\": [ApprovalCycle], \"workflowName\": \"abc123\", \"isAlias\": false, \"processes\": [Process], \"uuid\": \"abc123\", \"priority\": 987, \"isCheckedOut\": false, \"checkedOutBy\": User, \"privateWorkingRevision\": 123, \"isArchived\": true, \"archiveId\": 4, \"colorSpace\": ColorSpace, \"viewingCondition\": ViewingCondition, \"project\": Project, \"parents\": [Container], \"numberOfRevisions\": 987, \"expirationDate\": \"2007-12-03T10:15:30Z\", \"medias\": [Media], \"notes\": [Note], \"relationFrom\": [Relation], \"relationTo\": [Relation], \"accessControls\": {} } ] } }"
+ },
+ {
+ "name": "clearUserActionInstancesById",
+ "type": "mutation",
+ "description": "** Delete running or completed user action(s) specified by ID**",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "removeResult",
+ "type": "Boolean",
+ "description": "Default = false",
+ "required": false
+ }
+ ],
+ "example_query": "mutation clearUserActionInstancesById( $id: [ID!]!, $removeResult: Boolean ) { clearUserActionInstancesById( id: $id, removeResult: $removeResult ) }",
+ "example_variables": "{\"id\": [\"4\"], \"removeResult\": false}",
+ "example_response": "{\"data\": {\"clearUserActionInstancesById\": true}}"
+ },
+ {
+ "name": "clearUserActionInstancesByUser",
+ "type": "mutation",
+ "description": "** Delete running or completed user action(s) linked to the specified user**",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "user",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "removeResult",
+ "type": "Boolean",
+ "description": "Default = false",
+ "required": false
+ }
+ ],
+ "example_query": "mutation clearUserActionInstancesByUser( $user: [ID!]!, $removeResult: Boolean ) { clearUserActionInstancesByUser( user: $user, removeResult: $removeResult ) }",
+ "example_variables": "{\"user\": [4], \"removeResult\": false}",
+ "example_response": "{\"data\": {\"clearUserActionInstancesByUser\": true}}"
+ },
+ {
+ "name": "connectAs",
+ "type": "mutation",
+ "description": "Enable an Admin to connect to ES as another User. The response is identical to a standard login, a new AccessToken is received.",
+ "response_type": "a JSON!",
+ "arguments": [
+ {
+ "name": "login",
+ "type": "String!",
+ "description": "login of the user",
+ "required": true
+ },
+ {
+ "name": "withSecurityProfile",
+ "type": "String",
+ "description": "name of a securityProfile",
+ "required": false
+ },
+ {
+ "name": "createIfNotExists",
+ "type": "Boolean",
+ "description": "Auto-created user if not exists",
+ "required": false
+ }
+ ],
+ "example_query": "mutation connectAs( $login: String!, $withSecurityProfile: String, $createIfNotExists: Boolean ) { connectAs( login: $login, withSecurityProfile: $withSecurityProfile, createIfNotExists: $createIfNotExists ) }",
+ "example_variables": "{ \"login\": \"abc123\", \"withSecurityProfile\": \"abc123\", \"createIfNotExists\": true }",
+ "example_response": "{\"data\": {\"connectAs\": {}}}"
+ },
+ {
+ "name": "copyAssetToFolder",
+ "type": "mutation",
+ "description": "Duplicate an asset. WARNING It is not currently possible to copy an asset between two ProjectFolders in the same Project!",
+ "response_type": "[Asset!]!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "to",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation copyAssetToFolder( $id: [ID!]!, $to: ID! ) { copyAssetToFolder( id: $id, to: $to ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } trashDate trashUser { ...UserFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } status approvalSummary approvalStatus { ...ApprovalActivityStatusFragment } approvals { ...ApprovalCycleFragment } workflowName isAlias processes { ...ProcessFragment } uuid priority isCheckedOut checkedOutBy { ...UserFragment } privateWorkingRevision isArchived archiveId colorSpace { ...ColorSpaceFragment } viewingCondition { ...ViewingConditionFragment } project { ...ProjectFragment } parents { ...ContainerFragment } numberOfRevisions expirationDate medias { ...MediaFragment } notes { ...NoteFragment } relationFrom { ...RelationFragment } relationTo { ...RelationFragment } accessControls } }",
+ "example_variables": "{\"id\": [4], \"to\": 4}",
+ "example_response": "{ \"data\": { \"copyAssetToFolder\": [ { \"id\": 4, \"name\": \"abc123\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"trashDate\": \"2007-12-03T10:15:30Z\", \"trashUser\": User, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"status\": [\"ACTIVE\"], \"approvalSummary\": \"NONE\", \"approvalStatus\": [ApprovalActivityStatus], \"approvals\": [ApprovalCycle], \"workflowName\": \"xyz789\", \"isAlias\": true, \"processes\": [Process], \"uuid\": \"abc123\", \"priority\": 987, \"isCheckedOut\": false, \"checkedOutBy\": User, \"privateWorkingRevision\": 123, \"isArchived\": false, \"archiveId\": \"4\", \"colorSpace\": ColorSpace, \"viewingCondition\": ViewingCondition, \"project\": Project, \"parents\": [Container], \"numberOfRevisions\": 987, \"expirationDate\": \"2007-12-03T10:15:30Z\", \"medias\": [Media], \"notes\": [Note], \"relationFrom\": [Relation], \"relationTo\": [Relation], \"accessControls\": {} } ] } }"
+ },
+ {
+ "name": "createAdminSecurityProfile",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a UserSecurityProfile",
+ "arguments": [
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "description",
+ "type": "String",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation createAdminSecurityProfile( $name: String!, $description: String ) { createAdminSecurityProfile( name: $name, description: $description ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } properties { ...SecurityPropertyFragment } securityRoles } }",
+ "example_variables": "{ \"name\": \"xyz789\", \"description\": \"abc123\" }",
+ "example_response": "{ \"data\": { \"createAdminSecurityProfile\": { \"id\": 4, \"name\": \"abc123\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"properties\": [SecurityProperty], \"securityRoles\": [\"ADMIN\"] } } }"
+ },
+ {
+ "name": "createAndUploadUIFile",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "in",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "parentPath",
+ "type": "String",
+ "description": "Default = \"/\"",
+ "required": false
+ },
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "content",
+ "type": "Upload!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iUIFileSetup",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation createAndUploadUIFile( $in: String!, $parentPath: String, $name: String!, $content: Upload!, $setup: iUIFileSetup ) { createAndUploadUIFile( in: $in, parentPath: $parentPath, name: $name, content: $content, setup: $setup ) }",
+ "example_variables": "{ \"in\": \"abc123\", \"parentPath\": \"/\", \"name\": \"xyz789\", \"content\": Upload, \"setup\": iUIFileSetup }",
+ "example_response": "{\"data\": {\"createAndUploadUIFile\": true}}"
+ },
+ {
+ "name": "createAnnotationStatus",
+ "type": "mutation",
+ "description": "Returns an AnnotationStatus!",
+ "response_type": "an AnnotationStatus!",
+ "arguments": [
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iAnnotationStatus",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation createAnnotationStatus( $name: String!, $setup: iAnnotationStatus ) { createAnnotationStatus( name: $name, setup: $setup ) { id lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } color icon isActive order translations } }",
+ "example_variables": "{ \"name\": \"abc123\", \"setup\": iAnnotationStatus }",
+ "example_response": "{ \"data\": { \"createAnnotationStatus\": { \"id\": 4, \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"color\": \"xyz789\", \"icon\": \"xyz789\", \"isActive\": true, \"order\": 987, \"translations\": {} } } }"
+ },
+ {
+ "name": "createAsset",
+ "type": "mutation",
+ "description": "To create an Asset.",
+ "response_type": "an AssetCreationStatus!",
+ "arguments": [
+ {
+ "name": "in",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "name",
+ "type": "String",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "checkedOut",
+ "type": "Boolean",
+ "description": "Default = false",
+ "required": false
+ },
+ {
+ "name": "setup",
+ "type": "iAssetSetup",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "input",
+ "type": "iInputFile",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation createAsset( $in: [ID!]!, $name: String, $checkedOut: Boolean, $setup: iAssetSetup, $input: iInputFile ) { createAsset( in: $in, name: $name, checkedOut: $checkedOut, setup: $setup, input: $input ) { created asset { ...AssetFragment } } }",
+ "example_variables": "{ \"in\": [\"4\"], \"name\": \"xyz789\", \"checkedOut\": false, \"setup\": iAssetSetup, \"input\": iInputFile }",
+ "example_response": "{ \"data\": { \"createAsset\": {\"created\": false, \"asset\": Asset} } }"
+ },
+ {
+ "name": "createAssetAlias",
+ "type": "mutation",
+ "description": "To create an Asset alias where 'id' is the Asset ID and 'to' defines a project or a project subfolder ID",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "to",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation createAssetAlias( $id: [ID!]!, $to: ID! ) { createAssetAlias( id: $id, to: $to ) }",
+ "example_variables": "{\"id\": [4], \"to\": 4}",
+ "example_response": "{\"data\": {\"createAssetAlias\": false}}"
+ },
+ {
+ "name": "createAuthentication",
+ "type": "mutation",
+ "description": "",
+ "response_type": "an Authentication!",
+ "arguments": [
+ {
+ "name": "type",
+ "type": "AuthenticationType!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iAuthentication!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation createAuthentication( $type: AuthenticationType!, $setup: iAuthentication! ) { createAuthentication( type: $type, setup: $setup ) { id type name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } authorizationURL tokenURL clientId isActive samlSetup { ...SAMLSetupFragment } } }",
+ "example_variables": "{\"type\": \"INTERNAL\", \"setup\": iAuthentication}",
+ "example_response": "{ \"data\": { \"createAuthentication\": { \"id\": 4, \"type\": \"INTERNAL\", \"name\": \"xyz789\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"authorizationURL\": \"http://www.test.com/\", \"tokenURL\": \"http://www.test.com/\", \"clientId\": \"4\", \"isActive\": false, \"samlSetup\": SAMLSetup } } }"
+ },
+ {
+ "name": "createClientApplication",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a ClientApplication!",
+ "arguments": [
+ {
+ "name": "setup",
+ "type": "iCreateClientApplication!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation createClientApplication($setup: iCreateClientApplication!) { createClientApplication(setup: $setup) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } allowIntrospection maxQueryDepth redirectURL secret schema defaultTokenDuration algorithm { ...JWTAlgorithmFragment } } }",
+ "example_variables": "{\"setup\": iCreateClientApplication}",
+ "example_response": "{ \"data\": { \"createClientApplication\": { \"id\": 4, \"name\": \"xyz789\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"allowIntrospection\": true, \"maxQueryDepth\": 987, \"redirectURL\": \"http://www.test.com/\", \"secret\": \"xyz789\", \"schema\": [\"ADMIN\"], \"defaultTokenDuration\": {}, \"algorithm\": JWTAlgorithm } } }"
+ },
+ {
+ "name": "createCollection",
+ "type": "mutation",
+ "description": "To create a Collection",
+ "response_type": "a Collection!",
+ "arguments": [
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "in",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "setup",
+ "type": "iCollectionSetup",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation createCollection( $name: String!, $in: ID, $setup: iCollectionSetup ) { createCollection( name: $name, in: $in, setup: $setup ) { id name description color lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } trashDate trashUser { ...UserFragment } icon lName translations children { ...PagingResponseFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } readOnly accessControlList { ...AccessControlListFragment } path { ...CollectionFragment } parents { ...ContainerFragment } destination { ...EntityFragment } } }",
+ "example_variables": "{ \"name\": \"abc123\", \"in\": \"4\", \"setup\": iCollectionSetup }",
+ "example_response": "{ \"data\": { \"createCollection\": { \"id\": 4, \"name\": \"abc123\", \"description\": \"abc123\", \"color\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"trashDate\": \"2007-12-03T10:15:30Z\", \"trashUser\": User, \"icon\": 4, \"lName\": \"xyz789\", \"translations\": {}, \"children\": PagingResponse, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"readOnly\": false, \"accessControlList\": AccessControlList, \"path\": [Collection], \"parents\": [Container], \"destination\": Entity } } }"
+ },
+ {
+ "name": "createColorSpace",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a ColorSpace!",
+ "arguments": [
+ {
+ "name": "setup",
+ "type": "iColorSpace!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "in",
+ "type": "ID",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation createColorSpace( $setup: iColorSpace!, $in: ID ) { createColorSpace( setup: $setup, in: $in ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } parents { ...ContainerFragment } colorEngine blackPointCompensation mixedWorkingSpace { ...ICCDestinationSelectionFragment } mixedVectorInput { ...ICCSourceSelectionFragment } mixedRasterInput { ...ICCSourceSelectionFragment } rgbWorkingSpace { ...ICCDestinationSelectionFragment } cmykWorkingSpace { ...ICCDestinationSelectionFragment } grayWorkingSpace { ...ICCDestinationSelectionFragment } } }",
+ "example_variables": "{\"setup\": iColorSpace, \"in\": 4}",
+ "example_response": "{ \"data\": { \"createColorSpace\": { \"id\": \"4\", \"name\": \"xyz789\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"parents\": [Container], \"colorEngine\": \"ADOBE_ACE\", \"blackPointCompensation\": true, \"mixedWorkingSpace\": ICCDestinationSelection, \"mixedVectorInput\": ICCSourceSelection, \"mixedRasterInput\": ICCSourceSelection, \"rgbWorkingSpace\": ICCDestinationSelection, \"cmykWorkingSpace\": ICCDestinationSelection, \"grayWorkingSpace\": ICCDestinationSelection } } }"
+ },
+ {
+ "name": "createCustomActivity",
+ "type": "mutation",
+ "description": "Custom activity creation",
+ "response_type": "an Activity!",
+ "arguments": [
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iActivity!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation createCustomActivity( $name: String!, $setup: iActivity! ) { createCustomActivity( name: $name, setup: $setup ) { id name bypassed icon color category } }",
+ "example_variables": "{ \"name\": \"abc123\", \"setup\": iActivity }",
+ "example_response": "{ \"data\": { \"createCustomActivity\": { \"id\": \"4\", \"name\": \"abc123\", \"bypassed\": false, \"icon\": 4, \"color\": \"abc123\", \"category\": \"abc123\" } } }"
+ },
+ {
+ "name": "createCustomer",
+ "type": "mutation",
+ "description": "Create a Customer",
+ "response_type": "a Customer!",
+ "arguments": [
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "in",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "defaultProjectTemplateId",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iCustomerSetup",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation createCustomer( $name: String!, $in: ID!, $defaultProjectTemplateId: ID!, $setup: iCustomerSetup ) { createCustomer( name: $name, in: $in, defaultProjectTemplateId: $defaultProjectTemplateId, setup: $setup ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } sites defaultSite defaultProjectTemplate { ...ProjectTemplateFragment } projectTemplates { ...ProjectTemplateFragment } code phone phone2 www fax shippingAddress { ...AddressFragment } billingAddress { ...AddressFragment } organization { ...OrganizationFragment } children { ...PagingResponseFragment } emailTemplates { ...EmailTemplateFragment } notificationTemplates { ...NotificationTemplateFragment } securityConfiguration { ...SecurityConfigurationFragment } notifications { ...NotificationFragment } } }",
+ "example_variables": "{ \"name\": \"xyz789\", \"in\": 4, \"defaultProjectTemplateId\": \"4\", \"setup\": iCustomerSetup }",
+ "example_response": "{ \"data\": { \"createCustomer\": { \"id\": 4, \"name\": \"xyz789\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"sites\": [\"abc123\"], \"defaultSite\": \"xyz789\", \"defaultProjectTemplate\": ProjectTemplate, \"projectTemplates\": [ProjectTemplate], \"code\": \"xyz789\", \"phone\": \"xyz789\", \"phone2\": \"xyz789\", \"www\": \"xyz789\", \"fax\": \"xyz789\", \"shippingAddress\": Address, \"billingAddress\": Address, \"organization\": Organization, \"children\": PagingResponse, \"emailTemplates\": [EmailTemplate], \"notificationTemplates\": [NotificationTemplate], \"securityConfiguration\": SecurityConfiguration, \"notifications\": [Notification] } } }"
+ },
+ {
+ "name": "createDefaultSecurityProfile",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a UserSecurityProfile",
+ "arguments": [
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "description",
+ "type": "String",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation createDefaultSecurityProfile( $name: String!, $description: String ) { createDefaultSecurityProfile( name: $name, description: $description ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } properties { ...SecurityPropertyFragment } securityRoles } }",
+ "example_variables": "{ \"name\": \"xyz789\", \"description\": \"abc123\" }",
+ "example_response": "{ \"data\": { \"createDefaultSecurityProfile\": { \"id\": \"4\", \"name\": \"xyz789\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"properties\": [SecurityProperty], \"securityRoles\": [\"ADMIN\"] } } }"
+ },
+ {
+ "name": "createEmailOutputChannel",
+ "type": "mutation",
+ "description": "Create an email output channel",
+ "response_type": "an EmailOutputChannel!",
+ "arguments": [
+ {
+ "name": "setup",
+ "type": "iEmailOutputChannelSetup!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "group",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation createEmailOutputChannel( $setup: iEmailOutputChannelSetup!, $group: ID! ) { createEmailOutputChannel( setup: $setup, group: $group ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } isActive to subject body specificAttachmentURL attachCurrentFile } }",
+ "example_variables": "{\"setup\": iEmailOutputChannelSetup, \"group\": 4}",
+ "example_response": "{ \"data\": { \"createEmailOutputChannel\": { \"id\": 4, \"name\": \"abc123\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"isActive\": false, \"to\": [\"abc123\"], \"subject\": \"xyz789\", \"body\": \"xyz789\", \"specificAttachmentURL\": \"http://www.test.com/\", \"attachCurrentFile\": true } } }"
+ },
+ {
+ "name": "createEmailTemplate",
+ "type": "mutation",
+ "description": "",
+ "response_type": "an EmailTemplate!",
+ "arguments": [
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "in",
+ "type": "iCustomizableEntityId",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "setup",
+ "type": "iEmailTemplate",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation createEmailTemplate( $name: String!, $in: iCustomizableEntityId, $setup: iEmailTemplate ) { createEmailTemplate( name: $name, in: $in, setup: $setup ) { id name description parentEntity { ...WithEmailTemplateFragment } emailParts attachPreview attachPreviewsIfMultipage attachCurrentFile attachHistoryReportAllRevisions attachHistoryReportCurrentRevision attachNoteReportAllRevisions attachNoteReportCurrentRevision attachPreflightReport lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } } }",
+ "example_variables": "{ \"name\": \"abc123\", \"in\": iCustomizableEntityId, \"setup\": iEmailTemplate }",
+ "example_response": "{ \"data\": { \"createEmailTemplate\": { \"id\": 4, \"name\": \"xyz789\", \"description\": \"abc123\", \"parentEntity\": WithEmailTemplate, \"emailParts\": {}, \"attachPreview\": false, \"attachPreviewsIfMultipage\": true, \"attachCurrentFile\": false, \"attachHistoryReportAllRevisions\": true, \"attachHistoryReportCurrentRevision\": false, \"attachNoteReportAllRevisions\": false, \"attachNoteReportCurrentRevision\": false, \"attachPreflightReport\": false, \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User } } }"
+ },
+ {
+ "name": "createFileOutputChannel",
+ "type": "mutation",
+ "description": "Create a file output channel",
+ "response_type": "a FileOutputChannel!",
+ "arguments": [
+ {
+ "name": "setup",
+ "type": "iFileOutputChannelSetup!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "group",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation createFileOutputChannel( $setup: iFileOutputChannelSetup!, $group: ID! ) { createFileOutputChannel( setup: $setup, group: $group ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } isActive encoding protocol server userName path fileName } }",
+ "example_variables": "{ \"setup\": iFileOutputChannelSetup, \"group\": \"4\" }",
+ "example_response": "{ \"data\": { \"createFileOutputChannel\": { \"id\": \"4\", \"name\": \"xyz789\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"isActive\": true, \"encoding\": \"UTF8\", \"protocol\": \"FILE\", \"server\": \"abc123\", \"userName\": \"xyz789\", \"path\": \"xyz789\", \"fileName\": \"abc123\" } } }"
+ },
+ {
+ "name": "createFileSystemVolume",
+ "type": "mutation",
+ "description": "Create a File System Volume",
+ "response_type": "a FileSystemVolume!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iFileSystemVolumeSetup!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation createFileSystemVolume( $id: ID!, $setup: iFileSystemVolumeSetup! ) { createFileSystemVolume( id: $id, setup: $setup ) { id group access reference path nfsAlias smbAlias protocol server userName port host { ...HostFragment } diskId site folderRegExp folderExclRegExp fileRegExp fileExclRegExp projectTemplate { ...ProjectTemplateFragment } monitoringQueue monitoring versioning updateMetadata monitorOnBrowse accessControlList { ...AccessControlListFragment } } }",
+ "example_variables": "{ \"id\": \"4\", \"setup\": iFileSystemVolumeSetup }",
+ "example_response": "{ \"data\": { \"createFileSystemVolume\": { \"id\": \"4\", \"group\": \"ATTACHMENT\", \"access\": \"DISABLED\", \"reference\": \"xyz789\", \"path\": \"abc123\", \"nfsAlias\": \"xyz789\", \"smbAlias\": \"xyz789\", \"protocol\": \"FILE\", \"server\": \"abc123\", \"userName\": \"abc123\", \"port\": 123, \"host\": Host, \"diskId\": \"4\", \"site\": \"abc123\", \"folderRegExp\": \"abc123\", \"folderExclRegExp\": \"abc123\", \"fileRegExp\": \"xyz789\", \"fileExclRegExp\": \"xyz789\", \"projectTemplate\": ProjectTemplate, \"monitoringQueue\": \"abc123\", \"monitoring\": true, \"versioning\": true, \"updateMetadata\": false, \"monitorOnBrowse\": true, \"accessControlList\": AccessControlList } } }"
+ },
+ {
+ "name": "createFolder",
+ "type": "mutation",
+ "description": "To create a Folder",
+ "response_type": "a Folder!",
+ "arguments": [
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "in",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iFolderSetup",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation createFolder( $name: String!, $in: ID!, $setup: iFolderSetup ) { createFolder( name: $name, in: $in, setup: $setup ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } trashDate trashUser { ...UserFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } readOnly productionSettings { ...ProductionSettingsFragment } processes { ...ProcessFragment } accessControlList { ...AccessControlListFragment } children { ...PagingResponseFragment } project { ...ProjectFragment } parents { ...ContainerFragment } path { ...FolderFragment } color icon } }",
+ "example_variables": "{ \"name\": \"xyz789\", \"in\": 4, \"setup\": iFolderSetup }",
+ "example_response": "{ \"data\": { \"createFolder\": { \"id\": 4, \"name\": \"xyz789\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"trashDate\": \"2007-12-03T10:15:30Z\", \"trashUser\": User, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"readOnly\": true, \"productionSettings\": ProductionSettings, \"processes\": [Process], \"accessControlList\": AccessControlList, \"children\": PagingResponse, \"project\": Project, \"parents\": [Container], \"path\": [Folder], \"color\": \"xyz789\", \"icon\": 4 } } }"
+ },
+ {
+ "name": "createFolderFromProject",
+ "type": "mutation",
+ "description": "To create a Folder from a Project in the selected Folder",
+ "response_type": "a Folder!",
+ "arguments": [
+ {
+ "name": "projectId",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "folderId",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation createFolderFromProject( $projectId: ID!, $folderId: ID! ) { createFolderFromProject( projectId: $projectId, folderId: $folderId ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } trashDate trashUser { ...UserFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } readOnly productionSettings { ...ProductionSettingsFragment } processes { ...ProcessFragment } accessControlList { ...AccessControlListFragment } children { ...PagingResponseFragment } project { ...ProjectFragment } parents { ...ContainerFragment } path { ...FolderFragment } color icon } }",
+ "example_variables": "{\"projectId\": 4, \"folderId\": 4}",
+ "example_response": "{ \"data\": { \"createFolderFromProject\": { \"id\": \"4\", \"name\": \"abc123\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"trashDate\": \"2007-12-03T10:15:30Z\", \"trashUser\": User, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"readOnly\": true, \"productionSettings\": ProductionSettings, \"processes\": [Process], \"accessControlList\": AccessControlList, \"children\": PagingResponse, \"project\": Project, \"parents\": [Container], \"path\": [Folder], \"color\": \"xyz789\", \"icon\": 4 } } }"
+ },
+ {
+ "name": "createGlobalProofReadingMark",
+ "type": "mutation",
+ "description": "Returns a Boolean!",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "in",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "setup",
+ "type": "iProofReadingMarkSetup!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation createGlobalProofReadingMark( $name: String!, $in: ID, $setup: iProofReadingMarkSetup! ) { createGlobalProofReadingMark( name: $name, in: $in, setup: $setup ) }",
+ "example_variables": "{ \"name\": \"abc123\", \"in\": 4, \"setup\": iProofReadingMarkSetup }",
+ "example_response": "{\"data\": {\"createGlobalProofReadingMark\": false}}"
+ },
+ {
+ "name": "createGroup",
+ "type": "mutation",
+ "description": "Create a Group in the specified Organization",
+ "response_type": "a Group!",
+ "arguments": [
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "in",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iGroupSetup",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation createGroup( $name: String!, $in: ID!, $setup: iGroupSetup ) { createGroup( name: $name, in: $in, setup: $setup ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } isSystem metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } children { ...PagingResponseFragment } organization { ...OrganizationFragment } customers { ...CustomerPagingResponseFragment } } }",
+ "example_variables": "{ \"name\": \"xyz789\", \"in\": \"4\", \"setup\": iGroupSetup }",
+ "example_response": "{ \"data\": { \"createGroup\": { \"id\": \"4\", \"name\": \"xyz789\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"isSystem\": false, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"children\": PagingResponse, \"organization\": Organization, \"customers\": CustomerPagingResponse } } }"
+ },
+ {
+ "name": "createInputChannel",
+ "type": "mutation",
+ "description": "",
+ "response_type": "an InputChannel!",
+ "arguments": [
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "description",
+ "type": "String",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "ruleSets",
+ "type": "[iChannelInputRuleSet!]",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "pipes",
+ "type": "[iInputPipe!]",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation createInputChannel( $name: String!, $description: String, $ruleSets: [iChannelInputRuleSet!], $pipes: [iInputPipe!] ) { createInputChannel( name: $name, description: $description, ruleSets: $ruleSets, pipes: $pipes ) { id name description ruleSets { ...InputRuleSetFragment } pipes { ...InputPipeFragment } } }",
+ "example_variables": "{ \"name\": \"xyz789\", \"description\": \"xyz789\", \"ruleSets\": [iChannelInputRuleSet], \"pipes\": [iInputPipe] }",
+ "example_response": "{ \"data\": { \"createInputChannel\": { \"id\": 4, \"name\": \"xyz789\", \"description\": \"abc123\", \"ruleSets\": [InputRuleSet], \"pipes\": [InputPipe] } } }"
+ },
+ {
+ "name": "createInputRuleSet",
+ "type": "mutation",
+ "description": "",
+ "response_type": "an InputRuleSet!",
+ "arguments": [
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iInputRuleSet",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation createInputRuleSet( $name: String!, $setup: iInputRuleSet ) { createInputRuleSet( name: $name, setup: $setup ) { id name description rules { ...InputRuleFragment } } }",
+ "example_variables": "{ \"name\": \"xyz789\", \"setup\": iInputRuleSet }",
+ "example_response": "{ \"data\": { \"createInputRuleSet\": { \"id\": \"4\", \"name\": \"xyz789\", \"description\": \"abc123\", \"rules\": [InputRule] } } }"
+ },
+ {
+ "name": "createLayout",
+ "type": "mutation",
+ "description": "Create a layout",
+ "response_type": "a Layout!",
+ "arguments": [
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "type",
+ "type": "LayoutType",
+ "description": "Default = ENTITY",
+ "required": false
+ },
+ {
+ "name": "setup",
+ "type": "iLayoutSetup!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation createLayout( $name: String!, $type: LayoutType, $setup: iLayoutSetup! ) { createLayout( name: $name, type: $type, setup: $setup ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } type applyTo priority layout translations icon } }",
+ "example_variables": "{ \"name\": \"xyz789\", \"type\": \"ENTITY\", \"setup\": iLayoutSetup }",
+ "example_response": "{ \"data\": { \"createLayout\": { \"id\": \"4\", \"name\": \"abc123\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"type\": \"ENTITY\", \"applyTo\": [\"Folder\"], \"priority\": 123, \"layout\": {}, \"translations\": {}, \"icon\": 4 } } }"
+ },
+ {
+ "name": "createMetadataDefinition",
+ "type": "mutation",
+ "description": "To create a metadata definition",
+ "response_type": "a MetadataDefinition",
+ "arguments": [
+ {
+ "name": "in",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iMetadataDefinition",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation createMetadataDefinition( $in: ID!, $name: String!, $setup: iMetadataDefinition ) { createMetadataDefinition( in: $in, name: $name, setup: $setup ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } nameSpace { ...MetadataNameSpaceFragment } type cardinality struct { ...MetadataDefinitionFragment } lName translations searchable availableInLayout saveInXmp required unique editable dictionary { ...DictionaryFragment } minRange maxRange minChar maxChar regex defaultValue } }",
+ "example_variables": "{ \"in\": 4, \"name\": \"abc123\", \"setup\": iMetadataDefinition }",
+ "example_response": "{ \"data\": { \"createMetadataDefinition\": { \"id\": 4, \"name\": \"abc123\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"nameSpace\": MetadataNameSpace, \"type\": \"BOOLEAN\", \"cardinality\": \"SINGLE\", \"struct\": [MetadataDefinition], \"lName\": \"xyz789\", \"translations\": {}, \"searchable\": true, \"availableInLayout\": true, \"saveInXmp\": true, \"required\": false, \"unique\": false, \"editable\": true, \"dictionary\": Dictionary, \"minRange\": Number, \"maxRange\": Number, \"minChar\": Number, \"maxChar\": Number, \"regex\": \"abc123\", \"defaultValue\": {} } } }"
+ },
+ {
+ "name": "createMetadataNameSpace",
+ "type": "mutation",
+ "description": "To create a metadata nameSpace",
+ "response_type": "a MetadataNameSpace",
+ "arguments": [
+ {
+ "name": "uri",
+ "type": "URL!",
+ "description": "URI of the nameSpace must end with either / or #",
+ "required": true
+ },
+ {
+ "name": "prefix",
+ "type": "String!",
+ "description": "Preferred prefix of the name Space",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iMetadataNameSpaceCreation",
+ "description": "Definition of parameters. Default = {searchable : true, availableInLayout : true, saveInXmp : false}",
+ "required": false
+ },
+ {
+ "name": "in",
+ "type": "ID",
+ "description": "Id of a folder into which to create the nameSpace",
+ "required": false
+ },
+ {
+ "name": "metadatas",
+ "type": "[iCreateMetadata!]",
+ "description": "List of metadata definition that will be created in the same Transaction",
+ "required": true
+ }
+ ],
+ "example_query": "mutation createMetadataNameSpace( $uri: URL!, $prefix: String!, $setup: iMetadataNameSpaceCreation, $in: ID, $metadatas: [iCreateMetadata!] ) { createMetadataNameSpace( uri: $uri, prefix: $prefix, setup: $setup, in: $in, metadatas: $metadatas ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } uri prefix metadataDefs { ...MetadataDefinitionFragment } lName translations searchable availableInLayout saveInXmp } }",
+ "example_variables": "{ \"uri\": \"http://www.test.com/\", \"prefix\": \"xyz789\", \"setup\": { \"searchable\": \"true\", \"availableInLayout\": \"true\", \"saveInXmp\": \"false\" }, \"in\": 4, \"metadatas\": [iCreateMetadata] }",
+ "example_response": "{ \"data\": { \"createMetadataNameSpace\": { \"id\": 4, \"name\": \"abc123\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"uri\": \"http://www.test.com/\", \"prefix\": \"abc123\", \"metadataDefs\": [MetadataDefinition], \"lName\": \"xyz789\", \"translations\": {}, \"searchable\": true, \"availableInLayout\": true, \"saveInXmp\": true } } }"
+ },
+ {
+ "name": "createMilestone",
+ "type": "mutation",
+ "description": "To create a Milestone",
+ "response_type": "an Activity!",
+ "arguments": [
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iActivity!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "in",
+ "type": "ID",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation createMilestone( $name: String!, $setup: iActivity!, $in: ID ) { createMilestone( name: $name, setup: $setup, in: $in ) { id name bypassed icon color category } }",
+ "example_variables": "{ \"name\": \"xyz789\", \"setup\": iActivity, \"in\": \"4\" }",
+ "example_response": "{ \"data\": { \"createMilestone\": { \"id\": \"4\", \"name\": \"xyz789\", \"bypassed\": false, \"icon\": \"4\", \"color\": \"xyz789\", \"category\": \"abc123\" } } }"
+ },
+ {
+ "name": "createNamedSearchFilter",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a NamedSearchFilter!",
+ "arguments": [
+ {
+ "name": "name",
+ "type": "String",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "in",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "filter",
+ "type": "iSearchFilter!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation createNamedSearchFilter( $name: String, $in: ID, $filter: iSearchFilter! ) { createNamedSearchFilter( name: $name, in: $in, filter: $filter ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } filter { ...SearchFilterFragment } } }",
+ "example_variables": "{ \"name\": \"xyz789\", \"in\": \"4\", \"filter\": iSearchFilter }",
+ "example_response": "{ \"data\": { \"createNamedSearchFilter\": { \"id\": 4, \"name\": \"abc123\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"filter\": SearchFilter } } }"
+ },
+ {
+ "name": "createNote",
+ "type": "mutation",
+ "description": "Returns [Note!]!",
+ "response_type": "[Note!]!",
+ "arguments": [
+ {
+ "name": "on",
+ "type": "[ID!]!",
+ "description": "The id(s) of the object : Asset, Project, Media",
+ "required": true
+ },
+ {
+ "name": "type",
+ "type": "NoteType!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iNoteSetup!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation createNote( $on: [ID!]!, $type: NoteType!, $setup: iNoteSetup! ) { createNote( on: $on, type: $type, setup: $setup ) { id type objectOwnerId pageNumber lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } attachments { ...AttachmentFragment } checkable status { ...AnnotationStatusFragment } collapsed seenBy { ...UserFragment } replies { ...NoteReplyFragment } content originalContent stylizedContent positionX positionY positionZ anchorX anchorY anchorZ tx ty proofReadingMark { ...ProofReadingMarkFragment } path selectable startTime endTime } }",
+ "example_variables": "{ \"on\": [\"4\"], \"type\": \"Note\", \"setup\": iNoteSetup }",
+ "example_response": "{ \"data\": { \"createNote\": [ { \"id\": \"4\", \"type\": \"Note\", \"objectOwnerId\": \"4\", \"pageNumber\": {}, \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"attachments\": [Attachment], \"checkable\": true, \"status\": AnnotationStatus, \"collapsed\": true, \"seenBy\": [User], \"replies\": [NoteReply], \"content\": \"xyz789\", \"originalContent\": \"xyz789\", \"stylizedContent\": \"abc123\", \"positionX\": 123.45, \"positionY\": 123.45, \"positionZ\": 123.45, \"anchorX\": 123.45, \"anchorY\": 987.65, \"anchorZ\": 123.45, \"tx\": 987.65, \"ty\": 987.65, \"proofReadingMark\": ProofReadingMark, \"path\": \"abc123\", \"selectable\": true, \"startTime\": 123.45, \"endTime\": 987.65 } ] } }"
+ },
+ {
+ "name": "createNotificationTemplate",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a NotificationTemplate!",
+ "arguments": [
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "event",
+ "type": "iEmailTemplateNotificationEvent!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "in",
+ "type": "iCustomizableEntityId",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "setup",
+ "type": "iNotificationEmailTemplate",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation createNotificationTemplate( $name: String!, $event: iEmailTemplateNotificationEvent!, $in: iCustomizableEntityId, $setup: iNotificationEmailTemplate ) { createNotificationTemplate( name: $name, event: $event, in: $in, setup: $setup ) { id name event { ... on ApprovalNotificationTemplateEvent { ...ApprovalNotificationTemplateEventFragment } ... on MilestoneNotificationTemplateEvent { ...MilestoneNotificationTemplateEventFragment } ... on BaseNotificationTemplateEvent { ...BaseNotificationTemplateEventFragment } } emailTemplate { ...EmailTemplateFragment } parentEntity { ...WithEmailTemplateFragment } lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } } }",
+ "example_variables": "{ \"name\": \"xyz789\", \"event\": iEmailTemplateNotificationEvent, \"in\": iCustomizableEntityId, \"setup\": iNotificationEmailTemplate }",
+ "example_response": "{ \"data\": { \"createNotificationTemplate\": { \"id\": 4, \"name\": \"abc123\", \"event\": ApprovalNotificationTemplateEvent, \"emailTemplate\": EmailTemplate, \"parentEntity\": WithEmailTemplate, \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User } } }"
+ },
+ {
+ "name": "createOrganization",
+ "type": "mutation",
+ "description": "Create an Organization in the specified Organization",
+ "response_type": "an Organization!",
+ "arguments": [
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "in",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iOrganizationSetup",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation createOrganization( $name: String!, $in: ID!, $setup: iOrganizationSetup ) { createOrganization( name: $name, in: $in, setup: $setup ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } children { ...PagingResponseFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } phone phone2 www fax shippingAddress { ...AddressFragment } billingAddress { ...AddressFragment } organization { ...OrganizationFragment } customers { ...CustomerFragment } emailTemplates { ...EmailTemplateFragment } notificationTemplates { ...NotificationTemplateFragment } ldapConfiguration { ...LDAPConfigurationFragment } applySecurityConfigToSubOrganization securityConfiguration { ...SecurityConfigurationFragment } notifications { ...NotificationFragment } } }",
+ "example_variables": "{ \"name\": \"xyz789\", \"in\": \"4\", \"setup\": iOrganizationSetup }",
+ "example_response": "{ \"data\": { \"createOrganization\": { \"id\": \"4\", \"name\": \"abc123\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"children\": PagingResponse, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"phone\": \"xyz789\", \"phone2\": \"abc123\", \"www\": \"abc123\", \"fax\": \"xyz789\", \"shippingAddress\": Address, \"billingAddress\": Address, \"organization\": Organization, \"customers\": [Customer], \"emailTemplates\": [EmailTemplate], \"notificationTemplates\": [NotificationTemplate], \"ldapConfiguration\": LDAPConfiguration, \"applySecurityConfigToSubOrganization\": false, \"securityConfiguration\": SecurityConfiguration, \"notifications\": [Notification] } } }"
+ },
+ {
+ "name": "createOutputChannelGroup",
+ "type": "mutation",
+ "description": "Create an output channel group Note that it is possible to create an empty channel group",
+ "response_type": "an OutputChannelGroup!",
+ "arguments": [
+ {
+ "name": "setup",
+ "type": "iOutputChannelGroupSetup",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation createOutputChannelGroup($setup: iOutputChannelGroupSetup) { createOutputChannelGroup(setup: $setup) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } outputChannels { ...OutputChannelFragment } } }",
+ "example_variables": "{\"setup\": iOutputChannelGroupSetup}",
+ "example_response": "{ \"data\": { \"createOutputChannelGroup\": { \"id\": 4, \"name\": \"abc123\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"outputChannels\": [OutputChannel] } } }"
+ },
+ {
+ "name": "createPrivateProofReadingMark",
+ "type": "mutation",
+ "description": "Returns a Boolean!",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "in",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "setup",
+ "type": "iProofReadingMarkSetup!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation createPrivateProofReadingMark( $name: String!, $in: ID, $setup: iProofReadingMarkSetup! ) { createPrivateProofReadingMark( name: $name, in: $in, setup: $setup ) }",
+ "example_variables": "{ \"name\": \"abc123\", \"in\": \"4\", \"setup\": iProofReadingMarkSetup }",
+ "example_response": "{\"data\": {\"createPrivateProofReadingMark\": true}}"
+ },
+ {
+ "name": "createProject",
+ "type": "mutation",
+ "description": "security role handle by the mutationFetcher itself To create a Project for a Customer with a name",
+ "response_type": "a Project!",
+ "arguments": [
+ {
+ "name": "customerId",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iProjectSetup",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "inputs",
+ "type": "[iInputFile!]",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation createProject( $customerId: ID!, $name: String!, $setup: iProjectSetup, $inputs: [iInputFile!] ) { createProject( customerId: $customerId, name: $name, setup: $setup, inputs: $inputs ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } trashDate trashUser { ...UserFragment } endDate metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } status workflowName approvalStatus { ...ApprovalActivityStatusFragment } approvalSummary approvals { ...ApprovalCycleFragment } assetApprovals { ...ApprovalCycleFragment } children { ...PagingResponseFragment } assetWorkflow { ...WorkflowFragment } processes { ...ProcessFragment } projectTemplate { ...ProjectTemplateFragment } priority colorSpace { ...ColorSpaceFragment } viewingCondition { ...ViewingConditionFragment } reversedView customer { ...CustomerFragment } parents { ...ContainerFragment } mainAsset { ...AssetFragment } siteId productionParticipants { ...ProductionParticipantFragment } notes { ...NoteFragment } trimmedHeight trimmedWidth nbPages accessControls deadlines { ...ProjectDeadlineFragment } } }",
+ "example_variables": "{ \"customerId\": \"4\", \"name\": \"xyz789\", \"setup\": iProjectSetup, \"inputs\": [iInputFile] }",
+ "example_response": "{ \"data\": { \"createProject\": { \"id\": \"4\", \"name\": \"abc123\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"trashDate\": \"2007-12-03T10:15:30Z\", \"trashUser\": User, \"endDate\": \"2007-12-03T10:15:30Z\", \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"status\": [\"ACTIVE\"], \"workflowName\": \"xyz789\", \"approvalStatus\": [ApprovalActivityStatus], \"approvalSummary\": \"NONE\", \"approvals\": [ApprovalCycle], \"assetApprovals\": [ApprovalCycle], \"children\": PagingResponse, \"assetWorkflow\": Workflow, \"processes\": [Process], \"projectTemplate\": ProjectTemplate, \"priority\": 987, \"colorSpace\": ColorSpace, \"viewingCondition\": ViewingCondition, \"reversedView\": true, \"customer\": Customer, \"parents\": [Container], \"mainAsset\": Asset, \"siteId\": \"4\", \"productionParticipants\": [ProductionParticipant], \"notes\": [Note], \"trimmedHeight\": 123.45, \"trimmedWidth\": 123.45, \"nbPages\": 987, \"accessControls\": {}, \"deadlines\": [ProjectDeadline] } } }"
+ },
+ {
+ "name": "createProjectFolder",
+ "type": "mutation",
+ "description": "To create a ProjectFolder - Note: reusing iFoldersetup for now as iProjectFolderSetup would be identical",
+ "response_type": "a ProjectFolder!",
+ "arguments": [
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "in",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iFolderSetup",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation createProjectFolder( $name: String!, $in: ID!, $setup: iFolderSetup ) { createProjectFolder( name: $name, in: $in, setup: $setup ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } trashDate trashUser { ...UserFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } readOnly productionSettings { ...ProductionSettingsFragment } processes { ...ProcessFragment } accessControlList { ...AccessControlListFragment } children { ...PagingResponseFragment } project { ...ProjectFragment } parents { ...ContainerFragment } path { ...ProjectFolderFragment } color icon } }",
+ "example_variables": "{ \"name\": \"abc123\", \"in\": \"4\", \"setup\": iFolderSetup }",
+ "example_response": "{ \"data\": { \"createProjectFolder\": { \"id\": \"4\", \"name\": \"xyz789\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"trashDate\": \"2007-12-03T10:15:30Z\", \"trashUser\": User, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"readOnly\": false, \"productionSettings\": ProductionSettings, \"processes\": [Process], \"accessControlList\": AccessControlList, \"children\": PagingResponse, \"project\": Project, \"parents\": [Container], \"path\": [ProjectFolder], \"color\": \"xyz789\", \"icon\": \"4\" } } }"
+ },
+ {
+ "name": "createProjectFromFolder",
+ "type": "mutation",
+ "description": "To create a project from an existing filesystem Folder",
+ "response_type": "a Project!",
+ "arguments": [
+ {
+ "name": "folderId",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "customerId",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iProjectSetup",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "processWorkflow",
+ "type": "Boolean",
+ "description": "Default = true",
+ "required": false
+ }
+ ],
+ "example_query": "mutation createProjectFromFolder( $folderId: ID!, $customerId: ID!, $name: String!, $setup: iProjectSetup, $processWorkflow: Boolean ) { createProjectFromFolder( folderId: $folderId, customerId: $customerId, name: $name, setup: $setup, processWorkflow: $processWorkflow ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } trashDate trashUser { ...UserFragment } endDate metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } status workflowName approvalStatus { ...ApprovalActivityStatusFragment } approvalSummary approvals { ...ApprovalCycleFragment } assetApprovals { ...ApprovalCycleFragment } children { ...PagingResponseFragment } assetWorkflow { ...WorkflowFragment } processes { ...ProcessFragment } projectTemplate { ...ProjectTemplateFragment } priority colorSpace { ...ColorSpaceFragment } viewingCondition { ...ViewingConditionFragment } reversedView customer { ...CustomerFragment } parents { ...ContainerFragment } mainAsset { ...AssetFragment } siteId productionParticipants { ...ProductionParticipantFragment } notes { ...NoteFragment } trimmedHeight trimmedWidth nbPages accessControls deadlines { ...ProjectDeadlineFragment } } }",
+ "example_variables": "{ \"folderId\": 4, \"customerId\": 4, \"name\": \"xyz789\", \"setup\": iProjectSetup, \"processWorkflow\": true }",
+ "example_response": "{ \"data\": { \"createProjectFromFolder\": { \"id\": \"4\", \"name\": \"abc123\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"trashDate\": \"2007-12-03T10:15:30Z\", \"trashUser\": User, \"endDate\": \"2007-12-03T10:15:30Z\", \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"status\": [\"ACTIVE\"], \"workflowName\": \"xyz789\", \"approvalStatus\": [ApprovalActivityStatus], \"approvalSummary\": \"NONE\", \"approvals\": [ApprovalCycle], \"assetApprovals\": [ApprovalCycle], \"children\": PagingResponse, \"assetWorkflow\": Workflow, \"processes\": [Process], \"projectTemplate\": ProjectTemplate, \"priority\": 123, \"colorSpace\": ColorSpace, \"viewingCondition\": ViewingCondition, \"reversedView\": true, \"customer\": Customer, \"parents\": [Container], \"mainAsset\": Asset, \"siteId\": 4, \"productionParticipants\": [ProductionParticipant], \"notes\": [Note], \"trimmedHeight\": 987.65, \"trimmedWidth\": 123.45, \"nbPages\": 987, \"accessControls\": {}, \"deadlines\": [ProjectDeadline] } } }"
+ },
+ {
+ "name": "createProjectTemplate",
+ "type": "mutation",
+ "description": "To create a ProjectTemplate",
+ "response_type": "a ProjectTemplate!",
+ "arguments": [
+ {
+ "name": "setup",
+ "type": "iProjectTemplateSetup",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation createProjectTemplate($setup: iProjectTemplateSetup) { createProjectTemplate(setup: $setup) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } friendlyName priority colorSpace { ...ColorSpaceFragment } viewingCondition { ...ViewingConditionFragment } assetWorkflow { ...WorkflowFragment } projectWorkflow { ...WorkflowFragment } productionParticipants { ...ProductionParticipantFragment } assetApprovals { ...ApprovalCycleFragment } projectApprovals { ...ApprovalCycleFragment } deadlines { ...ProjectDeadlineFragment } skipWeekend } }",
+ "example_variables": "{\"setup\": iProjectTemplateSetup}",
+ "example_response": "{ \"data\": { \"createProjectTemplate\": { \"id\": 4, \"name\": \"abc123\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"friendlyName\": \"xyz789\", \"priority\": 987, \"colorSpace\": ColorSpace, \"viewingCondition\": ViewingCondition, \"assetWorkflow\": Workflow, \"projectWorkflow\": Workflow, \"productionParticipants\": [ProductionParticipant], \"assetApprovals\": [ApprovalCycle], \"projectApprovals\": [ApprovalCycle], \"deadlines\": [ProjectDeadline], \"skipWeekend\": true } } }"
+ },
+ {
+ "name": "createRelation",
+ "type": "mutation",
+ "description": "To create Relations between 1 source Entity and one or more target Entities",
+ "response_type": "[Relation!]",
+ "arguments": [
+ {
+ "name": "from",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "to",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iRelationSetup",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation createRelation( $from: ID!, $to: [ID!]!, $setup: iRelationSetup ) { createRelation( from: $from, to: $to, setup: $setup ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } from { ...WithRelationFragment } to { ...WithRelationFragment } } }",
+ "example_variables": "{ \"from\": 4, \"to\": [\"4\"], \"setup\": iRelationSetup }",
+ "example_response": "{ \"data\": { \"createRelation\": [ { \"id\": 4, \"name\": \"xyz789\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"from\": WithRelation, \"to\": WithRelation } ] } }"
+ },
+ {
+ "name": "createRole",
+ "type": "mutation",
+ "description": "Create a Role",
+ "response_type": "a Role!",
+ "arguments": [
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iRoleSetup",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation createRole( $name: String!, $setup: iRoleSetup ) { createRole( name: $name, setup: $setup ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } notifications { ...NotificationFragment } } }",
+ "example_variables": "{ \"name\": \"xyz789\", \"setup\": iRoleSetup }",
+ "example_response": "{ \"data\": { \"createRole\": { \"id\": \"4\", \"name\": \"abc123\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"notifications\": [Notification] } } }"
+ },
+ {
+ "name": "createSchemaExtension",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a SchemaExtension!",
+ "arguments": [
+ {
+ "name": "setup",
+ "type": "iSchemaExtension!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation createSchemaExtension($setup: iSchemaExtension!) { createSchemaExtension(setup: $setup) { id type executionType name newOperation operations script securityRole usableInSharing } }",
+ "example_variables": "{\"setup\": iSchemaExtension}",
+ "example_response": "{ \"data\": { \"createSchemaExtension\": { \"id\": 4, \"type\": \"QUERY\", \"executionType\": \"GRAPHQL\", \"name\": \"xyz789\", \"newOperation\": \"abc123\", \"operations\": [\"abc123\"], \"script\": \"abc123\", \"securityRole\": \"ADMIN\", \"usableInSharing\": false } } }"
+ },
+ {
+ "name": "createSecurityProfileMask",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a SecurityProfileMask",
+ "arguments": [
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iSecurityProfileMask",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation createSecurityProfileMask( $name: String!, $setup: iSecurityProfileMask ) { createSecurityProfileMask( name: $name, setup: $setup ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } properties { ...SecurityPropertyFragment } } }",
+ "example_variables": "{ \"name\": \"abc123\", \"setup\": iSecurityProfileMask }",
+ "example_response": "{ \"data\": { \"createSecurityProfileMask\": { \"id\": \"4\", \"name\": \"xyz789\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"properties\": [SecurityProperty] } } }"
+ },
+ {
+ "name": "createSmartCollection",
+ "type": "mutation",
+ "description": "To create a SmartCollection",
+ "response_type": "a SmartCollection!",
+ "arguments": [
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iSmartCollectionSetup",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation createSmartCollection( $name: String!, $setup: iSmartCollectionSetup ) { createSmartCollection( name: $name, setup: $setup ) { id name description color lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } trashDate trashUser { ...UserFragment } icon lName translations children { ...PagingResponseFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } readOnly accessControlList { ...AccessControlListFragment } searchProperties { ...SmartCollectionSearchPropertiesFragment } } }",
+ "example_variables": "{ \"name\": \"abc123\", \"setup\": iSmartCollectionSetup }",
+ "example_response": "{ \"data\": { \"createSmartCollection\": { \"id\": 4, \"name\": \"abc123\", \"description\": \"xyz789\", \"color\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"trashDate\": \"2007-12-03T10:15:30Z\", \"trashUser\": User, \"icon\": 4, \"lName\": \"abc123\", \"translations\": {}, \"children\": PagingResponse, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"readOnly\": true, \"accessControlList\": AccessControlList, \"searchProperties\": SmartCollectionSearchProperties } } }"
+ },
+ {
+ "name": "createSynSet",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a SynSet!",
+ "arguments": [
+ {
+ "name": "thesaurusId",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "label",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "uri",
+ "type": "URL",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "in",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "words",
+ "type": "[iWord!]",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "glosses",
+ "type": "[iWord!]",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "sentences",
+ "type": "[iWord!]",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation createSynSet( $thesaurusId: ID!, $label: String!, $uri: URL, $in: ID, $words: [iWord!], $glosses: [iWord!], $sentences: [iWord!] ) { createSynSet( thesaurusId: $thesaurusId, label: $label, uri: $uri, in: $in, words: $words, glosses: $glosses, sentences: $sentences ) { id uri label creationDate glosses sentences words { ...WordFragment } hyponyms { ...SynSetFragment } hypernyms { ...SynSetFragment } } }",
+ "example_variables": "{ \"thesaurusId\": \"4\", \"label\": \"xyz789\", \"uri\": \"http://www.test.com/\", \"in\": 4, \"words\": [iWord], \"glosses\": [iWord], \"sentences\": [iWord] }",
+ "example_response": "{ \"data\": { \"createSynSet\": { \"id\": \"4\", \"uri\": \"http://www.test.com/\", \"label\": \"xyz789\", \"creationDate\": \"2007-12-03T10:15:30Z\", \"glosses\": {}, \"sentences\": [{}], \"words\": [Word], \"hyponyms\": [SynSet], \"hypernyms\": [SynSet] } } }"
+ },
+ {
+ "name": "createThesaurus",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a Thesaurus!",
+ "arguments": [
+ {
+ "name": "uri",
+ "type": "URL!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "label",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "version",
+ "type": "String",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "titles",
+ "type": "[iWord!]",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "descriptions",
+ "type": "[iWord!]",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation createThesaurus( $uri: URL!, $label: String!, $version: String, $titles: [iWord!], $descriptions: [iWord!] ) { createThesaurus( uri: $uri, label: $label, version: $version, titles: $titles, descriptions: $descriptions ) { id uri label lastModificationDate creationDate version langs titles descriptions topLevels { ...SynSetFragment } } }",
+ "example_variables": "{ \"uri\": \"http://www.test.com/\", \"label\": \"abc123\", \"version\": \"abc123\", \"titles\": [iWord], \"descriptions\": [iWord] }",
+ "example_response": "{ \"data\": { \"createThesaurus\": { \"id\": \"4\", \"uri\": \"http://www.test.com/\", \"label\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"creationDate\": \"2007-12-03T10:15:30Z\", \"version\": \"abc123\", \"langs\": [\"ar\"], \"titles\": {}, \"descriptions\": {}, \"topLevels\": [SynSet] } } }"
+ },
+ {
+ "name": "createUIFile",
+ "type": "mutation",
+ "description": "",
+ "response_type": "an UIProjectFile!",
+ "arguments": [
+ {
+ "name": "in",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "parentPath",
+ "type": "String",
+ "description": "Default = \"/\"",
+ "required": false
+ },
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "content",
+ "type": "String",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "setup",
+ "type": "iUIFileSetup",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation createUIFile( $in: String!, $parentPath: String, $name: String!, $content: String, $setup: iUIFileSetup ) { createUIFile( in: $in, parentPath: $parentPath, name: $name, content: $content, setup: $setup ) { isFolder name path id description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } uiProject { ...UIProjectFragment } labels mimeType metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } translations } }",
+ "example_variables": "{ \"in\": \"xyz789\", \"parentPath\": \"/\", \"name\": \"xyz789\", \"content\": \"xyz789\", \"setup\": iUIFileSetup }",
+ "example_response": "{ \"data\": { \"createUIFile\": { \"isFolder\": false, \"name\": \"abc123\", \"path\": \"xyz789\", \"id\": \"4\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"uiProject\": UIProject, \"labels\": [\"xyz789\"], \"mimeType\": \"xyz789\", \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"translations\": {} } } }"
+ },
+ {
+ "name": "createUIFolder",
+ "type": "mutation",
+ "description": "",
+ "response_type": "an UIProjectFile",
+ "arguments": [
+ {
+ "name": "in",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "parentPath",
+ "type": "String",
+ "description": "Default = \"/\"",
+ "required": false
+ },
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation createUIFolder( $in: String!, $parentPath: String, $name: String! ) { createUIFolder( in: $in, parentPath: $parentPath, name: $name ) { isFolder name path id description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } uiProject { ...UIProjectFragment } labels mimeType metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } translations } }",
+ "example_variables": "{ \"in\": \"xyz789\", \"parentPath\": \"/\", \"name\": \"xyz789\" }",
+ "example_response": "{ \"data\": { \"createUIFolder\": { \"isFolder\": true, \"name\": \"abc123\", \"path\": \"abc123\", \"id\": 4, \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"uiProject\": UIProject, \"labels\": [\"abc123\"], \"mimeType\": \"abc123\", \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"translations\": {} } } }"
+ },
+ {
+ "name": "createUIProject",
+ "type": "mutation",
+ "description": "",
+ "response_type": "an UIProject",
+ "arguments": [
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation createUIProject($name: String!) { createUIProject(name: $name) { name id description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } type icon labels translations } }",
+ "example_variables": "{\"name\": \"xyz789\"}",
+ "example_response": "{ \"data\": { \"createUIProject\": { \"name\": \"abc123\", \"id\": 4, \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"type\": \"xyz789\", \"icon\": \"abc123\", \"labels\": [\"xyz789\"], \"translations\": {} } } }"
+ },
+ {
+ "name": "createUIProjectWithType",
+ "type": "mutation",
+ "description": "",
+ "response_type": "an UIProject",
+ "arguments": [
+ {
+ "name": "setup",
+ "type": "iUIProjectCreateSetup",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation createUIProjectWithType($setup: iUIProjectCreateSetup) { createUIProjectWithType(setup: $setup) { name id description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } type icon labels translations } }",
+ "example_variables": "{\"setup\": iUIProjectCreateSetup}",
+ "example_response": "{ \"data\": { \"createUIProjectWithType\": { \"name\": \"xyz789\", \"id\": \"4\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"type\": \"xyz789\", \"icon\": \"abc123\", \"labels\": [\"abc123\"], \"translations\": {} } } }"
+ },
+ {
+ "name": "createUser",
+ "type": "mutation",
+ "description": "Create an User in the specified Organization",
+ "response_type": "a User!",
+ "arguments": [
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "in",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iCreateUserSetup",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation createUser( $name: String!, $in: ID!, $setup: iCreateUserSetup ) { createUser( name: $name, in: $in, setup: $setup ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } login userCanLog lang dateFormat unitResolution unitLength color image use2FA channel2FA sessionTimeout workCapacity workCapacityUnit firstName lastName email title company phone phone2 homePhone fax mobilePhone department address { ...AddressFragment } organization { ...OrganizationFragment } groups { ...GroupFragment } roles { ...RoleFragment } defaultProfile { ...UserSecurityProfileFragment } availableProfiles { ...UserSecurityProfileFragment } notifications { ...NotificationFragment } } }",
+ "example_variables": "{ \"name\": \"abc123\", \"in\": 4, \"setup\": iCreateUserSetup }",
+ "example_response": "{ \"data\": { \"createUser\": { \"id\": 4, \"name\": \"abc123\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"login\": \"xyz789\", \"userCanLog\": false, \"lang\": \"ar\", \"dateFormat\": \"abc123\", \"unitResolution\": \"xyz789\", \"unitLength\": \"xyz789\", \"color\": \"xyz789\", \"image\": \"abc123\", \"use2FA\": true, \"channel2FA\": \"AUTHENTICATOR\", \"sessionTimeout\": 123, \"workCapacity\": \"xyz789\", \"workCapacityUnit\": \"xyz789\", \"firstName\": \"xyz789\", \"lastName\": \"xyz789\", \"email\": \"abc123\", \"title\": \"xyz789\", \"company\": \"xyz789\", \"phone\": \"xyz789\", \"phone2\": \"xyz789\", \"homePhone\": \"abc123\", \"fax\": \"xyz789\", \"mobilePhone\": \"abc123\", \"department\": \"abc123\", \"address\": Address, \"organization\": Organization, \"groups\": [Group], \"roles\": [Role], \"defaultProfile\": UserSecurityProfile, \"availableProfiles\": [UserSecurityProfile], \"notifications\": [Notification] } } }"
+ },
+ {
+ "name": "createUserAction",
+ "type": "mutation",
+ "description": "** Create a user action**",
+ "response_type": "a UserAction!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iUserAction!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation createUserAction( $id: ID!, $setup: iUserAction! ) { createUserAction( id: $id, setup: $setup ) { id description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } applyTo context enableGrouping assetMimeTypes script icon translations productionParticipants { ...ProductionParticipantFragment } workflow { ...WorkflowFragment } destination destinationCollection } }",
+ "example_variables": "{ \"id\": \"4\", \"setup\": iUserAction }",
+ "example_response": "{ \"data\": { \"createUserAction\": { \"id\": \"4\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"applyTo\": \"Folder\", \"context\": \"ORIGINAL_FILE\", \"enableGrouping\": true, \"assetMimeTypes\": [\"abc123\"], \"script\": \"abc123\", \"icon\": \"abc123\", \"translations\": {}, \"productionParticipants\": [ProductionParticipant], \"workflow\": Workflow, \"destination\": \"WORKFLOW_DRIVEN\", \"destinationCollection\": \"xyz789\" } } }"
+ },
+ {
+ "name": "createUserSecurityProfile",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a UserSecurityProfile",
+ "arguments": [
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iUserSecurityProfile",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation createUserSecurityProfile( $name: String!, $setup: iUserSecurityProfile ) { createUserSecurityProfile( name: $name, setup: $setup ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } properties { ...SecurityPropertyFragment } securityRoles } }",
+ "example_variables": "{ \"name\": \"abc123\", \"setup\": iUserSecurityProfile }",
+ "example_response": "{ \"data\": { \"createUserSecurityProfile\": { \"id\": \"4\", \"name\": \"xyz789\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"properties\": [SecurityProperty], \"securityRoles\": [\"ADMIN\"] } } }"
+ },
+ {
+ "name": "createViewingCondition",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a ViewingCondition!",
+ "arguments": [
+ {
+ "name": "setup",
+ "type": "iViewingCondition!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "in",
+ "type": "ID",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation createViewingCondition( $setup: iViewingCondition!, $in: ID ) { createViewingCondition( setup: $setup, in: $in ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } parents { ...ContainerFragment } renderingIntent gamutCheck profile rgb { ...WorkingSpaceSimulationFragment } cmyk { ...WorkingSpaceSimulationFragment } gray { ...WorkingSpaceSimulationFragment } useCloseLoop closeLoop { ...CloseLoopParamsFragment } } }",
+ "example_variables": "{ \"setup\": iViewingCondition, \"in\": \"4\" }",
+ "example_response": "{ \"data\": { \"createViewingCondition\": { \"id\": \"4\", \"name\": \"xyz789\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"parents\": [Container], \"renderingIntent\": \"PaperWhite\", \"gamutCheck\": false, \"profile\": \"xyz789\", \"rgb\": WorkingSpaceSimulation, \"cmyk\": WorkingSpaceSimulation, \"gray\": WorkingSpaceSimulation, \"useCloseLoop\": false, \"closeLoop\": CloseLoopParams } } }"
+ },
+ {
+ "name": "createVolume",
+ "type": "mutation",
+ "description": "Create a Volume",
+ "response_type": "a Volume!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "group",
+ "type": "IVolumeGroup!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iVolumeSetup!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation createVolume( $id: ID!, $group: IVolumeGroup!, $setup: iVolumeSetup! ) { createVolume( id: $id, group: $group, setup: $setup ) { id group access reference path nfsAlias smbAlias protocol server userName port } }",
+ "example_variables": "{\"id\": 4, \"group\": \"ATTACHMENT\", \"setup\": iVolumeSetup}",
+ "example_response": "{ \"data\": { \"createVolume\": { \"id\": 4, \"group\": \"ATTACHMENT\", \"access\": \"DISABLED\", \"reference\": \"xyz789\", \"path\": \"abc123\", \"nfsAlias\": \"xyz789\", \"smbAlias\": \"xyz789\", \"protocol\": \"FILE\", \"server\": \"xyz789\", \"userName\": \"xyz789\", \"port\": 123 } } }"
+ },
+ {
+ "name": "createWorkflow",
+ "type": "mutation",
+ "description": "Worflow creation",
+ "response_type": "a Workflow!",
+ "arguments": [
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "scope",
+ "type": "WorkflowableTypeName",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "description",
+ "type": "String",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "parameters",
+ "type": "[iMetadataValue!]",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "onCompletedRetention",
+ "type": "Int",
+ "description": "Default = -1",
+ "required": false
+ },
+ {
+ "name": "onFailedRetention",
+ "type": "Int",
+ "description": "Default = -1",
+ "required": false
+ },
+ {
+ "name": "activities",
+ "type": "[iActivity!]",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "links",
+ "type": "[iLink!]",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "layout",
+ "type": "iWorkflowLayout",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "failHandler",
+ "type": "iFailHandler",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "in",
+ "type": "ID",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation createWorkflow( $name: String!, $scope: WorkflowableTypeName, $description: String, $parameters: [iMetadataValue!], $onCompletedRetention: Int, $onFailedRetention: Int, $activities: [iActivity!], $links: [iLink!], $layout: iWorkflowLayout, $failHandler: iFailHandler, $in: ID ) { createWorkflow( name: $name, scope: $scope, description: $description, parameters: $parameters, onCompletedRetention: $onCompletedRetention, onFailedRetention: $onFailedRetention, activities: $activities, links: $links, layout: $layout, failHandler: $failHandler, in: $in ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } priority applyOn activities { ...ActivityFragment } links { ...LinkFragment } layout { ...WorkflowLayoutFragment } parameters { ...MetadataValueFragment } onFailed { ...FailHandlerFragment } onCompletedRetention onFailedRetention } }",
+ "example_variables": "{ \"name\": \"xyz789\", \"scope\": \"Folder\", \"description\": \"xyz789\", \"parameters\": [iMetadataValue], \"onCompletedRetention\": -1, \"onFailedRetention\": -1, \"activities\": [iActivity], \"links\": [iLink], \"layout\": iWorkflowLayout, \"failHandler\": iFailHandler, \"in\": \"4\" }",
+ "example_response": "{ \"data\": { \"createWorkflow\": { \"id\": \"4\", \"name\": \"xyz789\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"priority\": 123, \"applyOn\": \"Folder\", \"activities\": [Activity], \"links\": [Link], \"layout\": WorkflowLayout, \"parameters\": [MetadataValue], \"onFailed\": FailHandler, \"onCompletedRetention\": 987, \"onFailedRetention\": 123 } } }"
+ },
+ {
+ "name": "deleteActivity",
+ "type": "mutation",
+ "description": "To delete an activity",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "name",
+ "type": "[String!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "type",
+ "type": "ActivityType!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteActivity( $name: [String!]!, $type: ActivityType! ) { deleteActivity( name: $name, type: $type ) }",
+ "example_variables": "{\"name\": [\"xyz789\"], \"type\": \"InputFile\"}",
+ "example_response": "{\"data\": {\"deleteActivity\": false}}"
+ },
+ {
+ "name": "deleteActivityIcon",
+ "type": "mutation",
+ "description": "delete an activity icon",
+ "response_type": "a Boolean",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteActivityIcon($id: [ID!]!) { deleteActivityIcon(id: $id) }",
+ "example_variables": "{\"id\": [\"4\"]}",
+ "example_response": "{\"data\": {\"deleteActivityIcon\": true}}"
+ },
+ {
+ "name": "deleteActivityPreset",
+ "type": "mutation",
+ "description": "To delete a preset",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "type",
+ "type": "ActivityType!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteActivityPreset( $name: String!, $type: ActivityType! ) { deleteActivityPreset( name: $name, type: $type ) }",
+ "example_variables": "{\"name\": \"abc123\", \"type\": \"InputFile\"}",
+ "example_response": "{\"data\": {\"deleteActivityPreset\": true}}"
+ },
+ {
+ "name": "deleteAllTrashedObjects",
+ "type": "mutation",
+ "description": "Delete all objects that have been trashed with the current user",
+ "response_type": "a Boolean!",
+ "arguments": [],
+ "example_query": "mutation deleteAllTrashedObjects { deleteAllTrashedObjects }",
+ "example_variables": "",
+ "example_response": "{\"data\": {\"deleteAllTrashedObjects\": true}}"
+ },
+ {
+ "name": "deleteAnnotationStatus",
+ "type": "mutation",
+ "description": "Returns a Boolean",
+ "response_type": "a Boolean",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteAnnotationStatus($id: [ID!]!) { deleteAnnotationStatus(id: $id) }",
+ "example_variables": "{\"id\": [4]}",
+ "example_response": "{\"data\": {\"deleteAnnotationStatus\": false}}"
+ },
+ {
+ "name": "deleteAnyProofReadingMark",
+ "type": "mutation",
+ "description": "Returns a Boolean!",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteAnyProofReadingMark($id: [ID!]!) { deleteAnyProofReadingMark(id: $id) }",
+ "example_variables": "{\"id\": [\"4\"]}",
+ "example_response": "{\"data\": {\"deleteAnyProofReadingMark\": true}}"
+ },
+ {
+ "name": "deleteAsset",
+ "type": "mutation",
+ "description": "To delete an Asset. By default the Asset is moved to the trash",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "id of the Asset",
+ "required": true
+ },
+ {
+ "name": "now",
+ "type": "Boolean",
+ "description": "flag to be able to immediately delete the Asset otherwise it is moved to the trash. Default = false",
+ "required": false
+ }
+ ],
+ "example_query": "mutation deleteAsset( $id: [ID!]!, $now: Boolean ) { deleteAsset( id: $id, now: $now ) }",
+ "example_variables": "{\"id\": [4], \"now\": false}",
+ "example_response": "{\"data\": {\"deleteAsset\": false}}"
+ },
+ {
+ "name": "deleteAuthentication",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteAuthentication($id: ID!) { deleteAuthentication(id: $id) }",
+ "example_variables": "{\"id\": \"4\"}",
+ "example_response": "{\"data\": {\"deleteAuthentication\": false}}"
+ },
+ {
+ "name": "deleteClientApplication",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteClientApplication($id: ID!) { deleteClientApplication(id: $id) }",
+ "example_variables": "{\"id\": \"4\"}",
+ "example_response": "{\"data\": {\"deleteClientApplication\": false}}"
+ },
+ {
+ "name": "deleteCollection",
+ "type": "mutation",
+ "description": "To delete a Collection. By default the Collection is moved to the trash",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "id of the Collection",
+ "required": true
+ },
+ {
+ "name": "now",
+ "type": "Boolean",
+ "description": "flag to be able to immediately delete the Collection otherwise it is moved to the trash. Default = false",
+ "required": false
+ }
+ ],
+ "example_query": "mutation deleteCollection( $id: [ID!]!, $now: Boolean ) { deleteCollection( id: $id, now: $now ) }",
+ "example_variables": "{\"id\": [4], \"now\": false}",
+ "example_response": "{\"data\": {\"deleteCollection\": false}}"
+ },
+ {
+ "name": "deleteColorSpace",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteColorSpace($id: [ID!]!) { deleteColorSpace(id: $id) }",
+ "example_variables": "{\"id\": [4]}",
+ "example_response": "{\"data\": {\"deleteColorSpace\": true}}"
+ },
+ {
+ "name": "deleteCustomActivity",
+ "type": "mutation",
+ "description": "Custom activity deletion",
+ "response_type": "a Boolean",
+ "arguments": [
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteCustomActivity($name: String!) { deleteCustomActivity(name: $name) }",
+ "example_variables": "{\"name\": \"abc123\"}",
+ "example_response": "{\"data\": {\"deleteCustomActivity\": false}}"
+ },
+ {
+ "name": "deleteCustomer",
+ "type": "mutation",
+ "description": "Delete one or many Customer(s)",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteCustomer($id: [ID!]!) { deleteCustomer(id: $id) }",
+ "example_variables": "{\"id\": [\"4\"]}",
+ "example_response": "{\"data\": {\"deleteCustomer\": true}}"
+ },
+ {
+ "name": "deleteEmailOutputChannel",
+ "type": "mutation",
+ "description": "Delete one or more email output channels",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteEmailOutputChannel($id: [ID!]!) { deleteEmailOutputChannel(id: $id) }",
+ "example_variables": "{\"id\": [4]}",
+ "example_response": "{\"data\": {\"deleteEmailOutputChannel\": true}}"
+ },
+ {
+ "name": "deleteEmailTemplate",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteEmailTemplate($id: [ID!]!) { deleteEmailTemplate(id: $id) }",
+ "example_variables": "{\"id\": [\"4\"]}",
+ "example_response": "{\"data\": {\"deleteEmailTemplate\": true}}"
+ },
+ {
+ "name": "deleteFileOutputChannel",
+ "type": "mutation",
+ "description": "Delete one or more file output channels",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteFileOutputChannel($id: [ID!]!) { deleteFileOutputChannel(id: $id) }",
+ "example_variables": "{\"id\": [\"4\"]}",
+ "example_response": "{\"data\": {\"deleteFileOutputChannel\": false}}"
+ },
+ {
+ "name": "deleteFolder",
+ "type": "mutation",
+ "description": "To delete a Folder. By default the Folder is moved to the trash",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "id of the Folder",
+ "required": true
+ },
+ {
+ "name": "now",
+ "type": "Boolean",
+ "description": "flag to be able to immediately delete the Folder otherwise it is moved to the trash. Default = false",
+ "required": false
+ }
+ ],
+ "example_query": "mutation deleteFolder( $id: [ID!]!, $now: Boolean ) { deleteFolder( id: $id, now: $now ) }",
+ "example_variables": "{\"id\": [\"4\"], \"now\": false}",
+ "example_response": "{\"data\": {\"deleteFolder\": true}}"
+ },
+ {
+ "name": "deleteGroup",
+ "type": "mutation",
+ "description": "Delete one or many Groups that are not System Groups",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteGroup($id: [ID!]!) { deleteGroup(id: $id) }",
+ "example_variables": "{\"id\": [4]}",
+ "example_response": "{\"data\": {\"deleteGroup\": true}}"
+ },
+ {
+ "name": "deleteHost",
+ "type": "mutation",
+ "description": "Delete a Host deprecated",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteHost($id: [ID!]!) { deleteHost(id: $id) }",
+ "example_variables": "{\"id\": [\"4\"]}",
+ "example_response": "{\"data\": {\"deleteHost\": true}}"
+ },
+ {
+ "name": "deleteIccProfile",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a Boolean",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteIccProfile($id: [ID!]!) { deleteIccProfile(id: $id) }",
+ "example_variables": "{\"id\": [\"4\"]}",
+ "example_response": "{\"data\": {\"deleteIccProfile\": true}}"
+ },
+ {
+ "name": "deleteInputChannel",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteInputChannel($id: [ID!]!) { deleteInputChannel(id: $id) }",
+ "example_variables": "{\"id\": [\"4\"]}",
+ "example_response": "{\"data\": {\"deleteInputChannel\": true}}"
+ },
+ {
+ "name": "deleteInputRuleSet",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteInputRuleSet($id: [ID!]!) { deleteInputRuleSet(id: $id) }",
+ "example_variables": "{\"id\": [4]}",
+ "example_response": "{\"data\": {\"deleteInputRuleSet\": false}}"
+ },
+ {
+ "name": "deleteLayout",
+ "type": "mutation",
+ "description": "Delete a layout",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteLayout($id: [ID]!) { deleteLayout(id: $id) }",
+ "example_variables": "{\"id\": [\"4\"]}",
+ "example_response": "{\"data\": {\"deleteLayout\": false}}"
+ },
+ {
+ "name": "deleteMetadataDefinition",
+ "type": "mutation",
+ "description": "To delete a metadata definition",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteMetadataDefinition($id: [ID!]!) { deleteMetadataDefinition(id: $id) }",
+ "example_variables": "{\"id\": [\"4\"]}",
+ "example_response": "{\"data\": {\"deleteMetadataDefinition\": true}}"
+ },
+ {
+ "name": "deleteMetadataNameSpace",
+ "type": "mutation",
+ "description": "To delete a nameSpace definition",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteMetadataNameSpace($id: [ID!]!) { deleteMetadataNameSpace(id: $id) }",
+ "example_variables": "{\"id\": [\"4\"]}",
+ "example_response": "{\"data\": {\"deleteMetadataNameSpace\": false}}"
+ },
+ {
+ "name": "deleteMyProofReadingMark",
+ "type": "mutation",
+ "description": "Returns a Boolean!",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteMyProofReadingMark($id: [ID!]!) { deleteMyProofReadingMark(id: $id) }",
+ "example_variables": "{\"id\": [\"4\"]}",
+ "example_response": "{\"data\": {\"deleteMyProofReadingMark\": false}}"
+ },
+ {
+ "name": "deleteMySharing",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteMySharing($id: [ID!]!) { deleteMySharing(id: $id) }",
+ "example_variables": "{\"id\": [\"4\"]}",
+ "example_response": "{\"data\": {\"deleteMySharing\": false}}"
+ },
+ {
+ "name": "deleteMyWebAuthnRegistration",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteMyWebAuthnRegistration($id: [ID!]!) { deleteMyWebAuthnRegistration(id: $id) }",
+ "example_variables": "{\"id\": [\"4\"]}",
+ "example_response": "{\"data\": {\"deleteMyWebAuthnRegistration\": false}}"
+ },
+ {
+ "name": "deleteNote",
+ "type": "mutation",
+ "description": "Returns a Boolean!",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteNote($id: [ID!]!) { deleteNote(id: $id) }",
+ "example_variables": "{\"id\": [\"4\"]}",
+ "example_response": "{\"data\": {\"deleteNote\": true}}"
+ },
+ {
+ "name": "deleteNotificationTemplate",
+ "type": "mutation",
+ "description": "The default ones cannot be deleted",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteNotificationTemplate($id: [ID!]!) { deleteNotificationTemplate(id: $id) }",
+ "example_variables": "{\"id\": [4]}",
+ "example_response": "{\"data\": {\"deleteNotificationTemplate\": false}}"
+ },
+ {
+ "name": "deleteObject",
+ "type": "mutation",
+ "description": "Generic delete object",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "id of the Project",
+ "required": true
+ },
+ {
+ "name": "now",
+ "type": "Boolean",
+ "description": "flag to be able to immediately delete the Project otherwise it is moved to the trash. Default = false",
+ "required": false
+ }
+ ],
+ "example_query": "mutation deleteObject( $id: [ID!]!, $now: Boolean ) { deleteObject( id: $id, now: $now ) }",
+ "example_variables": "{\"id\": [\"4\"], \"now\": false}",
+ "example_response": "{\"data\": {\"deleteObject\": false}}"
+ },
+ {
+ "name": "deleteOrganization",
+ "type": "mutation",
+ "description": "Delete one or many Organizations",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteOrganization($id: [ID!]!) { deleteOrganization(id: $id) }",
+ "example_variables": "{\"id\": [\"4\"]}",
+ "example_response": "{\"data\": {\"deleteOrganization\": true}}"
+ },
+ {
+ "name": "deleteOutputChannelGroup",
+ "type": "mutation",
+ "description": "Delete one or more output channel groups Will also delete any output channels in the group",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteOutputChannelGroup($id: [ID!]!) { deleteOutputChannelGroup(id: $id) }",
+ "example_variables": "{\"id\": [4]}",
+ "example_response": "{\"data\": {\"deleteOutputChannelGroup\": false}}"
+ },
+ {
+ "name": "deleteProcess",
+ "type": "mutation",
+ "description": "To delete a Process",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteProcess($id: [ID!]) { deleteProcess(id: $id) }",
+ "example_variables": "{\"id\": [\"4\"]}",
+ "example_response": "{\"data\": {\"deleteProcess\": true}}"
+ },
+ {
+ "name": "deleteProject",
+ "type": "mutation",
+ "description": "To delete a Project. By default the project is moved to the trash",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "id of the Project",
+ "required": true
+ },
+ {
+ "name": "now",
+ "type": "Boolean",
+ "description": "flag to be able to immediately delete the Project otherwise it is moved to the trash. Default = false",
+ "required": false
+ }
+ ],
+ "example_query": "mutation deleteProject( $id: [ID!]!, $now: Boolean ) { deleteProject( id: $id, now: $now ) }",
+ "example_variables": "{\"id\": [4], \"now\": false}",
+ "example_response": "{\"data\": {\"deleteProject\": false}}"
+ },
+ {
+ "name": "deleteProjectFolder",
+ "type": "mutation",
+ "description": "To delete a ProjectFolder. By default the ProjectFolder is moved to the trash",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "id of the ProjectFolder",
+ "required": true
+ },
+ {
+ "name": "now",
+ "type": "Boolean",
+ "description": "flag to be able to immediately delete the Folder otherwise it is moved to the trash. Default = false",
+ "required": false
+ }
+ ],
+ "example_query": "mutation deleteProjectFolder( $id: [ID!]!, $now: Boolean ) { deleteProjectFolder( id: $id, now: $now ) }",
+ "example_variables": "{\"id\": [4], \"now\": false}",
+ "example_response": "{\"data\": {\"deleteProjectFolder\": false}}"
+ },
+ {
+ "name": "deleteProjectTemplate",
+ "type": "mutation",
+ "description": "To delete a ProjectTemplate",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteProjectTemplate($id: [ID!]!) { deleteProjectTemplate(id: $id) }",
+ "example_variables": "{\"id\": [\"4\"]}",
+ "example_response": "{\"data\": {\"deleteProjectTemplate\": false}}"
+ },
+ {
+ "name": "deleteProperty",
+ "type": "mutation",
+ "description": "To delete a property",
+ "response_type": "a ConfigProperty!",
+ "arguments": [
+ {
+ "name": "category",
+ "type": "String!",
+ "description": "The category to which belongs the property",
+ "required": true
+ },
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "The name of the property",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteProperty( $category: String!, $name: String! ) { deleteProperty( category: $category, name: $name ) { id category name value } }",
+ "example_variables": "{ \"category\": \"abc123\", \"name\": \"xyz789\" }",
+ "example_response": "{ \"data\": { \"deleteProperty\": { \"id\": 4, \"category\": \"abc123\", \"name\": \"xyz789\", \"value\": \"abc123\" } } }"
+ },
+ {
+ "name": "deleteRelation",
+ "type": "mutation",
+ "description": "To delete Relations by there ID(s)",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteRelation($id: [ID!]!) { deleteRelation(id: $id) }",
+ "example_variables": "{\"id\": [4]}",
+ "example_response": "{\"data\": {\"deleteRelation\": false}}"
+ },
+ {
+ "name": "deleteRelationFromObject",
+ "type": "mutation",
+ "description": "To delete Relations from there target and/or sources one of source or target is mandatory",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "from",
+ "type": "[ID!]",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "to",
+ "type": "[ID!]",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "name",
+ "type": "String",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation deleteRelationFromObject( $from: [ID!], $to: [ID!], $name: String ) { deleteRelationFromObject( from: $from, to: $to, name: $name ) }",
+ "example_variables": "{ \"from\": [\"4\"], \"to\": [4], \"name\": \"abc123\" }",
+ "example_response": "{\"data\": {\"deleteRelationFromObject\": false}}"
+ },
+ {
+ "name": "deleteReplyOfNote",
+ "type": "mutation",
+ "description": "Returns a Note!",
+ "response_type": "a Note!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "rank",
+ "type": "Long!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteReplyOfNote( $id: ID!, $rank: Long! ) { deleteReplyOfNote( id: $id, rank: $rank ) { id type objectOwnerId pageNumber lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } attachments { ...AttachmentFragment } checkable status { ...AnnotationStatusFragment } collapsed seenBy { ...UserFragment } replies { ...NoteReplyFragment } content originalContent stylizedContent positionX positionY positionZ anchorX anchorY anchorZ tx ty proofReadingMark { ...ProofReadingMarkFragment } path selectable startTime endTime } }",
+ "example_variables": "{\"id\": \"4\", \"rank\": {}}",
+ "example_response": "{ \"data\": { \"deleteReplyOfNote\": { \"id\": 4, \"type\": \"Note\", \"objectOwnerId\": \"4\", \"pageNumber\": {}, \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"attachments\": [Attachment], \"checkable\": true, \"status\": AnnotationStatus, \"collapsed\": true, \"seenBy\": [User], \"replies\": [NoteReply], \"content\": \"abc123\", \"originalContent\": \"abc123\", \"stylizedContent\": \"abc123\", \"positionX\": 987.65, \"positionY\": 987.65, \"positionZ\": 987.65, \"anchorX\": 987.65, \"anchorY\": 123.45, \"anchorZ\": 987.65, \"tx\": 987.65, \"ty\": 123.45, \"proofReadingMark\": ProofReadingMark, \"path\": \"abc123\", \"selectable\": false, \"startTime\": 987.65, \"endTime\": 123.45 } } }"
+ },
+ {
+ "name": "deleteRole",
+ "type": "mutation",
+ "description": "Delete one or many Role(s)",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteRole($id: [ID!]!) { deleteRole(id: $id) }",
+ "example_variables": "{\"id\": [4]}",
+ "example_response": "{\"data\": {\"deleteRole\": false}}"
+ },
+ {
+ "name": "deleteSchemaExtension",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteSchemaExtension($id: [ID!]) { deleteSchemaExtension(id: $id) }",
+ "example_variables": "{\"id\": [4]}",
+ "example_response": "{\"data\": {\"deleteSchemaExtension\": false}}"
+ },
+ {
+ "name": "deleteSecurityProfile",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteSecurityProfile($id: [ID!]!) { deleteSecurityProfile(id: $id) }",
+ "example_variables": "{\"id\": [4]}",
+ "example_response": "{\"data\": {\"deleteSecurityProfile\": false}}"
+ },
+ {
+ "name": "deleteSharing",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteSharing($id: [ID!]!) { deleteSharing(id: $id) }",
+ "example_variables": "{\"id\": [\"4\"]}",
+ "example_response": "{\"data\": {\"deleteSharing\": false}}"
+ },
+ {
+ "name": "deleteSmartCollection",
+ "type": "mutation",
+ "description": "To delete a SmartCollection. By default the SmartCollection is moved to the trash",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "id of the SmartCollection",
+ "required": true
+ },
+ {
+ "name": "now",
+ "type": "Boolean",
+ "description": "flag to be able to immediately delete the SmartCollection otherwise it is moved to the trash. Default = false",
+ "required": false
+ }
+ ],
+ "example_query": "mutation deleteSmartCollection( $id: [ID!]!, $now: Boolean ) { deleteSmartCollection( id: $id, now: $now ) }",
+ "example_variables": "{\"id\": [\"4\"], \"now\": false}",
+ "example_response": "{\"data\": {\"deleteSmartCollection\": true}}"
+ },
+ {
+ "name": "deleteSynSet",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "mode",
+ "type": "SynSetDeletionMode",
+ "description": "Default = None",
+ "required": false
+ }
+ ],
+ "example_query": "mutation deleteSynSet( $id: ID!, $mode: SynSetDeletionMode ) { deleteSynSet( id: $id, mode: $mode ) }",
+ "example_variables": "{\"id\": \"4\", \"mode\": \"None\"}",
+ "example_response": "{\"data\": {\"deleteSynSet\": true}}"
+ },
+ {
+ "name": "deleteThesaurus",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteThesaurus($id: ID!) { deleteThesaurus(id: $id) }",
+ "example_variables": "{\"id\": 4}",
+ "example_response": "{\"data\": {\"deleteThesaurus\": false}}"
+ },
+ {
+ "name": "deleteUIFile",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a Boolean",
+ "arguments": [
+ {
+ "name": "from",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "path",
+ "type": "[String!]",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteUIFile( $from: String!, $path: [String!] ) { deleteUIFile( from: $from, path: $path ) }",
+ "example_variables": "{ \"from\": \"abc123\", \"path\": [\"abc123\"] }",
+ "example_response": "{\"data\": {\"deleteUIFile\": true}}"
+ },
+ {
+ "name": "deleteUIFolder",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a Boolean",
+ "arguments": [
+ {
+ "name": "from",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "path",
+ "type": "[String!]",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteUIFolder( $from: String!, $path: [String!] ) { deleteUIFolder( from: $from, path: $path ) }",
+ "example_variables": "{ \"from\": \"abc123\", \"path\": [\"abc123\"] }",
+ "example_response": "{\"data\": {\"deleteUIFolder\": false}}"
+ },
+ {
+ "name": "deleteUIProject",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a Boolean",
+ "arguments": [
+ {
+ "name": "name",
+ "type": "[String!]",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteUIProject($name: [String!]) { deleteUIProject(name: $name) }",
+ "example_variables": "{\"name\": [\"xyz789\"]}",
+ "example_response": "{\"data\": {\"deleteUIProject\": true}}"
+ },
+ {
+ "name": "deleteUser",
+ "type": "mutation",
+ "description": "Delete one or many Users",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteUser($id: [ID!]!) { deleteUser(id: $id) }",
+ "example_variables": "{\"id\": [\"4\"]}",
+ "example_response": "{\"data\": {\"deleteUser\": false}}"
+ },
+ {
+ "name": "deleteUserAction",
+ "type": "mutation",
+ "description": "** Delete one or more user actions**",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteUserAction($id: [ID!]!) { deleteUserAction(id: $id) }",
+ "example_variables": "{\"id\": [4]}",
+ "example_response": "{\"data\": {\"deleteUserAction\": false}}"
+ },
+ {
+ "name": "deleteViewingCondition",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteViewingCondition($id: [ID!]!) { deleteViewingCondition(id: $id) }",
+ "example_variables": "{\"id\": [4]}",
+ "example_response": "{\"data\": {\"deleteViewingCondition\": false}}"
+ },
+ {
+ "name": "deleteVolume",
+ "type": "mutation",
+ "description": "Delete a Volume",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteVolume($id: [ID!]!) { deleteVolume(id: $id) }",
+ "example_variables": "{\"id\": [4]}",
+ "example_response": "{\"data\": {\"deleteVolume\": false}}"
+ },
+ {
+ "name": "deleteWebAuthnRegistration",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteWebAuthnRegistration($id: [ID!]!) { deleteWebAuthnRegistration(id: $id) }",
+ "example_variables": "{\"id\": [4]}",
+ "example_response": "{\"data\": {\"deleteWebAuthnRegistration\": true}}"
+ },
+ {
+ "name": "deleteWorkflow",
+ "type": "mutation",
+ "description": "Workflow deletion : to delete a workflow with entityId 0",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "name",
+ "type": "[String!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation deleteWorkflow($name: [String!]!) { deleteWorkflow(name: $name) }",
+ "example_variables": "{\"name\": [\"xyz789\"]}",
+ "example_response": "{\"data\": {\"deleteWorkflow\": false}}"
+ },
+ {
+ "name": "disableNotifications",
+ "type": "mutation",
+ "description": "for the current user",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "setup",
+ "type": "[iEnableDisableNotification!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation disableNotifications($setup: [iEnableDisableNotification!]!) { disableNotifications(setup: $setup) }",
+ "example_variables": "{\"setup\": [iEnableDisableNotification]}",
+ "example_response": "{\"data\": {\"disableNotifications\": false}}"
+ },
+ {
+ "name": "disconnectAs",
+ "type": "mutation",
+ "description": "When connected as another user, returns to the original login, the current token is revoked. The response is identical to a standard login, a new AccessToken is received. If the AccessToken does not correspond to a user connected as, then nothing append, the current token is still valid.",
+ "response_type": "a JSON!",
+ "arguments": [],
+ "example_query": "mutation disconnectAs { disconnectAs }",
+ "example_variables": "",
+ "example_response": "{\"data\": {\"disconnectAs\": {}}}"
+ },
+ {
+ "name": "duplicateActivity",
+ "type": "mutation",
+ "description": "To duplicate Top Level Activity",
+ "response_type": "an Activity!",
+ "arguments": [
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "newName",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "type",
+ "type": "ActivityType!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation duplicateActivity( $name: String!, $newName: String!, $type: ActivityType! ) { duplicateActivity( name: $name, newName: $newName, type: $type ) { id name bypassed icon color category } }",
+ "example_variables": "{ \"name\": \"xyz789\", \"newName\": \"abc123\", \"type\": \"InputFile\" }",
+ "example_response": "{ \"data\": { \"duplicateActivity\": { \"id\": 4, \"name\": \"abc123\", \"bypassed\": true, \"icon\": \"4\", \"color\": \"abc123\", \"category\": \"abc123\" } } }"
+ },
+ {
+ "name": "duplicateProject",
+ "type": "mutation",
+ "description": "To duplicate a project",
+ "response_type": "a Project!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "newName",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "duplicateImposition",
+ "type": "Boolean",
+ "description": "Default = false",
+ "required": false
+ },
+ {
+ "name": "duplicateImpositionDetails",
+ "type": "Boolean",
+ "description": "Default = false",
+ "required": false
+ }
+ ],
+ "example_query": "mutation duplicateProject( $id: ID!, $newName: String!, $duplicateImposition: Boolean, $duplicateImpositionDetails: Boolean ) { duplicateProject( id: $id, newName: $newName, duplicateImposition: $duplicateImposition, duplicateImpositionDetails: $duplicateImpositionDetails ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } trashDate trashUser { ...UserFragment } endDate metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } status workflowName approvalStatus { ...ApprovalActivityStatusFragment } approvalSummary approvals { ...ApprovalCycleFragment } assetApprovals { ...ApprovalCycleFragment } children { ...PagingResponseFragment } assetWorkflow { ...WorkflowFragment } processes { ...ProcessFragment } projectTemplate { ...ProjectTemplateFragment } priority colorSpace { ...ColorSpaceFragment } viewingCondition { ...ViewingConditionFragment } reversedView customer { ...CustomerFragment } parents { ...ContainerFragment } mainAsset { ...AssetFragment } siteId productionParticipants { ...ProductionParticipantFragment } notes { ...NoteFragment } trimmedHeight trimmedWidth nbPages accessControls deadlines { ...ProjectDeadlineFragment } } }",
+ "example_variables": "{ \"id\": \"4\", \"newName\": \"abc123\", \"duplicateImposition\": false, \"duplicateImpositionDetails\": false }",
+ "example_response": "{ \"data\": { \"duplicateProject\": { \"id\": \"4\", \"name\": \"xyz789\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"trashDate\": \"2007-12-03T10:15:30Z\", \"trashUser\": User, \"endDate\": \"2007-12-03T10:15:30Z\", \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"status\": [\"ACTIVE\"], \"workflowName\": \"abc123\", \"approvalStatus\": [ApprovalActivityStatus], \"approvalSummary\": \"NONE\", \"approvals\": [ApprovalCycle], \"assetApprovals\": [ApprovalCycle], \"children\": PagingResponse, \"assetWorkflow\": Workflow, \"processes\": [Process], \"projectTemplate\": ProjectTemplate, \"priority\": 987, \"colorSpace\": ColorSpace, \"viewingCondition\": ViewingCondition, \"reversedView\": true, \"customer\": Customer, \"parents\": [Container], \"mainAsset\": Asset, \"siteId\": 4, \"productionParticipants\": [ProductionParticipant], \"notes\": [Note], \"trimmedHeight\": 987.65, \"trimmedWidth\": 987.65, \"nbPages\": 987, \"accessControls\": {}, \"deadlines\": [ProjectDeadline] } } }"
+ },
+ {
+ "name": "duplicateProjectTemplate",
+ "type": "mutation",
+ "description": "To duplicate a ProjectTemplate",
+ "response_type": "a ProjectTemplate!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "friendlyName",
+ "type": "String",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation duplicateProjectTemplate( $id: ID, $friendlyName: String ) { duplicateProjectTemplate( id: $id, friendlyName: $friendlyName ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } friendlyName priority colorSpace { ...ColorSpaceFragment } viewingCondition { ...ViewingConditionFragment } assetWorkflow { ...WorkflowFragment } projectWorkflow { ...WorkflowFragment } productionParticipants { ...ProductionParticipantFragment } assetApprovals { ...ApprovalCycleFragment } projectApprovals { ...ApprovalCycleFragment } deadlines { ...ProjectDeadlineFragment } skipWeekend } }",
+ "example_variables": "{\"id\": 4, \"friendlyName\": \"xyz789\"}",
+ "example_response": "{ \"data\": { \"duplicateProjectTemplate\": { \"id\": \"4\", \"name\": \"xyz789\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"friendlyName\": \"xyz789\", \"priority\": 987, \"colorSpace\": ColorSpace, \"viewingCondition\": ViewingCondition, \"assetWorkflow\": Workflow, \"projectWorkflow\": Workflow, \"productionParticipants\": [ProductionParticipant], \"assetApprovals\": [ApprovalCycle], \"projectApprovals\": [ApprovalCycle], \"deadlines\": [ProjectDeadline], \"skipWeekend\": false } } }"
+ },
+ {
+ "name": "duplicateSecurityProfile",
+ "type": "mutation",
+ "description": "to duplicate a profile",
+ "response_type": "a SecurityProfile",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "description",
+ "type": "String",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation duplicateSecurityProfile( $id: ID!, $name: String!, $description: String ) { duplicateSecurityProfile( id: $id, name: $name, description: $description ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } properties { ...SecurityPropertyFragment } } }",
+ "example_variables": "{ \"id\": 4, \"name\": \"xyz789\", \"description\": \"abc123\" }",
+ "example_response": "{ \"data\": { \"duplicateSecurityProfile\": { \"id\": \"4\", \"name\": \"abc123\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"properties\": [SecurityProperty] } } }"
+ },
+ {
+ "name": "duplicateWorkflow",
+ "type": "mutation",
+ "description": "deleteWorkflowRevision(name:String! revision:Int!):Boolean! @security(role:ADMIN_WORKFLOW) Workflow duplication in can be null, the duplicated workflow is linked in the same folder as the original one",
+ "response_type": "a Workflow!",
+ "arguments": [
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "newName",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "in",
+ "type": "ID",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation duplicateWorkflow( $name: String!, $newName: String!, $in: ID ) { duplicateWorkflow( name: $name, newName: $newName, in: $in ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } priority applyOn activities { ...ActivityFragment } links { ...LinkFragment } layout { ...WorkflowLayoutFragment } parameters { ...MetadataValueFragment } onFailed { ...FailHandlerFragment } onCompletedRetention onFailedRetention } }",
+ "example_variables": "{ \"name\": \"abc123\", \"newName\": \"xyz789\", \"in\": \"4\" }",
+ "example_response": "{ \"data\": { \"duplicateWorkflow\": { \"id\": \"4\", \"name\": \"abc123\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"priority\": 123, \"applyOn\": \"Folder\", \"activities\": [Activity], \"links\": [Link], \"layout\": WorkflowLayout, \"parameters\": [MetadataValue], \"onFailed\": FailHandler, \"onCompletedRetention\": 987, \"onFailedRetention\": 987 } } }"
+ },
+ {
+ "name": "editActivity",
+ "type": "mutation",
+ "description": "To edit Top Level Activity toRemove: true will throw an Exception",
+ "response_type": "an Activity!",
+ "arguments": [
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "type",
+ "type": "ActivityType!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iActivity!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation editActivity( $name: String!, $type: ActivityType!, $setup: iActivity! ) { editActivity( name: $name, type: $type, setup: $setup ) { id name bypassed icon color category } }",
+ "example_variables": "{ \"name\": \"xyz789\", \"type\": \"InputFile\", \"setup\": iActivity }",
+ "example_response": "{ \"data\": { \"editActivity\": { \"id\": 4, \"name\": \"xyz789\", \"bypassed\": false, \"icon\": \"4\", \"color\": \"xyz789\", \"category\": \"abc123\" } } }"
+ },
+ {
+ "name": "editActivityEngineCapacity",
+ "type": "mutation",
+ "description": "Edit capacity of an ActivityEngine in a specific Workflow Engine",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "from",
+ "type": "URL!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "capacity",
+ "type": "Int!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation editActivityEngineCapacity( $id: ID!, $from: URL!, $capacity: Int! ) { editActivityEngineCapacity( id: $id, from: $from, capacity: $capacity ) }",
+ "example_variables": "{ \"id\": 4, \"from\": \"http://www.test.com/\", \"capacity\": 987 }",
+ "example_response": "{\"data\": {\"editActivityEngineCapacity\": true}}"
+ },
+ {
+ "name": "editActivityEngineTemplate",
+ "type": "mutation",
+ "description": "Edit an ActivityEngineTemplate in a specific Workflow Engine",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "from",
+ "type": "URL!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "JSON!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation editActivityEngineTemplate( $from: URL!, $setup: JSON! ) { editActivityEngineTemplate( from: $from, setup: $setup ) }",
+ "example_variables": "{ \"from\": \"http://www.test.com/\", \"setup\": {} }",
+ "example_response": "{\"data\": {\"editActivityEngineTemplate\": false}}"
+ },
+ {
+ "name": "editActivityPreset",
+ "type": "mutation",
+ "description": "To edit activity presets creates it if it doesn't exist",
+ "response_type": "an Activity!",
+ "arguments": [
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "type",
+ "type": "ActivityType!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iActivity!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation editActivityPreset( $name: String!, $type: ActivityType!, $setup: iActivity! ) { editActivityPreset( name: $name, type: $type, setup: $setup ) { id name bypassed icon color category } }",
+ "example_variables": "{ \"name\": \"xyz789\", \"type\": \"InputFile\", \"setup\": iActivity }",
+ "example_response": "{ \"data\": { \"editActivityPreset\": { \"id\": \"4\", \"name\": \"abc123\", \"bypassed\": false, \"icon\": \"4\", \"color\": \"abc123\", \"category\": \"abc123\" } } }"
+ },
+ {
+ "name": "editAnnotationStatus",
+ "type": "mutation",
+ "description": "Returns an AnnotationStatus!",
+ "response_type": "an AnnotationStatus!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iAnnotationStatus",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation editAnnotationStatus( $id: ID!, $setup: iAnnotationStatus ) { editAnnotationStatus( id: $id, setup: $setup ) { id lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } color icon isActive order translations } }",
+ "example_variables": "{ \"id\": \"4\", \"setup\": iAnnotationStatus }",
+ "example_response": "{ \"data\": { \"editAnnotationStatus\": { \"id\": \"4\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"color\": \"abc123\", \"icon\": \"abc123\", \"isActive\": false, \"order\": 987, \"translations\": {} } } }"
+ },
+ {
+ "name": "editAsset",
+ "type": "mutation",
+ "description": "To edit an Asset",
+ "response_type": "[Asset!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iAssetSetup",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation editAsset( $id: [ID!]!, $setup: iAssetSetup ) { editAsset( id: $id, setup: $setup ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } trashDate trashUser { ...UserFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } status approvalSummary approvalStatus { ...ApprovalActivityStatusFragment } approvals { ...ApprovalCycleFragment } workflowName isAlias processes { ...ProcessFragment } uuid priority isCheckedOut checkedOutBy { ...UserFragment } privateWorkingRevision isArchived archiveId colorSpace { ...ColorSpaceFragment } viewingCondition { ...ViewingConditionFragment } project { ...ProjectFragment } parents { ...ContainerFragment } numberOfRevisions expirationDate medias { ...MediaFragment } notes { ...NoteFragment } relationFrom { ...RelationFragment } relationTo { ...RelationFragment } accessControls } }",
+ "example_variables": "{\"id\": [4], \"setup\": iAssetSetup}",
+ "example_response": "{ \"data\": { \"editAsset\": [ { \"id\": 4, \"name\": \"abc123\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"trashDate\": \"2007-12-03T10:15:30Z\", \"trashUser\": User, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"status\": [\"ACTIVE\"], \"approvalSummary\": \"NONE\", \"approvalStatus\": [ApprovalActivityStatus], \"approvals\": [ApprovalCycle], \"workflowName\": \"xyz789\", \"isAlias\": true, \"processes\": [Process], \"uuid\": \"abc123\", \"priority\": 123, \"isCheckedOut\": true, \"checkedOutBy\": User, \"privateWorkingRevision\": 123, \"isArchived\": false, \"archiveId\": \"4\", \"colorSpace\": ColorSpace, \"viewingCondition\": ViewingCondition, \"project\": Project, \"parents\": [Container], \"numberOfRevisions\": 123, \"expirationDate\": \"2007-12-03T10:15:30Z\", \"medias\": [Media], \"notes\": [Note], \"relationFrom\": [Relation], \"relationTo\": [Relation], \"accessControls\": {} } ] } }"
+ },
+ {
+ "name": "editAuthentication",
+ "type": "mutation",
+ "description": "",
+ "response_type": "an Authentication!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iAuthentication!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation editAuthentication( $id: ID!, $setup: iAuthentication! ) { editAuthentication( id: $id, setup: $setup ) { id type name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } authorizationURL tokenURL clientId isActive samlSetup { ...SAMLSetupFragment } } }",
+ "example_variables": "{ \"id\": \"4\", \"setup\": iAuthentication }",
+ "example_response": "{ \"data\": { \"editAuthentication\": { \"id\": \"4\", \"type\": \"INTERNAL\", \"name\": \"abc123\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"authorizationURL\": \"http://www.test.com/\", \"tokenURL\": \"http://www.test.com/\", \"clientId\": 4, \"isActive\": false, \"samlSetup\": SAMLSetup } } }"
+ },
+ {
+ "name": "editClientApplication",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a ClientApplication!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iEditClientApplication!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation editClientApplication( $id: ID!, $setup: iEditClientApplication! ) { editClientApplication( id: $id, setup: $setup ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } allowIntrospection maxQueryDepth redirectURL secret schema defaultTokenDuration algorithm { ...JWTAlgorithmFragment } } }",
+ "example_variables": "{ \"id\": \"4\", \"setup\": iEditClientApplication }",
+ "example_response": "{ \"data\": { \"editClientApplication\": { \"id\": 4, \"name\": \"abc123\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"allowIntrospection\": true, \"maxQueryDepth\": 123, \"redirectURL\": \"http://www.test.com/\", \"secret\": \"xyz789\", \"schema\": [\"ADMIN\"], \"defaultTokenDuration\": {}, \"algorithm\": JWTAlgorithm } } }"
+ },
+ {
+ "name": "editCollection",
+ "type": "mutation",
+ "description": "To edit a Collection",
+ "response_type": "[Collection!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iCollectionSetup!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation editCollection( $id: [ID!]!, $setup: iCollectionSetup! ) { editCollection( id: $id, setup: $setup ) { id name description color lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } trashDate trashUser { ...UserFragment } icon lName translations children { ...PagingResponseFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } readOnly accessControlList { ...AccessControlListFragment } path { ...CollectionFragment } parents { ...ContainerFragment } destination { ...EntityFragment } } }",
+ "example_variables": "{ \"id\": [\"4\"], \"setup\": iCollectionSetup }",
+ "example_response": "{ \"data\": { \"editCollection\": [ { \"id\": 4, \"name\": \"abc123\", \"description\": \"abc123\", \"color\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"trashDate\": \"2007-12-03T10:15:30Z\", \"trashUser\": User, \"icon\": 4, \"lName\": \"xyz789\", \"translations\": {}, \"children\": PagingResponse, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"readOnly\": true, \"accessControlList\": AccessControlList, \"path\": [Collection], \"parents\": [Container], \"destination\": Entity } ] } }"
+ },
+ {
+ "name": "editColorSpace",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a ColorSpace!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iColorSpace!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation editColorSpace( $id: ID!, $setup: iColorSpace! ) { editColorSpace( id: $id, setup: $setup ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } parents { ...ContainerFragment } colorEngine blackPointCompensation mixedWorkingSpace { ...ICCDestinationSelectionFragment } mixedVectorInput { ...ICCSourceSelectionFragment } mixedRasterInput { ...ICCSourceSelectionFragment } rgbWorkingSpace { ...ICCDestinationSelectionFragment } cmykWorkingSpace { ...ICCDestinationSelectionFragment } grayWorkingSpace { ...ICCDestinationSelectionFragment } } }",
+ "example_variables": "{\"id\": 4, \"setup\": iColorSpace}",
+ "example_response": "{ \"data\": { \"editColorSpace\": { \"id\": 4, \"name\": \"abc123\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"parents\": [Container], \"colorEngine\": \"ADOBE_ACE\", \"blackPointCompensation\": true, \"mixedWorkingSpace\": ICCDestinationSelection, \"mixedVectorInput\": ICCSourceSelection, \"mixedRasterInput\": ICCSourceSelection, \"rgbWorkingSpace\": ICCDestinationSelection, \"cmykWorkingSpace\": ICCDestinationSelection, \"grayWorkingSpace\": ICCDestinationSelection } } }"
+ },
+ {
+ "name": "editCustomActivity",
+ "type": "mutation",
+ "description": "Custom activity edition",
+ "response_type": "an Activity!",
+ "arguments": [
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "type",
+ "type": "ActivityType!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iActivity",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation editCustomActivity( $name: String!, $type: ActivityType!, $setup: iActivity ) { editCustomActivity( name: $name, type: $type, setup: $setup ) { id name bypassed icon color category } }",
+ "example_variables": "{ \"name\": \"xyz789\", \"type\": \"InputFile\", \"setup\": iActivity }",
+ "example_response": "{ \"data\": { \"editCustomActivity\": { \"id\": 4, \"name\": \"xyz789\", \"bypassed\": false, \"icon\": 4, \"color\": \"xyz789\", \"category\": \"abc123\" } } }"
+ },
+ {
+ "name": "editCustomer",
+ "type": "mutation",
+ "description": "Edit a Customer",
+ "response_type": "a Customer!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "defaultProjectTemplateId",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "setup",
+ "type": "iCustomerSetup",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation editCustomer( $id: ID!, $defaultProjectTemplateId: ID, $setup: iCustomerSetup ) { editCustomer( id: $id, defaultProjectTemplateId: $defaultProjectTemplateId, setup: $setup ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } sites defaultSite defaultProjectTemplate { ...ProjectTemplateFragment } projectTemplates { ...ProjectTemplateFragment } code phone phone2 www fax shippingAddress { ...AddressFragment } billingAddress { ...AddressFragment } organization { ...OrganizationFragment } children { ...PagingResponseFragment } emailTemplates { ...EmailTemplateFragment } notificationTemplates { ...NotificationTemplateFragment } securityConfiguration { ...SecurityConfigurationFragment } notifications { ...NotificationFragment } } }",
+ "example_variables": "{ \"id\": \"4\", \"defaultProjectTemplateId\": 4, \"setup\": iCustomerSetup }",
+ "example_response": "{ \"data\": { \"editCustomer\": { \"id\": \"4\", \"name\": \"abc123\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"sites\": [\"abc123\"], \"defaultSite\": \"abc123\", \"defaultProjectTemplate\": ProjectTemplate, \"projectTemplates\": [ProjectTemplate], \"code\": \"abc123\", \"phone\": \"abc123\", \"phone2\": \"xyz789\", \"www\": \"abc123\", \"fax\": \"xyz789\", \"shippingAddress\": Address, \"billingAddress\": Address, \"organization\": Organization, \"children\": PagingResponse, \"emailTemplates\": [EmailTemplate], \"notificationTemplates\": [NotificationTemplate], \"securityConfiguration\": SecurityConfiguration, \"notifications\": [Notification] } } }"
+ },
+ {
+ "name": "editEmailOutputChannel",
+ "type": "mutation",
+ "description": "Edit email output channels",
+ "response_type": "[EmailOutputChannel!]!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iEmailOutputChannelSetup!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation editEmailOutputChannel( $id: [ID!]!, $setup: iEmailOutputChannelSetup! ) { editEmailOutputChannel( id: $id, setup: $setup ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } isActive to subject body specificAttachmentURL attachCurrentFile } }",
+ "example_variables": "{ \"id\": [\"4\"], \"setup\": iEmailOutputChannelSetup }",
+ "example_response": "{ \"data\": { \"editEmailOutputChannel\": [ { \"id\": 4, \"name\": \"abc123\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"isActive\": true, \"to\": [\"abc123\"], \"subject\": \"abc123\", \"body\": \"abc123\", \"specificAttachmentURL\": \"http://www.test.com/\", \"attachCurrentFile\": false } ] } }"
+ },
+ {
+ "name": "editEmailTemplate",
+ "type": "mutation",
+ "description": "",
+ "response_type": "an EmailTemplate!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iEmailTemplate",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation editEmailTemplate( $id: ID!, $setup: iEmailTemplate ) { editEmailTemplate( id: $id, setup: $setup ) { id name description parentEntity { ...WithEmailTemplateFragment } emailParts attachPreview attachPreviewsIfMultipage attachCurrentFile attachHistoryReportAllRevisions attachHistoryReportCurrentRevision attachNoteReportAllRevisions attachNoteReportCurrentRevision attachPreflightReport lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } } }",
+ "example_variables": "{\"id\": 4, \"setup\": iEmailTemplate}",
+ "example_response": "{ \"data\": { \"editEmailTemplate\": { \"id\": 4, \"name\": \"abc123\", \"description\": \"abc123\", \"parentEntity\": WithEmailTemplate, \"emailParts\": {}, \"attachPreview\": true, \"attachPreviewsIfMultipage\": true, \"attachCurrentFile\": true, \"attachHistoryReportAllRevisions\": false, \"attachHistoryReportCurrentRevision\": true, \"attachNoteReportAllRevisions\": true, \"attachNoteReportCurrentRevision\": true, \"attachPreflightReport\": true, \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User } } }"
+ },
+ {
+ "name": "editFileOutputChannel",
+ "type": "mutation",
+ "description": "Edit file output channels",
+ "response_type": "[FileOutputChannel!]!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iFileOutputChannelSetup!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation editFileOutputChannel( $id: [ID!]!, $setup: iFileOutputChannelSetup! ) { editFileOutputChannel( id: $id, setup: $setup ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } isActive encoding protocol server userName path fileName } }",
+ "example_variables": "{ \"id\": [\"4\"], \"setup\": iFileOutputChannelSetup }",
+ "example_response": "{ \"data\": { \"editFileOutputChannel\": [ { \"id\": \"4\", \"name\": \"abc123\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"isActive\": true, \"encoding\": \"UTF8\", \"protocol\": \"FILE\", \"server\": \"abc123\", \"userName\": \"abc123\", \"path\": \"abc123\", \"fileName\": \"abc123\" } ] } }"
+ },
+ {
+ "name": "editFileSystemVolume",
+ "type": "mutation",
+ "description": "Edit a File System Volume",
+ "response_type": "[FileSystemVolume!]!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iFileSystemVolumeSetup!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation editFileSystemVolume( $id: [ID!]!, $setup: iFileSystemVolumeSetup! ) { editFileSystemVolume( id: $id, setup: $setup ) { id group access reference path nfsAlias smbAlias protocol server userName port host { ...HostFragment } diskId site folderRegExp folderExclRegExp fileRegExp fileExclRegExp projectTemplate { ...ProjectTemplateFragment } monitoringQueue monitoring versioning updateMetadata monitorOnBrowse accessControlList { ...AccessControlListFragment } } }",
+ "example_variables": "{\"id\": [4], \"setup\": iFileSystemVolumeSetup}",
+ "example_response": "{ \"data\": { \"editFileSystemVolume\": [ { \"id\": 4, \"group\": \"ATTACHMENT\", \"access\": \"DISABLED\", \"reference\": \"xyz789\", \"path\": \"xyz789\", \"nfsAlias\": \"abc123\", \"smbAlias\": \"xyz789\", \"protocol\": \"FILE\", \"server\": \"xyz789\", \"userName\": \"xyz789\", \"port\": 123, \"host\": Host, \"diskId\": 4, \"site\": \"xyz789\", \"folderRegExp\": \"abc123\", \"folderExclRegExp\": \"xyz789\", \"fileRegExp\": \"abc123\", \"fileExclRegExp\": \"xyz789\", \"projectTemplate\": ProjectTemplate, \"monitoringQueue\": \"xyz789\", \"monitoring\": false, \"versioning\": false, \"updateMetadata\": false, \"monitorOnBrowse\": false, \"accessControlList\": AccessControlList } ] } }"
+ },
+ {
+ "name": "editFolder",
+ "type": "mutation",
+ "description": "To edit a Folder",
+ "response_type": "[Folder!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iFolderSetup",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation editFolder( $id: [ID!]!, $setup: iFolderSetup ) { editFolder( id: $id, setup: $setup ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } trashDate trashUser { ...UserFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } readOnly productionSettings { ...ProductionSettingsFragment } processes { ...ProcessFragment } accessControlList { ...AccessControlListFragment } children { ...PagingResponseFragment } project { ...ProjectFragment } parents { ...ContainerFragment } path { ...FolderFragment } color icon } }",
+ "example_variables": "{ \"id\": [\"4\"], \"setup\": iFolderSetup }",
+ "example_response": "{ \"data\": { \"editFolder\": [ { \"id\": \"4\", \"name\": \"abc123\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"trashDate\": \"2007-12-03T10:15:30Z\", \"trashUser\": User, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"readOnly\": false, \"productionSettings\": ProductionSettings, \"processes\": [Process], \"accessControlList\": AccessControlList, \"children\": PagingResponse, \"project\": Project, \"parents\": [Container], \"path\": [Folder], \"color\": \"abc123\", \"icon\": \"4\" } ] } }"
+ },
+ {
+ "name": "editGlobalProofReadingMark",
+ "type": "mutation",
+ "description": "Returns a Boolean!",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iProofReadingMarkSetup!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation editGlobalProofReadingMark( $id: ID!, $setup: iProofReadingMarkSetup! ) { editGlobalProofReadingMark( id: $id, setup: $setup ) }",
+ "example_variables": "{\"id\": 4, \"setup\": iProofReadingMarkSetup}",
+ "example_response": "{\"data\": {\"editGlobalProofReadingMark\": false}}"
+ },
+ {
+ "name": "editGroup",
+ "type": "mutation",
+ "description": "Edit a Group that is not a System Group",
+ "response_type": "a Group!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iGroupSetup",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation editGroup( $id: ID!, $setup: iGroupSetup ) { editGroup( id: $id, setup: $setup ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } isSystem metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } children { ...PagingResponseFragment } organization { ...OrganizationFragment } customers { ...CustomerPagingResponseFragment } } }",
+ "example_variables": "{ \"id\": \"4\", \"setup\": iGroupSetup }",
+ "example_response": "{ \"data\": { \"editGroup\": { \"id\": 4, \"name\": \"abc123\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"isSystem\": true, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"children\": PagingResponse, \"organization\": Organization, \"customers\": CustomerPagingResponse } } }"
+ },
+ {
+ "name": "editHost",
+ "type": "mutation",
+ "description": "Edit a Host deprecated",
+ "response_type": "a Host!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation editHost( $id: ID!, $name: String! ) { editHost( id: $id, name: $name ) { id url } }",
+ "example_variables": "{\"id\": 4, \"name\": \"abc123\"}",
+ "example_response": "{ \"data\": { \"editHost\": { \"id\": \"4\", \"url\": \"xyz789\" } } }"
+ },
+ {
+ "name": "editInk",
+ "type": "mutation",
+ "description": "This is to edit the opacity of the inks of a Asset/Revision or Media",
+ "response_type": "a Media!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "id of an Asset or a Media",
+ "required": true
+ },
+ {
+ "name": "revision",
+ "type": "Int",
+ "description": "revision if it is an Asset. Default = 0",
+ "required": false
+ },
+ {
+ "name": "setup",
+ "type": "[iInkOpacity!]!",
+ "description": "Ink opacities",
+ "required": true
+ }
+ ],
+ "example_query": "mutation editInk( $id: ID!, $revision: Int, $setup: [iInkOpacity!]! ) { editInk( id: $id, revision: $revision, setup: $setup ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } pageCount mimeType resolution size boxes { ...BoxFragment } inks { ...InkFragment } layerConfigs files { ...FileFragment } hasNotes notes { ...NoteFragment } revision isMajorRevision isCurrentRevision asset { ...AssetFragment } } }",
+ "example_variables": "{ \"id\": \"4\", \"revision\": 0, \"setup\": [iInkOpacity] }",
+ "example_response": "{ \"data\": { \"editInk\": { \"id\": \"4\", \"name\": \"abc123\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"pageCount\": 987, \"mimeType\": \"abc123\", \"resolution\": 123.45, \"size\": {}, \"boxes\": [Box], \"inks\": [Ink], \"layerConfigs\": {}, \"files\": [File], \"hasNotes\": true, \"notes\": [Note], \"revision\": 123, \"isMajorRevision\": false, \"isCurrentRevision\": true, \"asset\": Asset } } }"
+ },
+ {
+ "name": "editInputChannel",
+ "type": "mutation",
+ "description": "Edit an Input channelid Id of the Input channel to editpipes If pipes is given, the current pipes will be replaced by the given listExisting pipes that are not given in the new list will be deletedIf the given list is empty delete every existing pipes linked to the given input channelFor existing pipes that should not be updated but are still in the list, simply give their id and these will be kept but not editedruleSets If ruleSets is given, the current rule sets will be replaced by the given list Existing rule sets that are not given in the new list will be unlinked from the given input channelIf the given list is empty, unlink every rule sets from the given input channelFor linked rule sets that should not be updated but are still in the list, simply give their id and these will be kept but not edited The order in which the rule sets are given is taken into account to define the order in which these will be applied. Sending the same list with a different order will update the rule sets order",
+ "response_type": "an InputChannel!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "description",
+ "type": "String",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "ruleSets",
+ "type": "[iChannelInputRuleSet!]",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "pipes",
+ "type": "[iInputPipe!]",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation editInputChannel( $id: ID!, $description: String, $ruleSets: [iChannelInputRuleSet!], $pipes: [iInputPipe!] ) { editInputChannel( id: $id, description: $description, ruleSets: $ruleSets, pipes: $pipes ) { id name description ruleSets { ...InputRuleSetFragment } pipes { ...InputPipeFragment } } }",
+ "example_variables": "{ \"id\": \"4\", \"description\": \"xyz789\", \"ruleSets\": [iChannelInputRuleSet], \"pipes\": [iInputPipe] }",
+ "example_response": "{ \"data\": { \"editInputChannel\": { \"id\": \"4\", \"name\": \"abc123\", \"description\": \"abc123\", \"ruleSets\": [InputRuleSet], \"pipes\": [InputPipe] } } }"
+ },
+ {
+ "name": "editInputRuleSet",
+ "type": "mutation",
+ "description": "",
+ "response_type": "an InputRuleSet!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iInputRuleSet",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation editInputRuleSet( $id: ID!, $setup: iInputRuleSet ) { editInputRuleSet( id: $id, setup: $setup ) { id name description rules { ...InputRuleFragment } } }",
+ "example_variables": "{ \"id\": \"4\", \"setup\": iInputRuleSet }",
+ "example_response": "{ \"data\": { \"editInputRuleSet\": { \"id\": \"4\", \"name\": \"xyz789\", \"description\": \"xyz789\", \"rules\": [InputRule] } } }"
+ },
+ {
+ "name": "editLayout",
+ "type": "mutation",
+ "description": "Edit a layout",
+ "response_type": "a Layout!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iLayoutSetup!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation editLayout( $id: ID!, $setup: iLayoutSetup! ) { editLayout( id: $id, setup: $setup ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } type applyTo priority layout translations icon } }",
+ "example_variables": "{\"id\": 4, \"setup\": iLayoutSetup}",
+ "example_response": "{ \"data\": { \"editLayout\": { \"id\": \"4\", \"name\": \"abc123\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"type\": \"ENTITY\", \"applyTo\": [\"Folder\"], \"priority\": 987, \"layout\": {}, \"translations\": {}, \"icon\": 4 } } }"
+ },
+ {
+ "name": "editMetadataDefinition",
+ "type": "mutation",
+ "description": "To edit a metadata definition",
+ "response_type": "a MetadataDefinition",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iMetadataDefinition!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation editMetadataDefinition( $id: ID!, $setup: iMetadataDefinition! ) { editMetadataDefinition( id: $id, setup: $setup ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } nameSpace { ...MetadataNameSpaceFragment } type cardinality struct { ...MetadataDefinitionFragment } lName translations searchable availableInLayout saveInXmp required unique editable dictionary { ...DictionaryFragment } minRange maxRange minChar maxChar regex defaultValue } }",
+ "example_variables": "{\"id\": 4, \"setup\": iMetadataDefinition}",
+ "example_response": "{ \"data\": { \"editMetadataDefinition\": { \"id\": \"4\", \"name\": \"abc123\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"nameSpace\": MetadataNameSpace, \"type\": \"BOOLEAN\", \"cardinality\": \"SINGLE\", \"struct\": [MetadataDefinition], \"lName\": \"abc123\", \"translations\": {}, \"searchable\": false, \"availableInLayout\": true, \"saveInXmp\": false, \"required\": true, \"unique\": false, \"editable\": false, \"dictionary\": Dictionary, \"minRange\": Number, \"maxRange\": Number, \"minChar\": Number, \"maxChar\": Number, \"regex\": \"xyz789\", \"defaultValue\": {} } } }"
+ },
+ {
+ "name": "editMetadataNameSpace",
+ "type": "mutation",
+ "description": "To edit a metadata nameSpace",
+ "response_type": "a MetadataNameSpace",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "Id of the namespace to edit",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iMetadataNameSpaceEdition",
+ "description": "Definition of parameters",
+ "required": false
+ },
+ {
+ "name": "metadatas",
+ "type": "[iEditMetadata!]",
+ "description": "List of metadata definition that will be edited in the same Transaction",
+ "required": true
+ }
+ ],
+ "example_query": "mutation editMetadataNameSpace( $id: ID!, $setup: iMetadataNameSpaceEdition, $metadatas: [iEditMetadata!] ) { editMetadataNameSpace( id: $id, setup: $setup, metadatas: $metadatas ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } uri prefix metadataDefs { ...MetadataDefinitionFragment } lName translations searchable availableInLayout saveInXmp } }",
+ "example_variables": "{ \"id\": \"4\", \"setup\": iMetadataNameSpaceEdition, \"metadatas\": [iEditMetadata] }",
+ "example_response": "{ \"data\": { \"editMetadataNameSpace\": { \"id\": 4, \"name\": \"xyz789\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"uri\": \"http://www.test.com/\", \"prefix\": \"abc123\", \"metadataDefs\": [MetadataDefinition], \"lName\": \"xyz789\", \"translations\": {}, \"searchable\": false, \"availableInLayout\": false, \"saveInXmp\": false } } }"
+ },
+ {
+ "name": "editMySharing",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a Sharing!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iEditSharingSetup!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation editMySharing( $id: ID!, $setup: iEditSharingSetup! ) { editMySharing( id: $id, setup: $setup ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } key hasPinCode type startDate endDate isActive owner { ...UserFragment } entities { ...PagingResponseFragment } securityProfile { ...SecurityProfileFragment } } }",
+ "example_variables": "{ \"id\": \"4\", \"setup\": iEditSharingSetup }",
+ "example_response": "{ \"data\": { \"editMySharing\": { \"id\": 4, \"name\": \"abc123\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"key\": \"xyz789\", \"hasPinCode\": true, \"type\": \"xyz789\", \"startDate\": \"2007-12-03T10:15:30Z\", \"endDate\": \"2007-12-03T10:15:30Z\", \"isActive\": false, \"owner\": User, \"entities\": PagingResponse, \"securityProfile\": SecurityProfile } } }"
+ },
+ {
+ "name": "editMyUser",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a User!",
+ "arguments": [
+ {
+ "name": "setup",
+ "type": "iEditUserSetup",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation editMyUser($setup: iEditUserSetup) { editMyUser(setup: $setup) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } login userCanLog lang dateFormat unitResolution unitLength color image use2FA channel2FA sessionTimeout workCapacity workCapacityUnit firstName lastName email title company phone phone2 homePhone fax mobilePhone department address { ...AddressFragment } organization { ...OrganizationFragment } groups { ...GroupFragment } roles { ...RoleFragment } defaultProfile { ...UserSecurityProfileFragment } availableProfiles { ...UserSecurityProfileFragment } notifications { ...NotificationFragment } } }",
+ "example_variables": "{\"setup\": iEditUserSetup}",
+ "example_response": "{ \"data\": { \"editMyUser\": { \"id\": 4, \"name\": \"xyz789\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"login\": \"abc123\", \"userCanLog\": true, \"lang\": \"ar\", \"dateFormat\": \"abc123\", \"unitResolution\": \"xyz789\", \"unitLength\": \"abc123\", \"color\": \"abc123\", \"image\": \"abc123\", \"use2FA\": true, \"channel2FA\": \"AUTHENTICATOR\", \"sessionTimeout\": 123, \"workCapacity\": \"abc123\", \"workCapacityUnit\": \"abc123\", \"firstName\": \"abc123\", \"lastName\": \"abc123\", \"email\": \"abc123\", \"title\": \"abc123\", \"company\": \"abc123\", \"phone\": \"abc123\", \"phone2\": \"abc123\", \"homePhone\": \"abc123\", \"fax\": \"xyz789\", \"mobilePhone\": \"xyz789\", \"department\": \"abc123\", \"address\": Address, \"organization\": Organization, \"groups\": [Group], \"roles\": [Role], \"defaultProfile\": UserSecurityProfile, \"availableProfiles\": [UserSecurityProfile], \"notifications\": [Notification] } } }"
+ },
+ {
+ "name": "editMyWebAuthnRegistration",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a WebAuthnRegistration",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "description",
+ "type": "String!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation editMyWebAuthnRegistration( $id: ID!, $description: String! ) { editMyWebAuthnRegistration( id: $id, description: $description ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } credentialId signatureCounter user { ...UserFragment } } }",
+ "example_variables": "{ \"id\": \"4\", \"description\": \"abc123\" }",
+ "example_response": "{ \"data\": { \"editMyWebAuthnRegistration\": { \"id\": 4, \"name\": \"abc123\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"credentialId\": \"4\", \"signatureCounter\": {}, \"user\": User } } }"
+ },
+ {
+ "name": "editNamedSearchFilter",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a NamedSearchFilter!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "name",
+ "type": "String",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "filter",
+ "type": "iSearchFilter",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation editNamedSearchFilter( $id: ID!, $name: String, $filter: iSearchFilter ) { editNamedSearchFilter( id: $id, name: $name, filter: $filter ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } filter { ...SearchFilterFragment } } }",
+ "example_variables": "{ \"id\": \"4\", \"name\": \"xyz789\", \"filter\": iSearchFilter }",
+ "example_response": "{ \"data\": { \"editNamedSearchFilter\": { \"id\": 4, \"name\": \"xyz789\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"filter\": SearchFilter } } }"
+ },
+ {
+ "name": "editNote",
+ "type": "mutation",
+ "description": "Returns a Note!",
+ "response_type": "a Note!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iNoteSetup!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation editNote( $id: ID!, $setup: iNoteSetup! ) { editNote( id: $id, setup: $setup ) { id type objectOwnerId pageNumber lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } attachments { ...AttachmentFragment } checkable status { ...AnnotationStatusFragment } collapsed seenBy { ...UserFragment } replies { ...NoteReplyFragment } content originalContent stylizedContent positionX positionY positionZ anchorX anchorY anchorZ tx ty proofReadingMark { ...ProofReadingMarkFragment } path selectable startTime endTime } }",
+ "example_variables": "{\"id\": 4, \"setup\": iNoteSetup}",
+ "example_response": "{ \"data\": { \"editNote\": { \"id\": 4, \"type\": \"Note\", \"objectOwnerId\": 4, \"pageNumber\": {}, \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"attachments\": [Attachment], \"checkable\": true, \"status\": AnnotationStatus, \"collapsed\": true, \"seenBy\": [User], \"replies\": [NoteReply], \"content\": \"abc123\", \"originalContent\": \"abc123\", \"stylizedContent\": \"abc123\", \"positionX\": 987.65, \"positionY\": 123.45, \"positionZ\": 987.65, \"anchorX\": 987.65, \"anchorY\": 123.45, \"anchorZ\": 987.65, \"tx\": 987.65, \"ty\": 123.45, \"proofReadingMark\": ProofReadingMark, \"path\": \"abc123\", \"selectable\": true, \"startTime\": 123.45, \"endTime\": 987.65 } } }"
+ },
+ {
+ "name": "editNotificationTemplate",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a NotificationTemplate!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "name",
+ "type": "String",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "event",
+ "type": "iEmailTemplateNotificationEvent",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "setup",
+ "type": "iNotificationEmailTemplate",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation editNotificationTemplate( $id: ID!, $name: String, $event: iEmailTemplateNotificationEvent, $setup: iNotificationEmailTemplate ) { editNotificationTemplate( id: $id, name: $name, event: $event, setup: $setup ) { id name event { ... on ApprovalNotificationTemplateEvent { ...ApprovalNotificationTemplateEventFragment } ... on MilestoneNotificationTemplateEvent { ...MilestoneNotificationTemplateEventFragment } ... on BaseNotificationTemplateEvent { ...BaseNotificationTemplateEventFragment } } emailTemplate { ...EmailTemplateFragment } parentEntity { ...WithEmailTemplateFragment } lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } } }",
+ "example_variables": "{ \"id\": \"4\", \"name\": \"abc123\", \"event\": iEmailTemplateNotificationEvent, \"setup\": iNotificationEmailTemplate }",
+ "example_response": "{ \"data\": { \"editNotificationTemplate\": { \"id\": 4, \"name\": \"abc123\", \"event\": ApprovalNotificationTemplateEvent, \"emailTemplate\": EmailTemplate, \"parentEntity\": WithEmailTemplate, \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User } } }"
+ },
+ {
+ "name": "editNotifications",
+ "type": "mutation",
+ "description": "",
+ "response_type": "[Notification!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "iNotifiableID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "[iNotification!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation editNotifications( $id: iNotifiableID!, $setup: [iNotification!]! ) { editNotifications( id: $id, setup: $setup ) { id event } }",
+ "example_variables": "{ \"id\": iNotifiableID, \"setup\": [iNotification] }",
+ "example_response": "{\"data\": {\"editNotifications\": [{\"id\": 4, \"event\": \"PROJECT_CREATION\"}]}}"
+ },
+ {
+ "name": "editOrganization",
+ "type": "mutation",
+ "description": "Edit an Organization",
+ "response_type": "an Organization!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iOrganizationSetup",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation editOrganization( $id: ID!, $setup: iOrganizationSetup ) { editOrganization( id: $id, setup: $setup ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } children { ...PagingResponseFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } phone phone2 www fax shippingAddress { ...AddressFragment } billingAddress { ...AddressFragment } organization { ...OrganizationFragment } customers { ...CustomerFragment } emailTemplates { ...EmailTemplateFragment } notificationTemplates { ...NotificationTemplateFragment } ldapConfiguration { ...LDAPConfigurationFragment } applySecurityConfigToSubOrganization securityConfiguration { ...SecurityConfigurationFragment } notifications { ...NotificationFragment } } }",
+ "example_variables": "{ \"id\": \"4\", \"setup\": iOrganizationSetup }",
+ "example_response": "{ \"data\": { \"editOrganization\": { \"id\": 4, \"name\": \"xyz789\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"children\": PagingResponse, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"phone\": \"xyz789\", \"phone2\": \"abc123\", \"www\": \"xyz789\", \"fax\": \"abc123\", \"shippingAddress\": Address, \"billingAddress\": Address, \"organization\": Organization, \"customers\": [Customer], \"emailTemplates\": [EmailTemplate], \"notificationTemplates\": [NotificationTemplate], \"ldapConfiguration\": LDAPConfiguration, \"applySecurityConfigToSubOrganization\": true, \"securityConfiguration\": SecurityConfiguration, \"notifications\": [Notification] } } }"
+ },
+ {
+ "name": "editOutputChannelGroup",
+ "type": "mutation",
+ "description": "Edit output channel groups",
+ "response_type": "[OutputChannelGroup!]!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iOutputChannelGroupSetup",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation editOutputChannelGroup( $id: [ID!]!, $setup: iOutputChannelGroupSetup ) { editOutputChannelGroup( id: $id, setup: $setup ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } outputChannels { ...OutputChannelFragment } } }",
+ "example_variables": "{\"id\": [4], \"setup\": iOutputChannelGroupSetup}",
+ "example_response": "{ \"data\": { \"editOutputChannelGroup\": [ { \"id\": 4, \"name\": \"abc123\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"outputChannels\": [OutputChannel] } ] } }"
+ },
+ {
+ "name": "editPrivateProofReadingmark",
+ "type": "mutation",
+ "description": "Returns a Boolean!",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iProofReadingMarkSetup!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation editPrivateProofReadingmark( $id: ID!, $setup: iProofReadingMarkSetup! ) { editPrivateProofReadingmark( id: $id, setup: $setup ) }",
+ "example_variables": "{\"id\": 4, \"setup\": iProofReadingMarkSetup}",
+ "example_response": "{\"data\": {\"editPrivateProofReadingmark\": true}}"
+ },
+ {
+ "name": "editProject",
+ "type": "mutation",
+ "description": "To edit a Project",
+ "response_type": "[Project!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iProjectSetup",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "completed",
+ "type": "Boolean",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation editProject( $id: [ID!]!, $setup: iProjectSetup, $completed: Boolean ) { editProject( id: $id, setup: $setup, completed: $completed ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } trashDate trashUser { ...UserFragment } endDate metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } status workflowName approvalStatus { ...ApprovalActivityStatusFragment } approvalSummary approvals { ...ApprovalCycleFragment } assetApprovals { ...ApprovalCycleFragment } children { ...PagingResponseFragment } assetWorkflow { ...WorkflowFragment } processes { ...ProcessFragment } projectTemplate { ...ProjectTemplateFragment } priority colorSpace { ...ColorSpaceFragment } viewingCondition { ...ViewingConditionFragment } reversedView customer { ...CustomerFragment } parents { ...ContainerFragment } mainAsset { ...AssetFragment } siteId productionParticipants { ...ProductionParticipantFragment } notes { ...NoteFragment } trimmedHeight trimmedWidth nbPages accessControls deadlines { ...ProjectDeadlineFragment } } }",
+ "example_variables": "{\"id\": [4], \"setup\": iProjectSetup, \"completed\": false}",
+ "example_response": "{ \"data\": { \"editProject\": [ { \"id\": 4, \"name\": \"xyz789\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"trashDate\": \"2007-12-03T10:15:30Z\", \"trashUser\": User, \"endDate\": \"2007-12-03T10:15:30Z\", \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"status\": [\"ACTIVE\"], \"workflowName\": \"abc123\", \"approvalStatus\": [ApprovalActivityStatus], \"approvalSummary\": \"NONE\", \"approvals\": [ApprovalCycle], \"assetApprovals\": [ApprovalCycle], \"children\": PagingResponse, \"assetWorkflow\": Workflow, \"processes\": [Process], \"projectTemplate\": ProjectTemplate, \"priority\": 123, \"colorSpace\": ColorSpace, \"viewingCondition\": ViewingCondition, \"reversedView\": true, \"customer\": Customer, \"parents\": [Container], \"mainAsset\": Asset, \"siteId\": 4, \"productionParticipants\": [ProductionParticipant], \"notes\": [Note], \"trimmedHeight\": 123.45, \"trimmedWidth\": 987.65, \"nbPages\": 987, \"accessControls\": {}, \"deadlines\": [ProjectDeadline] } ] } }"
+ },
+ {
+ "name": "editProjectFolder",
+ "type": "mutation",
+ "description": "To edit a ProjectFolder",
+ "response_type": "[ProjectFolder!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iFolderSetup",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation editProjectFolder( $id: [ID!]!, $setup: iFolderSetup ) { editProjectFolder( id: $id, setup: $setup ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } trashDate trashUser { ...UserFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } readOnly productionSettings { ...ProductionSettingsFragment } processes { ...ProcessFragment } accessControlList { ...AccessControlListFragment } children { ...PagingResponseFragment } project { ...ProjectFragment } parents { ...ContainerFragment } path { ...ProjectFolderFragment } color icon } }",
+ "example_variables": "{ \"id\": [\"4\"], \"setup\": iFolderSetup }",
+ "example_response": "{ \"data\": { \"editProjectFolder\": [ { \"id\": 4, \"name\": \"abc123\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"trashDate\": \"2007-12-03T10:15:30Z\", \"trashUser\": User, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"readOnly\": true, \"productionSettings\": ProductionSettings, \"processes\": [Process], \"accessControlList\": AccessControlList, \"children\": PagingResponse, \"project\": Project, \"parents\": [Container], \"path\": [ProjectFolder], \"color\": \"xyz789\", \"icon\": 4 } ] } }"
+ },
+ {
+ "name": "editProjectTemplate",
+ "type": "mutation",
+ "description": "To edit a ProjectTemplate",
+ "response_type": "[ProjectTemplate!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iProjectTemplateSetup",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation editProjectTemplate( $id: [ID!]!, $setup: iProjectTemplateSetup ) { editProjectTemplate( id: $id, setup: $setup ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } friendlyName priority colorSpace { ...ColorSpaceFragment } viewingCondition { ...ViewingConditionFragment } assetWorkflow { ...WorkflowFragment } projectWorkflow { ...WorkflowFragment } productionParticipants { ...ProductionParticipantFragment } assetApprovals { ...ApprovalCycleFragment } projectApprovals { ...ApprovalCycleFragment } deadlines { ...ProjectDeadlineFragment } skipWeekend } }",
+ "example_variables": "{\"id\": [4], \"setup\": iProjectTemplateSetup}",
+ "example_response": "{ \"data\": { \"editProjectTemplate\": [ { \"id\": \"4\", \"name\": \"xyz789\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"friendlyName\": \"abc123\", \"priority\": 987, \"colorSpace\": ColorSpace, \"viewingCondition\": ViewingCondition, \"assetWorkflow\": Workflow, \"projectWorkflow\": Workflow, \"productionParticipants\": [ProductionParticipant], \"assetApprovals\": [ApprovalCycle], \"projectApprovals\": [ApprovalCycle], \"deadlines\": [ProjectDeadline], \"skipWeekend\": false } ] } }"
+ },
+ {
+ "name": "editRelation",
+ "type": "mutation",
+ "description": "To edit Relation",
+ "response_type": "[Relation!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iRelationSetup!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation editRelation( $id: [ID!]!, $setup: iRelationSetup! ) { editRelation( id: $id, setup: $setup ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } from { ...WithRelationFragment } to { ...WithRelationFragment } } }",
+ "example_variables": "{ \"id\": [\"4\"], \"setup\": iRelationSetup }",
+ "example_response": "{ \"data\": { \"editRelation\": [ { \"id\": 4, \"name\": \"abc123\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"from\": WithRelation, \"to\": WithRelation } ] } }"
+ },
+ {
+ "name": "editReplyOfNote",
+ "type": "mutation",
+ "description": "Returns a Note!",
+ "response_type": "a Note!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "rank",
+ "type": "Long!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "comment",
+ "type": "String",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "stylizedComment",
+ "type": "String",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation editReplyOfNote( $id: ID!, $rank: Long!, $comment: String, $stylizedComment: String ) { editReplyOfNote( id: $id, rank: $rank, comment: $comment, stylizedComment: $stylizedComment ) { id type objectOwnerId pageNumber lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } attachments { ...AttachmentFragment } checkable status { ...AnnotationStatusFragment } collapsed seenBy { ...UserFragment } replies { ...NoteReplyFragment } content originalContent stylizedContent positionX positionY positionZ anchorX anchorY anchorZ tx ty proofReadingMark { ...ProofReadingMarkFragment } path selectable startTime endTime } }",
+ "example_variables": "{ \"id\": \"4\", \"rank\": {}, \"comment\": \"xyz789\", \"stylizedComment\": \"abc123\" }",
+ "example_response": "{ \"data\": { \"editReplyOfNote\": { \"id\": 4, \"type\": \"Note\", \"objectOwnerId\": 4, \"pageNumber\": {}, \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"attachments\": [Attachment], \"checkable\": false, \"status\": AnnotationStatus, \"collapsed\": false, \"seenBy\": [User], \"replies\": [NoteReply], \"content\": \"xyz789\", \"originalContent\": \"xyz789\", \"stylizedContent\": \"abc123\", \"positionX\": 987.65, \"positionY\": 123.45, \"positionZ\": 123.45, \"anchorX\": 987.65, \"anchorY\": 123.45, \"anchorZ\": 123.45, \"tx\": 987.65, \"ty\": 987.65, \"proofReadingMark\": ProofReadingMark, \"path\": \"xyz789\", \"selectable\": true, \"startTime\": 987.65, \"endTime\": 123.45 } } }"
+ },
+ {
+ "name": "editRevision",
+ "type": "mutation",
+ "description": "Edit revision in an asset",
+ "response_type": "an Asset!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iRevisionSetup",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation editRevision( $id: ID!, $setup: iRevisionSetup ) { editRevision( id: $id, setup: $setup ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } trashDate trashUser { ...UserFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } status approvalSummary approvalStatus { ...ApprovalActivityStatusFragment } approvals { ...ApprovalCycleFragment } workflowName isAlias processes { ...ProcessFragment } uuid priority isCheckedOut checkedOutBy { ...UserFragment } privateWorkingRevision isArchived archiveId colorSpace { ...ColorSpaceFragment } viewingCondition { ...ViewingConditionFragment } project { ...ProjectFragment } parents { ...ContainerFragment } numberOfRevisions expirationDate medias { ...MediaFragment } notes { ...NoteFragment } relationFrom { ...RelationFragment } relationTo { ...RelationFragment } accessControls } }",
+ "example_variables": "{ \"id\": \"4\", \"setup\": iRevisionSetup }",
+ "example_response": "{ \"data\": { \"editRevision\": { \"id\": \"4\", \"name\": \"abc123\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"trashDate\": \"2007-12-03T10:15:30Z\", \"trashUser\": User, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"status\": [\"ACTIVE\"], \"approvalSummary\": \"NONE\", \"approvalStatus\": [ApprovalActivityStatus], \"approvals\": [ApprovalCycle], \"workflowName\": \"abc123\", \"isAlias\": false, \"processes\": [Process], \"uuid\": \"xyz789\", \"priority\": 123, \"isCheckedOut\": true, \"checkedOutBy\": User, \"privateWorkingRevision\": 123, \"isArchived\": true, \"archiveId\": \"4\", \"colorSpace\": ColorSpace, \"viewingCondition\": ViewingCondition, \"project\": Project, \"parents\": [Container], \"numberOfRevisions\": 123, \"expirationDate\": \"2007-12-03T10:15:30Z\", \"medias\": [Media], \"notes\": [Note], \"relationFrom\": [Relation], \"relationTo\": [Relation], \"accessControls\": {} } } }"
+ },
+ {
+ "name": "editRole",
+ "type": "mutation",
+ "description": "Edit a Role",
+ "response_type": "a Role!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iRoleSetup",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation editRole( $id: ID!, $setup: iRoleSetup ) { editRole( id: $id, setup: $setup ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } notifications { ...NotificationFragment } } }",
+ "example_variables": "{\"id\": 4, \"setup\": iRoleSetup}",
+ "example_response": "{ \"data\": { \"editRole\": { \"id\": \"4\", \"name\": \"abc123\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"notifications\": [Notification] } } }"
+ },
+ {
+ "name": "editSchemaExtension",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a SchemaExtension!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iSchemaExtension!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation editSchemaExtension( $id: ID!, $setup: iSchemaExtension! ) { editSchemaExtension( id: $id, setup: $setup ) { id type executionType name newOperation operations script securityRole usableInSharing } }",
+ "example_variables": "{\"id\": 4, \"setup\": iSchemaExtension}",
+ "example_response": "{ \"data\": { \"editSchemaExtension\": { \"id\": \"4\", \"type\": \"QUERY\", \"executionType\": \"GRAPHQL\", \"name\": \"abc123\", \"newOperation\": \"xyz789\", \"operations\": [\"abc123\"], \"script\": \"xyz789\", \"securityRole\": \"ADMIN\", \"usableInSharing\": true } } }"
+ },
+ {
+ "name": "editSecurityProfile",
+ "type": "mutation",
+ "description": "to edit a profile",
+ "response_type": "a SecurityProfile",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iUserSecurityProfile",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation editSecurityProfile( $id: ID!, $setup: iUserSecurityProfile ) { editSecurityProfile( id: $id, setup: $setup ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } properties { ...SecurityPropertyFragment } } }",
+ "example_variables": "{\"id\": 4, \"setup\": iUserSecurityProfile}",
+ "example_response": "{ \"data\": { \"editSecurityProfile\": { \"id\": 4, \"name\": \"xyz789\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"properties\": [SecurityProperty] } } }"
+ },
+ {
+ "name": "editSharing",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a Sharing!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iEditSharingSetup!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation editSharing( $id: ID!, $setup: iEditSharingSetup! ) { editSharing( id: $id, setup: $setup ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } key hasPinCode type startDate endDate isActive owner { ...UserFragment } entities { ...PagingResponseFragment } securityProfile { ...SecurityProfileFragment } } }",
+ "example_variables": "{ \"id\": \"4\", \"setup\": iEditSharingSetup }",
+ "example_response": "{ \"data\": { \"editSharing\": { \"id\": \"4\", \"name\": \"abc123\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"key\": \"xyz789\", \"hasPinCode\": false, \"type\": \"abc123\", \"startDate\": \"2007-12-03T10:15:30Z\", \"endDate\": \"2007-12-03T10:15:30Z\", \"isActive\": true, \"owner\": User, \"entities\": PagingResponse, \"securityProfile\": SecurityProfile } } }"
+ },
+ {
+ "name": "editSmartCollection",
+ "type": "mutation",
+ "description": "To edit a SmartCollection",
+ "response_type": "[SmartCollection!]",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iSmartCollectionSetup!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation editSmartCollection( $id: [ID!]!, $setup: iSmartCollectionSetup! ) { editSmartCollection( id: $id, setup: $setup ) { id name description color lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } trashDate trashUser { ...UserFragment } icon lName translations children { ...PagingResponseFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } readOnly accessControlList { ...AccessControlListFragment } searchProperties { ...SmartCollectionSearchPropertiesFragment } } }",
+ "example_variables": "{\"id\": [4], \"setup\": iSmartCollectionSetup}",
+ "example_response": "{ \"data\": { \"editSmartCollection\": [ { \"id\": 4, \"name\": \"abc123\", \"description\": \"abc123\", \"color\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"trashDate\": \"2007-12-03T10:15:30Z\", \"trashUser\": User, \"icon\": 4, \"lName\": \"abc123\", \"translations\": {}, \"children\": PagingResponse, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"readOnly\": false, \"accessControlList\": AccessControlList, \"searchProperties\": SmartCollectionSearchProperties } ] } }"
+ },
+ {
+ "name": "editSynSet",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a SynSet",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iSynSetEditParams",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation editSynSet( $id: ID!, $setup: iSynSetEditParams ) { editSynSet( id: $id, setup: $setup ) { id uri label creationDate glosses sentences words { ...WordFragment } hyponyms { ...SynSetFragment } hypernyms { ...SynSetFragment } } }",
+ "example_variables": "{ \"id\": \"4\", \"setup\": iSynSetEditParams }",
+ "example_response": "{ \"data\": { \"editSynSet\": { \"id\": \"4\", \"uri\": \"http://www.test.com/\", \"label\": \"xyz789\", \"creationDate\": \"2007-12-03T10:15:30Z\", \"glosses\": {}, \"sentences\": [{}], \"words\": [Word], \"hyponyms\": [SynSet], \"hypernyms\": [SynSet] } } }"
+ },
+ {
+ "name": "editUIFile",
+ "type": "mutation",
+ "description": "",
+ "response_type": "an UIProjectFile!",
+ "arguments": [
+ {
+ "name": "from",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "path",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iUIFileSetup",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "content",
+ "type": "String",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation editUIFile( $from: String!, $path: String!, $setup: iUIFileSetup, $content: String ) { editUIFile( from: $from, path: $path, setup: $setup, content: $content ) { isFolder name path id description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } uiProject { ...UIProjectFragment } labels mimeType metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } translations } }",
+ "example_variables": "{ \"from\": \"xyz789\", \"path\": \"abc123\", \"setup\": iUIFileSetup, \"content\": \"xyz789\" }",
+ "example_response": "{ \"data\": { \"editUIFile\": { \"isFolder\": true, \"name\": \"xyz789\", \"path\": \"xyz789\", \"id\": \"4\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"uiProject\": UIProject, \"labels\": [\"abc123\"], \"mimeType\": \"xyz789\", \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"translations\": {} } } }"
+ },
+ {
+ "name": "editUIProject",
+ "type": "mutation",
+ "description": "",
+ "response_type": "an UIProject",
+ "arguments": [
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iUIProjectEditSetup",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation editUIProject( $name: String!, $setup: iUIProjectEditSetup ) { editUIProject( name: $name, setup: $setup ) { name id description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } type icon labels translations } }",
+ "example_variables": "{ \"name\": \"xyz789\", \"setup\": iUIProjectEditSetup }",
+ "example_response": "{ \"data\": { \"editUIProject\": { \"name\": \"abc123\", \"id\": 4, \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"type\": \"abc123\", \"icon\": \"abc123\", \"labels\": [\"abc123\"], \"translations\": {} } } }"
+ },
+ {
+ "name": "editUser",
+ "type": "mutation",
+ "description": "Edit an User",
+ "response_type": "a User!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iEditUserSetup",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation editUser( $id: ID!, $setup: iEditUserSetup ) { editUser( id: $id, setup: $setup ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } login userCanLog lang dateFormat unitResolution unitLength color image use2FA channel2FA sessionTimeout workCapacity workCapacityUnit firstName lastName email title company phone phone2 homePhone fax mobilePhone department address { ...AddressFragment } organization { ...OrganizationFragment } groups { ...GroupFragment } roles { ...RoleFragment } defaultProfile { ...UserSecurityProfileFragment } availableProfiles { ...UserSecurityProfileFragment } notifications { ...NotificationFragment } } }",
+ "example_variables": "{\"id\": 4, \"setup\": iEditUserSetup}",
+ "example_response": "{ \"data\": { \"editUser\": { \"id\": 4, \"name\": \"abc123\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"login\": \"xyz789\", \"userCanLog\": true, \"lang\": \"ar\", \"dateFormat\": \"abc123\", \"unitResolution\": \"abc123\", \"unitLength\": \"xyz789\", \"color\": \"xyz789\", \"image\": \"xyz789\", \"use2FA\": false, \"channel2FA\": \"AUTHENTICATOR\", \"sessionTimeout\": 123, \"workCapacity\": \"abc123\", \"workCapacityUnit\": \"xyz789\", \"firstName\": \"abc123\", \"lastName\": \"abc123\", \"email\": \"abc123\", \"title\": \"xyz789\", \"company\": \"abc123\", \"phone\": \"xyz789\", \"phone2\": \"abc123\", \"homePhone\": \"abc123\", \"fax\": \"abc123\", \"mobilePhone\": \"abc123\", \"department\": \"abc123\", \"address\": Address, \"organization\": Organization, \"groups\": [Group], \"roles\": [Role], \"defaultProfile\": UserSecurityProfile, \"availableProfiles\": [UserSecurityProfile], \"notifications\": [Notification] } } }"
+ },
+ {
+ "name": "editUserAction",
+ "type": "mutation",
+ "description": "** Edit one or more user actions**",
+ "response_type": "[UserAction!]!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iUserAction!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation editUserAction( $id: [ID!]!, $setup: iUserAction! ) { editUserAction( id: $id, setup: $setup ) { id description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } applyTo context enableGrouping assetMimeTypes script icon translations productionParticipants { ...ProductionParticipantFragment } workflow { ...WorkflowFragment } destination destinationCollection } }",
+ "example_variables": "{ \"id\": [\"4\"], \"setup\": iUserAction }",
+ "example_response": "{ \"data\": { \"editUserAction\": [ { \"id\": \"4\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"applyTo\": \"Folder\", \"context\": \"ORIGINAL_FILE\", \"enableGrouping\": true, \"assetMimeTypes\": [\"abc123\"], \"script\": \"abc123\", \"icon\": \"xyz789\", \"translations\": {}, \"productionParticipants\": [ProductionParticipant], \"workflow\": Workflow, \"destination\": \"WORKFLOW_DRIVEN\", \"destinationCollection\": \"abc123\" } ] } }"
+ },
+ {
+ "name": "editUserPreference",
+ "type": "mutation",
+ "description": "Edit user preferences",
+ "response_type": "[UserPreference!]!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "setup",
+ "type": "iUserPreferenceSetup",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation editUserPreference( $id: ID, $setup: iUserPreferenceSetup ) { editUserPreference( id: $id, setup: $setup ) { id name value } }",
+ "example_variables": "{\"id\": 4, \"setup\": iUserPreferenceSetup}",
+ "example_response": "{ \"data\": { \"editUserPreference\": [ { \"id\": 4, \"name\": \"xyz789\", \"value\": 4 } ] } }"
+ },
+ {
+ "name": "editViewingCondition",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a ViewingCondition!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iViewingCondition!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation editViewingCondition( $id: ID!, $setup: iViewingCondition! ) { editViewingCondition( id: $id, setup: $setup ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } parents { ...ContainerFragment } renderingIntent gamutCheck profile rgb { ...WorkingSpaceSimulationFragment } cmyk { ...WorkingSpaceSimulationFragment } gray { ...WorkingSpaceSimulationFragment } useCloseLoop closeLoop { ...CloseLoopParamsFragment } } }",
+ "example_variables": "{ \"id\": \"4\", \"setup\": iViewingCondition }",
+ "example_response": "{ \"data\": { \"editViewingCondition\": { \"id\": \"4\", \"name\": \"abc123\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"parents\": [Container], \"renderingIntent\": \"PaperWhite\", \"gamutCheck\": false, \"profile\": \"abc123\", \"rgb\": WorkingSpaceSimulation, \"cmyk\": WorkingSpaceSimulation, \"gray\": WorkingSpaceSimulation, \"useCloseLoop\": true, \"closeLoop\": CloseLoopParams } } }"
+ },
+ {
+ "name": "editVolume",
+ "type": "mutation",
+ "description": "Edit a Volume",
+ "response_type": "[Volume!]!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iVolumeSetup!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation editVolume( $id: [ID!]!, $setup: iVolumeSetup! ) { editVolume( id: $id, setup: $setup ) { id group access reference path nfsAlias smbAlias protocol server userName port } }",
+ "example_variables": "{ \"id\": [\"4\"], \"setup\": iVolumeSetup }",
+ "example_response": "{ \"data\": { \"editVolume\": [ { \"id\": \"4\", \"group\": \"ATTACHMENT\", \"access\": \"DISABLED\", \"reference\": \"xyz789\", \"path\": \"xyz789\", \"nfsAlias\": \"xyz789\", \"smbAlias\": \"xyz789\", \"protocol\": \"FILE\", \"server\": \"xyz789\", \"userName\": \"xyz789\", \"port\": 123 } ] } }"
+ },
+ {
+ "name": "editWebAuthnRegistration",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a WebAuthnRegistration",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "description",
+ "type": "String!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation editWebAuthnRegistration( $id: ID!, $description: String! ) { editWebAuthnRegistration( id: $id, description: $description ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } credentialId signatureCounter user { ...UserFragment } } }",
+ "example_variables": "{ \"id\": \"4\", \"description\": \"abc123\" }",
+ "example_response": "{ \"data\": { \"editWebAuthnRegistration\": { \"id\": \"4\", \"name\": \"abc123\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"credentialId\": \"4\", \"signatureCounter\": {}, \"user\": User } } }"
+ },
+ {
+ "name": "editWorkflow",
+ "type": "mutation",
+ "description": "createWorkflowRevision(name:String!): Workflow! @security(role:ADMIN_WORKFLOW) To define the current revision of a Workflow setWorkflowCurrentRevision(name:String! revision:Int!): Workflow! @security(role:ADMIN_WORKFLOW) Workflow edition : ID AND entity id OR processId : to know which instance to edit",
+ "response_type": "a Workflow!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "entityId",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "processId",
+ "type": "ID",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "description",
+ "type": "String",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "parameters",
+ "type": "[iMetadataValue!]",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "onCompletedRetention",
+ "type": "Int",
+ "description": "Default = -1",
+ "required": false
+ },
+ {
+ "name": "onFailedRetention",
+ "type": "Int",
+ "description": "Default = -1",
+ "required": false
+ },
+ {
+ "name": "activities",
+ "type": "[iActivity!]",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "links",
+ "type": "[iLink!]",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "layout",
+ "type": "iWorkflowLayout",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "failHandler",
+ "type": "iFailHandler",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation editWorkflow( $id: ID, $entityId: ID, $processId: ID, $description: String, $parameters: [iMetadataValue!], $onCompletedRetention: Int, $onFailedRetention: Int, $activities: [iActivity!], $links: [iLink!], $layout: iWorkflowLayout, $failHandler: iFailHandler ) { editWorkflow( id: $id, entityId: $entityId, processId: $processId, description: $description, parameters: $parameters, onCompletedRetention: $onCompletedRetention, onFailedRetention: $onFailedRetention, activities: $activities, links: $links, layout: $layout, failHandler: $failHandler ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } priority applyOn activities { ...ActivityFragment } links { ...LinkFragment } layout { ...WorkflowLayoutFragment } parameters { ...MetadataValueFragment } onFailed { ...FailHandlerFragment } onCompletedRetention onFailedRetention } }",
+ "example_variables": "{ \"id\": \"4\", \"entityId\": \"4\", \"processId\": 4, \"description\": \"abc123\", \"parameters\": [iMetadataValue], \"onCompletedRetention\": -1, \"onFailedRetention\": -1, \"activities\": [iActivity], \"links\": [iLink], \"layout\": iWorkflowLayout, \"failHandler\": iFailHandler }",
+ "example_response": "{ \"data\": { \"editWorkflow\": { \"id\": \"4\", \"name\": \"abc123\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"priority\": 987, \"applyOn\": \"Folder\", \"activities\": [Activity], \"links\": [Link], \"layout\": WorkflowLayout, \"parameters\": [MetadataValue], \"onFailed\": FailHandler, \"onCompletedRetention\": 123, \"onFailedRetention\": 123 } } }"
+ },
+ {
+ "name": "editWorkflowEngineCapacity",
+ "type": "mutation",
+ "description": "Edit capacity of a Workflow Engine",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "from",
+ "type": "URL!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "capacity",
+ "type": "Int!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation editWorkflowEngineCapacity( $from: URL!, $capacity: Int! ) { editWorkflowEngineCapacity( from: $from, capacity: $capacity ) }",
+ "example_variables": "{ \"from\": \"http://www.test.com/\", \"capacity\": 123 }",
+ "example_response": "{\"data\": {\"editWorkflowEngineCapacity\": false}}"
+ },
+ {
+ "name": "enableNotifications",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "setup",
+ "type": "[iEnableDisableNotification!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation enableNotifications($setup: [iEnableDisableNotification!]!) { enableNotifications(setup: $setup) }",
+ "example_variables": "{\"setup\": [iEnableDisableNotification]}",
+ "example_response": "{\"data\": {\"enableNotifications\": true}}"
+ },
+ {
+ "name": "finishWebAuthnRegistration",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "setup",
+ "type": "iWebAuthnRegistration!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation finishWebAuthnRegistration($setup: iWebAuthnRegistration!) { finishWebAuthnRegistration(setup: $setup) }",
+ "example_variables": "{\"setup\": iWebAuthnRegistration}",
+ "example_response": "{\"data\": {\"finishWebAuthnRegistration\": true}}"
+ },
+ {
+ "name": "importData",
+ "type": "mutation",
+ "description": "**Import the given file",
+ "response_type": "a Boolean",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "in",
+ "type": "iImportCollection",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation importData( $id: ID!, $in: iImportCollection ) { importData( id: $id, in: $in ) }",
+ "example_variables": "{\"id\": 4, \"in\": iImportCollection}",
+ "example_response": "{\"data\": {\"importData\": true}}"
+ },
+ {
+ "name": "markAsSeen",
+ "type": "mutation",
+ "description": "Returns a Boolean!",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation markAsSeen($id: ID!) { markAsSeen(id: $id) }",
+ "example_variables": "{\"id\": 4}",
+ "example_response": "{\"data\": {\"markAsSeen\": false}}"
+ },
+ {
+ "name": "mergeAsset",
+ "type": "mutation",
+ "description": "Merge Assets with their revisions",
+ "response_type": "an Asset!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "with",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation mergeAsset( $id: ID!, $with: ID! ) { mergeAsset( id: $id, with: $with ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } trashDate trashUser { ...UserFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } status approvalSummary approvalStatus { ...ApprovalActivityStatusFragment } approvals { ...ApprovalCycleFragment } workflowName isAlias processes { ...ProcessFragment } uuid priority isCheckedOut checkedOutBy { ...UserFragment } privateWorkingRevision isArchived archiveId colorSpace { ...ColorSpaceFragment } viewingCondition { ...ViewingConditionFragment } project { ...ProjectFragment } parents { ...ContainerFragment } numberOfRevisions expirationDate medias { ...MediaFragment } notes { ...NoteFragment } relationFrom { ...RelationFragment } relationTo { ...RelationFragment } accessControls } }",
+ "example_variables": "{\"id\": 4, \"with\": \"4\"}",
+ "example_response": "{ \"data\": { \"mergeAsset\": { \"id\": 4, \"name\": \"abc123\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"trashDate\": \"2007-12-03T10:15:30Z\", \"trashUser\": User, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"status\": [\"ACTIVE\"], \"approvalSummary\": \"NONE\", \"approvalStatus\": [ApprovalActivityStatus], \"approvals\": [ApprovalCycle], \"workflowName\": \"abc123\", \"isAlias\": true, \"processes\": [Process], \"uuid\": \"xyz789\", \"priority\": 987, \"isCheckedOut\": true, \"checkedOutBy\": User, \"privateWorkingRevision\": 123, \"isArchived\": false, \"archiveId\": \"4\", \"colorSpace\": ColorSpace, \"viewingCondition\": ViewingCondition, \"project\": Project, \"parents\": [Container], \"numberOfRevisions\": 123, \"expirationDate\": \"2007-12-03T10:15:30Z\", \"medias\": [Media], \"notes\": [Note], \"relationFrom\": [Relation], \"relationTo\": [Relation], \"accessControls\": {} } } }"
+ },
+ {
+ "name": "moveAsset",
+ "type": "mutation",
+ "description": "Move one or several Asset(s) into a Folder or a Project",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "to",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation moveAsset( $id: [ID!]!, $to: ID! ) { moveAsset( id: $id, to: $to ) }",
+ "example_variables": "{\"id\": [4], \"to\": \"4\"}",
+ "example_response": "{\"data\": {\"moveAsset\": false}}"
+ },
+ {
+ "name": "moveCollection",
+ "type": "mutation",
+ "description": "To move a Collection",
+ "response_type": "[Collection!]!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "to",
+ "type": "ID",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation moveCollection( $id: [ID!]!, $to: ID ) { moveCollection( id: $id, to: $to ) { id name description color lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } trashDate trashUser { ...UserFragment } icon lName translations children { ...PagingResponseFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } readOnly accessControlList { ...AccessControlListFragment } path { ...CollectionFragment } parents { ...ContainerFragment } destination { ...EntityFragment } } }",
+ "example_variables": "{\"id\": [4], \"to\": \"4\"}",
+ "example_response": "{ \"data\": { \"moveCollection\": [ { \"id\": \"4\", \"name\": \"abc123\", \"description\": \"xyz789\", \"color\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"trashDate\": \"2007-12-03T10:15:30Z\", \"trashUser\": User, \"icon\": \"4\", \"lName\": \"abc123\", \"translations\": {}, \"children\": PagingResponse, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"readOnly\": false, \"accessControlList\": AccessControlList, \"path\": [Collection], \"parents\": [Container], \"destination\": Entity } ] } }"
+ },
+ {
+ "name": "moveFolder",
+ "type": "mutation",
+ "description": "To move a Folder - TODO Return type can't be folder anymore",
+ "response_type": "[Folder!]!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "to",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation moveFolder( $id: [ID!]!, $to: ID! ) { moveFolder( id: $id, to: $to ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } trashDate trashUser { ...UserFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } readOnly productionSettings { ...ProductionSettingsFragment } processes { ...ProcessFragment } accessControlList { ...AccessControlListFragment } children { ...PagingResponseFragment } project { ...ProjectFragment } parents { ...ContainerFragment } path { ...FolderFragment } color icon } }",
+ "example_variables": "{\"id\": [\"4\"], \"to\": 4}",
+ "example_response": "{ \"data\": { \"moveFolder\": [ { \"id\": 4, \"name\": \"xyz789\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"trashDate\": \"2007-12-03T10:15:30Z\", \"trashUser\": User, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"readOnly\": true, \"productionSettings\": ProductionSettings, \"processes\": [Process], \"accessControlList\": AccessControlList, \"children\": PagingResponse, \"project\": Project, \"parents\": [Container], \"path\": [Folder], \"color\": \"abc123\", \"icon\": \"4\" } ] } }"
+ },
+ {
+ "name": "moveObjectFromCollectionToCollection",
+ "type": "mutation",
+ "description": "To move an object from one collection to another one",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "class",
+ "type": "CollectionableTypeName!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "from",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "to",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation moveObjectFromCollectionToCollection( $id: [ID!]!, $class: CollectionableTypeName!, $from: ID!, $to: ID! ) { moveObjectFromCollectionToCollection( id: $id, class: $class, from: $from, to: $to ) }",
+ "example_variables": "{ \"id\": [4], \"class\": \"ColorSpace\", \"from\": \"4\", \"to\": \"4\" }",
+ "example_response": "{\"data\": {\"moveObjectFromCollectionToCollection\": false}}"
+ },
+ {
+ "name": "moveProjectFolder",
+ "type": "mutation",
+ "description": "To move a ProjectFolder - TODO using container as return for testing. Discuss long term return type.",
+ "response_type": "[Container!]!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "to",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation moveProjectFolder( $id: [ID!]!, $to: ID! ) { moveProjectFolder( id: $id, to: $to ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } children { ...PagingResponseFragment } } }",
+ "example_variables": "{\"id\": [\"4\"], \"to\": 4}",
+ "example_response": "{ \"data\": { \"moveProjectFolder\": [ { \"id\": 4, \"name\": \"xyz789\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"children\": PagingResponse } ] } }"
+ },
+ {
+ "name": "moveProjectToCustomer",
+ "type": "mutation",
+ "description": "To move one or several project(s) to a customer",
+ "response_type": "[Project!]!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "to",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation moveProjectToCustomer( $id: [ID!]!, $to: ID! ) { moveProjectToCustomer( id: $id, to: $to ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } trashDate trashUser { ...UserFragment } endDate metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } status workflowName approvalStatus { ...ApprovalActivityStatusFragment } approvalSummary approvals { ...ApprovalCycleFragment } assetApprovals { ...ApprovalCycleFragment } children { ...PagingResponseFragment } assetWorkflow { ...WorkflowFragment } processes { ...ProcessFragment } projectTemplate { ...ProjectTemplateFragment } priority colorSpace { ...ColorSpaceFragment } viewingCondition { ...ViewingConditionFragment } reversedView customer { ...CustomerFragment } parents { ...ContainerFragment } mainAsset { ...AssetFragment } siteId productionParticipants { ...ProductionParticipantFragment } notes { ...NoteFragment } trimmedHeight trimmedWidth nbPages accessControls deadlines { ...ProjectDeadlineFragment } } }",
+ "example_variables": "{\"id\": [\"4\"], \"to\": 4}",
+ "example_response": "{ \"data\": { \"moveProjectToCustomer\": [ { \"id\": 4, \"name\": \"abc123\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"trashDate\": \"2007-12-03T10:15:30Z\", \"trashUser\": User, \"endDate\": \"2007-12-03T10:15:30Z\", \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"status\": [\"ACTIVE\"], \"workflowName\": \"abc123\", \"approvalStatus\": [ApprovalActivityStatus], \"approvalSummary\": \"NONE\", \"approvals\": [ApprovalCycle], \"assetApprovals\": [ApprovalCycle], \"children\": PagingResponse, \"assetWorkflow\": Workflow, \"processes\": [Process], \"projectTemplate\": ProjectTemplate, \"priority\": 123, \"colorSpace\": ColorSpace, \"viewingCondition\": ViewingCondition, \"reversedView\": true, \"customer\": Customer, \"parents\": [Container], \"mainAsset\": Asset, \"siteId\": \"4\", \"productionParticipants\": [ProductionParticipant], \"notes\": [Note], \"trimmedHeight\": 123.45, \"trimmedWidth\": 123.45, \"nbPages\": 123, \"accessControls\": {}, \"deadlines\": [ProjectDeadline] } ] } }"
+ },
+ {
+ "name": "moveUser",
+ "type": "mutation",
+ "description": "Move an existing User in the specified Organization",
+ "response_type": "a User!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "in",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation moveUser( $id: ID!, $in: ID! ) { moveUser( id: $id, in: $in ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } login userCanLog lang dateFormat unitResolution unitLength color image use2FA channel2FA sessionTimeout workCapacity workCapacityUnit firstName lastName email title company phone phone2 homePhone fax mobilePhone department address { ...AddressFragment } organization { ...OrganizationFragment } groups { ...GroupFragment } roles { ...RoleFragment } defaultProfile { ...UserSecurityProfileFragment } availableProfiles { ...UserSecurityProfileFragment } notifications { ...NotificationFragment } } }",
+ "example_variables": "{ \"id\": \"4\", \"in\": \"4\" }",
+ "example_response": "{ \"data\": { \"moveUser\": { \"id\": \"4\", \"name\": \"abc123\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"login\": \"abc123\", \"userCanLog\": true, \"lang\": \"ar\", \"dateFormat\": \"abc123\", \"unitResolution\": \"xyz789\", \"unitLength\": \"abc123\", \"color\": \"xyz789\", \"image\": \"xyz789\", \"use2FA\": false, \"channel2FA\": \"AUTHENTICATOR\", \"sessionTimeout\": 123, \"workCapacity\": \"abc123\", \"workCapacityUnit\": \"xyz789\", \"firstName\": \"abc123\", \"lastName\": \"abc123\", \"email\": \"abc123\", \"title\": \"abc123\", \"company\": \"xyz789\", \"phone\": \"abc123\", \"phone2\": \"abc123\", \"homePhone\": \"xyz789\", \"fax\": \"xyz789\", \"mobilePhone\": \"xyz789\", \"department\": \"abc123\", \"address\": Address, \"organization\": Organization, \"groups\": [Group], \"roles\": [Role], \"defaultProfile\": UserSecurityProfile, \"availableProfiles\": [UserSecurityProfile], \"notifications\": [Notification] } } }"
+ },
+ {
+ "name": "putSecurityProperties",
+ "type": "mutation",
+ "description": "Add security properties to a security profile (user or mask)",
+ "response_type": "[SecurityProfile!]!",
+ "arguments": [
+ {
+ "name": "to",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "properties",
+ "type": "[iSecurityProperty!]",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation putSecurityProperties( $to: [ID!]!, $properties: [iSecurityProperty!] ) { putSecurityProperties( to: $to, properties: $properties ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } properties { ...SecurityPropertyFragment } } }",
+ "example_variables": "{ \"to\": [\"4\"], \"properties\": [iSecurityProperty] }",
+ "example_response": "{ \"data\": { \"putSecurityProperties\": [ { \"id\": 4, \"name\": \"abc123\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"properties\": [SecurityProperty] } ] } }"
+ },
+ {
+ "name": "putSecurityRoles",
+ "type": "mutation",
+ "description": "Add a security roles to a user Security Profile",
+ "response_type": "[UserSecurityProfile!]!",
+ "arguments": [
+ {
+ "name": "to",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "securityRoles",
+ "type": "[SecurityRole!]",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation putSecurityRoles( $to: [ID!]!, $securityRoles: [SecurityRole!] ) { putSecurityRoles( to: $to, securityRoles: $securityRoles ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } properties { ...SecurityPropertyFragment } securityRoles } }",
+ "example_variables": "{\"to\": [\"4\"], \"securityRoles\": [\"ADMIN\"]}",
+ "example_response": "{ \"data\": { \"putSecurityRoles\": [ { \"id\": 4, \"name\": \"xyz789\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"properties\": [SecurityProperty], \"securityRoles\": [\"ADMIN\"] } ] } }"
+ },
+ {
+ "name": "reactivateSynSet",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "mode",
+ "type": "SynSetRetireMode",
+ "description": "Default = None",
+ "required": false
+ }
+ ],
+ "example_query": "mutation reactivateSynSet( $id: ID!, $mode: SynSetRetireMode ) { reactivateSynSet( id: $id, mode: $mode ) }",
+ "example_variables": "{\"id\": \"4\", \"mode\": \"None\"}",
+ "example_response": "{\"data\": {\"reactivateSynSet\": true}}"
+ },
+ {
+ "name": "reject",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "The id(s) of the request approval(s) to reject",
+ "required": true
+ },
+ {
+ "name": "comment",
+ "type": "String",
+ "description": "The comment associated to the reject action",
+ "required": false
+ },
+ {
+ "name": "checkViewingCondition",
+ "type": "Boolean",
+ "description": "Specify if the viewing condition should be checked or not. Default = true",
+ "required": false
+ }
+ ],
+ "example_query": "mutation reject( $id: [ID!]!, $comment: String, $checkViewingCondition: Boolean ) { reject( id: $id, comment: $comment, checkViewingCondition: $checkViewingCondition ) }",
+ "example_variables": "{ \"id\": [\"4\"], \"comment\": \"abc123\", \"checkViewingCondition\": true }",
+ "example_response": "{\"data\": {\"reject\": false}}"
+ },
+ {
+ "name": "rejectObject",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "The id(s) of the object(s) to reject",
+ "required": true
+ },
+ {
+ "name": "comment",
+ "type": "String",
+ "description": "The comment associated to the reject action",
+ "required": false
+ },
+ {
+ "name": "checkViewingCondition",
+ "type": "Boolean",
+ "description": "Specify if the viewing condition should be checked or not. Default = true",
+ "required": false
+ }
+ ],
+ "example_query": "mutation rejectObject( $id: [ID!]!, $comment: String, $checkViewingCondition: Boolean ) { rejectObject( id: $id, comment: $comment, checkViewingCondition: $checkViewingCondition ) }",
+ "example_variables": "{ \"id\": [\"4\"], \"comment\": \"abc123\", \"checkViewingCondition\": true }",
+ "example_response": "{\"data\": {\"rejectObject\": true}}"
+ },
+ {
+ "name": "removeAssetAlias",
+ "type": "mutation",
+ "description": "To remove an Asset alias where 'id' is the Asset ID and 'from' defines a project or a project subfolder ID",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "from",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation removeAssetAlias( $id: [ID!]!, $from: ID! ) { removeAssetAlias( id: $id, from: $from ) }",
+ "example_variables": "{\"id\": [4], \"from\": 4}",
+ "example_response": "{\"data\": {\"removeAssetAlias\": true}}"
+ },
+ {
+ "name": "removeCustomerFromGroup",
+ "type": "mutation",
+ "description": "Remove one or many Customers from one Group.",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "from",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation removeCustomerFromGroup( $id: [ID!]!, $from: ID! ) { removeCustomerFromGroup( id: $id, from: $from ) }",
+ "example_variables": "{\"id\": [4], \"from\": 4}",
+ "example_response": "{\"data\": {\"removeCustomerFromGroup\": true}}"
+ },
+ {
+ "name": "removeCustomerFromOrganization",
+ "type": "mutation",
+ "description": "Remove one or many Customers from one Organization.",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "from",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation removeCustomerFromOrganization( $id: [ID!]!, $from: ID! ) { removeCustomerFromOrganization( id: $id, from: $from ) }",
+ "example_variables": "{\"id\": [\"4\"], \"from\": 4}",
+ "example_response": "{\"data\": {\"removeCustomerFromOrganization\": false}}"
+ },
+ {
+ "name": "removeNoteAttachment",
+ "type": "mutation",
+ "description": "Returns a Boolean!",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation removeNoteAttachment($id: [ID!]!) { removeNoteAttachment(id: $id) }",
+ "example_variables": "{\"id\": [\"4\"]}",
+ "example_response": "{\"data\": {\"removeNoteAttachment\": false}}"
+ },
+ {
+ "name": "removeObjectFromCollection",
+ "type": "mutation",
+ "description": "To remove an object from a Collection",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "class",
+ "type": "CollectionableTypeName!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "from",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation removeObjectFromCollection( $id: [ID!]!, $class: CollectionableTypeName!, $from: ID! ) { removeObjectFromCollection( id: $id, class: $class, from: $from ) }",
+ "example_variables": "{\"id\": [4], \"class\": \"ColorSpace\", \"from\": 4}",
+ "example_response": "{\"data\": {\"removeObjectFromCollection\": true}}"
+ },
+ {
+ "name": "removeProfileFromUser",
+ "type": "mutation",
+ "description": "Remove one or many SecurityProfiles from one or many Users",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "from",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation removeProfileFromUser( $id: [ID!]!, $from: [ID!]! ) { removeProfileFromUser( id: $id, from: $from ) }",
+ "example_variables": "{ \"id\": [\"4\"], \"from\": [\"4\"] }",
+ "example_response": "{\"data\": {\"removeProfileFromUser\": true}}"
+ },
+ {
+ "name": "removeRoleFromUser",
+ "type": "mutation",
+ "description": "Remove one or many Role(s) from one or many User(s)",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "from",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation removeRoleFromUser( $id: [ID!]!, $from: [ID!]! ) { removeRoleFromUser( id: $id, from: $from ) }",
+ "example_variables": "{\"id\": [4], \"from\": [4]}",
+ "example_response": "{\"data\": {\"removeRoleFromUser\": true}}"
+ },
+ {
+ "name": "removeSecurityProperties",
+ "type": "mutation",
+ "description": "Remove security properties from a security profile (user or mask)",
+ "response_type": "[SecurityProfile!]!",
+ "arguments": [
+ {
+ "name": "from",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "name",
+ "type": "[String!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation removeSecurityProperties( $from: [ID!]!, $name: [String!]! ) { removeSecurityProperties( from: $from, name: $name ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } properties { ...SecurityPropertyFragment } } }",
+ "example_variables": "{\"from\": [4], \"name\": [\"abc123\"]}",
+ "example_response": "{ \"data\": { \"removeSecurityProperties\": [ { \"id\": \"4\", \"name\": \"abc123\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"properties\": [SecurityProperty] } ] } }"
+ },
+ {
+ "name": "removeSecurityRoles",
+ "type": "mutation",
+ "description": "Remove security roles from a user Security Profile",
+ "response_type": "[UserSecurityProfile!]!",
+ "arguments": [
+ {
+ "name": "from",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "securityRoles",
+ "type": "[SecurityRole!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation removeSecurityRoles( $from: [ID!]!, $securityRoles: [SecurityRole!]! ) { removeSecurityRoles( from: $from, securityRoles: $securityRoles ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } properties { ...SecurityPropertyFragment } securityRoles } }",
+ "example_variables": "{\"from\": [4], \"securityRoles\": [\"ADMIN\"]}",
+ "example_response": "{ \"data\": { \"removeSecurityRoles\": [ { \"id\": \"4\", \"name\": \"abc123\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"properties\": [SecurityProperty], \"securityRoles\": [\"ADMIN\"] } ] } }"
+ },
+ {
+ "name": "removeUserFromGroup",
+ "type": "mutation",
+ "description": "Remove one or many Users from one or many Groups that are not System Groups. All the Users provided will be removed from each Groups provided",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "from",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation removeUserFromGroup( $id: [ID!]!, $from: [ID!]! ) { removeUserFromGroup( id: $id, from: $from ) }",
+ "example_variables": "{ \"id\": [\"4\"], \"from\": [\"4\"] }",
+ "example_response": "{\"data\": {\"removeUserFromGroup\": false}}"
+ },
+ {
+ "name": "renameAsset",
+ "type": "mutation",
+ "description": "Not yet implemented : To rename an Asset with Id newName is used to rename the asset",
+ "response_type": "an Asset!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "newName",
+ "type": "String!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation renameAsset( $id: ID!, $newName: String! ) { renameAsset( id: $id, newName: $newName ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } trashDate trashUser { ...UserFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } status approvalSummary approvalStatus { ...ApprovalActivityStatusFragment } approvals { ...ApprovalCycleFragment } workflowName isAlias processes { ...ProcessFragment } uuid priority isCheckedOut checkedOutBy { ...UserFragment } privateWorkingRevision isArchived archiveId colorSpace { ...ColorSpaceFragment } viewingCondition { ...ViewingConditionFragment } project { ...ProjectFragment } parents { ...ContainerFragment } numberOfRevisions expirationDate medias { ...MediaFragment } notes { ...NoteFragment } relationFrom { ...RelationFragment } relationTo { ...RelationFragment } accessControls } }",
+ "example_variables": "{\"id\": 4, \"newName\": \"xyz789\"}",
+ "example_response": "{ \"data\": { \"renameAsset\": { \"id\": \"4\", \"name\": \"abc123\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"trashDate\": \"2007-12-03T10:15:30Z\", \"trashUser\": User, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"status\": [\"ACTIVE\"], \"approvalSummary\": \"NONE\", \"approvalStatus\": [ApprovalActivityStatus], \"approvals\": [ApprovalCycle], \"workflowName\": \"xyz789\", \"isAlias\": true, \"processes\": [Process], \"uuid\": \"abc123\", \"priority\": 123, \"isCheckedOut\": false, \"checkedOutBy\": User, \"privateWorkingRevision\": 987, \"isArchived\": true, \"archiveId\": 4, \"colorSpace\": ColorSpace, \"viewingCondition\": ViewingCondition, \"project\": Project, \"parents\": [Container], \"numberOfRevisions\": 987, \"expirationDate\": \"2007-12-03T10:15:30Z\", \"medias\": [Media], \"notes\": [Note], \"relationFrom\": [Relation], \"relationTo\": [Relation], \"accessControls\": {} } } }"
+ },
+ {
+ "name": "renameCollection",
+ "type": "mutation",
+ "description": "To rename a Collection",
+ "response_type": "a Collection!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "newName",
+ "type": "String!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation renameCollection( $id: ID!, $newName: String! ) { renameCollection( id: $id, newName: $newName ) { id name description color lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } trashDate trashUser { ...UserFragment } icon lName translations children { ...PagingResponseFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } readOnly accessControlList { ...AccessControlListFragment } path { ...CollectionFragment } parents { ...ContainerFragment } destination { ...EntityFragment } } }",
+ "example_variables": "{ \"id\": \"4\", \"newName\": \"abc123\" }",
+ "example_response": "{ \"data\": { \"renameCollection\": { \"id\": \"4\", \"name\": \"abc123\", \"description\": \"xyz789\", \"color\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"trashDate\": \"2007-12-03T10:15:30Z\", \"trashUser\": User, \"icon\": 4, \"lName\": \"xyz789\", \"translations\": {}, \"children\": PagingResponse, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"readOnly\": false, \"accessControlList\": AccessControlList, \"path\": [Collection], \"parents\": [Container], \"destination\": Entity } } }"
+ },
+ {
+ "name": "renameFolder",
+ "type": "mutation",
+ "description": "To rename a Folder",
+ "response_type": "a Folder!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "newName",
+ "type": "String!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation renameFolder( $id: ID!, $newName: String! ) { renameFolder( id: $id, newName: $newName ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } trashDate trashUser { ...UserFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } readOnly productionSettings { ...ProductionSettingsFragment } processes { ...ProcessFragment } accessControlList { ...AccessControlListFragment } children { ...PagingResponseFragment } project { ...ProjectFragment } parents { ...ContainerFragment } path { ...FolderFragment } color icon } }",
+ "example_variables": "{\"id\": 4, \"newName\": \"abc123\"}",
+ "example_response": "{ \"data\": { \"renameFolder\": { \"id\": 4, \"name\": \"xyz789\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"trashDate\": \"2007-12-03T10:15:30Z\", \"trashUser\": User, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"readOnly\": true, \"productionSettings\": ProductionSettings, \"processes\": [Process], \"accessControlList\": AccessControlList, \"children\": PagingResponse, \"project\": Project, \"parents\": [Container], \"path\": [Folder], \"color\": \"xyz789\", \"icon\": \"4\" } } }"
+ },
+ {
+ "name": "renameMetadataDefinition",
+ "type": "mutation",
+ "description": "To rename a metadata definition",
+ "response_type": "a MetadataDefinition",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation renameMetadataDefinition( $id: ID!, $name: String! ) { renameMetadataDefinition( id: $id, name: $name ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } nameSpace { ...MetadataNameSpaceFragment } type cardinality struct { ...MetadataDefinitionFragment } lName translations searchable availableInLayout saveInXmp required unique editable dictionary { ...DictionaryFragment } minRange maxRange minChar maxChar regex defaultValue } }",
+ "example_variables": "{\"id\": 4, \"name\": \"xyz789\"}",
+ "example_response": "{ \"data\": { \"renameMetadataDefinition\": { \"id\": 4, \"name\": \"xyz789\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"nameSpace\": MetadataNameSpace, \"type\": \"BOOLEAN\", \"cardinality\": \"SINGLE\", \"struct\": [MetadataDefinition], \"lName\": \"abc123\", \"translations\": {}, \"searchable\": false, \"availableInLayout\": true, \"saveInXmp\": false, \"required\": true, \"unique\": false, \"editable\": false, \"dictionary\": Dictionary, \"minRange\": Number, \"maxRange\": Number, \"minChar\": Number, \"maxChar\": Number, \"regex\": \"abc123\", \"defaultValue\": {} } } }"
+ },
+ {
+ "name": "renameProject",
+ "type": "mutation",
+ "description": "To rename a Project with Id and newName",
+ "response_type": "a Project!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "newName",
+ "type": "String!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation renameProject( $id: ID!, $newName: String! ) { renameProject( id: $id, newName: $newName ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } trashDate trashUser { ...UserFragment } endDate metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } status workflowName approvalStatus { ...ApprovalActivityStatusFragment } approvalSummary approvals { ...ApprovalCycleFragment } assetApprovals { ...ApprovalCycleFragment } children { ...PagingResponseFragment } assetWorkflow { ...WorkflowFragment } processes { ...ProcessFragment } projectTemplate { ...ProjectTemplateFragment } priority colorSpace { ...ColorSpaceFragment } viewingCondition { ...ViewingConditionFragment } reversedView customer { ...CustomerFragment } parents { ...ContainerFragment } mainAsset { ...AssetFragment } siteId productionParticipants { ...ProductionParticipantFragment } notes { ...NoteFragment } trimmedHeight trimmedWidth nbPages accessControls deadlines { ...ProjectDeadlineFragment } } }",
+ "example_variables": "{\"id\": 4, \"newName\": \"xyz789\"}",
+ "example_response": "{ \"data\": { \"renameProject\": { \"id\": 4, \"name\": \"xyz789\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"trashDate\": \"2007-12-03T10:15:30Z\", \"trashUser\": User, \"endDate\": \"2007-12-03T10:15:30Z\", \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"status\": [\"ACTIVE\"], \"workflowName\": \"abc123\", \"approvalStatus\": [ApprovalActivityStatus], \"approvalSummary\": \"NONE\", \"approvals\": [ApprovalCycle], \"assetApprovals\": [ApprovalCycle], \"children\": PagingResponse, \"assetWorkflow\": Workflow, \"processes\": [Process], \"projectTemplate\": ProjectTemplate, \"priority\": 987, \"colorSpace\": ColorSpace, \"viewingCondition\": ViewingCondition, \"reversedView\": true, \"customer\": Customer, \"parents\": [Container], \"mainAsset\": Asset, \"siteId\": 4, \"productionParticipants\": [ProductionParticipant], \"notes\": [Note], \"trimmedHeight\": 123.45, \"trimmedWidth\": 987.65, \"nbPages\": 123, \"accessControls\": {}, \"deadlines\": [ProjectDeadline] } } }"
+ },
+ {
+ "name": "renameProjectFolder",
+ "type": "mutation",
+ "description": "To rename a ProjectFolder",
+ "response_type": "a ProjectFolder!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "newName",
+ "type": "String!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation renameProjectFolder( $id: ID!, $newName: String! ) { renameProjectFolder( id: $id, newName: $newName ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } trashDate trashUser { ...UserFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } readOnly productionSettings { ...ProductionSettingsFragment } processes { ...ProcessFragment } accessControlList { ...AccessControlListFragment } children { ...PagingResponseFragment } project { ...ProjectFragment } parents { ...ContainerFragment } path { ...ProjectFolderFragment } color icon } }",
+ "example_variables": "{ \"id\": \"4\", \"newName\": \"abc123\" }",
+ "example_response": "{ \"data\": { \"renameProjectFolder\": { \"id\": 4, \"name\": \"abc123\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"trashDate\": \"2007-12-03T10:15:30Z\", \"trashUser\": User, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"readOnly\": false, \"productionSettings\": ProductionSettings, \"processes\": [Process], \"accessControlList\": AccessControlList, \"children\": PagingResponse, \"project\": Project, \"parents\": [Container], \"path\": [ProjectFolder], \"color\": \"abc123\", \"icon\": 4 } } }"
+ },
+ {
+ "name": "renameSmartCollection",
+ "type": "mutation",
+ "description": "To rename a SmartCollection",
+ "response_type": "a SmartCollection!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "newName",
+ "type": "String!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation renameSmartCollection( $id: ID!, $newName: String! ) { renameSmartCollection( id: $id, newName: $newName ) { id name description color lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } trashDate trashUser { ...UserFragment } icon lName translations children { ...PagingResponseFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } readOnly accessControlList { ...AccessControlListFragment } searchProperties { ...SmartCollectionSearchPropertiesFragment } } }",
+ "example_variables": "{\"id\": 4, \"newName\": \"xyz789\"}",
+ "example_response": "{ \"data\": { \"renameSmartCollection\": { \"id\": 4, \"name\": \"xyz789\", \"description\": \"abc123\", \"color\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"trashDate\": \"2007-12-03T10:15:30Z\", \"trashUser\": User, \"icon\": \"4\", \"lName\": \"xyz789\", \"translations\": {}, \"children\": PagingResponse, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"readOnly\": true, \"accessControlList\": AccessControlList, \"searchProperties\": SmartCollectionSearchProperties } } }"
+ },
+ {
+ "name": "replyToNote",
+ "type": "mutation",
+ "description": "rank : The rank of the reply. This allows to insert a reply at a certain rank, provided a reply with this rank already exists. If not, the rank will be incremented.",
+ "response_type": "a Note!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "type",
+ "type": "NoteReplyType",
+ "description": "Default = Text",
+ "required": false
+ },
+ {
+ "name": "comment",
+ "type": "String",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "stylizedComment",
+ "type": "String",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "rank",
+ "type": "Long",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation replyToNote( $id: ID!, $type: NoteReplyType, $comment: String, $stylizedComment: String, $rank: Long ) { replyToNote( id: $id, type: $type, comment: $comment, stylizedComment: $stylizedComment, rank: $rank ) { id type objectOwnerId pageNumber lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } attachments { ...AttachmentFragment } checkable status { ...AnnotationStatusFragment } collapsed seenBy { ...UserFragment } replies { ...NoteReplyFragment } content originalContent stylizedContent positionX positionY positionZ anchorX anchorY anchorZ tx ty proofReadingMark { ...ProofReadingMarkFragment } path selectable startTime endTime } }",
+ "example_variables": "{ \"id\": \"4\", \"type\": \"Text\", \"comment\": \"abc123\", \"stylizedComment\": \"abc123\", \"rank\": {} }",
+ "example_response": "{ \"data\": { \"replyToNote\": { \"id\": 4, \"type\": \"Note\", \"objectOwnerId\": 4, \"pageNumber\": {}, \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"attachments\": [Attachment], \"checkable\": true, \"status\": AnnotationStatus, \"collapsed\": true, \"seenBy\": [User], \"replies\": [NoteReply], \"content\": \"xyz789\", \"originalContent\": \"abc123\", \"stylizedContent\": \"xyz789\", \"positionX\": 123.45, \"positionY\": 987.65, \"positionZ\": 987.65, \"anchorX\": 987.65, \"anchorY\": 987.65, \"anchorZ\": 987.65, \"tx\": 987.65, \"ty\": 987.65, \"proofReadingMark\": ProofReadingMark, \"path\": \"xyz789\", \"selectable\": true, \"startTime\": 123.45, \"endTime\": 987.65 } } }"
+ },
+ {
+ "name": "reprocessAsset",
+ "type": "mutation",
+ "description": "Reprocess an asset's workflow",
+ "response_type": "[Process!]!",
+ "arguments": [
+ {
+ "name": "workflowName",
+ "type": "String",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "on",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "fromTemplate",
+ "type": "Boolean",
+ "description": "Default = false",
+ "required": false
+ }
+ ],
+ "example_query": "mutation reprocessAsset( $workflowName: String, $on: [ID!]!, $fromTemplate: Boolean ) { reprocessAsset( workflowName: $workflowName, on: $on, fromTemplate: $fromTemplate ) { id priority status virtualStatus startTime steps { ...ActivityInstanceFragment } workflow { ...WorkflowFragment } stages { ...StageFragment } object { ...EntityFragment } } }",
+ "example_variables": "{ \"workflowName\": \"xyz789\", \"on\": [4], \"fromTemplate\": false }",
+ "example_response": "{ \"data\": { \"reprocessAsset\": [ { \"id\": 4, \"priority\": 123, \"status\": \"Created\", \"virtualStatus\": \"xyz789\", \"startTime\": \"2007-12-03T10:15:30Z\", \"steps\": [ActivityInstance], \"workflow\": Workflow, \"stages\": [Stage], \"object\": Entity } ] } }"
+ },
+ {
+ "name": "resendMail",
+ "type": "mutation",
+ "description": "not yet implemented",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation resendMail($id: [ID!]!) { resendMail(id: $id) }",
+ "example_variables": "{\"id\": [4]}",
+ "example_response": "{\"data\": {\"resendMail\": true}}"
+ },
+ {
+ "name": "reset2FAKey",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "id of the user",
+ "required": true
+ }
+ ],
+ "example_query": "mutation reset2FAKey($id: ID!) { reset2FAKey(id: $id) }",
+ "example_variables": "{\"id\": \"4\"}",
+ "example_response": "{\"data\": {\"reset2FAKey\": true}}"
+ },
+ {
+ "name": "resetUserPassword",
+ "type": "mutation",
+ "description": "Generate temporary password for a user, if possible an email is sent to the user with that password. The password is valid during 10 mn",
+ "response_type": "a String!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation resetUserPassword($id: ID!) { resetUserPassword(id: $id) }",
+ "example_variables": "{\"id\": 4}",
+ "example_response": "{\"data\": {\"resetUserPassword\": \"xyz789\"}}"
+ },
+ {
+ "name": "restartActivity",
+ "type": "mutation",
+ "description": "Restart a workflow on an object from an activity",
+ "response_type": "[Process!]!",
+ "arguments": [
+ {
+ "name": "on",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "activityId",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation restartActivity( $on: [ID!]!, $activityId: ID! ) { restartActivity( on: $on, activityId: $activityId ) { id priority status virtualStatus startTime steps { ...ActivityInstanceFragment } workflow { ...WorkflowFragment } stages { ...StageFragment } object { ...EntityFragment } } }",
+ "example_variables": "{\"on\": [\"4\"], \"activityId\": 4}",
+ "example_response": "{ \"data\": { \"restartActivity\": [ { \"id\": \"4\", \"priority\": 987, \"status\": \"Created\", \"virtualStatus\": \"xyz789\", \"startTime\": \"2007-12-03T10:15:30Z\", \"steps\": [ActivityInstance], \"workflow\": Workflow, \"stages\": [Stage], \"object\": Entity } ] } }"
+ },
+ {
+ "name": "restartProcess",
+ "type": "mutation",
+ "description": "Restart a workflow on an object from an activity",
+ "response_type": "[Process!]!",
+ "arguments": [
+ {
+ "name": "on",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "activityId",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation restartProcess( $on: [ID!]!, $activityId: ID! ) { restartProcess( on: $on, activityId: $activityId ) { id priority status virtualStatus startTime steps { ...ActivityInstanceFragment } workflow { ...WorkflowFragment } stages { ...StageFragment } object { ...EntityFragment } } }",
+ "example_variables": "{\"on\": [4], \"activityId\": \"4\"}",
+ "example_response": "{ \"data\": { \"restartProcess\": [ { \"id\": 4, \"priority\": 987, \"status\": \"Created\", \"virtualStatus\": \"xyz789\", \"startTime\": \"2007-12-03T10:15:30Z\", \"steps\": [ActivityInstance], \"workflow\": Workflow, \"stages\": [Stage], \"object\": Entity } ] } }"
+ },
+ {
+ "name": "retireSynSet",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "mode",
+ "type": "SynSetRetireMode",
+ "description": "Default = None",
+ "required": false
+ }
+ ],
+ "example_query": "mutation retireSynSet( $id: ID!, $mode: SynSetRetireMode ) { retireSynSet( id: $id, mode: $mode ) }",
+ "example_variables": "{\"id\": 4, \"mode\": \"None\"}",
+ "example_response": "{\"data\": {\"retireSynSet\": true}}"
+ },
+ {
+ "name": "revokeUserConnection",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation revokeUserConnection($id: [ID!]) { revokeUserConnection(id: $id) }",
+ "example_variables": "{\"id\": [\"4\"]}",
+ "example_response": "{\"data\": {\"revokeUserConnection\": false}}"
+ },
+ {
+ "name": "saveFile",
+ "type": "mutation",
+ "description": "-------- Deprecated ---------",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "in",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "parentPath",
+ "type": "String",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "content",
+ "type": "String",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "overwrite",
+ "type": "Boolean",
+ "description": "Default = true",
+ "required": false
+ }
+ ],
+ "example_query": "mutation saveFile( $in: String!, $parentPath: String, $name: String!, $content: String, $overwrite: Boolean ) { saveFile( in: $in, parentPath: $parentPath, name: $name, content: $content, overwrite: $overwrite ) }",
+ "example_variables": "{ \"in\": \"abc123\", \"parentPath\": \"xyz789\", \"name\": \"abc123\", \"content\": \"abc123\", \"overwrite\": true }",
+ "example_response": "{\"data\": {\"saveFile\": false}}"
+ },
+ {
+ "name": "saveUIFile",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "in",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "parentPath",
+ "type": "String",
+ "description": "Default = \"/\"",
+ "required": false
+ },
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "content",
+ "type": "String",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation saveUIFile( $in: String!, $parentPath: String, $name: String!, $content: String ) { saveUIFile( in: $in, parentPath: $parentPath, name: $name, content: $content ) }",
+ "example_variables": "{ \"in\": \"abc123\", \"parentPath\": \"/\", \"name\": \"abc123\", \"content\": \"xyz789\" }",
+ "example_response": "{\"data\": {\"saveUIFile\": false}}"
+ },
+ {
+ "name": "setContent",
+ "type": "mutation",
+ "description": "replace the content of an asset the Asset must be checked out",
+ "response_type": "an Asset!",
+ "arguments": [
+ {
+ "name": "file",
+ "type": "Upload",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "on",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation setContent( $file: Upload, $on: ID! ) { setContent( file: $file, on: $on ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } trashDate trashUser { ...UserFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } status approvalSummary approvalStatus { ...ApprovalActivityStatusFragment } approvals { ...ApprovalCycleFragment } workflowName isAlias processes { ...ProcessFragment } uuid priority isCheckedOut checkedOutBy { ...UserFragment } privateWorkingRevision isArchived archiveId colorSpace { ...ColorSpaceFragment } viewingCondition { ...ViewingConditionFragment } project { ...ProjectFragment } parents { ...ContainerFragment } numberOfRevisions expirationDate medias { ...MediaFragment } notes { ...NoteFragment } relationFrom { ...RelationFragment } relationTo { ...RelationFragment } accessControls } }",
+ "example_variables": "{\"file\": Upload, \"on\": 4}",
+ "example_response": "{ \"data\": { \"setContent\": { \"id\": \"4\", \"name\": \"xyz789\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"trashDate\": \"2007-12-03T10:15:30Z\", \"trashUser\": User, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"status\": [\"ACTIVE\"], \"approvalSummary\": \"NONE\", \"approvalStatus\": [ApprovalActivityStatus], \"approvals\": [ApprovalCycle], \"workflowName\": \"xyz789\", \"isAlias\": false, \"processes\": [Process], \"uuid\": \"xyz789\", \"priority\": 987, \"isCheckedOut\": false, \"checkedOutBy\": User, \"privateWorkingRevision\": 987, \"isArchived\": false, \"archiveId\": 4, \"colorSpace\": ColorSpace, \"viewingCondition\": ViewingCondition, \"project\": Project, \"parents\": [Container], \"numberOfRevisions\": 123, \"expirationDate\": \"2007-12-03T10:15:30Z\", \"medias\": [Media], \"notes\": [Note], \"relationFrom\": [Relation], \"relationTo\": [Relation], \"accessControls\": {} } } }"
+ },
+ {
+ "name": "setCorsSetting",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a CorsSetting!",
+ "arguments": [
+ {
+ "name": "setup",
+ "type": "iCorsSetup",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation setCorsSetting($setup: iCorsSetup) { setCorsSetting(setup: $setup) { enableCors allowedOrigins allowedMethods allowedHeaders exposedHeaders preflightMaxAge } }",
+ "example_variables": "{\"setup\": iCorsSetup}",
+ "example_response": "{ \"data\": { \"setCorsSetting\": { \"enableCors\": true, \"allowedOrigins\": [\"xyz789\"], \"allowedMethods\": [\"xyz789\"], \"allowedHeaders\": [\"xyz789\"], \"exposedHeaders\": [\"abc123\"], \"preflightMaxAge\": 987 } } }"
+ },
+ {
+ "name": "setLogLevel",
+ "type": "mutation",
+ "description": "Set the server log level",
+ "response_type": "a LogLevel!",
+ "arguments": [
+ {
+ "name": "level",
+ "type": "LogLevel",
+ "description": "The log level to set",
+ "required": false
+ }
+ ],
+ "example_query": "mutation setLogLevel($level: LogLevel) { setLogLevel(level: $level) }",
+ "example_variables": "{\"level\": \"ALL\"}",
+ "example_response": "{\"data\": {\"setLogLevel\": \"ALL\"}}"
+ },
+ {
+ "name": "setLogQueries",
+ "type": "mutation",
+ "description": "To enable or disable the log of queries",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "logQueries",
+ "type": "Boolean!",
+ "description": "true = activate false = deactivate",
+ "required": true
+ }
+ ],
+ "example_query": "mutation setLogQueries($logQueries: Boolean!) { setLogQueries(logQueries: $logQueries) }",
+ "example_variables": "{\"logQueries\": false}",
+ "example_response": "{\"data\": {\"setLogQueries\": true}}"
+ },
+ {
+ "name": "setMaxQueryComplexity",
+ "type": "mutation",
+ "description": "",
+ "response_type": "an Int!",
+ "arguments": [
+ {
+ "name": "value",
+ "type": "Int!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation setMaxQueryComplexity($value: Int!) { setMaxQueryComplexity(value: $value) }",
+ "example_variables": "{\"value\": 987}",
+ "example_response": "{\"data\": {\"setMaxQueryComplexity\": 987}}"
+ },
+ {
+ "name": "setMaxQuerySize",
+ "type": "mutation",
+ "description": "",
+ "response_type": "an Int!",
+ "arguments": [
+ {
+ "name": "value",
+ "type": "Int!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation setMaxQuerySize($value: Int!) { setMaxQuerySize(value: $value) }",
+ "example_variables": "{\"value\": 987}",
+ "example_response": "{\"data\": {\"setMaxQuerySize\": 123}}"
+ },
+ {
+ "name": "setMaxTopLevelFieldCount",
+ "type": "mutation",
+ "description": "",
+ "response_type": "an Int!",
+ "arguments": [
+ {
+ "name": "value",
+ "type": "Int!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation setMaxTopLevelFieldCount($value: Int!) { setMaxTopLevelFieldCount(value: $value) }",
+ "example_variables": "{\"value\": 987}",
+ "example_response": "{\"data\": {\"setMaxTopLevelFieldCount\": 987}}"
+ },
+ {
+ "name": "setProperties",
+ "type": "mutation",
+ "description": "To set propert-y-ies",
+ "response_type": "[ConfigProperty!]",
+ "arguments": [
+ {
+ "name": "properties",
+ "type": "[iConfigProperty!]!",
+ "description": "One or many definition of configuration properties",
+ "required": true
+ }
+ ],
+ "example_query": "mutation setProperties($properties: [iConfigProperty!]!) { setProperties(properties: $properties) { id category name value } }",
+ "example_variables": "{\"properties\": [iConfigProperty]}",
+ "example_response": "{ \"data\": { \"setProperties\": [ { \"id\": \"4\", \"category\": \"abc123\", \"name\": \"xyz789\", \"value\": \"abc123\" } ] } }"
+ },
+ {
+ "name": "setSecurityRoles",
+ "type": "mutation",
+ "description": "replace security roles list to a user Security Profile",
+ "response_type": "[UserSecurityProfile!]!",
+ "arguments": [
+ {
+ "name": "to",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "securityRoles",
+ "type": "[SecurityRole!]",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation setSecurityRoles( $to: [ID!]!, $securityRoles: [SecurityRole!] ) { setSecurityRoles( to: $to, securityRoles: $securityRoles ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } properties { ...SecurityPropertyFragment } securityRoles } }",
+ "example_variables": "{\"to\": [4], \"securityRoles\": [\"ADMIN\"]}",
+ "example_response": "{ \"data\": { \"setSecurityRoles\": [ { \"id\": \"4\", \"name\": \"abc123\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"properties\": [SecurityProperty], \"securityRoles\": [\"ADMIN\"] } ] } }"
+ },
+ {
+ "name": "share",
+ "type": "mutation",
+ "description": "",
+ "response_type": "[Sharing!]!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "setup",
+ "type": "iCreateSharingSetup!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation share( $id: [ID!]!, $setup: iCreateSharingSetup! ) { share( id: $id, setup: $setup ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } key hasPinCode type startDate endDate isActive owner { ...UserFragment } entities { ...PagingResponseFragment } securityProfile { ...SecurityProfileFragment } } }",
+ "example_variables": "{ \"id\": [\"4\"], \"setup\": iCreateSharingSetup }",
+ "example_response": "{ \"data\": { \"share\": [ { \"id\": \"4\", \"name\": \"abc123\", \"description\": \"abc123\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"key\": \"xyz789\", \"hasPinCode\": false, \"type\": \"xyz789\", \"startDate\": \"2007-12-03T10:15:30Z\", \"endDate\": \"2007-12-03T10:15:30Z\", \"isActive\": true, \"owner\": User, \"entities\": PagingResponse, \"securityProfile\": SecurityProfile } ] } }"
+ },
+ {
+ "name": "startFileProcess",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a Process!",
+ "arguments": [
+ {
+ "name": "workflowName",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "file",
+ "type": "Upload!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "parameters",
+ "type": "[iMetadataValue!]",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "priority",
+ "type": "Int",
+ "description": "Default = 50",
+ "required": false
+ },
+ {
+ "name": "callbackURL",
+ "type": "URL",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation startFileProcess( $workflowName: String!, $file: Upload!, $parameters: [iMetadataValue!], $priority: Int, $callbackURL: URL ) { startFileProcess( workflowName: $workflowName, file: $file, parameters: $parameters, priority: $priority, callbackURL: $callbackURL ) { id priority status virtualStatus startTime steps { ...ActivityInstanceFragment } workflow { ...WorkflowFragment } stages { ...StageFragment } object { ...EntityFragment } } }",
+ "example_variables": "{ \"workflowName\": \"xyz789\", \"file\": Upload, \"parameters\": [iMetadataValue], \"priority\": 50, \"callbackURL\": \"http://www.test.com/\" }",
+ "example_response": "{ \"data\": { \"startFileProcess\": { \"id\": 4, \"priority\": 123, \"status\": \"Created\", \"virtualStatus\": \"abc123\", \"startTime\": \"2007-12-03T10:15:30Z\", \"steps\": [ActivityInstance], \"workflow\": Workflow, \"stages\": [Stage], \"object\": Entity } } }"
+ },
+ {
+ "name": "startProcess",
+ "type": "mutation",
+ "description": "Start a workflow on an object",
+ "response_type": "[Process!]!",
+ "arguments": [
+ {
+ "name": "workflowName",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "on",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation startProcess( $workflowName: String!, $on: [ID!]! ) { startProcess( workflowName: $workflowName, on: $on ) { id priority status virtualStatus startTime steps { ...ActivityInstanceFragment } workflow { ...WorkflowFragment } stages { ...StageFragment } object { ...EntityFragment } } }",
+ "example_variables": "{ \"workflowName\": \"xyz789\", \"on\": [\"4\"] }",
+ "example_response": "{ \"data\": { \"startProcess\": [ { \"id\": \"4\", \"priority\": 123, \"status\": \"Created\", \"virtualStatus\": \"abc123\", \"startTime\": \"2007-12-03T10:15:30Z\", \"steps\": [ActivityInstance], \"workflow\": Workflow, \"stages\": [Stage], \"object\": Entity } ] } }"
+ },
+ {
+ "name": "startURLProcess",
+ "type": "mutation",
+ "description": "To start a workflow without Object",
+ "response_type": "a Process!",
+ "arguments": [
+ {
+ "name": "workflowName",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "url",
+ "type": "URL!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "parameters",
+ "type": "[iMetadataValue!]",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "priority",
+ "type": "Int",
+ "description": "Default = 50",
+ "required": false
+ },
+ {
+ "name": "callbackURL",
+ "type": "URL",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation startURLProcess( $workflowName: String!, $url: URL!, $parameters: [iMetadataValue!], $priority: Int, $callbackURL: URL ) { startURLProcess( workflowName: $workflowName, url: $url, parameters: $parameters, priority: $priority, callbackURL: $callbackURL ) { id priority status virtualStatus startTime steps { ...ActivityInstanceFragment } workflow { ...WorkflowFragment } stages { ...StageFragment } object { ...EntityFragment } } }",
+ "example_variables": "{ \"workflowName\": \"xyz789\", \"url\": \"http://www.test.com/\", \"parameters\": [iMetadataValue], \"priority\": 50, \"callbackURL\": \"http://www.test.com/\" }",
+ "example_response": "{ \"data\": { \"startURLProcess\": { \"id\": \"4\", \"priority\": 987, \"status\": \"Created\", \"virtualStatus\": \"xyz789\", \"startTime\": \"2007-12-03T10:15:30Z\", \"steps\": [ActivityInstance], \"workflow\": Workflow, \"stages\": [Stage], \"object\": Entity } } }"
+ },
+ {
+ "name": "startUserAction",
+ "type": "mutation",
+ "description": "Start a user action on one or more objects",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "on",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "parameters",
+ "type": "[iMetadataValue!]",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation startUserAction( $id: String!, $on: [ID!]!, $parameters: [iMetadataValue!] ) { startUserAction( id: $id, on: $on, parameters: $parameters ) }",
+ "example_variables": "{ \"id\": \"abc123\", \"on\": [4], \"parameters\": [iMetadataValue] }",
+ "example_response": "{\"data\": {\"startUserAction\": false}}"
+ },
+ {
+ "name": "startWebAuthnRegistration",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a WebAuthOptions!",
+ "arguments": [],
+ "example_query": "mutation startWebAuthnRegistration { startWebAuthnRegistration { sessionToken options } }",
+ "example_variables": "",
+ "example_response": "{ \"data\": { \"startWebAuthnRegistration\": { \"sessionToken\": 4, \"options\": \"xyz789\" } } }"
+ },
+ {
+ "name": "stopStartNotificationSender",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a Boolean",
+ "arguments": [],
+ "example_query": "mutation stopStartNotificationSender { stopStartNotificationSender }",
+ "example_variables": "",
+ "example_response": "{\"data\": {\"stopStartNotificationSender\": false}}"
+ },
+ {
+ "name": "submitURLProcess",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "workflowName",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "url",
+ "type": "URL!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "parameters",
+ "type": "[iMetadataValue!]",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "priority",
+ "type": "Int",
+ "description": "Default = 50",
+ "required": false
+ },
+ {
+ "name": "scaleBy",
+ "type": "ScalingType",
+ "description": "Default = Activity",
+ "required": false
+ },
+ {
+ "name": "callbackURL",
+ "type": "URL",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "mutation submitURLProcess( $workflowName: String!, $url: URL!, $parameters: [iMetadataValue!], $priority: Int, $scaleBy: ScalingType, $callbackURL: URL ) { submitURLProcess( workflowName: $workflowName, url: $url, parameters: $parameters, priority: $priority, scaleBy: $scaleBy, callbackURL: $callbackURL ) }",
+ "example_variables": "{ \"workflowName\": \"xyz789\", \"url\": \"http://www.test.com/\", \"parameters\": [iMetadataValue], \"priority\": 50, \"scaleBy\": \"Activity\", \"callbackURL\": \"http://www.test.com/\" }",
+ "example_response": "{\"data\": {\"submitURLProcess\": false}}"
+ },
+ {
+ "name": "trashObject",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation trashObject($id: [ID!]!) { trashObject(id: $id) }",
+ "example_variables": "{\"id\": [\"4\"]}",
+ "example_response": "{\"data\": {\"trashObject\": true}}"
+ },
+ {
+ "name": "unTrashAllObjects",
+ "type": "mutation",
+ "description": "Untrash all objects that have been trashed with the current user",
+ "response_type": "a Boolean!",
+ "arguments": [],
+ "example_query": "mutation unTrashAllObjects { unTrashAllObjects }",
+ "example_variables": "",
+ "example_response": "{\"data\": {\"unTrashAllObjects\": true}}"
+ },
+ {
+ "name": "unTrashObject",
+ "type": "mutation",
+ "description": "Untrash object(s)",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation unTrashObject($id: [ID!]!) { unTrashObject(id: $id) }",
+ "example_variables": "{\"id\": [\"4\"]}",
+ "example_response": "{\"data\": {\"unTrashObject\": true}}"
+ },
+ {
+ "name": "updateFileSystemVolumeDiskId",
+ "type": "mutation",
+ "description": "Update a File System Volume Disk UUID",
+ "response_type": "[FileSystemVolume!]!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation updateFileSystemVolumeDiskId($id: [ID!]!) { updateFileSystemVolumeDiskId(id: $id) { id group access reference path nfsAlias smbAlias protocol server userName port host { ...HostFragment } diskId site folderRegExp folderExclRegExp fileRegExp fileExclRegExp projectTemplate { ...ProjectTemplateFragment } monitoringQueue monitoring versioning updateMetadata monitorOnBrowse accessControlList { ...AccessControlListFragment } } }",
+ "example_variables": "{\"id\": [4]}",
+ "example_response": "{ \"data\": { \"updateFileSystemVolumeDiskId\": [ { \"id\": 4, \"group\": \"ATTACHMENT\", \"access\": \"DISABLED\", \"reference\": \"xyz789\", \"path\": \"abc123\", \"nfsAlias\": \"abc123\", \"smbAlias\": \"xyz789\", \"protocol\": \"FILE\", \"server\": \"xyz789\", \"userName\": \"abc123\", \"port\": 123, \"host\": Host, \"diskId\": \"4\", \"site\": \"xyz789\", \"folderRegExp\": \"xyz789\", \"folderExclRegExp\": \"xyz789\", \"fileRegExp\": \"xyz789\", \"fileExclRegExp\": \"abc123\", \"projectTemplate\": ProjectTemplate, \"monitoringQueue\": \"abc123\", \"monitoring\": true, \"versioning\": true, \"updateMetadata\": false, \"monitorOnBrowse\": false, \"accessControlList\": AccessControlList } ] } }"
+ },
+ {
+ "name": "uploadActivityIcon",
+ "type": "mutation",
+ "description": "upload an activity icon",
+ "response_type": "an UploadStatus!",
+ "arguments": [
+ {
+ "name": "file",
+ "type": "Upload!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "replace",
+ "type": "Boolean",
+ "description": "Default = false",
+ "required": false
+ }
+ ],
+ "example_query": "mutation uploadActivityIcon( $file: Upload!, $name: String!, $replace: Boolean ) { uploadActivityIcon( file: $file, name: $name, replace: $replace ) }",
+ "example_variables": "{ \"file\": Upload, \"name\": \"abc123\", \"replace\": false }",
+ "example_response": "{\"data\": {\"uploadActivityIcon\": \"ERROR\"}}"
+ },
+ {
+ "name": "uploadAvatar",
+ "type": "mutation",
+ "description": "Returns an UploadStatus!",
+ "response_type": "an UploadStatus!",
+ "arguments": [
+ {
+ "name": "file",
+ "type": "Upload!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "on",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation uploadAvatar( $file: Upload!, $on: ID! ) { uploadAvatar( file: $file, on: $on ) }",
+ "example_variables": "{ \"file\": Upload, \"on\": \"4\" }",
+ "example_response": "{\"data\": {\"uploadAvatar\": \"ERROR\"}}"
+ },
+ {
+ "name": "uploadFile",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "in",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "parentPath",
+ "type": "String",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "content",
+ "type": "Upload!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "overwrite",
+ "type": "Boolean",
+ "description": "Default = true",
+ "required": false
+ }
+ ],
+ "example_query": "mutation uploadFile( $in: String!, $parentPath: String, $name: String!, $content: Upload!, $overwrite: Boolean ) { uploadFile( in: $in, parentPath: $parentPath, name: $name, content: $content, overwrite: $overwrite ) }",
+ "example_variables": "{ \"in\": \"abc123\", \"parentPath\": \"abc123\", \"name\": \"abc123\", \"content\": Upload, \"overwrite\": true }",
+ "example_response": "{\"data\": {\"uploadFile\": false}}"
+ },
+ {
+ "name": "uploadIccProfile",
+ "type": "mutation",
+ "description": "",
+ "response_type": "an UploadStatus!",
+ "arguments": [
+ {
+ "name": "file",
+ "type": "Upload!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation uploadIccProfile($file: Upload!) { uploadIccProfile(file: $file) }",
+ "example_variables": "{\"file\": Upload}",
+ "example_response": "{\"data\": {\"uploadIccProfile\": \"ERROR\"}}"
+ },
+ {
+ "name": "uploadImportFile",
+ "type": "mutation",
+ "description": "**Upload the given file in the imported files",
+ "response_type": "an UploadStatus!",
+ "arguments": [
+ {
+ "name": "file",
+ "type": "Upload!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation uploadImportFile($file: Upload!) { uploadImportFile(file: $file) }",
+ "example_variables": "{\"file\": Upload}",
+ "example_response": "{\"data\": {\"uploadImportFile\": \"ERROR\"}}"
+ },
+ {
+ "name": "uploadOn",
+ "type": "mutation",
+ "description": "to upload on a specific Asset : temporary",
+ "response_type": "an Asset",
+ "arguments": [
+ {
+ "name": "file",
+ "type": "Upload",
+ "description": "",
+ "required": false
+ },
+ {
+ "name": "on",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation uploadOn( $file: Upload, $on: ID! ) { uploadOn( file: $file, on: $on ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } trashDate trashUser { ...UserFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } status approvalSummary approvalStatus { ...ApprovalActivityStatusFragment } approvals { ...ApprovalCycleFragment } workflowName isAlias processes { ...ProcessFragment } uuid priority isCheckedOut checkedOutBy { ...UserFragment } privateWorkingRevision isArchived archiveId colorSpace { ...ColorSpaceFragment } viewingCondition { ...ViewingConditionFragment } project { ...ProjectFragment } parents { ...ContainerFragment } numberOfRevisions expirationDate medias { ...MediaFragment } notes { ...NoteFragment } relationFrom { ...RelationFragment } relationTo { ...RelationFragment } accessControls } }",
+ "example_variables": "{\"file\": Upload, \"on\": 4}",
+ "example_response": "{ \"data\": { \"uploadOn\": { \"id\": 4, \"name\": \"xyz789\", \"description\": \"xyz789\", \"lastModificationDate\": \"2007-12-03T10:15:30Z\", \"lastModificationUser\": User, \"creationDate\": \"2007-12-03T10:15:30Z\", \"creationUser\": User, \"trashDate\": \"2007-12-03T10:15:30Z\", \"trashUser\": User, \"metadatas\": [MetadataValue], \"metadataProperties\": [MetadataValue], \"status\": [\"ACTIVE\"], \"approvalSummary\": \"NONE\", \"approvalStatus\": [ApprovalActivityStatus], \"approvals\": [ApprovalCycle], \"workflowName\": \"abc123\", \"isAlias\": true, \"processes\": [Process], \"uuid\": \"xyz789\", \"priority\": 123, \"isCheckedOut\": false, \"checkedOutBy\": User, \"privateWorkingRevision\": 123, \"isArchived\": true, \"archiveId\": \"4\", \"colorSpace\": ColorSpace, \"viewingCondition\": ViewingCondition, \"project\": Project, \"parents\": [Container], \"numberOfRevisions\": 987, \"expirationDate\": \"2007-12-03T10:15:30Z\", \"medias\": [Media], \"notes\": [Note], \"relationFrom\": [Relation], \"relationTo\": [Relation], \"accessControls\": {} } } }"
+ },
+ {
+ "name": "uploadOnMilestone",
+ "type": "mutation",
+ "description": "To upload on a Milestone",
+ "response_type": "an UploadStatus",
+ "arguments": [
+ {
+ "name": "file",
+ "type": "Upload!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "on",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "stepId",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation uploadOnMilestone( $file: Upload!, $on: ID!, $stepId: ID! ) { uploadOnMilestone( file: $file, on: $on, stepId: $stepId ) }",
+ "example_variables": "{ \"file\": Upload, \"on\": \"4\", \"stepId\": \"4\" }",
+ "example_response": "{\"data\": {\"uploadOnMilestone\": \"ERROR\"}}"
+ },
+ {
+ "name": "uploadOrganizationLogo",
+ "type": "mutation",
+ "description": "Returns an UploadStatus!",
+ "response_type": "an UploadStatus!",
+ "arguments": [
+ {
+ "name": "file",
+ "type": "Upload!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "on",
+ "type": "ID!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation uploadOrganizationLogo( $file: Upload!, $on: ID! ) { uploadOrganizationLogo( file: $file, on: $on ) }",
+ "example_variables": "{\"file\": Upload, \"on\": 4}",
+ "example_response": "{\"data\": {\"uploadOrganizationLogo\": \"ERROR\"}}"
+ },
+ {
+ "name": "uploadUIFile",
+ "type": "mutation",
+ "description": "",
+ "response_type": "a Boolean!",
+ "arguments": [
+ {
+ "name": "in",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "parentPath",
+ "type": "String",
+ "description": "Default = \"/\"",
+ "required": false
+ },
+ {
+ "name": "name",
+ "type": "String!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "content",
+ "type": "Upload!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation uploadUIFile( $in: String!, $parentPath: String, $name: String!, $content: Upload! ) { uploadUIFile( in: $in, parentPath: $parentPath, name: $name, content: $content ) }",
+ "example_variables": "{ \"in\": \"abc123\", \"parentPath\": \"/\", \"name\": \"xyz789\", \"content\": Upload }",
+ "example_response": "{\"data\": {\"uploadUIFile\": false}}"
+ },
+ {
+ "name": "uploadUserActionIcon",
+ "type": "mutation",
+ "description": "** Upload a user action icon**",
+ "response_type": "an UploadStatus!",
+ "arguments": [
+ {
+ "name": "file",
+ "type": "Upload!",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "on",
+ "type": "[ID!]!",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "mutation uploadUserActionIcon( $file: Upload!, $on: [ID!]! ) { uploadUserActionIcon( file: $file, on: $on ) }",
+ "example_variables": "{ \"file\": Upload, \"on\": [\"4\"] }",
+ "example_response": "{\"data\": {\"uploadUserActionIcon\": \"ERROR\"}}"
+ },
+ {
+ "name": "assetChange",
+ "type": "subscription",
+ "description": "",
+ "response_type": "an AssetEvent",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "types",
+ "type": "[EntityEventType!]",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "subscription assetChange( $id: [ID!], $types: [EntityEventType!] ) { assetChange( id: $id, types: $types ) { id type object { ...AssetFragment } } }",
+ "example_variables": "{\"id\": [\"4\"], \"types\": [\"OBJECT_EDITED\"]}",
+ "example_response": "{ \"data\": { \"assetChange\": { \"id\": \"4\", \"type\": \"OBJECT_EDITED\", \"object\": Asset } } }"
+ },
+ {
+ "name": "authenticationChanged",
+ "type": "subscription",
+ "description": "",
+ "response_type": "an AuthenticationEvent",
+ "arguments": [],
+ "example_query": "subscription authenticationChanged { authenticationChanged { id type object { ...AuthenticationFragment } } }",
+ "example_variables": "",
+ "example_response": "{ \"data\": { \"authenticationChanged\": { \"id\": \"4\", \"type\": \"OBJECT_EDITED\", \"object\": Authentication } } }"
+ },
+ {
+ "name": "collectionChange",
+ "type": "subscription",
+ "description": "",
+ "response_type": "a CollectionEvent",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "types",
+ "type": "[EntityEventType!]",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "subscription collectionChange( $id: [ID!], $types: [EntityEventType!] ) { collectionChange( id: $id, types: $types ) { id type object { ...CollectionFragment } } }",
+ "example_variables": "{\"id\": [\"4\"], \"types\": [\"OBJECT_EDITED\"]}",
+ "example_response": "{ \"data\": { \"collectionChange\": { \"id\": \"4\", \"type\": \"OBJECT_EDITED\", \"object\": Collection } } }"
+ },
+ {
+ "name": "dummy",
+ "type": "subscription",
+ "description": "",
+ "response_type": "a Boolean",
+ "arguments": [],
+ "example_query": "subscription dummy { dummy }",
+ "example_variables": "",
+ "example_response": "{\"data\": {\"dummy\": true}}"
+ },
+ {
+ "name": "folderChange",
+ "type": "subscription",
+ "description": "",
+ "response_type": "a FolderEvent",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "types",
+ "type": "[EntityEventType!]",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "subscription folderChange( $id: [ID!], $types: [EntityEventType!] ) { folderChange( id: $id, types: $types ) { id type object { ...FolderFragment } } }",
+ "example_variables": "{\"id\": [\"4\"], \"types\": [\"OBJECT_EDITED\"]}",
+ "example_response": "{ \"data\": { \"folderChange\": { \"id\": 4, \"type\": \"OBJECT_EDITED\", \"object\": Folder } } }"
+ },
+ {
+ "name": "mediaChange",
+ "type": "subscription",
+ "description": "",
+ "response_type": "a MediaEvent",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "types",
+ "type": "[EntityEventType!]",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "subscription mediaChange( $id: [ID!], $types: [EntityEventType!] ) { mediaChange( id: $id, types: $types ) { id type object { ...MediaFragment } } }",
+ "example_variables": "{\"id\": [4], \"types\": [\"OBJECT_EDITED\"]}",
+ "example_response": "{ \"data\": { \"mediaChange\": { \"id\": \"4\", \"type\": \"OBJECT_EDITED\", \"object\": Media } } }"
+ },
+ {
+ "name": "noteChange",
+ "type": "subscription",
+ "description": "",
+ "response_type": "an OldNoteEvent",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "types",
+ "type": "[NoteEventType!]",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "subscription noteChange( $id: [ID!], $types: [NoteEventType!] ) { noteChange( id: $id, types: $types ) { id type note { ...NoteFragment } object { ...EntityFragment } } }",
+ "example_variables": "{\"id\": [\"4\"], \"types\": [\"NOTE_CREATED\"]}",
+ "example_response": "{ \"data\": { \"noteChange\": { \"id\": \"4\", \"type\": \"NOTE_CREATED\", \"note\": Note, \"object\": Entity } } }"
+ },
+ {
+ "name": "notificationSender",
+ "type": "subscription",
+ "description": "",
+ "response_type": "a SenderEvent",
+ "arguments": [],
+ "example_query": "subscription notificationSender { notificationSender { id timeStamp type } }",
+ "example_variables": "",
+ "example_response": "{ \"data\": { \"notificationSender\": { \"id\": \"4\", \"timeStamp\": \"2007-12-03T10:15:30Z\", \"type\": \"NOTIFICATION_SENDER\" } } }"
+ },
+ {
+ "name": "processChanged",
+ "type": "subscription",
+ "description": "",
+ "response_type": "a ProcessEvent!",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "omitSystemProcess",
+ "type": "Boolean",
+ "description": "Default = true",
+ "required": false
+ }
+ ],
+ "example_query": "subscription processChanged( $id: [ID!], $omitSystemProcess: Boolean ) { processChanged( id: $id, omitSystemProcess: $omitSystemProcess ) { type previousStatus newStatus processId stepId stepName workflowEngineId } }",
+ "example_variables": "{\"id\": [\"4\"], \"omitSystemProcess\": true}",
+ "example_response": "{ \"data\": { \"processChanged\": { \"type\": \"PROCESS_STATUS\", \"previousStatus\": \"Created\", \"newStatus\": \"Created\", \"processId\": \"4\", \"stepId\": \"4\", \"stepName\": \"xyz789\", \"workflowEngineId\": \"abc123\" } } }"
+ },
+ {
+ "name": "projectChange",
+ "type": "subscription",
+ "description": "",
+ "response_type": "a ProjectEvent",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "types",
+ "type": "[EntityEventType!]",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "subscription projectChange( $id: [ID!], $types: [EntityEventType!] ) { projectChange( id: $id, types: $types ) { id type object { ...ProjectFragment } } }",
+ "example_variables": "{\"id\": [4], \"types\": [\"OBJECT_EDITED\"]}",
+ "example_response": "{ \"data\": { \"projectChange\": { \"id\": 4, \"type\": \"OBJECT_EDITED\", \"object\": Project } } }"
+ },
+ {
+ "name": "projectFolderChange",
+ "type": "subscription",
+ "description": "",
+ "response_type": "a ProjectFolderEvent",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "types",
+ "type": "[EntityEventType!]",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "subscription projectFolderChange( $id: [ID!], $types: [EntityEventType!] ) { projectFolderChange( id: $id, types: $types ) { id type object { ...ProjectFolderFragment } } }",
+ "example_variables": "{\"id\": [4], \"types\": [\"OBJECT_EDITED\"]}",
+ "example_response": "{ \"data\": { \"projectFolderChange\": { \"id\": \"4\", \"type\": \"OBJECT_EDITED\", \"object\": ProjectFolder } } }"
+ },
+ {
+ "name": "proofReadingMarkChange",
+ "type": "subscription",
+ "description": "",
+ "response_type": "a ProofReadingMarkEvent",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "types",
+ "type": "[EntityEventType!]",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "subscription proofReadingMarkChange( $id: [ID!], $types: [EntityEventType!] ) { proofReadingMarkChange( id: $id, types: $types ) { id type object { ...ProofReadingMarkFragment } } }",
+ "example_variables": "{\"id\": [4], \"types\": [\"OBJECT_EDITED\"]}",
+ "example_response": "{ \"data\": { \"proofReadingMarkChange\": { \"id\": 4, \"type\": \"OBJECT_EDITED\", \"object\": ProofReadingMark } } }"
+ },
+ {
+ "name": "reIndexAll",
+ "type": "subscription",
+ "description": "",
+ "response_type": "a ProgressEvent",
+ "arguments": [],
+ "example_query": "subscription reIndexAll { reIndexAll { total current percent } }",
+ "example_variables": "",
+ "example_response": "{\"data\": {\"reIndexAll\": {\"total\": {}, \"current\": {}, \"percent\": 987.65}}}"
+ },
+ {
+ "name": "smartCollectionChange",
+ "type": "subscription",
+ "description": "",
+ "response_type": "a SmartCollectionEvent",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "types",
+ "type": "[EntityEventType!]",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "subscription smartCollectionChange( $id: [ID!], $types: [EntityEventType!] ) { smartCollectionChange( id: $id, types: $types ) { id type object { ...SmartCollectionFragment } } }",
+ "example_variables": "{\"id\": [4], \"types\": [\"OBJECT_EDITED\"]}",
+ "example_response": "{ \"data\": { \"smartCollectionChange\": { \"id\": \"4\", \"type\": \"OBJECT_EDITED\", \"object\": SmartCollection } } }"
+ },
+ {
+ "name": "userActionChange",
+ "type": "subscription",
+ "description": "",
+ "response_type": "an OldUserActionEvent",
+ "arguments": [],
+ "example_query": "subscription userActionChange { userActionChange { id type sources { ...EntityFragment } results { ...EntityFragment } } }",
+ "example_variables": "",
+ "example_response": "{ \"data\": { \"userActionChange\": { \"id\": \"4\", \"type\": \"USERACTION_STARTED\", \"sources\": [Entity], \"results\": [Entity] } } }"
+ },
+ {
+ "name": "userChange",
+ "type": "subscription",
+ "description": "",
+ "response_type": "a UserEvent",
+ "arguments": [],
+ "example_query": "subscription userChange { userChange { id type object { ...UserFragment } } }",
+ "example_variables": "",
+ "example_response": "{ \"data\": { \"userChange\": { \"id\": \"4\", \"type\": \"OBJECT_EDITED\", \"object\": User } } }"
+ },
+ {
+ "name": "whenNoteChange",
+ "type": "subscription",
+ "description": "",
+ "response_type": "a NoteEvent",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "types",
+ "type": "[NoteEventType!]",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "subscription whenNoteChange( $id: [ID!], $types: [NoteEventType!] ) { whenNoteChange( id: $id, types: $types ) { id timeStamp type entityId entityType noteId params } }",
+ "example_variables": "{\"id\": [4], \"types\": [\"NOTE_CREATED\"]}",
+ "example_response": "{ \"data\": { \"whenNoteChange\": { \"id\": 4, \"timeStamp\": \"2007-12-03T10:15:30Z\", \"type\": \"NOTE_CREATED\", \"entityId\": \"4\", \"entityType\": \"Asset\", \"noteId\": \"4\", \"params\": {} } } }"
+ },
+ {
+ "name": "whenObjectChange",
+ "type": "subscription",
+ "description": "ParentId only works with CREATE_OBJECT EntityEventType and not on Media and User EntityTypes",
+ "response_type": "an EntityEvent",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "types",
+ "type": "[EntityEventType!]",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "entityTypes",
+ "type": "[EntityType!]",
+ "description": "",
+ "required": true
+ },
+ {
+ "name": "parentId",
+ "type": "ID",
+ "description": "",
+ "required": false
+ }
+ ],
+ "example_query": "subscription whenObjectChange( $id: [ID!], $types: [EntityEventType!], $entityTypes: [EntityType!], $parentId: ID ) { whenObjectChange( id: $id, types: $types, entityTypes: $entityTypes, parentId: $parentId ) { id type timeStamp entityId entityType } }",
+ "example_variables": "{ \"id\": [\"4\"], \"types\": [\"OBJECT_EDITED\"], \"entityTypes\": [\"Asset\"], \"parentId\": 4 }",
+ "example_response": "{ \"data\": { \"whenObjectChange\": { \"id\": 4, \"type\": \"OBJECT_EDITED\", \"timeStamp\": \"2007-12-03T10:15:30Z\", \"entityId\": 4, \"entityType\": \"Asset\" } } }"
+ },
+ {
+ "name": "whenStepStatusChange",
+ "type": "subscription",
+ "description": "",
+ "response_type": "a StepEvent",
+ "arguments": [
+ {
+ "name": "id",
+ "type": "[ID!]",
+ "description": "",
+ "required": true
+ }
+ ],
+ "example_query": "subscription whenStepStatusChange($id: [ID!]) { whenStepStatusChange(id: $id) { id entityId entityType timeStamp activityId activityName oldStatus status } }",
+ "example_variables": "{\"id\": [4]}",
+ "example_response": "{ \"data\": { \"whenStepStatusChange\": { \"id\": \"4\", \"entityId\": \"4\", \"entityType\": \"Asset\", \"timeStamp\": \"2007-12-03T10:15:30Z\", \"activityId\": \"4\", \"activityName\": \"abc123\", \"oldStatus\": \"abc123\", \"status\": \"abc123\" } } }"
+ },
+ {
+ "name": "whenUserActionChange",
+ "type": "subscription",
+ "description": "Events for UserActions triggered by the current user",
+ "response_type": "a UserActionEvent",
+ "arguments": [],
+ "example_query": "subscription whenUserActionChange { whenUserActionChange { id type timeStamp sourceEntityIds sourceEntityTypes resultEntityIds resultEntityTypes } }",
+ "example_variables": "",
+ "example_response": "{ \"data\": { \"whenUserActionChange\": { \"id\": 4, \"type\": \"USERACTION_STARTED\", \"timeStamp\": \"2007-12-03T10:15:30Z\", \"sourceEntityIds\": [\"4\"], \"sourceEntityTypes\": [\"Asset\"], \"resultEntityIds\": [\"4\"], \"resultEntityTypes\": [\"Asset\"] } } }"
+ },
+ {
+ "name": "whenUserChange",
+ "type": "subscription",
+ "description": "Subscribe to the changes of the current user.",
+ "response_type": "an EntityEvent",
+ "arguments": [],
+ "example_query": "subscription whenUserChange { whenUserChange { id type timeStamp entityId entityType } }",
+ "example_variables": "",
+ "example_response": "{ \"data\": { \"whenUserChange\": { \"id\": \"4\", \"type\": \"OBJECT_EDITED\", \"timeStamp\": \"2007-12-03T10:15:30Z\", \"entityId\": \"4\", \"entityType\": \"Asset\" } } }"
+ }
+ ]
+}
\ No newline at end of file
diff --git a/docs/dalim-api-index.md b/docs/dalim-api-index.md
new file mode 100644
index 0000000..d92ccc2
--- /dev/null
+++ b/docs/dalim-api-index.md
@@ -0,0 +1,675 @@
+# Dalim ES FUSiON API — Full Capability Index
+
+This file lists **all** GraphQL operations available in the Dalim ES FUSiON API.
+For detailed docs (arguments, types, examples) on actively used endpoints, see `dalim-api-reference.md`.
+
+**Total: 466 operations** — 173 Queries, 272 Mutations, 21 Subscriptions
+
+## Authentication & System
+
+### Queries
+- `whoami` — No description → `a Whoami!`
+- `serverInformation` — No description → `a ServerInformation!`
+- `authentications` — No description → `[Authentication!]!`
+- `clientApplications` — No description → `[ClientApplication!]!`
+- `getCorsSetting` — No description → `a CorsSetting!`
+- `getLogLevel` — Return the current log level → `a LogLevel!`
+- `getLogQueries` — Return if the server logs queries → `a Boolean!`
+- `getMaxQueryComplexity` — No description → `an Int!`
+- `getMaxQuerySize` — No description → `an Int!`
+- `getMaxTopLevelFieldCount` — No description → `an Int!`
+- `queryStatistics` — Return the current query' statistics → `[QueryStatistic!]!`
+- `servlets` — List all registered servlet's name → `[String!]`
+- `openDialogueConnection` — Open a Dialogue connection to a document → `a DialogueConnection!`
+- `closeDialogueConnection` — Close a Dialogue connection → `an ID!`
+- `dialogueConnections` — List open connections optionally to a single Asset with id/revision. → `[DialogueConnection!]`
+- `get2FAQRCode` — Return the Authenticator QR code → `a Stream`
+- `getSecret2FAKey` — Return the Authenticator secret key → `a String!`
+- `send2FAQRCodeByEmail` — send the Authenticator QR code to the user per email → `a Boolean`
+- `myWebAuthnRegistrations` — No description → `a WebAuthnPagingResponse!`
+- `webAuthnRegistrations` — List all Webauthn registration of all users visible by the logged one. → `a WebAuthnPagingResponse!`
+- `userConnectionById` — No description → `[UserConnection!]`
+- `userConnectionByClientId` — No description → `[UserConnection!]`
+- `userConnections` — No description → `a UserConnectionPagingResponse`
+
+### Mutations
+- `connectAs` — Enable an Admin to connect to ES as another User. The response is identical to a standard login, a new AccessToken is... → `a JSON!`
+- `disconnectAs` — When connected as another user, returns to the original login, the current token is revoked. The response is identica... → `a JSON!`
+- `createAuthentication` — No description → `an Authentication!`
+- `deleteAuthentication` — No description → `a Boolean!`
+- `editAuthentication` — No description → `an Authentication!`
+- `createClientApplication` — No description → `a ClientApplication!`
+- `deleteClientApplication` — No description → `a Boolean!`
+- `editClientApplication` — No description → `a ClientApplication!`
+- `setCorsSetting` — No description → `a CorsSetting!`
+- `setLogLevel` — Set the server log level → `a LogLevel!`
+- `setLogQueries` — To enable or disable the log of queries → `a Boolean!`
+- `setMaxQueryComplexity` — No description → `an Int!`
+- `setMaxQuerySize` — No description → `an Int!`
+- `setMaxTopLevelFieldCount` — No description → `an Int!`
+- `reset2FAKey` — No description → `a Boolean!`
+- `deleteMyWebAuthnRegistration` — No description → `a Boolean!`
+- `deleteWebAuthnRegistration` — No description → `a Boolean!`
+- `editMyWebAuthnRegistration` — No description → `a WebAuthnRegistration`
+- `editWebAuthnRegistration` — No description → `a WebAuthnRegistration`
+- `startWebAuthnRegistration` — No description → `a WebAuthOptions!`
+- `finishWebAuthnRegistration` — No description → `a Boolean!`
+- `revokeUserConnection` — No description → `a Boolean!`
+
+### Subscriptions
+- `authenticationChanged` — No description → `an AuthenticationEvent`
+- `reIndexAll` — No description → `a ProgressEvent`
+- `dummy` — No description → `a Boolean`
+
+## Users & Profiles
+
+### Queries
+- `users` — Retrieve visible users by the current logged user → `a UserPagingResponse!`
+- `userById` — Retrieve user by id → `[User!]`
+- `userPreference` — No description → `[UserPreference]`
+
+### Mutations
+- `createUser` — Create an User in the specified Organization → `a User!`
+- `changeUser` — No description → `a User!`
+- `deleteUser` — Delete one or many Users → `a Boolean!`
+- `editUser` — Edit an User → `a User!`
+- `editMyUser` — No description → `a User!`
+- `moveUser` — Move an existing User in the specified Organization → `a User!`
+- `changeMyPassword` — No description → `a Boolean!`
+- `changeMyProfile` — No description → `a JSON!`
+- `resetUserPassword` — Generate temporary password for a user, if possible an email is sent to the user with that password. The password is ... → `a String!`
+- `editUserPreference` — Edit user preferences → `[UserPreference!]!`
+- `uploadAvatar` — Returns an UploadStatus! → `an UploadStatus!`
+
+### Subscriptions
+- `userChange` — No description → `a UserEvent`
+- `whenUserChange` — Subscribe to the changes of the current user. → `an EntityEvent`
+
+## Security Profiles
+
+### Queries
+- `securityProfiles` — Retrieve SecurityProfile by filter → `a SecurityProfilePagingResponse!`
+- `securityProfileById` — Retrieve SecurityProfile by id → `[SecurityProfile!]`
+- `securityRoles` — List all SecurityRoles → `[SecurityRoleDefinition!]!`
+
+### Mutations
+- `createAdminSecurityProfile` — No description → `a UserSecurityProfile`
+- `createDefaultSecurityProfile` — No description → `a UserSecurityProfile`
+- `createUserSecurityProfile` — No description → `a UserSecurityProfile`
+- `createSecurityProfileMask` — No description → `a SecurityProfileMask`
+- `deleteSecurityProfile` — No description → `a Boolean!`
+- `editSecurityProfile` — to edit a profile → `a SecurityProfile`
+- `duplicateSecurityProfile` — to duplicate a profile → `a SecurityProfile`
+- `addProfileToUser` — Add one or many SecurityProfiles to one or many Users → `a Boolean!`
+- `removeProfileFromUser` — Remove one or many SecurityProfiles from one or many Users → `a Boolean!`
+- `putSecurityProperties` — Add security properties to a security profile (user or mask) → `[SecurityProfile!]!`
+- `removeSecurityProperties` — Remove security properties from a security profile (user or mask) → `[SecurityProfile!]!`
+- `putSecurityRoles` — Add a security roles to a user Security Profile → `[UserSecurityProfile!]!`
+- `removeSecurityRoles` — Remove security roles from a user Security Profile → `[UserSecurityProfile!]!`
+- `setSecurityRoles` — replace security roles list to a user Security Profile → `[UserSecurityProfile!]!`
+
+## Groups & Roles
+
+### Queries
+- `groups` — Retrieve visible groups by the current logged user → `a GroupPagingResponse!`
+- `groupById` — Retrieve group by id → `[Group!]`
+- `roles` — Retrieve visible roles by the current logged user → `a RolePagingResponse!`
+- `roleById` — Retrieve role by id → `[Role!]`
+
+### Mutations
+- `createGroup` — Create a Group in the specified Organization → `a Group!`
+- `deleteGroup` — Delete one or many Groups that are not System Groups → `a Boolean!`
+- `editGroup` — Edit a Group that is not a System Group → `a Group!`
+- `addUserToGroup` — Add one or many Users to one or many Groups that are not System Groups. All the Users provided will be added to each ... → `a Boolean!`
+- `removeUserFromGroup` — Remove one or many Users from one or many Groups that are not System Groups. All the Users provided will be removed f... → `a Boolean!`
+- `createRole` — Create a Role → `a Role!`
+- `deleteRole` — Delete one or many Role(s) → `a Boolean!`
+- `editRole` — Edit a Role → `a Role!`
+- `addRoleToUser` — Add one or many Role(s) to one or many User(s) → `a Boolean!`
+- `removeRoleFromUser` — Remove one or many Role(s) from one or many User(s) → `a Boolean!`
+
+## Organizations & Customers
+
+### Queries
+- `organizations` — Retrieve visible organizations by the current logged user → `an OrganizationPagingResponse!`
+- `organizationById` — No description → `[Organization!]`
+- `organizationsByFilter` — No description → `an OrganizationPagingResponse!`
+- `customers` — Retrieve Customers by filter → `a CustomerPagingResponse!`
+- `customerById` — Retrieve Customers by ID or [ID] → `[Customer!]`
+
+### Mutations
+- `createOrganization` — Create an Organization in the specified Organization → `an Organization!`
+- `deleteOrganization` — Delete one or many Organizations → `a Boolean!`
+- `editOrganization` — Edit an Organization → `an Organization!`
+- `uploadOrganizationLogo` — Returns an UploadStatus! → `an UploadStatus!`
+- `createCustomer` — Create a Customer → `a Customer!`
+- `deleteCustomer` — Delete one or many Customer(s) → `a Boolean!`
+- `editCustomer` — Edit a Customer → `a Customer!`
+- `addCustomerToGroup` — **Add one or many Customers to one group. → `a Boolean!`
+- `addCustomerToOrganization` — **Add one or many Customers to one Organization. → `a Boolean!`
+- `removeCustomerFromGroup` — Remove one or many Customers from one Group. → `a Boolean!`
+- `removeCustomerFromOrganization` — Remove one or many Customers from one Organization. → `a Boolean!`
+
+## Projects
+
+### Queries
+- `projects` — Retrieve Projects by filter → `a ProjectPagingResponse!`
+- `projectById` — Retrieve Projects by ID or [ID] → `[Project!]`
+- `projectTemplates` — Retrieve Project Templates → `a ProjectTemplateResponse!`
+- `projectTemplateById` — Retrieve Project Templates by ID or [ID] → `[ProjectTemplate!]`
+- `projectFolderById` — Returns ProjectFolders by their IDs TODO Change security role → `[ProjectFolder!]`
+- `participantsByRoleFilter` — Retrieve visible participants that can use the given role in production list → `[Participant!]`
+
+### Mutations
+- `createProject` — security role handle by the mutationFetcher itself To create a Project for a Customer with a name → `a Project!`
+- `deleteProject` — To delete a Project. By default the project is moved to the trash → `a Boolean!`
+- `renameProject` — To rename a Project with Id and newName → `a Project!`
+- `duplicateProject` — To duplicate a project → `a Project!`
+- `editProject` — To edit a Project → `[Project!]`
+- `moveProjectToCustomer` — To move one or several project(s) to a customer → `[Project!]!`
+- `createProjectFolder` — To create a ProjectFolder - Note: reusing iFoldersetup for now as iProjectFolderSetup would be identical → `a ProjectFolder!`
+- `deleteProjectFolder` — To delete a ProjectFolder. By default the ProjectFolder is moved to the trash → `a Boolean!`
+- `renameProjectFolder` — To rename a ProjectFolder → `a ProjectFolder!`
+- `editProjectFolder` — To edit a ProjectFolder → `[ProjectFolder!]`
+- `moveProjectFolder` — To move a ProjectFolder - TODO using container as return for testing. Discuss long term return type. → `[Container!]!`
+- `createProjectTemplate` — To create a ProjectTemplate → `a ProjectTemplate!`
+- `deleteProjectTemplate` — To delete a ProjectTemplate → `a Boolean!`
+- `editProjectTemplate` — To edit a ProjectTemplate → `[ProjectTemplate!]`
+- `duplicateProjectTemplate` — To duplicate a ProjectTemplate → `a ProjectTemplate!`
+- `createFolderFromProject` — To create a Folder from a Project in the selected Folder → `a Folder!`
+- `createProjectFromFolder` — To create a project from an existing filesystem Folder → `a Project!`
+
+### Subscriptions
+- `projectChange` — No description → `a ProjectEvent`
+- `projectFolderChange` — No description → `a ProjectFolderEvent`
+
+## Folders
+
+### Queries
+- `folders` — Returns the paginated list of top-level folders.Use triggerMonitoring to override volume monitorOnBrowse setting → `a FolderPagingResponse!`
+- `folderById` — Retrieve Folders by ID or [ID]. Use triggerMonitoring to override volume monitorOnBrowse setting, determining whether... → `[Folder!]`
+
+### Mutations
+- `createFolder` — To create a Folder → `a Folder!`
+- `deleteFolder` — To delete a Folder. By default the Folder is moved to the trash → `a Boolean!`
+- `renameFolder` — To rename a Folder → `a Folder!`
+- `moveFolder` — To move a Folder - TODO Return type can't be folder anymore → `[Folder!]!`
+- `editFolder` — To edit a Folder → `[Folder!]`
+
+### Subscriptions
+- `folderChange` — No description → `a FolderEvent`
+
+## Assets
+
+### Queries
+- `assets` — Retrieve Assets by filter → `an AssetPagingResponse!`
+- `assetById` — Retrieve Assets by ID or [ID] → `[Asset!]`
+- `downloadAsset` — Stream an Asset → `a Stream`
+- `downloadAssetWithNotes` — Download one Asset or a .zip of several Assets with notes translated to PDF annotations → `a Stream`
+- `streamAttachment` — No description → `a Stream`
+- `streamFile` — Stream a subFile of an Asset → `a Stream`
+
+### Mutations
+- `createAsset` — To create an Asset. → `an AssetCreationStatus!`
+- `deleteAsset` — To delete an Asset. By default the Asset is moved to the trash → `a Boolean!`
+- `renameAsset` — Not yet implemented : To rename an Asset with Id newName is used to rename the asset → `an Asset!`
+- `moveAsset` — Move one or several Asset(s) into a Folder or a Project → `a Boolean!`
+- `editAsset` — To edit an Asset → `[Asset!]`
+- `checkOutAsset` — To checkOut the Asset(s) with Id or Ids → `[Asset!]`
+- `checkInAsset` — To checkin a new version of an Asset → `an Asset!`
+- `cancelCheckOutAsset` — To cancel the checkout of an Asset → `[Asset!]`
+- `copyAssetToFolder` — Duplicate an asset. WARNING It is not currently possible to copy an asset between two ProjectFolders in the same Proj... → `[Asset!]!`
+- `createAssetAlias` — To create an Asset alias where 'id' is the Asset ID and 'to' defines a project or a project subfolder ID → `a Boolean!`
+- `removeAssetAlias` — To remove an Asset alias where 'id' is the Asset ID and 'from' defines a project or a project subfold... → `a Boolean!`
+- `mergeAsset` — Merge Assets with their revisions → `an Asset!`
+- `reprocessAsset` — Reprocess an asset's workflow → `[Process!]!`
+- `editRevision` — Edit revision in an asset → `an Asset!`
+- `editInk` — This is to edit the opacity of the inks of a Asset/Revision or Media → `a Media!`
+- `uploadFile` — No description → `a Boolean!`
+- `uploadOn` — to upload on a specific Asset : temporary → `an Asset`
+- `uploadOnMilestone` — To upload on a Milestone → `an UploadStatus`
+
+### Subscriptions
+- `assetChange` — No description → `an AssetEvent`
+- `mediaChange` — No description → `a MediaEvent`
+
+## Collections
+
+### Queries
+- `collections` — Returns the paginated list of top-level collections. → `a CollectionPagingResponse!`
+- `collectionById` — Retrieve Collections by ID or [ID] → `[Collection!]`
+- `anyCollections` — Returns the paginated list of any top-level collections (Smart Collections and Collections). → `an AnyCollectionPagingResponse!`
+- `smartCollections` — Returns the paginated list of smart collections. → `a SmartCollectionPagingResponse!`
+- `smartCollectionById` — Retrieve Smart Collection by ID or [ID] → `[SmartCollection!]`
+
+### Mutations
+- `createCollection` — To create a Collection → `a Collection!`
+- `deleteCollection` — To delete a Collection. By default the Collection is moved to the trash → `a Boolean!`
+- `renameCollection` — To rename a Collection → `a Collection!`
+- `editCollection` — To edit a Collection → `[Collection!]`
+- `addObjectToCollection` — To add an object in a Collection → `a Boolean!`
+- `removeObjectFromCollection` — To remove an object from a Collection → `a Boolean!`
+- `moveCollection` — To move a Collection → `[Collection!]!`
+- `moveObjectFromCollectionToCollection` — To move an object from one collection to another one → `a Boolean!`
+- `createSmartCollection` — To create a SmartCollection → `a SmartCollection!`
+- `deleteSmartCollection` — To delete a SmartCollection. By default the SmartCollection is moved to the trash → `a Boolean!`
+- `editSmartCollection` — To edit a SmartCollection → `[SmartCollection!]`
+- `renameSmartCollection` — To rename a SmartCollection → `a SmartCollection!`
+
+### Subscriptions
+- `collectionChange` — No description → `a CollectionEvent`
+- `smartCollectionChange` — No description → `a SmartCollectionEvent`
+
+## Search & Filters
+
+### Queries
+- `search` — No description → `a SearchResponse`
+- `searchBySmartCollection` — No description → `a SearchResponse`
+- `entityByPath` — No description → `[EntityPath!]`
+- `dumpText` — Dump the text contained in the document → `[TextPage!]`
+- `namedSearchFilters` — No description → `[NamedSearchFilter!]!`
+- `namedSearchFilterById` — No description → `[NamedSearchFilter!]!`
+- `namedSearchFilterByName` — No description → `[NamedSearchFilter!]!`
+
+### Mutations
+- `createNamedSearchFilter` — No description → `a NamedSearchFilter!`
+- `editNamedSearchFilter` — No description → `a NamedSearchFilter!`
+
+## Approvals
+
+### Queries
+- `approvals` — Retrieve objects to approve by the current logged user → `an ApprovalPagingResponse!`
+- `approvalsByUser` — Retrieve objects to approve for a specific user → `an ApprovalPagingResponse!`
+
+### Mutations
+- `approve` — No description → `a Boolean!`
+- `approveObject` — No description → `a Boolean!`
+- `reject` — No description → `a Boolean!`
+- `rejectObject` — No description → `a Boolean!`
+
+## Workflows & Processes
+
+### Queries
+- `workflows` — Retrieve Workflows by filter → `a WorkflowPagingResponse!`
+- `workflowsById` — Retrieve Workflows by ID or [ID] → `[Workflow!]`
+- `workflowsByName` — Retrieve Workflows by name or [name] When revision is not defined returns the current revision, when revision is 0 re... → `[Workflow!]`
+- `workflowsByEntity` — No description → `[Workflow!]`
+- `workflowEngine` — Retrieve Workflow Engine infos → `a WorkflowEngine!`
+- `processes` — Retrieve Processes by filter → `a ProcessPagingResponse!`
+- `processById` — Retrieve Processes by ID or [ID] → `[Process!]`
+- `processMonitoring` — Workflow activity → `a MonitoringPagingResponse!`
+
+### Mutations
+- `createWorkflow` — Worflow creation → `a Workflow!`
+- `deleteWorkflow` — Workflow deletion : to delete a workflow with entityId 0 → `a Boolean!`
+- `editWorkflow` — createWorkflowRevision(name:String!): Workflow! @security(role:ADMIN_WORKFLOW) To define the current revision of a Wo... → `a Workflow!`
+- `duplicateWorkflow` — deleteWorkflowRevision(name:String! revision:Int!):Boolean! @security(role:ADMIN_WORKFLOW) Workflow duplication in ca... → `a Workflow!`
+- `editWorkflowEngineCapacity` — Edit capacity of a Workflow Engine → `a Boolean!`
+- `cancelProcess` — To cancel a workflow → `[Process!]!`
+- `deleteProcess` — To delete a Process → `a Boolean!`
+- `changeProcessPriority` — To change the priority of a workflow → `[Process!]!`
+- `startProcess` — Start a workflow on an object → `[Process!]!`
+- `startFileProcess` — No description → `a Process!`
+- `startURLProcess` — To start a workflow without Object → `a Process!`
+- `submitURLProcess` — No description → `a Boolean!`
+- `restartProcess` — Restart a workflow on an object from an activity → `[Process!]!`
+- `restartActivity` — Restart a workflow on an object from an activity → `[Process!]!`
+
+### Subscriptions
+- `processChanged` — No description → `a ProcessEvent!`
+
+## Notes & Annotations
+
+### Queries
+- `getNotes` — Returns [Note]! → `[Note]!`
+- `noteReport` — **Generate a Report for one or several Asset(s) ** → `a Stream`
+- `annotationStatuses` — No description → `[AnnotationStatus!]`
+- `annotationStatusById` — No description → `[AnnotationStatus!]`
+- `proofReadingMarks` — Returns a ProofReadingMarkPagingResponse! → `a ProofReadingMarkPagingResponse!`
+- `proofReadingMarksById` — Returns [ProofReadingMark!] → `[ProofReadingMark!]`
+- `myProofReadingMarks` — Returns a ProofReadingMarkPagingResponse! → `a ProofReadingMarkPagingResponse!`
+- `myProofReadingMarksById` — Returns [ProofReadingMark!] → `[ProofReadingMark!]`
+
+### Mutations
+- `createNote` — Returns [Note!]! → `[Note!]!`
+- `deleteNote` — Returns a Boolean! → `a Boolean!`
+- `editNote` — Returns a Note! → `a Note!`
+- `replyToNote` — rank : The rank of the reply. This allows to insert a reply at a certain rank, provided a reply with this rank alread... → `a Note!`
+- `editReplyOfNote` — Returns a Note! → `a Note!`
+- `deleteReplyOfNote` — Returns a Note! → `a Note!`
+- `addNoteAttachment` — If a rank is specified the attachment will be added to the reply of the given rank If an attachment ID is specified, ... → `a Note!`
+- `removeNoteAttachment` — Returns a Boolean! → `a Boolean!`
+- `createAnnotationStatus` — Returns an AnnotationStatus! → `an AnnotationStatus!`
+- `deleteAnnotationStatus` — Returns a Boolean → `a Boolean`
+- `editAnnotationStatus` — Returns an AnnotationStatus! → `an AnnotationStatus!`
+- `createGlobalProofReadingMark` — Returns a Boolean! → `a Boolean!`
+- `createPrivateProofReadingMark` — Returns a Boolean! → `a Boolean!`
+- `deleteAnyProofReadingMark` — Returns a Boolean! → `a Boolean!`
+- `deleteMyProofReadingMark` — Returns a Boolean! → `a Boolean!`
+- `editGlobalProofReadingMark` — Returns a Boolean! → `a Boolean!`
+- `editPrivateProofReadingmark` — Returns a Boolean! → `a Boolean!`
+
+### Subscriptions
+- `noteChange` — No description → `an OldNoteEvent`
+- `whenNoteChange` — No description → `a NoteEvent`
+- `proofReadingMarkChange` — No description → `a ProofReadingMarkEvent`
+
+## Notifications
+
+### Queries
+- `notifications` — Retrieve the notifications of a given type → `[Notification!]`
+- `userNotifications` — Retrieve the notifications of the current user → `[Notification!]`
+- `notificationTemplates` — No description → `a NotificationTemplatePagingResponse!`
+- `notificationTemplateById` — No description → `[NotificationTemplate!]`
+
+### Mutations
+- `createNotificationTemplate` — No description → `a NotificationTemplate!`
+- `deleteNotificationTemplate` — The default ones cannot be deleted → `a Boolean!`
+- `editNotificationTemplate` — No description → `a NotificationTemplate!`
+- `editNotifications` — No description → `[Notification!]`
+- `disableNotifications` — for the current user → `a Boolean!`
+- `enableNotifications` — No description → `a Boolean!`
+- `stopStartNotificationSender` — No description → `a Boolean`
+- `markAsSeen` — Returns a Boolean! → `a Boolean!`
+- `resendMail` — not yet implemented → `a Boolean!`
+
+### Subscriptions
+- `notificationSender` — No description → `a SenderEvent`
+
+## Sharing
+
+### Queries
+- `getSharing` — to retrieve the current sharing when logged in from a sharing key → `a Sharing`
+- `sharingById` — No description → `[Sharing!]`
+- `sharingByUser` — here Name or ID for the users? → `a SharingResponse!`
+- `sharings` — No description → `a SharingResponse!`
+- `mySharing` — No description → `a SharingResponse!`
+
+### Mutations
+- `deleteSharing` — No description → `a Boolean!`
+- `deleteMySharing` — No description → `a Boolean!`
+- `editSharing` — No description → `a Sharing!`
+- `editMySharing` — No description → `a Sharing!`
+- `share` — No description → `[Sharing!]!`
+
+## Email & Output Channels
+
+### Queries
+- `emailTemplates` — Returns an EmailTemplatePagingResponse! → `an EmailTemplatePagingResponse!`
+- `emailTemplateById` — No description → `[EmailTemplate!]`
+- `outputChannelGroups` — Get output channel groups → `an OutputChannelGroupPagingResponse!`
+- `outputChannelGroupById` — Get output channel group(s) based on ID → `[OutputChannelGroup!]!`
+- `outputChannelById` — Get output channel(s) based on ID → `[OutputChannel!]!`
+
+### Mutations
+- `createEmailTemplate` — No description → `an EmailTemplate!`
+- `deleteEmailTemplate` — No description → `a Boolean!`
+- `editEmailTemplate` — No description → `an EmailTemplate!`
+- `createOutputChannelGroup` — Create an output channel group Note that it is possible to create an empty channel group → `an OutputChannelGroup!`
+- `deleteOutputChannelGroup` — Delete one or more output channel groups Will also delete any output channels in the group → `a Boolean!`
+- `editOutputChannelGroup` — Edit output channel groups → `[OutputChannelGroup!]!`
+- `createEmailOutputChannel` — Create an email output channel → `an EmailOutputChannel!`
+- `deleteEmailOutputChannel` — Delete one or more email output channels → `a Boolean!`
+- `editEmailOutputChannel` — Edit email output channels → `[EmailOutputChannel!]!`
+- `createFileOutputChannel` — Create a file output channel → `a FileOutputChannel!`
+- `deleteFileOutputChannel` — Delete one or more file output channels → `a Boolean!`
+- `editFileOutputChannel` — Edit file output channels → `[FileOutputChannel!]!`
+
+## Input Channels & Rules
+
+### Queries
+- `inputChannels` — No description → `an InputChannelPagingResponse!`
+- `inputChannelById` — No description → `[InputChannel!]`
+- `inputRuleSets` — No description → `an InputRuleSetPagingResponse!`
+- `inputRuleSetById` — No description → `[InputRuleSet!]`
+
+### Mutations
+- `createInputChannel` — No description → `an InputChannel!`
+- `deleteInputChannel` — No description → `a Boolean!`
+- `editInputChannel` — Edit an Input channelid Id of the Input channel to editpipes If pipes is given, the current pipes will be replaced by... → `an InputChannel!`
+- `createInputRuleSet` — No description → `an InputRuleSet!`
+- `deleteInputRuleSet` — No description → `a Boolean!`
+- `editInputRuleSet` — No description → `an InputRuleSet!`
+
+## Metadata
+
+### Queries
+- `metadataDefinitionById` — No description → `[MetadataDefinition!]`
+- `metadataDefinitionByRef` — No description → `[MetadataDefinition!]`
+- `nameSpaceDefinitions` — No description → `[MetadataNameSpace!]`
+- `nameSpaceDefinitionById` — No description → `[MetadataNameSpace!]`
+- `nameSpaceDefinitionByPrefix` — No description → `[MetadataNameSpace!]`
+- `nameSpaceDefinitionByURI` — No description → `[MetadataNameSpace!]`
+- `getProperties` — Read all configuration properties of a particular category → `[ConfigProperty!]!`
+- `getProperty` — Read a configuration property → `a ConfigProperty`
+
+### Mutations
+- `createMetadataDefinition` — To create a metadata definition → `a MetadataDefinition`
+- `deleteMetadataDefinition` — To delete a metadata definition → `a Boolean!`
+- `editMetadataDefinition` — To edit a metadata definition → `a MetadataDefinition`
+- `renameMetadataDefinition` — To rename a metadata definition → `a MetadataDefinition`
+- `createMetadataNameSpace` — To create a metadata nameSpace → `a MetadataNameSpace`
+- `deleteMetadataNameSpace` — To delete a nameSpace definition → `a Boolean!`
+- `editMetadataNameSpace` — To edit a metadata nameSpace → `a MetadataNameSpace`
+- `setProperties` — To set propert-y-ies → `[ConfigProperty!]`
+- `setContent` — replace the content of an asset the Asset must be checked out → `an Asset!`
+- `deleteProperty` — To delete a property → `a ConfigProperty!`
+
+## Thesaurus & Taxonomy
+
+### Queries
+- `thesaurus` — No description → `[Thesaurus!]!`
+- `thesaurusById` — No description → `[Thesaurus!]`
+- `thesaurusByLabel` — No description → `[Thesaurus!]`
+- `thesaurusByURI` — No description → `[Thesaurus!]`
+- `synSetById` — No description → `[SynSet!]`
+- `synSetByLabel` — No description → `[SynSet!]`
+- `synSetByURI` — No description → `[SynSet!]`
+
+### Mutations
+- `createThesaurus` — No description → `a Thesaurus!`
+- `deleteThesaurus` — No description → `a Boolean!`
+- `createSynSet` — No description → `a SynSet!`
+- `deleteSynSet` — No description → `a Boolean!`
+- `editSynSet` — No description → `a SynSet`
+- `reactivateSynSet` — No description → `a Boolean!`
+- `retireSynSet` — No description → `a Boolean!`
+
+## Volumes & Hosts
+
+### Queries
+- `volumes` — List all volumes → `[Volume!]!`
+- `volumeById` — Get volume(s) based on ID → `[Volume!]!`
+- `checkVolumeConnectivity` — check connectivity of a volume to it's storage location or server → `a Boolean!`
+- `hosts` — List all hosts → `[Host!]!`
+- `hostById` — Get host(s) based on ID → `[Host!]!`
+- `hostFoldersByPath` — **List folders in a host ** → `[String!]!`
+
+### Mutations
+- `createVolume` — Create a Volume → `a Volume!`
+- `createFileSystemVolume` — Create a File System Volume → `a FileSystemVolume!`
+- `deleteVolume` — Delete a Volume → `a Boolean!`
+- `editVolume` — Edit a Volume → `[Volume!]!`
+- `editFileSystemVolume` — Edit a File System Volume → `[FileSystemVolume!]!`
+- `updateFileSystemVolumeDiskId` — Update a File System Volume Disk UUID → `[FileSystemVolume!]!`
+- `deleteHost` — Delete a Host deprecated → `a Boolean!`
+- `editHost` — Edit a Host deprecated → `a Host!`
+
+## Color Management
+
+### Queries
+- `colorSpaces` — No description → `a ColorSpacePagingResponse!`
+- `colorSpaceById` — No description → `[ColorSpace!]`
+- `iccProfiles` — No description → `an IccProfilePagingResponse!`
+- `iccProfileById` — No description → `[IccProfile!]`
+- `iccProfileByName` — No description → `an IccProfile!`
+- `inks` — No description → `an InkPagingResponse!`
+- `inkById` — No description → `[Ink!]`
+- `inkByName` — No description → `an Ink!`
+- `inkCoverage` — Compute the ink coverage of a portion of a document defined by parameters of input iInkCoverageParams The response is... → `a Stream`
+- `viewingConditions` — No description → `a ViewingConditionPagingResponse!`
+- `viewingConditionById` — No description → `[ViewingCondition!]`
+- `editIccContext` — Setup ICC context → `a Boolean!`
+- `densitometer` — Read the color value at a certain position → `a DensitometerValues`
+- `gamutCheck` — Compute the area where the color are out of gamut according to the monitor or to a simulation profile of a portion of... → `a Stream`
+- `gamutWarning` — Return true if the document is viewed out of gamut → `a Boolean!`
+
+### Mutations
+- `createColorSpace` — No description → `a ColorSpace!`
+- `deleteColorSpace` — No description → `a Boolean!`
+- `editColorSpace` — No description → `a ColorSpace!`
+- `deleteIccProfile` — No description → `a Boolean`
+- `uploadIccProfile` — No description → `an UploadStatus!`
+- `createViewingCondition` — No description → `a ViewingCondition!`
+- `deleteViewingCondition` — No description → `a Boolean!`
+- `editViewingCondition` — No description → `a ViewingCondition!`
+
+## Layouts
+
+### Queries
+- `layouts` — Retrieve Layouts → `a LayoutPagingResponse!`
+- `layoutById` — Retrieve Layout by ID or [ID] → `[Layout!]`
+
+### Mutations
+- `createLayout` — Create a layout → `a Layout!`
+- `deleteLayout` — Delete a layout → `a Boolean!`
+- `editLayout` — Edit a layout → `a Layout!`
+
+## User Actions
+
+### Queries
+- `userActions` — List all user actions → `[UserAction!]!`
+- `userActionById` — Get user action(s) based on ID → `[UserAction!]!`
+- `userActionIconNames` — ** List the names of all uploaded user action icons ** → `[String!]!`
+- `userActionInstancesById` — ** Get user action instance(s) by id ** → `[UserActionInstance!]!`
+- `userActionInstancesByUser` — ** Get user action instance(s) executed by the specified user** → `[UserActionInstance!]!`
+
+### Mutations
+- `createUserAction` — ** Create a user action** → `a UserAction!`
+- `deleteUserAction` — ** Delete one or more user actions** → `a Boolean!`
+- `editUserAction` — ** Edit one or more user actions** → `[UserAction!]!`
+- `clearUserActionInstancesById` — ** Delete running or completed user action(s) specified by ID** → `a Boolean!`
+- `clearUserActionInstancesByUser` — ** Delete running or completed user action(s) linked to the specified user** → `a Boolean!`
+- `startUserAction` — Start a user action on one or more objects → `a Boolean!`
+- `uploadUserActionIcon` — ** Upload a user action icon** → `an UploadStatus!`
+
+### Subscriptions
+- `userActionChange` — No description → `an OldUserActionEvent`
+- `whenUserActionChange` — Events for UserActions triggered by the current user → `a UserActionEvent`
+
+## UI & Files
+
+### Queries
+- `getUIFiles` — No description → `[UIProjectFile!]`
+- `getUIFileContent` — No description → `a String`
+- `getUIFilesByFilter` — No description → `[UIProjectFile!]`
+- `getUIProjects` — No description → `[UIProject!]`
+- `getUIProjectFiles` — No description → `[UIProjectFile!]`
+- `getUIProjectsByFilter` — No description → `[UIProject!]`
+- `getUIProjectsByName` — No description → `an UIProject`
+- `getUIProjectsByType` — No description → `[UIProject!]`
+- `streamUIFileContent` — No description → `a Stream`
+- `getFileContent` — -------- Deprecated --------- → `a String`
+
+### Mutations
+- `createUIFile` — No description → `an UIProjectFile!`
+- `createAndUploadUIFile` — No description → `a Boolean!`
+- `deleteUIFile` — No description → `a Boolean`
+- `editUIFile` — No description → `an UIProjectFile!`
+- `saveUIFile` — No description → `a Boolean!`
+- `uploadUIFile` — No description → `a Boolean!`
+- `createUIFolder` — No description → `an UIProjectFile`
+- `deleteUIFolder` — No description → `a Boolean`
+- `createUIProject` — No description → `an UIProject`
+- `createUIProjectWithType` — No description → `an UIProject`
+- `deleteUIProject` — No description → `a Boolean`
+- `editUIProject` — No description → `an UIProject`
+- `saveFile` — -------- Deprecated --------- → `a Boolean!`
+
+## Preflighting & Rasterizing
+
+### Queries
+- `preflightReport` — **Generate a Preflight report for one or several Asset(s) or Media(s) ** → `a Stream`
+- `streamPreflightPreview` — Retrieve the preview of a given page of the preflight report → `a Stream`
+- `rasterize` — Rendering of a portion of a document defined by parameters of input iRasterizeParams The response is a jpeg image (Wa... → `a Stream`
+- `readBarCode` — Read a Barcode in the area defined by it's coordinates (in pt) → `[BarCode!]!`
+
+## Import / Export
+
+### Queries
+- `importedFiles` — **Get the list of files that have been imported → `[ImportedFile!]!`
+- `getImportConflicts` — ** Retrieve the objects to import that conflicts with existing one for a given ImportedFile → `[ImportedInfo!]`
+- `getImportInfo` — ** Retrieve the objects to import for a given ImportedFile → `[ImportedInfo!]`
+- `exportData` — **Export the given object(s) in an .es file → `a Stream`
+- `getSchemaExtensions` — No description → `[SchemaExtension!]`
+
+### Mutations
+- `importData` — **Import the given file → `a Boolean`
+- `uploadImportFile` — **Upload the given file in the imported files → `an UploadStatus!`
+- `createSchemaExtension` — No description → `a SchemaExtension!`
+- `deleteSchemaExtension` — No description → `a Boolean!`
+- `editSchemaExtension` — No description → `a SchemaExtension!`
+
+## Events & Logging
+
+### Queries
+- `getEventLogs` — No description → `a LogResponse`
+
+### Subscriptions
+- `whenObjectChange` — ParentId only works with CREATE_OBJECT EntityEventType and not on Media and User EntityTypes → `an EntityEvent`
+- `whenStepStatusChange` — No description → `a StepEvent`
+
+## Relations
+
+### Mutations
+- `createRelation` — To create Relations between 1 source Entity and one or more target Entities → `[Relation!]`
+- `deleteRelation` — To delete Relations by there ID(s) → `a Boolean!`
+- `deleteRelationFromObject` — To delete Relations from there target and/or sources one of source or target is mandatory → `a Boolean!`
+- `editRelation` — To edit Relation → `[Relation!]`
+
+## Reports
+
+### Queries
+- `reports` — No description → `[Report!]`
+- `getReportURL` — No description → `a String`
+
+## Trash
+
+### Queries
+- `trashedObjects` — No description → `a TrashablePagingResponse!`
+
+### Mutations
+- `deleteAllTrashedObjects` — Delete all objects that have been trashed with the current user → `a Boolean!`
+- `deleteObject` — Generic delete object → `a Boolean!`
+- `trashObject` — No description → `a Boolean!`
+- `unTrashObject` — Untrash object(s) → `a Boolean!`
+- `unTrashAllObjects` — Untrash all objects that have been trashed with the current user → `a Boolean!`
+
+## Milestones
+
+### Mutations
+- `createMilestone` — To create a Milestone → `an Activity!`
+
+## Activities
+
+### Queries
+- `activities` — List of topLevel activities → `[Activity!]`
+- `activityById` — Activity by Id → `[Activity!]`
+- `activityIconById` — No description → `[ActivityIcon!]`
+- `activityIcons` — Retrieve Activity Icon → `an ActivityIconPagingResponse!`
+- `activityPresets` — List of activity presets → `[Activity!]`
+- `activityVariables` — Retrieve variables names depending on WorkflowableTypeName → `[String]`
+
+### Mutations
+- `deleteActivity` — To delete an activity → `a Boolean!`
+- `deleteActivityIcon` — delete an activity icon → `a Boolean`
+- `deleteActivityPreset` — To delete a preset → `a Boolean!`
+- `duplicateActivity` — To duplicate Top Level Activity → `an Activity!`
+- `createCustomActivity` — Custom activity creation → `an Activity!`
+- `deleteCustomActivity` — Custom activity deletion → `a Boolean`
+- `editActivity` — To edit Top Level Activity toRemove: true will throw an Exception → `an Activity!`
+- `editActivityPreset` — To edit activity presets creates it if it doesn't exist → `an Activity!`
+- `editCustomActivity` — Custom activity edition → `an Activity!`
+- `editActivityEngineCapacity` — Edit capacity of an ActivityEngine in a specific Workflow Engine → `a Boolean!`
+- `editActivityEngineTemplate` — Edit an ActivityEngineTemplate in a specific Workflow Engine → `a Boolean!`
+- `uploadActivityIcon` — upload an activity icon → `an UploadStatus!`
diff --git a/docs/dalim-api-reference.md b/docs/dalim-api-reference.md
new file mode 100644
index 0000000..322a3ce
--- /dev/null
+++ b/docs/dalim-api-reference.md
@@ -0,0 +1,955 @@
+# Dalim ES FUSiON API — Active Endpoint Reference
+
+Detailed documentation for the endpoints actively used in this project.
+For a full list of all 466 available operations, see `dalim-api-index.md`.
+
+---
+
+## Authentication
+
+The API uses OAuth2 with HMAC SHA256 signing.
+
+**Token endpoint:** `https://{HOST}/ES/api/oauth/token`
+**GraphQL endpoint:** `https://{HOST}/ES/api/graphql`
+
+**Get a token:**
+```python
+token_data = {
+ "grant_type": "password",
+ "client_id": CLIENT_ID,
+ "client_secret": CLIENT_SECRET,
+ "username": USERNAME,
+ "password": PASSWORD
+}
+response = requests.post(TOKEN_URL, data=token_data)
+access_token = response.json()["access_token"]
+headers = {"Authorization": f"Bearer {access_token}", "Content-Type": "application/json"}
+```
+
+**Dependency chain** (must create in this order):
+Security Profiles → Users → Projects → Assets
+
+---
+
+## System & Auth
+
+### connectAs
+
+**Type:** Mutation
+**Returns:** `a JSON!`
+
+Enable an Admin to connect to ES as another User. The response is identical to a standard login, a new AccessToken is received.
+
+**Arguments:**
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `login` | `String!` | Yes | login of the user |
+| `withSecurityProfile` | `String` | No | name of a securityProfile |
+| `createIfNotExists` | `Boolean` | No | Auto-created user if not exists |
+
+**Example Query:**
+```graphql
+mutation connectAs( $login: String!, $withSecurityProfile: String, $createIfNotExists: Boolean ) { connectAs( login: $login, withSecurityProfile: $withSecurityProfile, createIfNotExists: $createIfNotExists ) }
+```
+
+**Example Variables:**
+```json
+{ "login": "abc123", "withSecurityProfile": "abc123", "createIfNotExists": true }
+```
+
+**Example Response:**
+```json
+{"data": {"connectAs": {}}}
+```
+
+---
+
+### disconnectAs
+
+**Type:** Mutation
+**Returns:** `a JSON!`
+
+When connected as another user, returns to the original login, the current token is revoked. The response is identical to a standard login, a new AccessToken is received. If the AccessToken does not correspond to a user connected as, then nothing append, the current token is still valid.
+
+**Example Query:**
+```graphql
+mutation disconnectAs { disconnectAs }
+```
+
+**Example Response:**
+```json
+{"data": {"disconnectAs": {}}}
+```
+
+---
+
+### whoami
+
+**Type:** Query
+**Returns:** `a Whoami!`
+
+**Example Query:**
+```graphql
+query whoami { whoami { id user { ...UserFragment } securityProfile { ...UserSecurityProfileFragment } } }
+```
+
+**Example Response:**
+```json
+{ "data": { "whoami": { "id": "4", "user": User, "securityProfile": UserSecurityProfile } } }
+```
+
+---
+
+### serverInformation
+
+**Type:** Query
+**Returns:** `a ServerInformation!`
+
+**Example Query:**
+```graphql
+query serverInformation { serverInformation { guiClientId authorizationURL accessTokenURL authenticationKeys } }
+```
+
+**Example Response:**
+```json
+{ "data": { "serverInformation": { "guiClientId": "abc123", "authorizationURL": "http://www.test.com/", "accessTokenURL": "http://www.test.com/", "authenticationKeys": ["4"] } } }
+```
+
+---
+
+## Users
+
+### users
+
+**Type:** Query
+**Returns:** `a UserPagingResponse!`
+
+Retrieve visible users by the current logged user
+
+**Arguments:**
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `filter` | `iFilter` | No | — |
+| `limit` | `Int` | No | — |
+| `cursor` | `ID` | No | — |
+| `orderBy` | `iOrderBy` | No | Default = {property : "id", direction : ASC} |
+
+**Example Query:**
+```graphql
+query users( $filter: iFilter, $limit: Int, $cursor: ID, $orderBy: iOrderBy ) { users( filter: $filter, limit: $limit, cursor: $cursor, orderBy: $orderBy ) { lowerCursor upperCursor hasMoreItems objectList { ...UserFragment } } }
+```
+
+**Example Variables:**
+```json
+{ "filter": iFilter, "limit": 123, "cursor": 4, "orderBy": {"property": "id", "direction": "ASC"} }
+```
+
+**Example Response:**
+```json
+{ "data": { "users": { "lowerCursor": "4", "upperCursor": "4", "hasMoreItems": true, "objectList": [User] } } }
+```
+
+---
+
+### userById
+
+**Type:** Query
+**Returns:** `[User!]`
+
+Retrieve user by id
+
+**Arguments:**
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `id` | `[ID!]!` | Yes | — |
+
+**Example Query:**
+```graphql
+query userById($id: [ID!]!) { userById(id: $id) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } login userCanLog lang dateFormat unitResolution unitLength color image use2FA channel2FA sessionTimeout workCapacity workCapacityUnit firstName lastName email title company phone phone2 homePhone fax mobilePhone department address { ...AddressFragment } organization { ...OrganizationFragment } groups { ...GroupFragment } roles { ...RoleFragment } defaultProfile { ...UserSecurityProfileFragment } availableProfiles { ...UserSecurityProfileFragment } notifications { ...NotificationFragment } } }
+```
+
+**Example Variables:**
+```json
+{"id": ["4"]}
+```
+
+**Example Response:**
+```json
+{ "data": { "userById": [ { "id": "4", "name": "abc123", "description": "xyz789", "lastModificationDate": "2007-12-03T10:15:30Z", "lastModificationUser": User, "creationDate": "2007-12-03T10:15:30Z", "creationUser": User, "metadatas": [MetadataValue], "metadataProperties": [MetadataValue], "login": "abc123", "userCanLog": true, "lang": "ar", "dateFormat": "abc123", "unitResolution": "xyz789", "unitLength": "xyz789", "color": "xyz789", "image": "xyz789", "use2FA": true, "channel2FA": "AUTHENTICATOR", "sessionTimeout": 123, "workCapacity": "abc123", "workCapacityUnit": "xyz789", "firstName": "xyz789", "lastName": "abc123", "email": "abc123", "title": "abc123", "company": "xyz789", "phone": "abc123", "phone2": "xyz789", "homePhone": "xyz789", "fax": "abc123", "mobilePhone": "xyz789", "departm
+... (truncated)
+```
+
+---
+
+### createUser
+
+**Type:** Mutation
+**Returns:** `a User!`
+
+Create an User in the specified Organization
+
+**Arguments:**
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `name` | `String!` | Yes | — |
+| `in` | `ID!` | Yes | — |
+| `setup` | `iCreateUserSetup` | No | — |
+
+**Example Query:**
+```graphql
+mutation createUser( $name: String!, $in: ID!, $setup: iCreateUserSetup ) { createUser( name: $name, in: $in, setup: $setup ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } login userCanLog lang dateFormat unitResolution unitLength color image use2FA channel2FA sessionTimeout workCapacity workCapacityUnit firstName lastName email title company phone phone2 homePhone fax mobilePhone department address { ...AddressFragment } organization { ...OrganizationFragment } groups { ...GroupFragment } roles { ...RoleFragment } defaultProfile { ...UserSecurityProfileFragment } availableProfiles { ...UserSecurityProfileFragment } notifications { ...NotificationFragment } } }
+```
+
+**Example Variables:**
+```json
+{ "name": "abc123", "in": 4, "setup": iCreateUserSetup }
+```
+
+**Example Response:**
+```json
+{ "data": { "createUser": { "id": 4, "name": "abc123", "description": "xyz789", "lastModificationDate": "2007-12-03T10:15:30Z", "lastModificationUser": User, "creationDate": "2007-12-03T10:15:30Z", "creationUser": User, "metadatas": [MetadataValue], "metadataProperties": [MetadataValue], "login": "xyz789", "userCanLog": false, "lang": "ar", "dateFormat": "abc123", "unitResolution": "xyz789", "unitLength": "xyz789", "color": "xyz789", "image": "abc123", "use2FA": true, "channel2FA": "AUTHENTICATOR", "sessionTimeout": 123, "workCapacity": "xyz789", "workCapacityUnit": "xyz789", "firstName": "xyz789", "lastName": "xyz789", "email": "abc123", "title": "xyz789", "company": "xyz789", "phone": "xyz789", "phone2": "xyz789", "homePhone": "abc123", "fax": "xyz789", "mobilePhone": "abc123", "departme
+... (truncated)
+```
+
+---
+
+### changeUser
+
+**Type:** Mutation
+**Returns:** `a User!`
+
+**Arguments:**
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `name` | `String!` | Yes | — |
+
+**Example Query:**
+```graphql
+mutation changeUser($name: String!) { changeUser(name: $name) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } login userCanLog lang dateFormat unitResolution unitLength color image use2FA channel2FA sessionTimeout workCapacity workCapacityUnit firstName lastName email title company phone phone2 homePhone fax mobilePhone department address { ...AddressFragment } organization { ...OrganizationFragment } groups { ...GroupFragment } roles { ...RoleFragment } defaultProfile { ...UserSecurityProfileFragment } availableProfiles { ...UserSecurityProfileFragment } notifications { ...NotificationFragment } } }
+```
+
+**Example Variables:**
+```json
+{"name": "abc123"}
+```
+
+**Example Response:**
+```json
+{ "data": { "changeUser": { "id": "4", "name": "abc123", "description": "abc123", "lastModificationDate": "2007-12-03T10:15:30Z", "lastModificationUser": User, "creationDate": "2007-12-03T10:15:30Z", "creationUser": User, "metadatas": [MetadataValue], "metadataProperties": [MetadataValue], "login": "xyz789", "userCanLog": true, "lang": "ar", "dateFormat": "xyz789", "unitResolution": "abc123", "unitLength": "abc123", "color": "xyz789", "image": "abc123", "use2FA": true, "channel2FA": "AUTHENTICATOR", "sessionTimeout": 123, "workCapacity": "xyz789", "workCapacityUnit": "xyz789", "firstName": "abc123", "lastName": "xyz789", "email": "xyz789", "title": "abc123", "company": "abc123", "phone": "xyz789", "phone2": "abc123", "homePhone": "abc123", "fax": "abc123", "mobilePhone": "abc123", "departm
+... (truncated)
+```
+
+---
+
+## Security Profiles
+
+### securityProfiles
+
+**Type:** Query
+**Returns:** `a SecurityProfilePagingResponse!`
+
+Retrieve SecurityProfile by filter
+
+**Arguments:**
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `filter` | `iFilter` | No | — |
+| `limit` | `Int` | No | — |
+| `cursor` | `ID` | No | — |
+| `orderBy` | `iOrderBy` | No | Default = {property : "id", direction : ASC} |
+
+**Example Query:**
+```graphql
+query securityProfiles( $filter: iFilter, $limit: Int, $cursor: ID, $orderBy: iOrderBy ) { securityProfiles( filter: $filter, limit: $limit, cursor: $cursor, orderBy: $orderBy ) { lowerCursor upperCursor hasMoreItems objectList { ...SecurityProfileFragment } } }
+```
+
+**Example Variables:**
+```json
+{ "filter": iFilter, "limit": 123, "cursor": "4", "orderBy": {"property": "id", "direction": "ASC"} }
+```
+
+**Example Response:**
+```json
+{ "data": { "securityProfiles": { "lowerCursor": 4, "upperCursor": "4", "hasMoreItems": true, "objectList": [SecurityProfile] } } }
+```
+
+---
+
+### createUserSecurityProfile
+
+**Type:** Mutation
+**Returns:** `a UserSecurityProfile`
+
+**Arguments:**
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `name` | `String!` | Yes | — |
+| `setup` | `iUserSecurityProfile` | No | — |
+
+**Example Query:**
+```graphql
+mutation createUserSecurityProfile( $name: String!, $setup: iUserSecurityProfile ) { createUserSecurityProfile( name: $name, setup: $setup ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } properties { ...SecurityPropertyFragment } securityRoles } }
+```
+
+**Example Variables:**
+```json
+{ "name": "abc123", "setup": iUserSecurityProfile }
+```
+
+**Example Response:**
+```json
+{ "data": { "createUserSecurityProfile": { "id": "4", "name": "xyz789", "description": "xyz789", "lastModificationDate": "2007-12-03T10:15:30Z", "lastModificationUser": User, "creationDate": "2007-12-03T10:15:30Z", "creationUser": User, "properties": [SecurityProperty], "securityRoles": ["ADMIN"] } } }
+```
+
+---
+
+### addProfileToUser
+
+**Type:** Mutation
+**Returns:** `a Boolean!`
+
+Add one or many SecurityProfiles to one or many Users
+
+**Arguments:**
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `id` | `[ID!]!` | Yes | — |
+| `to` | `[ID!]!` | Yes | — |
+
+**Example Query:**
+```graphql
+mutation addProfileToUser( $id: [ID!]!, $to: [ID!]! ) { addProfileToUser( id: $id, to: $to ) }
+```
+
+**Example Variables:**
+```json
+{"id": ["4"], "to": [4]}
+```
+
+**Example Response:**
+```json
+{"data": {"addProfileToUser": true}}
+```
+
+---
+
+### addRoleToUser
+
+**Type:** Mutation
+**Returns:** `a Boolean!`
+
+Add one or many Role(s) to one or many User(s)
+
+**Arguments:**
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `id` | `[ID!]!` | Yes | — |
+| `to` | `[ID!]!` | Yes | — |
+
+**Example Query:**
+```graphql
+mutation addRoleToUser( $id: [ID!]!, $to: [ID!]! ) { addRoleToUser( id: $id, to: $to ) }
+```
+
+**Example Variables:**
+```json
+{"id": ["4"], "to": [4]}
+```
+
+**Example Response:**
+```json
+{"data": {"addRoleToUser": true}}
+```
+
+---
+
+## Projects
+
+### projects
+
+**Type:** Query
+**Returns:** `a ProjectPagingResponse!`
+
+Retrieve Projects by filter
+
+**Arguments:**
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `filter` | `iFilter` | No | — |
+| `limit` | `Int` | No | — |
+| `cursor` | `ID` | No | — |
+| `orderBy` | `iOrderBy` | No | Default = {property : "id", direction : ASC} |
+
+**Example Query:**
+```graphql
+query projects( $filter: iFilter, $limit: Int, $cursor: ID, $orderBy: iOrderBy ) { projects( filter: $filter, limit: $limit, cursor: $cursor, orderBy: $orderBy ) { lowerCursor upperCursor hasMoreItems objectList { ...ProjectFragment } } }
+```
+
+**Example Variables:**
+```json
+{ "filter": iFilter, "limit": 123, "cursor": "4", "orderBy": {"property": "id", "direction": "ASC"} }
+```
+
+**Example Response:**
+```json
+{ "data": { "projects": { "lowerCursor": 4, "upperCursor": 4, "hasMoreItems": true, "objectList": [Project] } } }
+```
+
+---
+
+### projectById
+
+**Type:** Query
+**Returns:** `[Project!]`
+
+Retrieve Projects by ID or [ID]
+
+**Arguments:**
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `id` | `[ID!]!` | Yes | — |
+
+**Example Query:**
+```graphql
+query projectById($id: [ID!]!) { projectById(id: $id) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } trashDate trashUser { ...UserFragment } endDate metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } status workflowName approvalStatus { ...ApprovalActivityStatusFragment } approvalSummary approvals { ...ApprovalCycleFragment } assetApprovals { ...ApprovalCycleFragment } children { ...PagingResponseFragment } assetWorkflow { ...WorkflowFragment } processes { ...ProcessFragment } projectTemplate { ...ProjectTemplateFragment } priority colorSpace { ...ColorSpaceFragment } viewingCondition { ...ViewingConditionFragment } reversedView customer { ...CustomerFragment } parents { ...ContainerFragment } mainAsset { ...AssetFragment } siteId productionParticipants { ...ProductionParticipantFragment } notes { ...NoteFragment } trimmedHeight trimmedWidth nbPages accessControls deadlines { ...ProjectDeadlineFragment } } }
+```
+
+**Example Variables:**
+```json
+{"id": [4]}
+```
+
+**Example Response:**
+```json
+{ "data": { "projectById": [ { "id": 4, "name": "abc123", "description": "xyz789", "lastModificationDate": "2007-12-03T10:15:30Z", "lastModificationUser": User, "creationDate": "2007-12-03T10:15:30Z", "creationUser": User, "trashDate": "2007-12-03T10:15:30Z", "trashUser": User, "endDate": "2007-12-03T10:15:30Z", "metadatas": [MetadataValue], "metadataProperties": [MetadataValue], "status": ["ACTIVE"], "workflowName": "abc123", "approvalStatus": [ApprovalActivityStatus], "approvalSummary": "NONE", "approvals": [ApprovalCycle], "assetApprovals": [ApprovalCycle], "children": PagingResponse, "assetWorkflow": Workflow, "processes": [Process], "projectTemplate": ProjectTemplate, "priority": 123, "colorSpace": ColorSpace, "viewingCondition": ViewingCondition, "reversedView": true, "customer": Cus
+... (truncated)
+```
+
+---
+
+### projectTemplates
+
+**Type:** Query
+**Returns:** `a ProjectTemplateResponse!`
+
+Retrieve Project Templates
+
+**Arguments:**
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `filter` | `iFilter` | No | — |
+| `limit` | `Int` | No | — |
+| `cursor` | `ID` | No | — |
+| `orderBy` | `iOrderBy` | No | Default = {property : "id", direction : ASC} |
+
+**Example Query:**
+```graphql
+query projectTemplates( $filter: iFilter, $limit: Int, $cursor: ID, $orderBy: iOrderBy ) { projectTemplates( filter: $filter, limit: $limit, cursor: $cursor, orderBy: $orderBy ) { lowerCursor upperCursor hasMoreItems objectList { ...ProjectTemplateFragment } } }
+```
+
+**Example Variables:**
+```json
+{ "filter": iFilter, "limit": 123, "cursor": 4, "orderBy": {"property": "id", "direction": "ASC"} }
+```
+
+**Example Response:**
+```json
+{ "data": { "projectTemplates": { "lowerCursor": 4, "upperCursor": 4, "hasMoreItems": true, "objectList": [ProjectTemplate] } } }
+```
+
+---
+
+### createProject
+
+**Type:** Mutation
+**Returns:** `a Project!`
+
+security role handle by the mutationFetcher itself To create a Project for a Customer with a name
+
+**Arguments:**
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `customerId` | `ID!` | Yes | — |
+| `name` | `String!` | Yes | — |
+| `setup` | `iProjectSetup` | No | — |
+| `inputs` | `[iInputFile!]` | Yes | — |
+
+**Example Query:**
+```graphql
+mutation createProject( $customerId: ID!, $name: String!, $setup: iProjectSetup, $inputs: [iInputFile!] ) { createProject( customerId: $customerId, name: $name, setup: $setup, inputs: $inputs ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } trashDate trashUser { ...UserFragment } endDate metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } status workflowName approvalStatus { ...ApprovalActivityStatusFragment } approvalSummary approvals { ...ApprovalCycleFragment } assetApprovals { ...ApprovalCycleFragment } children { ...PagingResponseFragment } assetWorkflow { ...WorkflowFragment } processes { ...ProcessFragment } projectTemplate { ...ProjectTemplateFragment } priority colorSpace { ...ColorSpaceFragment } viewingCondition { ...ViewingConditionFragment } reversedView customer { ...CustomerFragment } parents { ...ContainerFragment } mainAsset { ...AssetFragment } siteId productionParticipants { ...ProductionParticipantFragment } notes { ...NoteFragment } trimmedHeight trimmedWidth nbPages accessControls deadlines { ...ProjectDeadlineFragment } } }
+```
+
+**Example Variables:**
+```json
+{ "customerId": "4", "name": "xyz789", "setup": iProjectSetup, "inputs": [iInputFile] }
+```
+
+**Example Response:**
+```json
+{ "data": { "createProject": { "id": "4", "name": "abc123", "description": "abc123", "lastModificationDate": "2007-12-03T10:15:30Z", "lastModificationUser": User, "creationDate": "2007-12-03T10:15:30Z", "creationUser": User, "trashDate": "2007-12-03T10:15:30Z", "trashUser": User, "endDate": "2007-12-03T10:15:30Z", "metadatas": [MetadataValue], "metadataProperties": [MetadataValue], "status": ["ACTIVE"], "workflowName": "xyz789", "approvalStatus": [ApprovalActivityStatus], "approvalSummary": "NONE", "approvals": [ApprovalCycle], "assetApprovals": [ApprovalCycle], "children": PagingResponse, "assetWorkflow": Workflow, "processes": [Process], "projectTemplate": ProjectTemplate, "priority": 987, "colorSpace": ColorSpace, "viewingCondition": ViewingCondition, "reversedView": true, "customer": C
+... (truncated)
+```
+
+---
+
+### deleteProject
+
+**Type:** Mutation
+**Returns:** `a Boolean!`
+
+To delete a Project. By default the project is moved to the trash
+
+**Arguments:**
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `id` | `[ID!]!` | Yes | id of the Project |
+| `now` | `Boolean` | No | flag to be able to immediately delete the Project otherwise it is moved to the trash. Default = false |
+
+**Example Query:**
+```graphql
+mutation deleteProject( $id: [ID!]!, $now: Boolean ) { deleteProject( id: $id, now: $now ) }
+```
+
+**Example Variables:**
+```json
+{"id": [4], "now": false}
+```
+
+**Example Response:**
+```json
+{"data": {"deleteProject": false}}
+```
+
+---
+
+### createFolder
+
+**Type:** Mutation
+**Returns:** `a Folder!`
+
+To create a Folder
+
+**Arguments:**
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `name` | `String!` | Yes | — |
+| `in` | `ID!` | Yes | — |
+| `setup` | `iFolderSetup` | No | — |
+
+**Example Query:**
+```graphql
+mutation createFolder( $name: String!, $in: ID!, $setup: iFolderSetup ) { createFolder( name: $name, in: $in, setup: $setup ) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } trashDate trashUser { ...UserFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } readOnly productionSettings { ...ProductionSettingsFragment } processes { ...ProcessFragment } accessControlList { ...AccessControlListFragment } children { ...PagingResponseFragment } project { ...ProjectFragment } parents { ...ContainerFragment } path { ...FolderFragment } color icon } }
+```
+
+**Example Variables:**
+```json
+{ "name": "xyz789", "in": 4, "setup": iFolderSetup }
+```
+
+**Example Response:**
+```json
+{ "data": { "createFolder": { "id": 4, "name": "xyz789", "description": "abc123", "lastModificationDate": "2007-12-03T10:15:30Z", "lastModificationUser": User, "creationDate": "2007-12-03T10:15:30Z", "creationUser": User, "trashDate": "2007-12-03T10:15:30Z", "trashUser": User, "metadatas": [MetadataValue], "metadataProperties": [MetadataValue], "readOnly": true, "productionSettings": ProductionSettings, "processes": [Process], "accessControlList": AccessControlList, "children": PagingResponse, "project": Project, "parents": [Container], "path": [Folder], "color": "xyz789", "icon": 4 } } }
+```
+
+---
+
+## Assets
+
+### assets
+
+**Type:** Query
+**Returns:** `an AssetPagingResponse!`
+
+Retrieve Assets by filter
+
+**Arguments:**
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `filter` | `iFilter` | No | — |
+| `limit` | `Int` | No | — |
+| `cursor` | `ID` | No | — |
+| `orderBy` | `iOrderBy` | No | Default = {property : "id", direction : ASC} |
+
+**Example Query:**
+```graphql
+query assets( $filter: iFilter, $limit: Int, $cursor: ID, $orderBy: iOrderBy ) { assets( filter: $filter, limit: $limit, cursor: $cursor, orderBy: $orderBy ) { lowerCursor upperCursor hasMoreItems objectList { ...AssetFragment } } }
+```
+
+**Example Variables:**
+```json
+{ "filter": iFilter, "limit": 987, "cursor": 4, "orderBy": {"property": "id", "direction": "ASC"} }
+```
+
+**Example Response:**
+```json
+{ "data": { "assets": { "lowerCursor": "4", "upperCursor": "4", "hasMoreItems": false, "objectList": [Asset] } } }
+```
+
+---
+
+### assetById
+
+**Type:** Query
+**Returns:** `[Asset!]`
+
+Retrieve Assets by ID or [ID]
+
+**Arguments:**
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `id` | `[ID!]!` | Yes | — |
+
+**Example Query:**
+```graphql
+query assetById($id: [ID!]!) { assetById(id: $id) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } trashDate trashUser { ...UserFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } status approvalSummary approvalStatus { ...ApprovalActivityStatusFragment } approvals { ...ApprovalCycleFragment } workflowName isAlias processes { ...ProcessFragment } uuid priority isCheckedOut checkedOutBy { ...UserFragment } privateWorkingRevision isArchived archiveId colorSpace { ...ColorSpaceFragment } viewingCondition { ...ViewingConditionFragment } project { ...ProjectFragment } parents { ...ContainerFragment } numberOfRevisions expirationDate medias { ...MediaFragment } notes { ...NoteFragment } relationFrom { ...RelationFragment } relationTo { ...RelationFragment } accessControls } }
+```
+
+**Example Variables:**
+```json
+{"id": [4]}
+```
+
+**Example Response:**
+```json
+{ "data": { "assetById": [ { "id": 4, "name": "xyz789", "description": "abc123", "lastModificationDate": "2007-12-03T10:15:30Z", "lastModificationUser": User, "creationDate": "2007-12-03T10:15:30Z", "creationUser": User, "trashDate": "2007-12-03T10:15:30Z", "trashUser": User, "metadatas": [MetadataValue], "metadataProperties": [MetadataValue], "status": ["ACTIVE"], "approvalSummary": "NONE", "approvalStatus": [ApprovalActivityStatus], "approvals": [ApprovalCycle], "workflowName": "abc123", "isAlias": false, "processes": [Process], "uuid": "abc123", "priority": 987, "isCheckedOut": false, "checkedOutBy": User, "privateWorkingRevision": 987, "isArchived": true, "archiveId": 4, "colorSpace": ColorSpace, "viewingCondition": ViewingCondition, "project": Project, "parents": [Container], "numberO
+... (truncated)
+```
+
+---
+
+### createAsset
+
+**Type:** Mutation
+**Returns:** `an AssetCreationStatus!`
+
+To create an Asset.
+
+**Arguments:**
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `in` | `[ID!]!` | Yes | — |
+| `name` | `String` | No | — |
+| `checkedOut` | `Boolean` | No | Default = false |
+| `setup` | `iAssetSetup` | No | — |
+| `input` | `iInputFile` | No | — |
+
+**Example Query:**
+```graphql
+mutation createAsset( $in: [ID!]!, $name: String, $checkedOut: Boolean, $setup: iAssetSetup, $input: iInputFile ) { createAsset( in: $in, name: $name, checkedOut: $checkedOut, setup: $setup, input: $input ) { created asset { ...AssetFragment } } }
+```
+
+**Example Variables:**
+```json
+{ "in": ["4"], "name": "xyz789", "checkedOut": false, "setup": iAssetSetup, "input": iInputFile }
+```
+
+**Example Response:**
+```json
+{ "data": { "createAsset": {"created": false, "asset": Asset} } }
+```
+
+---
+
+### deleteAsset
+
+**Type:** Mutation
+**Returns:** `a Boolean!`
+
+To delete an Asset. By default the Asset is moved to the trash
+
+**Arguments:**
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `id` | `[ID!]!` | Yes | id of the Asset |
+| `now` | `Boolean` | No | flag to be able to immediately delete the Asset otherwise it is moved to the trash. Default = false |
+
+**Example Query:**
+```graphql
+mutation deleteAsset( $id: [ID!]!, $now: Boolean ) { deleteAsset( id: $id, now: $now ) }
+```
+
+**Example Variables:**
+```json
+{"id": [4], "now": false}
+```
+
+**Example Response:**
+```json
+{"data": {"deleteAsset": false}}
+```
+
+---
+
+### downloadAsset
+
+**Type:** Query
+**Returns:** `a Stream`
+
+Stream an Asset
+
+**Arguments:**
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `id` | `ID!` | Yes | — |
+| `revision` | `Int` | No | Default = 0 |
+
+**Example Query:**
+```graphql
+query downloadAsset( $id: ID!, $revision: Int ) { downloadAsset( id: $id, revision: $revision ) }
+```
+
+**Example Variables:**
+```json
+{"id": "4", "revision": 0}
+```
+
+**Example Response:**
+```json
+{"data": {"downloadAsset": Stream}}
+```
+
+---
+
+## Organizations & Customers
+
+### customers
+
+**Type:** Query
+**Returns:** `a CustomerPagingResponse!`
+
+Retrieve Customers by filter
+
+**Arguments:**
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `filter` | `iFilter` | No | — |
+| `limit` | `Int` | No | — |
+| `cursor` | `ID` | No | — |
+| `orderBy` | `iOrderBy` | No | Default = {property : "id", direction : ASC} |
+
+**Example Query:**
+```graphql
+query customers( $filter: iFilter, $limit: Int, $cursor: ID, $orderBy: iOrderBy ) { customers( filter: $filter, limit: $limit, cursor: $cursor, orderBy: $orderBy ) { lowerCursor upperCursor hasMoreItems objectList { ...CustomerFragment } } }
+```
+
+**Example Variables:**
+```json
+{ "filter": iFilter, "limit": 123, "cursor": 4, "orderBy": {"property": "id", "direction": "ASC"} }
+```
+
+**Example Response:**
+```json
+{ "data": { "customers": { "lowerCursor": "4", "upperCursor": 4, "hasMoreItems": false, "objectList": [Customer] } } }
+```
+
+---
+
+### customerById
+
+**Type:** Query
+**Returns:** `[Customer!]`
+
+Retrieve Customers by ID or [ID]
+
+**Arguments:**
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `id` | `[ID!]!` | Yes | — |
+
+**Example Query:**
+```graphql
+query customerById($id: [ID!]!) { customerById(id: $id) { id name description lastModificationDate lastModificationUser { ...UserFragment } creationDate creationUser { ...UserFragment } metadatas { ...MetadataValueFragment } metadataProperties { ...MetadataValueFragment } sites defaultSite defaultProjectTemplate { ...ProjectTemplateFragment } projectTemplates { ...ProjectTemplateFragment } code phone phone2 www fax shippingAddress { ...AddressFragment } billingAddress { ...AddressFragment } organization { ...OrganizationFragment } children { ...PagingResponseFragment } emailTemplates { ...EmailTemplateFragment } notificationTemplates { ...NotificationTemplateFragment } securityConfiguration { ...SecurityConfigurationFragment } notifications { ...NotificationFragment } } }
+```
+
+**Example Variables:**
+```json
+{"id": [4]}
+```
+
+**Example Response:**
+```json
+{ "data": { "customerById": [ { "id": 4, "name": "abc123", "description": "abc123", "lastModificationDate": "2007-12-03T10:15:30Z", "lastModificationUser": User, "creationDate": "2007-12-03T10:15:30Z", "creationUser": User, "metadatas": [MetadataValue], "metadataProperties": [MetadataValue], "sites": ["abc123"], "defaultSite": "xyz789", "defaultProjectTemplate": ProjectTemplate, "projectTemplates": [ProjectTemplate], "code": "xyz789", "phone": "abc123", "phone2": "abc123", "www": "xyz789", "fax": "abc123", "shippingAddress": Address, "billingAddress": Address, "organization": Organization, "children": PagingResponse, "emailTemplates": [EmailTemplate], "notificationTemplates": [NotificationTemplate], "securityConfiguration": SecurityConfiguration, "notifications": [Notification] } ] } }
+```
+
+---
+
+### groups
+
+**Type:** Query
+**Returns:** `a GroupPagingResponse!`
+
+Retrieve visible groups by the current logged user
+
+**Arguments:**
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `filter` | `iFilter` | No | — |
+| `limit` | `Int` | No | — |
+| `cursor` | `ID` | No | — |
+| `orderBy` | `iOrderBy` | No | Default = {property : "id", direction : ASC} |
+
+**Example Query:**
+```graphql
+query groups( $filter: iFilter, $limit: Int, $cursor: ID, $orderBy: iOrderBy ) { groups( filter: $filter, limit: $limit, cursor: $cursor, orderBy: $orderBy ) { lowerCursor upperCursor hasMoreItems objectList { ...GroupFragment } } }
+```
+
+**Example Variables:**
+```json
+{ "filter": iFilter, "limit": 123, "cursor": 4, "orderBy": {"property": "id", "direction": "ASC"} }
+```
+
+**Example Response:**
+```json
+{ "data": { "groups": { "lowerCursor": "4", "upperCursor": 4, "hasMoreItems": false, "objectList": [Group] } } }
+```
+
+---
+
+### addUserToGroup
+
+**Type:** Mutation
+**Returns:** `a Boolean!`
+
+Add one or many Users to one or many Groups that are not System Groups. All the Users provided will be added to each Groups provided
+
+**Arguments:**
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `id` | `[ID!]!` | Yes | — |
+| `to` | `[ID!]!` | Yes | — |
+
+**Example Query:**
+```graphql
+mutation addUserToGroup( $id: [ID!]!, $to: [ID!]! ) { addUserToGroup( id: $id, to: $to ) }
+```
+
+**Example Variables:**
+```json
+{"id": ["4"], "to": [4]}
+```
+
+**Example Response:**
+```json
+{"data": {"addUserToGroup": false}}
+```
+
+---
+
+## Search
+
+### search
+
+**Type:** Query
+**Returns:** `a SearchResponse`
+
+**Arguments:**
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `filter` | `iSearchFilter!` | Yes | — |
+| `facets` | `[String!]` | Yes | — |
+| `limit` | `Int` | No | — |
+| `cursor` | `ID` | No | — |
+
+**Example Query:**
+```graphql
+query search( $filter: iSearchFilter!, $facets: [String!], $limit: Int, $cursor: ID ) { search( filter: $filter, facets: $facets, limit: $limit, cursor: $cursor ) { upperCursor hasMoreItems objectList { ...EntityFragment } scores facets { ...FacetFragment } } }
+```
+
+**Example Variables:**
+```json
+{ "filter": iSearchFilter, "facets": ["abc123"], "limit": 987, "cursor": 4 }
+```
+
+**Example Response:**
+```json
+{ "data": { "search": { "upperCursor": "4", "hasMoreItems": false, "objectList": [Entity], "scores": [987.65], "facets": [Facet] } } }
+```
+
+---
+
+## Approvals
+
+### approve
+
+**Type:** Mutation
+**Returns:** `a Boolean!`
+
+**Arguments:**
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `id` | `[ID!]!` | Yes | The id(s) of the request approval(s) to approve |
+| `comment` | `String` | No | The comment associated to the approve action |
+| `checkViewingCondition` | `Boolean` | No | Specify if the viewing condition should be checked or not. Default = true |
+
+**Example Query:**
+```graphql
+mutation approve( $id: [ID!]!, $comment: String, $checkViewingCondition: Boolean ) { approve( id: $id, comment: $comment, checkViewingCondition: $checkViewingCondition ) }
+```
+
+**Example Variables:**
+```json
+{ "id": [4], "comment": "xyz789", "checkViewingCondition": true }
+```
+
+**Example Response:**
+```json
+{"data": {"approve": true}}
+```
+
+---
+
+### approveObject
+
+**Type:** Mutation
+**Returns:** `a Boolean!`
+
+**Arguments:**
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `id` | `[ID!]!` | Yes | The id(s) of the object(s) to approve |
+| `comment` | `String` | No | The comment associated to the approve action |
+| `checkViewingCondition` | `Boolean` | No | Specify if the viewing condition should be checked or not. Default = true |
+
+**Example Query:**
+```graphql
+mutation approveObject( $id: [ID!]!, $comment: String, $checkViewingCondition: Boolean ) { approveObject( id: $id, comment: $comment, checkViewingCondition: $checkViewingCondition ) }
+```
+
+**Example Variables:**
+```json
+{ "id": [4], "comment": "xyz789", "checkViewingCondition": true }
+```
+
+**Example Response:**
+```json
+{"data": {"approveObject": false}}
+```
+
+---
diff --git a/generate_docs.py b/generate_docs.py
new file mode 100644
index 0000000..f2c5acd
--- /dev/null
+++ b/generate_docs.py
@@ -0,0 +1,486 @@
+#!/usr/bin/env python3
+"""Generate Tier 1 index and Tier 2 reference from parsed API data."""
+
+import json
+import re
+
+DOCS_DIR = '/Users/daveporter/Desktop/CODING-2024/DALIM-API/docs'
+
+# Domain groupings based on operation name patterns
+DOMAIN_PATTERNS = [
+ ('Authentication & System', [
+ 'connectAs', 'disconnectAs', 'whoami', 'serverInformation', 'authentications',
+ 'createAuthentication', 'deleteAuthentication', 'editAuthentication',
+ 'clientApplications', 'createClientApplication', 'deleteClientApplication', 'editClientApplication',
+ 'getCorsSetting', 'setCorsSetting',
+ 'getLogLevel', 'setLogLevel', 'getLogQueries', 'setLogQueries',
+ 'getMaxQueryComplexity', 'setMaxQueryComplexity', 'getMaxQuerySize', 'setMaxQuerySize',
+ 'getMaxTopLevelFieldCount', 'setMaxTopLevelFieldCount', 'queryStatistics',
+ 'servlets', 'openDialogueConnection', 'closeDialogueConnection', 'dialogueConnections',
+ 'get2FAQRCode', 'getSecret2FAKey', 'send2FAQRCodeByEmail', 'enable2FA', 'disable2FA',
+ 'verify2FACode', 'reset2FAKey',
+ 'myWebAuthnRegistrations', 'webAuthnRegistrations',
+ 'deleteMyWebAuthnRegistration', 'deleteWebAuthnRegistration',
+ 'editMyWebAuthnRegistration', 'editWebAuthnRegistration',
+ 'startWebAuthnRegistration', 'finishWebAuthnRegistration',
+ 'userConnectionById', 'userConnectionByClientId', 'userConnections',
+ 'revokeUserConnection', 'authenticationChanged',
+ 'reIndexAll', 'dummy',
+ ]),
+ ('Users & Profiles', [
+ 'users', 'userById', 'createUser', 'changeUser', 'deleteUser',
+ 'editUser', 'editMyUser', 'moveUser',
+ 'changeMyPassword', 'changeMyProfile', 'resetUserPassword',
+ 'userPreference', 'setUserPreference', 'editUserPreference',
+ 'uploadAvatar', 'userChange', 'whenUserChange',
+ ]),
+ ('Security Profiles', [
+ 'securityProfiles', 'securityProfileById', 'securityRoles',
+ 'createAdminSecurityProfile', 'createDefaultSecurityProfile',
+ 'createUserSecurityProfile', 'createSecurityProfileMask',
+ 'deleteSecurityProfile', 'editSecurityProfile', 'duplicateSecurityProfile',
+ 'addProfileToUser', 'removeProfileFromUser',
+ 'putSecurityProperties', 'removeSecurityProperties',
+ 'putSecurityRoles', 'removeSecurityRoles', 'setSecurityRoles',
+ ]),
+ ('Groups & Roles', [
+ 'groups', 'groupById', 'createGroup', 'deleteGroup', 'editGroup',
+ 'addUserToGroup', 'removeUserFromGroup',
+ 'roles', 'roleById', 'createRole', 'deleteRole', 'editRole',
+ 'addRoleToUser', 'removeRoleFromUser',
+ ]),
+ ('Organizations & Customers', [
+ 'organizations', 'organizationById', 'organizationsByFilter',
+ 'createOrganization', 'deleteOrganization', 'renameOrganization', 'editOrganization',
+ 'uploadOrganizationLogo',
+ 'customers', 'customerById', 'createCustomer', 'deleteCustomer',
+ 'renameCustomer', 'editCustomer',
+ 'addCustomerToGroup', 'addCustomerToOrganization',
+ 'removeCustomerFromGroup', 'removeCustomerFromOrganization',
+ ]),
+ ('Projects', [
+ 'projects', 'projectById', 'projectTemplates', 'projectTemplateById',
+ 'projectFolderById',
+ 'createProject', 'deleteProject', 'renameProject', 'duplicateProject',
+ 'editProject', 'moveProject', 'moveProjectToCustomer',
+ 'createProjectFolder', 'deleteProjectFolder',
+ 'renameProjectFolder', 'editProjectFolder', 'moveProjectFolder',
+ 'createProjectTemplate', 'deleteProjectTemplate',
+ 'editProjectTemplate', 'duplicateProjectTemplate',
+ 'createFolderFromProject', 'createProjectFromFolder',
+ 'participantsByRoleFilter',
+ 'projectChange', 'projectFolderChange',
+ ]),
+ ('Folders', [
+ 'folders', 'folderById',
+ 'createFolder', 'deleteFolder', 'renameFolder', 'moveFolder', 'editFolder',
+ 'folderChange',
+ ]),
+ ('Assets', [
+ 'assets', 'assetById', 'downloadAsset', 'downloadAssetWithNotes',
+ 'createAsset', 'deleteAsset', 'renameAsset', 'moveAsset', 'editAsset',
+ 'checkOutAsset', 'checkInAsset', 'cancelCheckOutAsset',
+ 'copyAssetToFolder', 'createAssetAlias', 'removeAssetAlias',
+ 'mergeAsset', 'reprocessAsset',
+ 'editRevision', 'editInk',
+ 'streamAttachment', 'streamFile',
+ 'uploadFile', 'uploadOn', 'uploadOnMilestone',
+ 'assetChange', 'mediaChange',
+ ]),
+ ('Collections', [
+ 'collections', 'collectionById', 'anyCollections',
+ 'createCollection', 'deleteCollection', 'renameCollection', 'editCollection',
+ 'addObjectToCollection', 'removeObjectFromCollection',
+ 'moveCollection', 'moveObjectFromCollectionToCollection',
+ 'smartCollections', 'smartCollectionById',
+ 'createSmartCollection', 'deleteSmartCollection',
+ 'editSmartCollection', 'renameSmartCollection',
+ 'collectionChange', 'smartCollectionChange',
+ ]),
+ ('Search & Filters', [
+ 'search', 'searchBySmartCollection', 'entityByPath', 'dumpText',
+ 'namedSearchFilters', 'namedSearchFilterById', 'namedSearchFilterByName',
+ 'createNamedSearchFilter', 'deleteNamedSearchFilter', 'editNamedSearchFilter',
+ ]),
+ ('Approvals', [
+ 'approvals', 'approvalsByUser',
+ 'approve', 'approveObject', 'reject', 'rejectObject',
+ 'resetApproval', 'resetObjectApproval',
+ ]),
+ ('Workflows & Processes', [
+ 'workflows', 'workflowsById', 'workflowsByName', 'workflowsByEntity',
+ 'workflowEngine',
+ 'createWorkflow', 'deleteWorkflow', 'editWorkflow', 'duplicateWorkflow',
+ 'startWorkflow', 'cancelWorkflow',
+ 'editWorkflowEngineCapacity',
+ 'processes', 'processById', 'processMonitoring',
+ 'cancelProcess', 'deleteProcess', 'changeProcessPriority',
+ 'startProcess', 'startFileProcess', 'startURLProcess', 'submitURLProcess',
+ 'restartProcess', 'restartActivity',
+ 'processChanged',
+ ]),
+ ('Notes & Annotations', [
+ 'getNotes', 'noteReport',
+ 'createNote', 'deleteNote', 'updateNote', 'editNote',
+ 'replyToNote', 'editReplyOfNote', 'deleteReplyOfNote',
+ 'addNoteAttachment', 'removeNoteAttachment',
+ 'annotationStatuses', 'annotationStatusById',
+ 'createAnnotationStatus', 'deleteAnnotationStatus',
+ 'updateAnnotationStatus', 'editAnnotationStatus',
+ 'proofReadingMarks', 'proofReadingMarksById',
+ 'myProofReadingMarks', 'myProofReadingMarksById',
+ 'createGlobalProofReadingMark', 'createPrivateProofReadingMark',
+ 'deleteAnyProofReadingMark', 'deleteMyProofReadingMark',
+ 'editGlobalProofReadingMark', 'editPrivateProofReadingmark',
+ 'noteChange', 'whenNoteChange', 'proofReadingMarkChange',
+ ]),
+ ('Notifications', [
+ 'notifications', 'userNotifications', 'notificationSender',
+ 'notificationTemplates', 'notificationTemplateById',
+ 'createNotificationTemplate', 'deleteNotificationTemplate',
+ 'editNotificationTemplate', 'editNotifications',
+ 'disableNotifications', 'enableNotifications',
+ 'updateNotificationSender', 'stopStartNotificationSender',
+ 'markAsSeen', 'resendMail',
+ ]),
+ ('Sharing', [
+ 'getSharing', 'sharingById', 'sharingByUser', 'sharings', 'mySharing',
+ 'createSharing', 'deleteSharing', 'deleteMySharing',
+ 'updateSharing', 'editSharing', 'editMySharing', 'share',
+ ]),
+ ('Email & Output Channels', [
+ 'emailTemplates', 'emailTemplateById',
+ 'createEmailTemplate', 'deleteEmailTemplate',
+ 'updateEmailTemplate', 'editEmailTemplate',
+ 'outputChannelGroups', 'outputChannelGroupById', 'outputChannelById',
+ 'createOutputChannelGroup', 'deleteOutputChannelGroup', 'editOutputChannelGroup',
+ 'createEmailOutputChannel', 'deleteEmailOutputChannel', 'editEmailOutputChannel',
+ 'createFileOutputChannel', 'deleteFileOutputChannel', 'editFileOutputChannel',
+ ]),
+ ('Input Channels & Rules', [
+ 'inputChannels', 'inputChannelById',
+ 'createInputChannel', 'deleteInputChannel', 'editInputChannel',
+ 'inputRuleSets', 'inputRuleSetById',
+ 'createInputRuleSet', 'deleteInputRuleSet', 'editInputRuleSet',
+ ]),
+ ('Metadata', [
+ 'metadataDefinitionById', 'metadataDefinitionByRef',
+ 'createMetadataDefinition', 'deleteMetadataDefinition',
+ 'editMetadataDefinition', 'renameMetadataDefinition',
+ 'nameSpaceDefinitions', 'nameSpaceDefinitionById',
+ 'nameSpaceDefinitionByPrefix', 'nameSpaceDefinitionByURI',
+ 'createMetadataNameSpace', 'deleteMetadataNameSpace', 'editMetadataNameSpace',
+ 'getProperties', 'getProperty', 'setProperties', 'setContent', 'deleteProperty',
+ ]),
+ ('Thesaurus & Taxonomy', [
+ 'thesaurus', 'thesaurusById', 'thesaurusByLabel', 'thesaurusByURI',
+ 'createThesaurus', 'deleteThesaurus',
+ 'synSetById', 'synSetByLabel', 'synSetByURI',
+ 'createSynSet', 'deleteSynSet', 'editSynSet',
+ 'reactivateSynSet', 'retireSynSet',
+ ]),
+ ('Volumes & Hosts', [
+ 'volumes', 'volumeById', 'checkVolumeConnectivity',
+ 'createVolume', 'createFileSystemVolume', 'deleteVolume',
+ 'editVolume', 'editFileSystemVolume', 'updateFileSystemVolumeDiskId',
+ 'hosts', 'hostById', 'hostFoldersByPath',
+ 'deleteHost', 'editHost',
+ ]),
+ ('Color Management', [
+ 'colorSpaces', 'colorSpaceById',
+ 'createColorSpace', 'deleteColorSpace', 'editColorSpace',
+ 'iccProfiles', 'iccProfileById', 'iccProfileByName',
+ 'deleteIccProfile', 'uploadIccProfile',
+ 'inks', 'inkById', 'inkByName', 'inkCoverage',
+ 'viewingConditions', 'viewingConditionById',
+ 'createViewingCondition', 'deleteViewingCondition', 'editViewingCondition',
+ 'editIccContext', 'densitometer', 'gamutCheck', 'gamutWarning',
+ ]),
+ ('Layouts', [
+ 'layouts', 'layoutById',
+ 'createLayout', 'deleteLayout', 'editLayout',
+ ]),
+ ('User Actions', [
+ 'userActions', 'userActionById', 'userActionIconNames',
+ 'userActionInstancesById', 'userActionInstancesByUser',
+ 'createUserAction', 'deleteUserAction', 'editUserAction',
+ 'clearUserActionInstancesById', 'clearUserActionInstancesByUser',
+ 'executeUserAction', 'startUserAction',
+ 'uploadUserActionIcon',
+ 'userActionChange', 'whenUserActionChange',
+ ]),
+ ('UI & Files', [
+ 'getUIFiles', 'getUIFileContent', 'getUIFilesByFilter',
+ 'getUIProjects', 'getUIProjectFiles', 'getUIProjectsByFilter',
+ 'getUIProjectsByName', 'getUIProjectsByType',
+ 'createUIFile', 'createAndUploadUIFile', 'deleteUIFile',
+ 'editUIFile', 'saveUIFile', 'uploadUIFile',
+ 'createUIFolder', 'deleteUIFolder',
+ 'createUIProject', 'createUIProjectWithType', 'deleteUIProject',
+ 'editUIProject',
+ 'streamUIFileContent', 'getFileContent', 'saveFile',
+ ]),
+ ('Preflighting & Rasterizing', [
+ 'preflightReport', 'streamPreflightPreview', 'rasterize', 'readBarCode',
+ ]),
+ ('Import / Export', [
+ 'importedFiles', 'getImportConflicts', 'getImportInfo',
+ 'importData', 'exportData', 'uploadImportFile',
+ 'getSchemaExtensions', 'createSchemaExtension', 'deleteSchemaExtension',
+ 'editSchemaExtension',
+ ]),
+ ('Events & Logging', [
+ 'getEventLogs',
+ 'whenObjectChange', 'whenStepStatusChange',
+ ]),
+ ('Relations', [
+ 'createRelation', 'deleteRelation', 'deleteRelationFromObject', 'editRelation',
+ ]),
+ ('Reports', [
+ 'reports', 'getReportURL',
+ ]),
+ ('Trash', [
+ 'trashedObjects', 'deleteAllTrashedObjects', 'deleteObject',
+ 'restoreTrashedObject', 'trashObject', 'unTrashObject', 'unTrashAllObjects',
+ ]),
+ ('Milestones', [
+ 'createMilestone',
+ ]),
+ ('Activities', [
+ 'activities', 'activityById', 'activityIconById', 'activityIcons',
+ 'activityPresets', 'activityVariables',
+ 'deleteActivity', 'deleteActivityIcon', 'deleteActivityPreset',
+ 'duplicateActivity', 'createCustomActivity', 'deleteCustomActivity',
+ 'editActivity', 'editActivityPreset', 'editCustomActivity',
+ 'editActivityEngineCapacity', 'editActivityEngineTemplate',
+ 'uploadActivityIcon',
+ ]),
+]
+
+# Seed endpoints for Tier 2 detailed docs
+SEED_ENDPOINTS = [
+ # Auth & System
+ 'connectAs', 'disconnectAs', 'whoami', 'serverInformation',
+ # Users
+ 'users', 'userById', 'createUser', 'changeUser',
+ # Security
+ 'securityProfiles', 'createUserSecurityProfile', 'addProfileToUser', 'addRoleToUser',
+ # Projects
+ 'projects', 'projectById', 'projectTemplates', 'createProject', 'deleteProject', 'createFolder',
+ # Assets
+ 'assets', 'assetById', 'createAsset', 'deleteAsset', 'downloadAsset',
+ # Org
+ 'customers', 'customerById', 'groups', 'addUserToGroup',
+ # Search
+ 'search',
+ # Approvals
+ 'approve', 'approveObject',
+]
+
+
+def generate_tier1_index(operations):
+ """Generate the full capability index."""
+ lines = []
+ lines.append("# Dalim ES FUSiON API — Full Capability Index")
+ lines.append("")
+ lines.append("This file lists **all** GraphQL operations available in the Dalim ES FUSiON API.")
+ lines.append("For detailed docs (arguments, types, examples) on actively used endpoints, see `dalim-api-reference.md`.")
+ lines.append("")
+ lines.append(f"**Total: {len(operations)} operations** — {sum(1 for o in operations if o['type']=='query')} Queries, {sum(1 for o in operations if o['type']=='mutation')} Mutations, {sum(1 for o in operations if o['type']=='subscription')} Subscriptions")
+ lines.append("")
+
+ # Build a lookup
+ op_lookup = {op['name']: op for op in operations}
+ assigned = set()
+
+ for domain, names in DOMAIN_PATTERNS:
+ domain_ops = []
+ for name in names:
+ if name in op_lookup:
+ domain_ops.append(op_lookup[name])
+ assigned.add(name)
+
+ if not domain_ops:
+ continue
+
+ lines.append(f"## {domain}")
+ lines.append("")
+
+ # Group by type within domain
+ for op_type, label in [('query', 'Queries'), ('mutation', 'Mutations'), ('subscription', 'Subscriptions')]:
+ typed = [op for op in domain_ops if op['type'] == op_type]
+ if not typed:
+ continue
+ lines.append(f"### {label}")
+ for op in typed:
+ desc = op['description'] or 'No description'
+ # Clean up description
+ desc = desc.replace('\n', ' ').strip()
+ if len(desc) > 120:
+ desc = desc[:117] + '...'
+ ret = op['response_type']
+ lines.append(f"- `{op['name']}` — {desc} → `{ret}`")
+ lines.append("")
+
+ # Catch any unassigned operations
+ unassigned = [op for op in operations if op['name'] not in assigned]
+ if unassigned:
+ lines.append("## Other Operations")
+ lines.append("")
+ for op_type, label in [('query', 'Queries'), ('mutation', 'Mutations'), ('subscription', 'Subscriptions')]:
+ typed = [op for op in unassigned if op['type'] == op_type]
+ if not typed:
+ continue
+ lines.append(f"### {label}")
+ for op in typed:
+ desc = op['description'] or 'No description'
+ desc = desc.replace('\n', ' ').strip()
+ if len(desc) > 120:
+ desc = desc[:117] + '...'
+ ret = op['response_type']
+ lines.append(f"- `{op['name']}` — {desc} → `{ret}`")
+ lines.append("")
+
+ return '\n'.join(lines)
+
+
+def generate_tier2_reference(operations):
+ """Generate detailed reference for seed endpoints."""
+ op_lookup = {op['name']: op for op in operations}
+
+ lines = []
+ lines.append("# Dalim ES FUSiON API — Active Endpoint Reference")
+ lines.append("")
+ lines.append("Detailed documentation for the endpoints actively used in this project.")
+ lines.append("For a full list of all 466 available operations, see `dalim-api-index.md`.")
+ lines.append("")
+ lines.append("---")
+ lines.append("")
+ lines.append("## Authentication")
+ lines.append("")
+ lines.append("The API uses OAuth2 with HMAC SHA256 signing.")
+ lines.append("")
+ lines.append("**Token endpoint:** `https://{HOST}/ES/api/oauth/token`")
+ lines.append("**GraphQL endpoint:** `https://{HOST}/ES/api/graphql`")
+ lines.append("")
+ lines.append("**Get a token:**")
+ lines.append("```python")
+ lines.append('token_data = {')
+ lines.append(' "grant_type": "password",')
+ lines.append(' "client_id": CLIENT_ID,')
+ lines.append(' "client_secret": CLIENT_SECRET,')
+ lines.append(' "username": USERNAME,')
+ lines.append(' "password": PASSWORD')
+ lines.append('}')
+ lines.append('response = requests.post(TOKEN_URL, data=token_data)')
+ lines.append('access_token = response.json()["access_token"]')
+ lines.append('headers = {"Authorization": f"Bearer {access_token}", "Content-Type": "application/json"}')
+ lines.append("```")
+ lines.append("")
+ lines.append("**Dependency chain** (must create in this order):")
+ lines.append("Security Profiles → Users → Projects → Assets")
+ lines.append("")
+ lines.append("---")
+ lines.append("")
+
+ # Group seed endpoints by category
+ categories = [
+ ("System & Auth", ['connectAs', 'disconnectAs', 'whoami', 'serverInformation']),
+ ("Users", ['users', 'userById', 'createUser', 'changeUser']),
+ ("Security Profiles", ['securityProfiles', 'createUserSecurityProfile', 'addProfileToUser', 'addRoleToUser']),
+ ("Projects", ['projects', 'projectById', 'projectTemplates', 'createProject', 'deleteProject', 'createFolder']),
+ ("Assets", ['assets', 'assetById', 'createAsset', 'deleteAsset', 'downloadAsset']),
+ ("Organizations & Customers", ['customers', 'customerById', 'groups', 'addUserToGroup']),
+ ("Search", ['search']),
+ ("Approvals", ['approve', 'approveObject']),
+ ]
+
+ for cat_name, cat_endpoints in categories:
+ lines.append(f"## {cat_name}")
+ lines.append("")
+
+ for ep_name in cat_endpoints:
+ if ep_name not in op_lookup:
+ lines.append(f"### {ep_name}")
+ lines.append(f"*Not found in API — may have a different name*")
+ lines.append("")
+ continue
+
+ op = op_lookup[ep_name]
+
+ lines.append(f"### {op['name']}")
+ lines.append("")
+ lines.append(f"**Type:** {op['type'].capitalize()}")
+ lines.append(f"**Returns:** `{op['response_type']}`")
+ lines.append("")
+
+ if op['description']:
+ lines.append(f"{op['description']}")
+ lines.append("")
+
+ if op['arguments']:
+ lines.append("**Arguments:**")
+ lines.append("")
+ lines.append("| Name | Type | Required | Description |")
+ lines.append("|------|------|----------|-------------|")
+ for arg in op['arguments']:
+ req = "Yes" if arg['required'] else "No"
+ desc = arg['description'] or '—'
+ lines.append(f"| `{arg['name']}` | `{arg['type']}` | {req} | {desc} |")
+ lines.append("")
+
+ if op['example_query']:
+ lines.append("**Example Query:**")
+ lines.append("```graphql")
+ lines.append(op['example_query'])
+ lines.append("```")
+ lines.append("")
+
+ if op['example_variables']:
+ lines.append("**Example Variables:**")
+ lines.append("```json")
+ lines.append(op['example_variables'])
+ lines.append("```")
+ lines.append("")
+
+ if op['example_response']:
+ # Truncate very long responses
+ resp = op['example_response']
+ if len(resp) > 800:
+ resp = resp[:800] + '\n... (truncated)'
+ lines.append("**Example Response:**")
+ lines.append("```json")
+ lines.append(resp)
+ lines.append("```")
+ lines.append("")
+
+ lines.append("---")
+ lines.append("")
+
+ return '\n'.join(lines)
+
+
+def main():
+ with open(f'{DOCS_DIR}/api_parsed.json') as f:
+ data = json.load(f)
+
+ operations = data['operations']
+ print(f"Loaded {len(operations)} operations")
+
+ # Generate Tier 1
+ tier1 = generate_tier1_index(operations)
+ tier1_path = f'{DOCS_DIR}/dalim-api-index.md'
+ with open(tier1_path, 'w') as f:
+ f.write(tier1)
+ print(f"Tier 1 index: {len(tier1):,} bytes → {tier1_path}")
+
+ # Generate Tier 2
+ tier2 = generate_tier2_reference(operations)
+ tier2_path = f'{DOCS_DIR}/dalim-api-reference.md'
+ with open(tier2_path, 'w') as f:
+ f.write(tier2)
+ print(f"Tier 2 reference: {len(tier2):,} bytes → {tier2_path}")
+
+
+if __name__ == '__main__':
+ main()
diff --git a/javascripts/spectaql.min.js b/javascripts/spectaql.min.js
new file mode 100644
index 0000000..6ef3202
--- /dev/null
+++ b/javascripts/spectaql.min.js
@@ -0,0 +1 @@
+function scrollSpy(){var l=5,e=document.querySelector("html"),c=(e&&(e=window.getComputedStyle(e).scrollPaddingTop)&&"string"==typeof e&&"auto"!==e&&e.endsWith("px")&&(l+=parseInt(e.split("px")[0])),"nav-scroll-active"),i=null,d=[];function t(){i=null;var e=document.querySelectorAll("[data-traverse-target]");Array.prototype.forEach.call(e,function(e){d.push({id:e.id,top:e.offsetTop})})}var n=debounce(function(){t(),o()},500),o=debounce(function(){var e,t,n,o,r=(e=>{for(var t=e+l,n=0;n=d[n].top&&(!o||t{toggleMenu(),scrollSpy()});
\ No newline at end of file
diff --git a/parse_api.py b/parse_api.py
new file mode 100644
index 0000000..3f67d9c
--- /dev/null
+++ b/parse_api.py
@@ -0,0 +1,135 @@
+#!/usr/bin/env python3
+"""Parse FUSION_API_index.html using regex to extract all GraphQL operations."""
+
+import re
+import json
+
+def strip_html(text):
+ """Remove HTML tags and clean whitespace."""
+ text = re.sub(r'<[^>]+>', '', text)
+ text = re.sub(r'\s+', ' ', text).strip()
+ return text
+
+def extract_code_text(html):
+ """Extract text content from code blocks, stripping span tags."""
+ return strip_html(html)
+
+def main():
+ print("Reading HTML file...")
+ with open('/Users/daveporter/Desktop/CODING-2024/DALIM-API/FUSION_API_index.html', 'r', encoding='utf-8') as f:
+ html = f.read()
+
+ print(f"HTML size: {len(html):,} bytes")
+
+ # Extract all operation sections
+ # Each section starts with ]*class="operation[^"]*"[^>]*>(.*?)'
+ sections = re.findall(section_pattern, html, re.DOTALL)
+
+ print(f"Found {len(sections)} operation sections")
+
+ operations = []
+ for op_type, op_name, content in sections:
+ op = {
+ 'name': op_name,
+ 'type': op_type,
+ 'description': '',
+ 'response_type': '',
+ 'arguments': [],
+ 'example_query': '',
+ 'example_variables': '',
+ 'example_response': ''
+ }
+
+ # Description
+ desc_match = re.search(r'class="operation-description[^"]*"[^>]*>.*?(.*?)
', content, re.DOTALL)
+ if desc_match:
+ op['description'] = strip_html(desc_match.group(1))
+
+ # Response type
+ resp_match = re.search(r'class="operation-response[^"]*"[^>]*>.*?Returns\s+(.*?)', content, re.DOTALL)
+ if resp_match:
+ op['response_type'] = strip_html(resp_match.group(1))
+
+ # Arguments from table
+ args_section = re.search(r'class="operation-arguments[^"]*"[^>]*>(.*?)