Data library

Set a node, i.e. create or update it, or retrieve information required to create or update it.

Get a version of a node.

Delete a node version and everything that depends on it. If this is the only version, delete the node.

Copies a node version to a new node, or to a new version of an existing node.

Change the reference of a node.

Change the node type for a node.

Change the owner associated with a node.

Node import is a flexible, high-performance service for loading data into Advisor.

Export nodes.

This is used as a quick way of retrieving a piece of data, but bypassing the read if the data has not changed since the last read.

Call the service passing it a node version reference for the node, one for the member type, and optionally a timestamp when it was last retrieved or updated.

If the data has changed since the timestamp, the service will return changed of true, timestamp set to ...

Return a list of node versions.

Lists all the versions of a node.

List the node types that the user has used recently.

List the node types that are in use within a package.

The Update Node Versions service creates new versions of nodes which link to new versions of node types and member type targets, to update a node structure to later node versions.

Freeze a node version, and all the draft node versions on which it depends, i.e. the node version of its node type and all its target nodes.

Create a user.

Retrieve information about a user.

The user running the service must be able to grant to the user, e.g. they must be the user, or have maintain-users permission, or own-users permission.

This is similar to GetUser, but GetUser is used for sign on processing and only returns details of the user ...

Return the home node for the current user.

Indicates whether a user or user group already exists.

Return all the user groups and all the users to which the current user is authorised to grant, or, on the case of users, authorised to include in user groups.

Search for a user.

Return all the users over which the current user has own-users authority.

Lists users for a given email address.

This is intended to be used by a sign-in helper script. It returns the response in JSON format.

Update user information, i.e. name and email address.

Change a user's status.

Set the indicator to force a user to change their password next time they sign in.

Change a user's password.

Service to set or get a user property, i.e. a property on the user's node.

Delete a user.

The caller must have authority to maintain the user and must have own users authority on the new group, the same permissions they would need to delete and user and create a new user in the to user group.

Creates a Metrici session.

It does not create a proxy session if:

• The caller is not authorised.
• The account identifier is not passed or does not exist.
• The caller does not have a proxy user in the account.

Determine if a session token is still valid.

This does not sign in with the session token. Single use session tokens are not consumed by using this.

Cancels a Metrici session.

Create a user group.

Return details of a user group and its members.

Indicates whether a user or user group already exists.

Return all the user groups and all the users to which the current user is authorised to grant, or, on the case of users, authorised to include in user groups.

Return a list of user groups that this user is authorised to administer, or over which they have own-users authority.

Update the name and description of a user group.

Add a user to a user group.

Remove a user from a user group.

The caller must have authority to maintain the user and must have own users authority on the new group, the same permissions they would need to delete and user and create a new user in the to user group.

Delete a user group.

Create permissions.

List the permissions the user is authorised to maintain and create.

Delete a permission, using the permission id.

Refreshes the permissions defined on a manifest.

Run another service, after checking that the user has submit service authority.

It is astronomically improbable that two strings have the same hash, or that a string can be derived from a hash by brute force.

Returns a secure one-way hash of a string in a way that only the user can calculate. Use this so that a user can "sign" a string and later check that it has not been modified.

It is astronomically improbable that two strings have the same hash, or that a string can be derived from a hash by brute force.

The hash is sensitive to changes in the user setup, such as password change, so this should only be used for hashing strings as part of a short-term process.

Use ...

Generates a public/private key pair, using the RSA algorithm, and 2048 bit encryption.

Keys are returned in privacy enhanced mail (PEM) format.

This is a very simple service. It requires no authorisation, and it returns no errors.

Create a JSON Web Token (JWT), signed with a private key. The private key should have been generated with the GenerateKeys service, and is passed in as a PEM-format PKCS#8 encoded string.

Verify a JSON Web Token (JWT).

The JWT is verified against a public key passed in as a PEM-encoded string.

In addition to verifying the JWT signature, the service performs the following checks:

• That the jwt has not expired. If passed, the clockSkew value can be set to a number of additional seconds to allow an expired token, to make up for clockSkew, or for the time taken for a token to be passed to a service.
• The the JWT "aud" claim, if present, ...

Return theming details for a user and/or a domain.

List the themes available to a user.

Read all of the data in a user file and return it as a block of text. Optionally can access an entry within a zip file. Can return plain text or base64.

The service runs without authority; if a user knows the storage key they are presumed to have authority to read the file.

Write data out to a user file.

Returns information about a user file identified by a file storage key.

By default this returns only an error number to indicate if the file storage key is valid and, if it is valid, the size of the file.

Set the parameter contentType to true to return a contentType for the file.

Set the parameter digest to a digest method (such as MD5) to return a digest of the content of the file. The list of permissible methods is available in the "MessageDigest ...

Resizes an image held in a user file.

Read an Excel file and return the contents using JavaScript Object Notation (JSON).

This supports .xlxs files, as produced by Excel 2007 onwards.

Write an Excel file using data described using JavaScript Object Notation (JSON).

Write a PDF file using XSL formatting object (FO) data.

Utilities for manipulating PDF files.

Sends an email.

The HttpClient service performs HTTP operations such as GET and POST against a remote service. It can be used to retrieve remote web pages or interact with web services.

It supports:

• GET, POST, PUT, DELETE and HEAD methods
• HTTPS and port specification.
• Authentication
• Parameters
• Headers
• Data

The service deals with basic authentication and redirects which may require more than one HTTP request. It will ...

SFTP client accesses files on a remote server using the SSH file transfer protocol (SFTP).

Returns whatever is passed to it, minus user credentials.

Run a JavaScript script.

Schedule a service to run later.

Run a set of rules to infer more findings from a set of input facts.

Parses tabular data that typically has been pasted or saved from a spreadsheet program.

Searches for nodes.