Versions Compared

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

webhook_request_identifier

(mandatory)

Webhook Request Identifier

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

Include Page
V4:webhook_request_identifier
V4:webhook_request_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

...

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

true
Code Block
themeConfluence
languagejs
linenumbers
{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    {
        "response": "4A63ECC0D78946F8BF23D73681D6DA66",
        "entity": "ACTIVITIES",
        "error_code": "LazyInitializationException",
        "error_description": "org.hibernate.LazyInitializationException: could not initialize proxy - no Session
	at org.hibernate.proxy.AbstractLazyInitializer.initialize(AbstractLazyInitializer.java:167)
	at org.hibernate.proxy.AbstractLazyInitializer.getImplementation(AbstractLazyInitializer.java:215)
	at org.hibernate.proxy.pojo.javassist.JavassistLazyInitializer.invoke(JavassistLazyInitializer.java:191)
	at com.crm.dataobject.securitymanagement.CRMDOSecretKey_$$_javassist_111.getKey(CRMDOSecretKey_$$_javassist_111.java)
	at com.cr",
        "number": "7",
        "url": "http://127.0.0.1:9080/crmapi/rest/v2/activities/create",
        "request": "4A63ECC0D78946F8BF23D73681D6DA66",
        "log_information":
        {
            "updated_date": "2015-11-02T16:03:41",
            "created_date": "2015-11-02T16:03:33",
            "created_by_unit":
            {
                "community_name": "Internal Community",
                "id": "0C3B5CB66ED4AACF5C2FDDAE984704E8",
                "name": "Installation Team 4",
                "group_name": "Paphos",
                "description": null,
                "alternative_code": "IT4"
            },
            "updated_by_unit":
            {
                "community_name": "Internal Community",
                "id": "0C3B5CB66ED4AACF5C2FDDAE984704E8",
                "name": "Installation Team 4",
                "group_name": "Paphos",
                "description": null,
                "alternative_code": "IT4"
            },
            "created_by_user":
            {
                "person_name": "m_ioannou",
                "username": "m_ioannou",
                "id": "C5D6D95C71C4484F9168A5444FC928EF",
                "email": "m_ioannou@crm.com"
            },
            "updated_by_user":
            {
                "person_name": "m_ioannou",
                "username": "m_ioannou",
                "id": "C5D6D95C71C4484F9168A5444FC928EF",
                "email": "m_ioannou@crm.com"
            }
        },
        "life_cycle_state": "REJECTED",
        "entity_id": "4A63ECC0D78946F8BF23D73681D6DA66",
        "id": "2429282E27054ABFB4A8F4F20593D241",
        "webhook_definition":
        {
            "life_cycle_state": "EFFECTIVE",
            "id": "53D29BC888854021A238DF9FEB7D6F76",
            "name": "Test",
            "alternative_code": "T"
        },
        "fields_set": null,
        "workflow_rule":
        {
            "life_cycle_state": "EFFECTIVE",
            "id": "A94ABA3BDF2745FA8AE8F5B71DD4CA8F",
            "name": "Activity Rule",
            "alternative_code": "AR"
        }
    }
} 

...

Name

Type

Description

token

String

The token retrieved from the login method

webhook_definition_identifier

(semi-optional)

Webhook Definition IdentifierThe identifier of the webhook definition related with the webhook requests that should be returned as a result. The allowed webhook definition identifier fields are the following:

Include Page
V4:webhook_definition_identifier
V4:webhook_definition_identifier

workflow_rule_identifier

(semi-optional)

Workflow Rule IdentifierThe identifier of the workflow rule that triggered the webhook requests 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 webhook requests 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 webhook requests that should be returned as a result

url

(optional)

StringThe URL related with the webhook requests that should be returned as a result

life_cycle_state

(optional)

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

created_date

(optional)

Date The created date of the webhook requests 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

 
webhook_request_identifier

(mandatory)

Webhook Request Identifier

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

Include Page
V4:webhook_request_identifier
V4:webhook_request_identifier

Note that only rejected webhook requests can be specified in this method.

 

...

Name

Type

Description

 

token

String

The token retrieved from the login method

 
webhook_request_identifier

(mandatory)

Webhook Request Identifier

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

Include Page
V4:webhook_request_identifier
V4:webhook_request_identifier

 

...