Versions Compared

Old Version 2

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Joseph Ioannou (Unlicensed)

Saved on

Key

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

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...


Excerpt

This method updates activities.  Single  Single activities 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

activity_identifier

(mandatory)

Activity Identifier

The identifier of the activity to be updated. The allowed activity identifier fields are the following:

Include Page
V4:activity_identifier
V4:activity_identifier

category_identifier

(optional)

Category Identifier

The category of the activity. The allowed activity category identifiers are the following:

Include Page
V4:activity_category_identifier
V4:activity_category_identifier

status_identifier

(optional)

Activity Status Identifier

The status of the activity. The allowed activity status identifiers are the following:

Include Page
V4:activity_status_identifier
V4:activity_status_identifier

description

(optional)

StringThe description of the retrieved activity

notes

(optional)

StringThe notes of the retrieved activity

start_date

(optional)

DateThe date that the activity will start

owned_by_group_identifier

(optional)

The identifier of the owned by group information

The owned by group information of the activity. The allowed group identifier fields are the following:

Include Page
V4:group_identifier
V4:group_identifier

privacy_level_identifier

(optional)

The identifier of the privacy level

The privacy level of the activity. The allowed privacy level identifier fields are the following:

Include Page
V4:privacy_level_identifier
V4:privacy_level_identifier

Tip

Deprecated from CRM.COM R18.0.0


udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3 

(optional)

String

User Defined Field of type String

udf_string_4 

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6 

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1 

(optional)

Date

User Defined Field of type Date

udf_date_2 

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date

expected_completion_date

(optional)

DateThe date that the activity is expected to be completed

estimated_completion_time

(optional)

Time Period Object

The time that is estimated to complete the activity, measured in

minutes

MINUTES, HOURS,

hours

DAYS,

days, weeks, years

WEEKS, YEARS

Tip

From CRM.COM R17.0.0, YEARS is deprecated


assign_to

(mandatory on conditions)

Assign To Object

The assignment information of the activity. Assign to information is mandatory to be specified, unless if it is set automatically through ACR rules.

performed_for

(optional)

Performed for Object

The entities which are related with the activity

 


services_to_be_provided_set

(optional)

Set of Services to be Provided Object

The information related to the services to be provided with the activity

Include Page
V4:Web API - Updating Sets
V4:Web API - Updating Sets

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

 

...



Anchor
activities_update referred objects parameters
activities_update referred objects parameters
Referred Parameters Objects Data

...

Expand
titleExample 1

HTTP Method: POST 


Request:

Body:

Code Block
languagejavascript
themeConfluence
languagejavascript
linenumberstrue
{
    "token" :   "1B4D09A2C62B477791544314C3847FE5",
    "activity_identifier"         :    { "number" : "9" },
    "status_identifier"           :    { "name" : "Assigned"},
    "description"                  :    "Description For Activity",
    "start_date"                  :    "2014-08-01T09:00:00",
	"udf_string_1": "userfield1",
    "udf_string_2": "userfield2",
    "udf_string_3": "userfield3",
    "udf_string_4": "userfield4",
    "udf_string_5": "userfield5",
    "udf_string_6": "userfield6",
    "udf_string_7": "userfield7",
    "udf_string_8": "userfield8",
    "udf_string_9": "userfield9",
    "udf_string_10": "userfield10",
    "udf_string_11": "userfield11",
    "udf_string_12": "userfield12",
    "udf_string_13": "userfield13",
    "udf_string_14": "userfield14",
    "udf_string_15": "userfield15",
    "udf_string_16": "userfield16",
    "udf_float_1":1,
    "udf_float_2":2,
	"udf_float_3":3,
	"udf_float_4":4,
	"udf_float_5":5,
	"udf_float_6":6,
	"udf_float_7":7,
	"udf_float_8":8,
	"udf_float_9":9,
	"udf_float_10":10,
    "udf_date_1": "2011-08-01T09:00:00",
    "udf_date_2": "2012-08-01T09:00:00",
    "udf_date_3": "2013-08-01T09:00:00",
    "udf_date_4": "2014-08-01T09:00:00",
    "udf_date_5": "2015-08-01T09:00:00",
    "udf_date_6": "2016-08-01T09:00:00",
    "udf_date_7": "2017-08-01T09:00:00",
    "udf_date_8": "2018-08-01T09:00:00",
    "udf_date_9": "2019-08-01T09:00:00",
    "udf_date_10": "2020-08-01T09:00:00"
	"performed_for"              :   {
                "lead_identifier" : { "number" : "61"}
                    },
    "estimate_completion_time"     :    {
                                        "time_period_value" : 5,
                                        "time_period_uot" : "DAYS"
                                    },
   "services_to_be_provided_set":    [
                                        {
                                            "action": "add",
                                            "product_identifier" : { "code" : "Installation"},
                                            "time_spend" : {
                                                                "time_period_value" : 10,
                                                                "time_period_uot"    : "WEEKS"
                                                            },
                                           "resource_request":{
                                                            "requested_by_group_identifier" : {"name" : "Developers Group"},
                                                            "planned_date" : "2015-02-18T00:00:00",
                                                            "from_time" : "12:00",
                                                            "to_time" : "18:00",
                                                            "requested_by_unit_identifier" : {"name" : "U1"},
                                                            "requested_by_user_identifier" : {"username" : "MPAdministrator"},
                                                            "requested_resource_plan_entry_identifier" : { "number" : "1827"},
                                                            "requested_one_time_service_identifier":{"code" : "Installation"},
                                                            "number_of_resources":1
                                           }
                                        }
              ]
}

 


Response:

Code Block
languagejavascript
themeConfluencelanguagejavascript
linenumberstrue
{
       "status":
       {
           "message": null,
           "description": null,
           "code": "OK"
       },
       "data":
       {
           "notes": null,
           "udf_string_10": "userfield10",
           "udf_float_1": 1,
           "udf_string_11": "userfield11",
           "udf_float_2": 2,
           "udf_string_12": "userfield12",
           "udf_float_3": 3,
           "udf_string_13": "userfield13",
           "udf_float_4": 4,
           "udf_string_14": "userfield14",
           "udf_float_5": 5,
           "udf_string_15": "userfield15",
           "udf_string_16": "userfield16",
           "udf_float_6": 6,
           "udf_string_1": "userfield1",
           "udf_string_2": "userfield2",
       	   "udf_float_7": 7,

           "performed_for":
           {
               "service_request": null,
               "lead":
               {
                   "life_cycle_state": "PENDING",
                   "number": "61",
                   "id": "FB7E2F2337BAC04BA21DAEA5B2380A7E",
                   "description": null,
                   "contact_information":
                   {
                       "last_name": "Spector",
                       "life_cycle_state": "FINANCIAL",
                       "middle_name": null,
                       "company_profile": null,
                       "title": null,
                       "type": "PERSON",
                       "first_name": "Matt",
                       "name": null,
                       "id": "58F5508072753180E10322DBCA1862EE",
                       "company_name": null,
                       "demographics":
                       {
                           "gender": "MALE",
                           "passport_issued_by_country": null,
                           "passport_number": "JB0007689",
                           "social_security_number": null,
                           "industry_sector": null,
                           "date_of_birth":
                           {
                               "month": null,
                               "day": null,
                               "year": null
                           },
                           "name_day":
                           {
                               "month": null,
                               "day": null
                           },
                           "id_number": null,
                           "id_issued_by_country": null,
                           "industry": null
                       }
                   }
               },
               "subscription": null,
               "job": null
           },
           "assign_to":
           {
               "unit":
               {
                   "group_name": null,
                   "name": "U1",
                   "id": "8B4009FA8BC8A612D0DB62B5F2AB135B",
                   "description": null,
                   "alternative_code": null
               },
               "user": null
           },
           "privacy_level":
           {
               "number": null,
               "hierarchy_level": 2,
               "name": "High",
               "id": "321ACE4A65A24800365B2B2236F5E171"
           },
           "contact_information":
           {
               "last_name": "Spector",
               "life_cycle_state": "FINANCIAL",
               "middle_name": null,
               "company_profile": null,
               "title": null,
               "type": "PERSON",
               "first_name": "Matt",
               "name": "Matt Spector",
               "id": "58F5508072753180E10322DBCA1862EE",
               "company_name": null,
               "demographics":
               {
                   "gender": "MALE",
                   "passport_issued_by_country": null,
                   "passport_number": "JB0007689",
                   "social_security_number": null,
                   "country_of_residence":
                   {
                       "name": "JAPAN",
                       "id": "237"
                   },
                   "industry_sector": null,
                   "date_of_birth":
                   {
                       "month": null,
                       "day": null,
                       "year": null
                   },
                   "name_day":
                   {
                       "month": null,
                       "day": null
                   },
                   "id_number": null,
                   "id_issued_by_country": null,
                   "industry": null
               }
           },
           "udf_string_3": "userfield3",
           "udf_float_8": 8,
           "udf_string_4": "userfield4",
           "udf_float_9": 9,
           "udf_string_5": "userfield5",
           "udf_string_6": "userfield6",
           "udf_string_7": "userfield7",
           "udf_string_8": "userfield8",
           "udf_string_9": "userfield9",
           "id": "D9C6BE3D7817C8DA8E16703CAAEC1A9A",
           "expected_completion_date": "2014-12-03T10:12:51",
           "start_date": "2014-12-02T10:12:51",
           "time_to_completion":
           {
               "time_period_value": null,
               "time_period_uot": "DAYS"
           },
           "time_overdue":
           {
               "time_period_value": 2.571428571428571,
               "time_period_uot": "MONTHS"
           },
           "owned_by_group":
           {
               "community_name": "Main Community",
               "name": "Developers Group",
               "id": "8BD400EC50DB9678F9C3573401399924",
               "description": "test2",
               "alternative_code": null
           },
           "log_information":
           {
               "updated_date": "2015-02-19T13:00:50",
               "created_by_unit":
               {
                   "community_name": "Main Community",
                   "group_name": "Main Group",
                   "name": "Admin Unit",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "description": "r1",
                   "alternative_code": "MG"
               },
               "created_date": "2014-12-02T10:12:51",
               "updated_by_unit":
               {
                   "community_name": "Main Community",
                   "group_name": "Main Group",
                   "name": "Admin Unit",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "description": "r1",
                   "alternative_code": "MG"
               },
               "created_by_user":
               {
                   "person_name": "MPAdministrator",
                   "username": "MPAdministrator",
                   "id": "1",
                   "email": "mp@ministrator.com"
               },
               "updated_by_user":
               {
                   "person_name": "Marios Lannister",
                   "username": "MPAdministrator",
                   "id": "1",
                   "email": null
               }
           },
           "udf_date_10": "2020-08-01T09:00:00",
           "status":
           {
               "name": "To Be approved",
               "id": "C93B05CCFC11CFFA62BA2A04F87603C8",
               "description": null,
               "alternative_code": "TBA"
           },
           "udf_date_1": "2011-08-01T09:00:00",
           "udf_date_2": "2012-08-01T09:00:00",
           "udf_float_10": 10,
           "udf_date_3": "2013-08-01T09:00:00",
           "udf_date_4": "2014-08-01T09:00:00",
           "udf_date_5": "2015-08-01T09:00:00",
           "udf_date_6": "2016-08-01T09:00:00",
           "udf_date_7": "2017-08-01T09:00:00",
           "udf_date_8": "2018-08-01T09:00:00",
           "udf_date_9": "2019-08-01T09:00:00",
           "actual_completed_date": null,
           "life_cycle_state": "PENDING",
           "estimate_completion_time":
           {
               "time_period_value": 1,
               "time_period_uot": "DAYS"
           },
           "type":
           {
               "name": "Installations",
               "id": "BF60960C7FC5B0E5B81DB7E5BCC7F140",
               "description": null,
               "alternative_code": "IN"
           },
           "description": "test",
           "category": null,
           "services_to_be_provided_set":
           [
               {
                   "service":
                   {
                       "product_type":
                       {
                           "physical_good_type": null,
                           "service_type": "ONETIME",
                           "used_for_provisioning": true,
                           "composition_method": "FLAT",
                           "classification": "SERVICES",
                           "name": "One Time Services",
                           "id": "7EDF537A938DECAB1352E6EEAD54A5D0",
                           "description": "A type which is used for one time services",
                           "alternative_code": "OTS"
                       },
                       "id": "009F001976DA6F8F4DFD0BB5F704C0D7",
                       "description": null,
                       "code": "material delivery",
                       "alternative_code": "MD"
                   },
                   "id": "F05890872A35462D93C9B74BEA9AD931",
                   "time_spend":
                   {
                       "time_period_value": 10,
                       "time_period_uot": "WEEKS"
                   }
               },
               {
                   "service":
                   {
                       "product_type":
                       {
                           "physical_good_type": null,
                           "service_type": "ONETIME",
                           "used_for_provisioning": true,
                           "composition_method": "FLAT",
                           "classification": "SERVICES",
                           "name": "One Time Services",
                           "id": "7EDF537A938DECAB1352E6EEAD54A5D0",
                           "description": "A type which is used for one time services",
                           "alternative_code": "OTS"
                       },
                       "id": "8E990D550CC2F4D2951A273E9D84F9E6",
                       "description": null,
                       "code": "Installation",
                       "alternative_code": "IN"
                   },
                   "id": "255F82E21CCE44CAA72678687261C86D",
                   "time_spend":
                   {
                       "time_period_value": 10,
                       "time_period_uot": "WEEKS"
                   }
               }
           ]
       }
}


...