Skip to main content
Version: 1.1beta1

Concepts

This page describes high-level concepts relevant to understand in relation to our API method structure.

Method​

Method is a named operation that takes as set of parameters and returns a result of a specific type. This is pretty much analogious to a function or method in almost any programming language. The only real difference to be aware of, is that all RPC methods may return an error, and that a method will never return both an error and a result.

Please see the page on JSON RPC requests for detials.

Namespace​

Namespace is a group of methods that is used in Clarify to describe and controll access. It appears as a prefix in the full method name. Which namespace a particular integration should have acces to, must be configured in the admin pannel API acccess tab. By default, all integrations have access to the integration namespace.

Integration​

Integration is a princiapl resource type that represents your application or integration code inside Clarify. Your application will need to use credentials associated with a specific integration in Clarify in order to get access to Clarify.

In the current API version you will find references to an Integration ID, but no specific methods to view or modify the resource. You will however be able to find the resource inside the admin panel.

Resource​

Resource describe an a meta-data entity that holds a specific type and has a unqiue ID. A resource can have multiple views. Most typically, it would have at least one view for select operations and another view for save operatoins.

Resources are accessed and modified through methods, which are organized in namespaces.

Resource type​

A resource type, is a group of resources that hold the same "type" property. Resources of the same type share the same set of views, and can typicaly be accessed or modified together in the same set of methods.

Each type will aslo define their own set of filterable fields for use with our filter syntax in select methods.

Exaple of resource types are "signals" and "items".

View​

View refer to the top-level schema for a resource entry in a particular context. Generally select views expose more fields than save views.

Schema​

A schema is an explicit description of how to validate a (JSON) data-type. Such a description could include a regex pattern for a string, or a list of sub-schemas for how ti validate each named property of a JSON object.