Tip
Available from CRM.COM R9.0.0

Table of Contents

maxLevel	2

...

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 Identifier

The 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 Identifier

The 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 Identifier

The 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)

String

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

recipient_email_address

(optional)

String

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

recipient_phone_number

(optional)

String

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

life_cycle_state

(optional)

String

The 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

...

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	js
linenumbers	true

 {
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    [
        {
            "entity": "ACTIVITIES",
            "number": "4",
            "recipient_email_address": "m_ioannou@crm.com",
            "subject": "Test Alert ACT000366 ",
            "log_information":
            {
                "updated_date": "2015-11-03T12:08:04",
                "created_date": "2015-11-03T12:08:03",
                "created_by_unit":
                {
                    "community_name": "Internal Community",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "group_name": "Main Group",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "community_name": "Internal Community",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "group_name": "Main Group",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "sakkascy1986@hotmail.com"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "sakkascy1986@hotmail.com"
                }
            },
            "life_cycle_state": "SUCCESSFUL",
            "alert_definition":
            {
                "life_cycle_state": "EFFECTIVE",
                "type": "EMAIL",
                "id": "26D38E26DE6647529FDCCBFD0F2F7C48",
                "name": "Send Alert To created By User",
                "alternative_code": "CREATED_BY_USER"
            },
            "entity_id": "78F2C4952DF14A38B7F789393AC84EDC",
            "content": "  Mr Ioannou132 Marios  your  activity with number  ACT000366 was created

  with sub    location    

   with job     location    

   with lead           ",
            "recipient": null,
            "type": "EMAIL",
            "id": "DDB095659F0A4354BA4DF17F1BC21232",
            "workflow_rule":
            {
                "life_cycle_state": "EFFECTIVE",
                "id": "5DB96A77C25B4D19A65C4515D4E0D394",
                "name": "Workflow Rule Activity On Update",
                "alternative_code": "Upd_Act"
            }
        },
        {
            "entity": "ACTIVITIES",
            "number": "5",
            "recipient_email_address": "sakkascy1986@hotmail.com",
            "subject": "Test Alert ACT000355 ",
            "log_information":
            {
                "updated_date": "2015-11-03T15:00:44",
                "created_date": "2015-11-03T15:00:43",
                "created_by_unit":
                {
                    "community_name": "Internal Community",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "group_name": "Main Group",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "community_name": "Internal Community",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "group_name": "Main Group",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "sakkascy1986@hotmail.com"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "sakkascy1986@hotmail.com"
                }
            },
            "life_cycle_state": "SUCCESSFUL",
            "alert_definition":
            {
                "life_cycle_state": "EFFECTIVE",
                "type": "EMAIL",
                "id": "26D38E26DE6647529FDCCBFD0F2F7C48",
                "name": "Send Alert To created By User",
                "alternative_code": "CREATED_BY_USER"
            },
            "entity_id": "7FB01C80AF6D47B0A9740E0A9A10C2D0",
            "content": "  Mr Ioannou130 Marios  your  activity with number  ACT000355 was created

  with sub    location    

   with job     location    

   with lead           ",
            "recipient":
            {
                "person_name": "MPAdministrator",
                "username": "MPAdministrator",
                "id": "1",
                "email": "sakkascy1986@hotmail.com"
            },
            "type": "EMAIL",
            "id": "B59339D5C4DE47569D71FD077FE26325",
            "workflow_rule":
            {
                "life_cycle_state": "EFFECTIVE",
                "id": "5DB96A77C25B4D19A65C4515D4E0D394",
                "name": "Workflow Rule Activity On Update",
                "alternative_code": "Upd_Act"
            }
        },
        {
            "entity": "ACTIVITIES",
            "number": "6",
            "recipient_email_address": "m_ioannou@crm.com",
            "subject": "Test Alert ACT000366 ",
            "log_information":
            {
                "updated_date": "2015-11-03T16:43:01",
                "created_date": "2015-11-03T16:42:31",
                "created_by_unit":
                {
                    "community_name": "Internal Community",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "group_name": "Main Group",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "community_name": "Internal Community",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "group_name": "Main Group",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "sakkascy1986@hotmail.com"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "sakkascy1986@hotmail.com"
                }
            },
            "life_cycle_state": "SUCCESSFUL",
            "alert_definition":
            {
                "life_cycle_state": "EFFECTIVE",
                "type": "EMAIL",
                "id": "26D38E26DE6647529FDCCBFD0F2F7C48",
                "name": "Send Alert To created By User",
                "alternative_code": "CREATED_BY_USER"
            },
            "entity_id": "78F2C4952DF14A38B7F789393AC84EDC",
            "content": "  Mr Ioannou132 Marios  your  activity with number  ACT000366 was created

  with sub    location    

   with job     location    

   with lead           ",
            "recipient":
            {
                "person_name": "m_ioannou",
                "username": "m_ioannou",
                "id": "C5D6D95C71C4484F9168A5444FC928EF"
            },
            "type": "EMAIL",
            "id": "761E70B2CF7E4E3F9DD4140A98023536",
            "workflow_rule":
            {
                "life_cycle_state": "EFFECTIVE",
                "id": "5DB96A77C25B4D19A65C4515D4E0D394",
                "name": "Workflow Rule Activity On Update",
                "alternative_code": "Upd_Act"
            }
        },
....
   ]
}

POST alerts/resend

This method is used to re-send rejected alerts. This method is applicable only on rejected alerts. A single alert can be re-send 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 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.

...

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

...

Versions Compared

Old Version 7

New Version 8

Key

POST alerts/resend

Page Comparison

Versions Compared

Old Version 7

New Version 8

Key

POST alerts/resend