Private Optional ItemProtected baseProtected configPrivate fetchProtected instanceProtected jsonProtected labelProtected loggerProtected matrixPrivate projectProtected sessionProtected simplePrivate appPrivate appPrivate appPrivate appOptional filter: stringOptional ignoreFilters: booleanOptional fieldList: stringOptional crossProject: stringOptional labels: booleanOptional down: booleanOptional up: booleanOptional treeOrder: booleanPrivate appCreates a folder
where to store the folder
name of the folder
Optional data: ISetField[]array with fieldNames and values
Promise to the item id of folder
error in case of input error (bad fields, etc)
create a new item in the database
Use: createItem( "F-REQ-1", "my item", [{fieldName:"description",value:"x"}], ["labelx"], downlinks:["SPEC-1"], uplinks:[] )
where to store the item
name of the item
Optional data: ISetField[]array with fieldNames and values
Optional labels: []list of labels to set
Optional downlinks: []list of downlinks to create
Optional uplinks: []list of uplinks to create
the created item id
Actually download a job file
Optional mode: stringOptional format: stringOptional disposition: stringOptional options: unknownAn ArrayBuffer
gets the value of a field of an item from the database
Use: await getField( "REQ-1", "description")
the id of the item like "REQ-1" or a specific version like "REQ-1-v1"
name of the field
Promise to the value of the field
Error in case of invalid item or field
get a folder from the database, filling in it's children.
the id of the folder like "F-
Promise to ITitleAndId array
error if folderId is invalid
Private getget an item from the database as json object.
Use: await api.getItem("F-DOC-1")
the id of the item like "REQ-1" or a specific version like "REQ-1-v1"
Promise to json object with all fields, links and labels
error in case the itemId is bad.
Optional options: unknownRetrieve all changes in a project
project name
Optional startAt: number(optional) start the audit after N records
Optional maxResults: number(optional) retrieve N results per page
Optional deleteOnly: boolean(optional) if true, only returns actions of type delete
Optional tech: boolean(optional) if true, returns the underneath changes
Optional auditIdMin: number(optional) sets a minimum ID for audits as returned by GET calendar
Optional auditIdMax: number(optional) sets a maximum ID for audits
Optional noReport: boolean(optional) if true, avoid reports in the output
Optional noImport: boolean(optional) if true, avoid imports in the output
Optional include: string(optional) a comma-seperated list of actions to include (delete,undelete,add,edit,...)
Optional resolveRef: boolean(optional) if true, resolve item IDs into refs
Optional itemRef: string(optional) restrict the audit to only those mentioning this item
a TrimAuditList structure
Get the TODOs for a project.
project name
Optional itemRef: stringif specified, returns all todos linked to an item, regardless of user
Optional includeDone: booleanif true, includes done todos
Optional includeAllUsers: booleanif true, includes all todos for all users.
Optional includeFuture: booleanfalse by default. If true, includes future todos.
Information on the todos.
Return server settings (also called customer settings).
A GetSettingAck object describing all the server settings
get the initial tree structure from a project. Project must be set first.
Private getPrivate initializePrivate logRetrieve or create a Project object for the given project name. The method is asynchronous because it may require a trip to the server to retrieve project configuration.
a valid string.
A valid Project object, or null if the project name is undefined.
Private parseProtected parsePrivate parseOptional fieldList: stringsearch items
search expression, e.g. mrql:category=REQ
Optional includeFields: booleantrue to include fields
Optional includeLinks: booleantrue to include links
Optional includeLabels: booleantrue to include labels
Optional filter: stringsearch results
Optional options: IProjectSearchOptionsset a field of an item in the database
Use: await api.setField("PROC-83", "plain english", "x");
itemId the id of the item like "REQ-1"
name of the field
value of the field
Promise to the updated item
Error in case of invalid itemId or fieldName
sets multiple fields in the database
Use: await api.setFields("PROC-83", [{fieldName:"plain english",value:"x"}] )
itemId itemId the id of the item like "REQ-1"
array of fieldName and value tupels
the updated item
Error in case of invalid id or fields
Optional currentVersion: numberPrivate uploadGenerated using TypeDoc
StandaloneMatrixSDK is a connection to a Matrix Instance. It offers services to interact with the Instance. A primary purpose beyond authenticating on the server is to provide access to Project objects through openProject() or openCurrentProjectFromSession().