Tip
Available from CRM.COM R6.0.0

Table of Contents

maxLevel	2

GET activities/configuration/types/list

This method returns the activity types that are allowed to be used in the system. Multiple activity types are returned by each call

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

group_identifier

(optional)

...

The identifier of the group that will be providing the activity type. The group is filtered against the activity types' allowed organisational units. The allowed group identifier fields are the following:

...

unit_identifier

(optional)

...

The identifier of the unit that will be providing the activity type. The unit is filtered against the activity types' allowed organisational units. The allowed unit 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

Response Data

...

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    [
        {
            "log_information":
            {
                "updated_date": "2015-05-14T13:06:51",
                "created_date": "2015-04-30T10:08:04",
                "created_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                }
            },
            "id": "B163FF3F08B44CBEB00F1CCD875C54DE",
            "name": "Installation",
            "estimated_completion_time":
            {
                "time_period_value": 2,
                "time_period_uot": "WEEKS"
            },
            "alternative_code": "INS"
        },
        {
            "log_information":
            {
                "updated_date": "2015-05-14T17:54:56",
                "created_date": "2015-04-15T10:06:22",
                "created_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                }
            },
            "id": "09EE47872CF8414A98C2EC5655936BF5",
            "name": "Customer Training",
            "estimated_completion_time":
            {
                "time_period_value": 8,
                "time_period_uot": "HOURS"
            },
            "alternative_code": "CT"
        },
        {
            "log_information":
            {
                "updated_date": "2015-05-15T13:20:59",
                "created_date": "2015-04-15T10:07:35",
                "created_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                }
            },
            "id": "CB7953F4D06C4135A794623C9F1620D8",
            "name": "Onside Deliveries",
            "estimated_completion_time":
            {
                "time_period_value": 2,
                "time_period_uot": "DAYS"
            },
            "alternative_code": "OD"
        },
        {
            "log_information":
            {
                "updated_date": "2015-04-29T14:41:51",
                "created_date": "2015-04-15T10:08:37",
                "created_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                }
            },
            "id": "915B12F6D9FE4264A013AEDE1595240A",
            "name": "In house Training",
            "estimated_completion_time":
            {
                "time_period_value": 1,
                "time_period_uot": "WEEKS"
            },
            "alternative_code": "IHT"
        },
        {
            "log_information":
            {
                "updated_date": "2015-05-15T17:06:37",
                "updated_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                }
            },
            "id": "938B9B6411AAB03DC25B3F569A443C6D",
            "name": "InstallationsX",
            "description": "Test",
            "estimated_completion_time":
            {
                "time_period_value": 8,
                "time_period_uot": "HOURS"
            },
            "alternative_code": "INX"
        },
        {
            "log_information":
            {
                "updated_date": "2015-04-03T12:11:44",
                "created_date": "2014-08-25T13:17:20",
                "created_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                }
            },
            "id": "6D0C79835F7B0059D3BD1A51F2A03F41",
            "name": "Maintenance visits",
            "estimated_completion_time":
            {
                "time_period_value": 5,
                "time_period_uot": "HOURS"
            },
            "alternative_code": "MV"
        }
    ]
}

GET activities/configuration/categories/list

This method returns the activity categories that are allowed to be used by activities of specific type. Multiple activity categories are returned by each call

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

activity_type_identifier

(mandatory)

...

The identifier of the type of the activity that will be using the categories. The categories are filtered against the allowed categories of the specified type. The allowed activity type 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

Response Data

...

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    [
        {
            "parent_id": "E037ECCED154220494E1466B9C792A99",
            "id": "4EABFA904E60168F1777CA2FB3B21140",
            "name": "Difficult",
            "description": "Difficult",
            "code": "DI"
        },
        {
            "parent_id": "E037ECCED154220494E1466B9C792A99",
            "id": "73EE48F5950613300C48B806FCCCFB2E",
            "name": "Normal",
            "description": "Normal 1",
            "code": "N1"
        },
        {
            "id": "E037ECCED154220494E1466B9C792A99",
            "name": "Installations",
            "description": "Installations",
            "code": "IN"
        }
    ]
}

GET activities/configuration/services/list

This method returns the services that are allowed to be used by activities of specific type. Multiple services are returned by each call

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

activity_type_identifier

(mandatory)

...

The identifier of the type of the activity that will be using the services. The services are filtered against the allowed services of the specified type. The allowed activity type 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

Response Data

...

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    [
        {
            "automatically_applied": true,
            "time_spent_logging_method": "FIXED",
            "service":
            {
                "product_type":
                {
                    "service_type": "ONETIME",
                    "used_for_provisioning": false,
                    "classification": "SERVICES",
                    "composition_method": "FIXEDBUNDLE",
                    "id": "391D5E5E5F4F70FCA75C4D01ECAD0B6C",
                    "name": "One Time Services - Fixed",
                    "description": "One Time Services - Fixed",
                    "alternative_code": "OTS-F_1"
                },
                "id": "690A6B1932D34421A1EE254425F2CB12",
                "code": "Installation Service",
                "alternative_code": "IS"
            },
            "mandatory": true,
            "id": "1EB36F485FDB4C3CB58AD33FAE3EB6A9",
            "minimum_time_spent":
            {
                "time_period_value": 1,
                "time_period_uot": "DAYS"
            }
        },
        {
            "time_spent_logging_method": "FLEXIBLE",
            "service":
            {
                "product_type":
                {
                    "service_type": "ONETIME",
                    "used_for_provisioning": true,
                    "classification": "SERVICES",
                    "composition_method": "FIXEDBUNDLE",
                    "id": "AD3C6C3E2D2D4C9DA7BDBC2908718AEB",
                    "name": "One Time- Fixed B",
                    "description": "One time Fixed Bundle product",
                    "alternative_code": "OT-Fixed"
                },
                "id": "DFEA1EC8521F416AABB8D79305CEF600",
                "code": "Delivery Service",
                "alternative_code": "DS"
            },
            "mandatory": false,
            "id": "9B21815339F4432E856D4530D7408ACA",
            "minimum_time_spent":
            {
                "time_period_value": 2,
                "time_period_uot": "HOURS"
            }
        },
        {
            "time_spent_logging_method": "FLEXIBLE",
            "service":
            {
                "product_type":
                {
                    "service_type": "ONETIME",
                    "used_for_provisioning": true,
                    "classification": "SERVICES",
                    "composition_method": "FIXEDBUNDLE",
                    "id": "AD3C6C3E2D2D4C9DA7BDBC2908718AEB",
                    "name": "One Time- Fixed B",
                    "description": "One time Fixed Bundle product",
                    "alternative_code": "OT-Fixed"
                },
                "id": "7858EF0C20F34F87B845321352269EBD",
                "code": "Tuning Service",
                "alternative_code": "TS"
            },
            "mandatory": false,
            "id": "74F4478CB4554B4B80535D55694594B8",
            "minimum_time_spent":
            {
                "time_period_uot": "HOURS"
            }
        }
    ]
}

GET activities/configuration/statuses/list

This method returns the statuses that are allowed to be used by activities of specific type. Multiple statuses are returned by each call

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

activity_type_identifier

(mandatory)

...

The identifier of the type of the activity that will be using the statuses. The statuses are filtered against the allowed statuses of the specified type. The allowed activity type identifier fields are the following:

...

life_cycle_state

(optional)

...

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

Response Data

...

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

GET activities/configuration/cancellation_reasons/list

This method returns the cancellation reasons that are allowed to be used by activities, as defined on the active activity definition. Multiple cancellation reasons are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

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

Response Data

...

Examples

HTTP Method: GET

Request:

Response:

{ "status": { "message": "", "description": "", "code": "OK" }, "data": [ { "id": "352B746264664A96BC9FC2C16816B7F5", "name": "Cancel Reason 1", "description": "Description", "alternative_code": "CR1" }, { "id": "8CE6FE0AD2CC42C0B5D8A7AF660FCEC5", "name": "Cancel Reason 2", "alternative_code": "CR2" }, { "id": "D38A9C9649AF4EF2BF8F5BA25DCE4AF7", "name": "Cancel Reason 3", "alternative_code": "CR3" } ] }

Expand

title	Example 1

Code Block

theme	Confluence
language	javascript
linenumbers	true

Panel

name	blue

Child pages (Children Display)

excerpt	true

Versions Compared

Old Version 6

New Version Current

Key

GET activities/configuration/types/list

Resource URL

Parameters

Response Data

Examples

GET activities/configuration/categories/list

Resource URL

Parameters

Response Data

Examples

GET activities/configuration/services/list

Resource URL

Parameters

Response Data

Examples

GET activities/configuration/statuses/list

Resource URL

Parameters

Response Data

Examples

GET activities/configuration/cancellation_reasons/list

Resource URL

Parameters

Response Data

Examples

Page Comparison

Versions Compared

Old Version 6

New Version Current

Key

GET activities/configuration/types/list

Resource URL

Parameters

Response Data

Examples

GET activities/configuration/categories/list

Resource URL

Parameters

Response Data

Examples

GET activities/configuration/services/list

Resource URL

Parameters

Response Data

Examples

GET activities/configuration/statuses/list

Resource URL

Parameters

Response Data

Examples

GET activities/configuration/cancellation_reasons/list

Resource URL

Parameters

Response Data

Examples