Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Tip

Available from CRM.COM R5.0.0

Table of Contents
maxLevel2

GET access_tokens/show

This method returns information related with an access token. A single access token is returned by each call

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

(mandatory)

...

Access Token identifier  

The identifier of the access token that should be returned as a result. The allowed access token identifier fields are the following:

...

fields_set

(optional)

...

List of Strings, comma separated 

...

A list of fields that should be included in the results. If not specified then all the available fields will be returned

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

...

Examples

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 

POST access_tokens/create

This method creates an access token.  Single access tokens can be created by each call.

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

authentication_code

(optional)

String

The authentication code of the access token that will be created. If not specified then it will be generated automatically.

identifier

(mandatory on conditions)

String

The identifier of the access token that will be created. This information is not mandatory if the system is set up to allow creating access tokens with no identifier and pass code.

pass_code

(mandatory on conditions)

StringThe pass code of the access token that will be created. This information is not mandatory if the system is set up to allow creating access tokens with no identifier and pass code, although it is always mandatory if an identifier was specified. 

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

...

Examples

Expand
titleExample 1

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 

 

 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 

POST access_tokens/update

This method updates reward participants. A single rewards participant can be updated by each call. Fields which are not specified are not updated at all. Fields which are specified as null will be set as null.

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

(mandatory)

...

Access Token identifier  

The identifier of the access token that should be updated. The allowed access token identifier fields are the following:

...

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

...

Examples

HTTP Method: POST

 

Request:

Body:

Expand
titleExample 1
Code Block
themeConfluence
languagejavascript
linenumberstrue
 

 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
  Panel
nameblue

Child pages (Children Display)
alltrue
excerpttrue