Versions Compared

Old Version 9

changes.mady.by.user Marios Michael

Saved on

compared with

New Version 10

changes.mady.by.user Marios Michael

Saved on

Key

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

Available from CRM.COM R9.0.0


Table of Contents
maxLevel2

...

Name

Type

Description

token

String

The token retrieved from the login method

alert_identifier

(mandatory)

Alert Identifier

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

Include Page
V4:alert_identifier
V4:alert_identifier

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

...

Name

Type

Description

token

String

The token retrieved from the login method

recipient_identifier
(semi-optional)		Recipient IdentifierThe identifier of the recipient related with the alerts that should be returned as a result. The allowed recipient identifier fields are the following:

Include Page
V4:user_identifier
V4:user_identifier

alert_definition_identifier

(semi-optional)

Alert Definition IdentifierThe identifier of the alert definition related with the alerts that should be returned as a result. The allowed alert definition identifier fields are the following:

Include Page
V4:alert_definition_identifier
V4:alert_definition_identifier

workflow_rule_identifier

(semi-optional)

Workflow Rule IdentifierThe identifier of the workflow rule that triggered the alerts that should be returned as a result. The allowed workflow rule identifier fields are the following:

Include Page
V4:workflow_rule_identifier
V4:workflow_rule_identifier

entity

(semi-optional)

String

The name of the entity related with the alerts that should be returned as a result. The supported entities are the following:

  • ACTIVITIES

entity_id

(semi-optional)

StringThe ID of the entity related with the alerts that should be returned as a result

recipient_email_address

(optional)

StringThe email address of the recipient related with the alerts that should be returned as a result

recipient_phone_number

(optional)

StringThe phone number of the recipient related with the alerts that should be returned as a result

life_cycle_state

(optional)

StringThe life cycle state of the alerts that should be returned as a result. The supported options are SUCCESSFUL or REJECTED

created_date

(optional)

Date The created date of the alerts that should be returned as a result.

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

...

Name

Type

Description

 

token

String

The token retrieved from the login method

 
alert_identifier

(mandatory)

Alert Identifier

The identifier of the alert that should be send again. The allowed alert Identifier fields are the following:

Include Page
V4:alert_identifier
V4:alert_identifier

Note that only rejected alerts can be specified in this method.

 

...

Expand
titleExample 1

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejs
linenumberstrue
 

 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
          "token":"438BA44BD33B44EEBC77746030A92629",
          "alert_identifier":{"number":"11"}
} 

 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    {
        "recipient_phone_number": "357232256789",
        "entity": "ACTIVITIES",
        "error_code": "SendingSMSFailException",
        "error_description": "Error:Sending sms failed.  Error: ERROR No Account Found for the Given Credentials. - Description:Sending sms failed.",
        "number": "11",
        "log_information":
        {
            "updated_date": "2016-01-19T11:28:22",
            "created_date": "2016-01-07T13:33:22",
            "created_by_unit":
            {
                "community_name": "Internal Community",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "name": "Admin Unit",
                "group_name": "Main Group",
                "description": "r1",
                "alternative_code": "MG"
            },
            "updated_by_unit":
            {
                "community_name": "Internal Community",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "name": "Admin Unit",
                "group_name": "Main Group",
                "description": "r1",
                "alternative_code": "MG"
            },
            "created_by_user":
            {
                "person_name": "MPAdministrator",
                "username": "MPAdministrator",
                "id": "1",
                "email": "crm.com.tst@gmail.com"
            },
            "updated_by_user":
            {
                "person_name": "Marios Lannister",
                "username": "MPAdministrator",
                "id": "1"
            }
        },
        "life_cycle_state": "REJECTED",
        "alert_definition":
        {
            "life_cycle_state": "EFFECTIVE",
            "type": "SMS",
            "id": "3901B04101C843C4BA80EC6698FA8331",
            "name": "Installation alert SMS",
            "alternative_code": "IAS"
        },
        "entity_id": "FB351B991DFB46FFAD49BDB19B653ED3",
        "content": "New Installation activity ACT000256 assigned to your unit Admin Unit ",
        "recipient":
        {
            "person_name": "m_clerides",
            "username": "m_clerides",
            "id": "D502772234A6A5F3DEBF0D77D06D9703",
            "email": "crm.com.tst@gmail.com"
        },
        "type": "SMS",
        "id": "02F9E6D58FC14B4CB5740451067FDB64",
        "workflow_rule":
        {
            "life_cycle_state": "NOT_EFFECTIVE",
            "id": "70701D9EAD034C52A729BD4EC89C7230",
            "name": "Installations",
            "alternative_code": "I"
        }
    }
}

POST alerts/delete

This method is used to delete successful or rejected alerts.  A single alert can be deleted through this method

...

Name

Type

Description

 

token

String

The token retrieved from the login method

 
alert_identifier

(mandatory)

Alert Identifier

The identifier of the alert that should be deleted. The allowed alert Identifier fields are the following:

Include Page
V4:alert_identifier
V4:alert_identifier

 

...