584b7df68b
Complete client-facing DAM interface for Dalim ES FUSiON GraphQL API: - Asset browsing, search with faceted filtering, project/folder navigation - Send To distribution to 17 MMS platforms (PIM, Social, Google, In-Store, Print) - 10 workflow templates, approval queue, process monitor with progress bars - Collections with thumbnail mosaics, dashboard with KPI cards and activity feed - Docker Compose (app + PostgreSQL), mock mode, error boundaries - Two-tier API reference docs (466 operations indexed, 29 detailed) - MediaMarkt branding: Noto Sans Display, #DF0000 red, dark sidebar Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
10815 lines
No EOL
541 KiB
JSON
10815 lines
No EOL
541 KiB
JSON
{
|
|
"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\" } } }"
|
|
}
|
|
]
|
|
} |