OBJECT
Mutation

GraphQL Schema definition

type Mutation {
#   Adds a document which will be assigned to an existing or new docSet on the basis 
#   of the specified selectors
# 
# Arguments
#   selectors: The selectors for this document, the keys of which 
#   must match those of the Proskomma instance
#   contentType: The format of the content (probably usfm or usx)
#   content: The document content as a string
#   tags: A list of tags to be added
addDocument(
selectors: [InputKeyValue!]!,
contentType: String!,
content: String!,
tags: [String!]
): Boolean! 
#   Creates a new, empty sequence
# 
# Arguments
#   documentId: The id of the document to which the sequence will 
#   be added
#   type: The type of the new sequence (main, heading...)
#   blocksSpec: The JSON describing blocks, if any, for the new 
#   sequence
#   graftToMain: If true, graft to the first block of the main 
#   sequence
#   tags: 'A list of tags to be added
newSequence(
documentId: String!,
type: String!,
blocksSpec: [inputBlockSpec!],
graftToMain: Boolean,
tags: [String!]
): String! 
#   Adds a new block to a sequence
# 
# Arguments
#   documentId: The id of the document containing the sequence to 
#   which the block will be added
#   sequenceId: The id of the sequence to which the block will be 
#   added
#   blockN: The zero-indexed position at which to add the block
#   blockScope: The scope to be applied to the block, eg 
#   blockScope/p
newBlock(
documentId: String!,
sequenceId: String!,
blockN: Int!,
blockScope: String!
): Boolean! 
#   Deletes a docSet
# 
# Arguments
#   docSetId: The id of the docSet containing the document to be 
#   deleted
deleteDocSet(docSetId: String!): Boolean 
#   Deletes a document
# 
# Arguments
#   docSetId: The id of the docSet containing the document to be 
#   deleted
#   documentId: The id of the document to be deleted
deleteDocument(docSetId: String!, documentId: String!): Boolean 
#   Deletes a sequence from a document
# 
# Arguments
#   documentId: The id of the document containing the sequence to 
#   be deleted
#   sequenceId: The id of the sequence to be deleted
deleteSequence(documentId: String!, sequenceId: String!): Boolean 
#   Deletes a block from a sequence
# 
# Arguments
#   documentId: The id of the document containing the sequence from 
#   which the block will be deleted
#   sequenceId: The id of the sequence from which the block will be 
#   deleted
#   blockN: The zero-indexed number of the block to be deleted
deleteBlock(documentId: String!, sequenceId: String!, blockN: Int!): Boolean 
#   Explicitly rebuild the text lookup tables for a docSet. (You probably don't need 
#   to do this)
# 
# Arguments
#   docSetId: The id of the docSet
rehashDocSet(docSetId: String!): Boolean! 
#   Add one or more tags to a docSet, if they are not already present
# 
# Arguments
#   docSetId: The id of the docSet to which the tags will be added
#   tags: A list of tags to be added
addDocSetTags(docSetId: String!, tags: [String]!): [String!]! 
#   Add one or more tags to a document, if they are not already present
# 
# Arguments
#   docSetId: The id of the docSet containing the document to which 
#   the tags will be added
#   documentId: The id of the document to which the tags will be 
#   added
#   tags: A list of tags to be added
addDocumentTags(
docSetId: String!,
documentId: String!,
tags: [String]!
): [String!] 
#   Add one or more tags to a sequence, if they are not already present
# 
# Arguments
#   docSetId: The id of the docSet containing the document 
#   containing the sequence to which the tags will be added
#   documentId: The id of the document containing the sequence to 
#   which the tags will be added
#   sequenceId: The id of the sequence to which the tags will be 
#   added
#   tags: A list of tags to be added
addSequenceTags(
docSetId: String!,
documentId: String!,
sequenceId: String!,
tags: [String]!
): [String!] 
#   Remove one or more tags from a docSet, if they are present
# 
# Arguments
#   docSetId: The id of the docSet from which the tags will be 
#   removed
#   tags: A list of tags to be removed
removeDocSetTags(docSetId: String!, tags: [String]!): [String!] 
#   Remove one or more tags from a document, if they are present
# 
# Arguments
#   docSetId: The id of the docSet containing the document from 
#   which the tags will be removed
#   documentId: The id of the document from which the tags will be 
#   removed
#   tags: A list of tags to be removed
removeDocumentTags(
docSetId: String!,
documentId: String!,
tags: [String]!
): [String!] 
#   Remove one or more tags from a sequence, if they are present
# 
# Arguments
#   docSetId: The id of the docSet containing the document 
#   containing the sequence from which the tags will be removed
#   documentId: The id of the document containing the sequence from 
#   which the tags will be removed
#   sequenceId: The id of the sequence from which the tags will be 
#   removed
#   tags: A list of tags to be removed
removeSequenceTags(
docSetId: String!,
documentId: String!,
sequenceId: String!,
tags: [String]!
): [String!] 
#   Replaces the items of a block with a new set of items
# 
# Arguments
#   docSetId: The id of the docSet containing the document 
#   containing the sequence containing the block for which the items will be updated
#   documentId: The id of the document containing the sequence 
#   containing the block for which the items will be updated
#   sequenceId: The id of the sequence containing the block for 
#   which the items will be updated (defaults to the main sequence)
#   blockPosition: The zero-indexed number of the block for which 
#   the items will be updated
#   items: The new content for the block as item objects
#   blockGrafts: BlockGrafts for the block as item objects
#   blockScope: Optional blockScope for the block as an item object
updateItems(
docSetId: String!,
documentId: String!,
sequenceId: String,
blockPosition: Int!,
items: [InputItemObject!],
blockGrafts: [InputItemObject!],
blockScope: InputItemObject
): Boolean! 
#   Replaces all the blocks of a sequence with a new set of blocks
# 
# Arguments
#   docSetId: The id of the docSet containing the document 
#   containing the sequence for which the blocks will be updated
#   documentId: The id of the document containing the sequence for 
#   which the blocks will be updated
#   sequenceId: The id of the sequence for which the blocks will be 
#   updated (defaults to the main sequence)
#   blocksSpec: The JSON describing blocks
updateAllBlocks(
docSetId: String!,
documentId: String!,
sequenceId: String,
blocksSpec: [inputBlockSpec!]!
): Boolean! 
#   Garbage collects unused sequences within a document. (You probably don\'t need 
#   to do this.)
# 
# Arguments
#   docSetId: The id of the docSet containing the document to be 
#   garbage collected
#   documentId: The id of the document to be garbage collected
gcSequences(docSetId: String!, documentId: String!): Boolean! 
#   Adds verse mapping tables to the documents in a docSet, where the verse mapping 
#   may be provided in legacy .vrs or JSON format
# 
# Arguments
#   docSetId: the id of the docSet to which the verse mapping will 
#   be added
#   vrsSource: The verse mapping, in legacy .vrs format (as a 
#   string)
#   jsonSource: The verse mapping, in JSON format (as a string)
setVerseMapping(
docSetId: String!,
vrsSource: String,
jsonSource: String
): Boolean! 
#   Removes verse mapping tables from the documents in a docSet
# 
# Arguments
#   docSetId: The id of the docSet from which verse mapping will be 
#   removed
unsetVerseMapping(docSetId: String!): Boolean! 
}
Require by

This element is not required by anyone
Mutation

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
