Versions Compared

Old Version 9

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user p_demou

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

GET service_requests/configuration/types/list

This method returns the service request types that are allowed to be used in the system as these are defined in active Service Request Definitions. Multiple service request 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 service request type. The group is filtered against the service request 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 service request type. The unit is filtered against the service request 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
titleExample 1

HTTP Method: GET

Request:

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
      {
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    [
        {
            "udf_float_1": null,
            "udf_float_2": null,
            "udf_float_3": null,
            "udf_date_1": null,
            "udf_float_4": null,
            "udf_date_2": null,
            "udf_date_3": null,
            "udf_date_4": null,
            "name": "Test123",
            "udf_string_1": null,
            "udf_string_2": null,
            "estimated_completion_time":
            {
                "time_period_value": 2,
                "time_period_uot": "MONTHS"
            },
            "udf_string_3": null,
            "udf_string_4": null,
            "udf_string_5": null,
            "udf_string_6": null,
            "udf_string_7": null,
            "log_information":
            {
                "updated_date": "2015-05-26T13:19:25",
                "created_date": "2015-05-18T12:43:59",
                "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"
                }
            },
            "udf_string_8": null,
            "id": "071C3C130B804FB593908CA4BBE1A276",
            "description": null,
            "alternative_code": "T_1"
        },
        {
            "udf_float_1": null,
            "udf_float_2": null,
            "udf_float_3": null,
            "udf_date_1": null,
            "udf_float_4": null,
            "udf_date_2": null,
            "udf_date_3": null,
            "udf_date_4": null,
            "name": "Information",
            "udf_string_1": null,
            "udf_string_2": null,
            "estimated_completion_time":
            {
                "time_period_value": 2,
                "time_period_uot": "HOURS"
            },
            "udf_string_3": null,
            "udf_string_4": null,
            "udf_string_5": null,
            "udf_string_6": null,
            "udf_string_7": null,
            "log_information":
            {
                "updated_date": "2015-10-07T11:11:33",
                "created_date": "2015-01-09T15:57:22",
                "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": "emichailidou",
                    "username": "emichailidou",
                    "id": "63ACDBBC5B39AD2DF5B167FA70EE57DD",
                    "email": "e_michailidou@crm.com"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "sakkascy1986@hotmail.com"
                }
            },
            "udf_string_8": null,
            "id": "3E19C42A76820EFEF54DB4F103DC1BFC",
            "description": null,
            "alternative_code": "I"
        },
        {
            "udf_float_1": null,
            "udf_float_2": null,
            "udf_float_3": null,
            "udf_date_1": null,
            "udf_float_4": null,
            "udf_date_2": null,
            "udf_date_3": null,
            "udf_date_4": null,
            "name": "Request for Change",
            "udf_string_1": null,
            "udf_string_2": null,
            "estimated_completion_time":
            {
                "time_period_value": 2,
                "time_period_uot": "HOURS"
            },
            "udf_string_3": null,
            "udf_string_4": null,
            "udf_string_5": null,
            "udf_string_6": null,
            "udf_string_7": null,
            "log_information":
            {
                "updated_date": "2015-10-08T15:18:40",
                "created_date": "2015-01-09T16:37:23",
                "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": "emichailidou",
                    "username": "emichailidou",
                    "id": "63ACDBBC5B39AD2DF5B167FA70EE57DD",
                    "email": "e_michailidou@crm.com"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "sakkascy1986@hotmail.com"
                }
            },
            "udf_string_8": null,
            "id": "C0014B5217E42FCF43100373A17E9A6E",
            "description": null,
            "alternative_code": "RFC"
        },
        {
            "udf_float_1": null,
            "udf_float_2": null,
            "udf_float_3": null,
            "udf_date_1": null,
            "udf_float_4": null,
            "udf_date_2": null,
            "udf_date_3": null,
            "udf_date_4": null,
            "name": "Technical",
            "udf_string_1": null,
            "udf_string_2": null,
            "estimated_completion_time":
            {
                "time_period_value": null,
                "time_period_uot": "SECONDS"
            },
            "udf_string_3": null,
            "udf_string_4": null,
            "udf_string_5": null,
            "udf_string_6": null,
            "udf_string_7": null,
            "log_information":
            {
                "updated_date": "2015-08-26T12:25:31",
                "created_date": "2015-01-20T17:24:48",
                "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": "emichailidou",
                    "username": "emichailidou",
                    "id": "63ACDBBC5B39AD2DF5B167FA70EE57DD",
                    "email": "e_michailidou@crm.com"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "sakkascy1986@hotmail.com"
                }
            },
            "udf_string_8": null,
            "id": "C0F246EC670740F793868C1CA78D6AF6",
            "description": null,
            "alternative_code": "T"
        }
    ]
}

GET service_requests/configuration/statuses/list

This method returns the statuses that are allowed to be used by service requests 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

...

service_request_type_identifier

(mandatory)

...

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

...

life_cycle_state

(optional)

...

The life cycle state that the status should have. If specified then only statuses related with the specified life cycle state will be retrieved. Life cycle state options are:

PENDING, RESPONDED, TEMPORARY RESOLVED, FINAL RESOLVED and COMPLETED

...

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
titleExample 1

HTTP Method: GET

 

Request:

Response:

 

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    [
        {
            "default": true,
            "status":
            {
                "life_cycle_state": "PENDING",
                "id": "4174EEED1CBFD73A67AB75C5DF99AFED",
                "name": "To Be Approved",
                "description": "To be Approved - Pending",
                "alternative_code": "TBA"
            },
            "id": "7244393FFDA6E09D16CACCA0A87D8772"
        },
        {
            "default": false,
            "status":
            {
                "life_cycle_state": "RESPONDED",
                "id": "3719E9998E567A788A865CD1B4556821",
                "name": "Assigned",
                "description": "Assigned",
                "alternative_code": "ASG"
            },
            "id": "6FB8BA4DD6658972FC5AD9D6C74D9A84"
        },
        {
            "default": false,
            "status":
            {
                "life_cycle_state": "RESPONDED",
                "id": "C46FA997FD069D6F1863F4F6A02916C6",
                "name": "In Progress",
                "description": null,
                "alternative_code": "IP"
            },
            "id": "8A79FE4BBDA349FC61E8875DE034FDEE"
        },
        {
            "default": false,
            "status":
            {
                "life_cycle_state": "TEMPORARY_RESOLVED",
                "id": "0B7EF8D78A8711BA03FFF11EB0BBC0F6",
                "name": "Temporary Solution",
                "description": null,
                "alternative_code": "TS"
            },
            "id": "BFF9AB00ADAF3A860FBDDDC0D30BA039"
        },
        {
            "default": false,
            "status":
            {
                "life_cycle_state": "FINAL_RESOLVED",
                "id": "78BD681A48EE3EAE9246D25AB76F632B",
                "name": "Final Solution",
                "description": null,
                "alternative_code": "FS"
            },
            "id": "0F0CCA77C5AF23955E2CF9277BE2D733"
        },
        {
            "default": false,
            "status":
            {
                "life_cycle_state": "COMPLETED",
                "id": "5611E4C4BD556315E1AE9F9A883158D2",
                "name": "Accepted by Customer",
                "description": "The Service Request has been accepted by customer/caller ",
                "alternative_code": "ACC"
            },
            "id": "FE655F50C6A9BFD9E847291B6E706785"
        }
    ]
}
 

GET service_requests/configuration/categories/list

This method returns the service request categories that are allowed to be used by service requests of a specific type. Multiple service request categories are returned by each call

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

service_request_type_identifier

(mandatory)

...

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

HTTP Method: GET

 

Request:

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    [
        {
            "default": true,
            "id": "5468158350D9469EB4467A7E2C9D089C",
            "category":
            {
                "parent_id": "451E8F57CFCD9D425E599832F3AC32DE",
                "id": "3B14EF18F2D75893416B62208A07EA51",
                "name": "Normal",
                "description": "Normal",
                "code": "ADV_NML"
            }
        },
        {
            "default": false,
            "id": "7B0B1EDEF35F4A548EE3BB3C1844A676",
            "category":
            {
                "parent_id": "451E8F57CFCD9D425E599832F3AC32DE",
                "id": "E99CB6E1D075857EB7DE9985782F577F",
                "name": "Difficult",
                "description": "Difficult",
                "code": "ADV_DFCT"
            }
        },
        {
            "default": false,
            "id": "BA2B74FB65B8450AB628EB1CB0AFA1B6",
            "category":
            {
                "id": "451E8F57CFCD9D425E599832F3AC32DE",
                "name": "Advice",
                "description": "Advice Related",
                "code": "ADV"
            }
        }
    ]
}
 

GET service_requests/configuration/response_categories/list

This method returns the service request response categories that are allowed to be used by service requests of a specific type. Multiple service request response categories are returned by each call

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

service_request_type_identifier

(mandatory)

...

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

HTTP Method: GET

 

Request:

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    [
        {
            "default": true,
            "id": "D70228FB4221FB96610BD3DA20BB7B65",
            "category":
            {
                "id": "AB9574217CF96FE7FC5B2A134EF1ADC9",
                "name": "Approved for Resolution",
                "description": null,
                "code": "AFR"
            }
        }
    ]
}
 

GET service_requests/configuration/temporary_resolution_categories/list

This method returns the service request temporary resolution categories that are allowed to be used by service requests of a specific type. Multiple service request temporary resolution categories are returned by each call

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

service_request_type_identifier

(mandatory)

...

The identifier of the type of the service request that will be using the temporary resolution categories. The temporary resolution categories are filtered against the allowed temporary resolution categories of the specified type. The allowed service request 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
titleExample 1

HTTP Method: GET

 

Request:

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    [
        {
            "default": true,
            "id": "1257FAFC51E521FAF3BFAB15C79CB09C",
            "category":
            {
                "id": "6559C7CE07640154D674E1B5B802693C",
                "name": "Technical Temporary Resolution",
                "description": null,
                "code": "TTR"
            }
        },
        {
            "default": false,
            "id": "CBF5CF9BDC35677BF9933B0FB838C6F3",
            "category":
            {
                "parent_id": "6559C7CE07640154D674E1B5B802693C",
                "id": "31126D17295386308CEDEDB9A67D526D",
                "name": "Workaround",
                "description": "test",
                "code": "WRD"
            }
        }
    ]
}
 

GET service_requests/configuration/final_resolution_categories/list

This method returns the service request final resolution categories that are allowed to be used by service requests of a specific type. Multiple service request final resolution categories are returned by each call

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

service_request_type_identifier

(mandatory)

...

The identifier of the type of the service request that will be using the final resolution categories. The final resolution categories are filtered against the allowed final  resolution categories of the specified type. The allowed service request 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
titleExample 1

HTTP Method: GET

 

Request:

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    [
        {
            "default": false,
            "id": "15FFEE41D6E6AAC0B9F8D7327D6294B1",
            "category":
            {
                "id": "D3E8465639CAA0DA093FB96230B9B400",
                "name": "Technical Final Resolution",
                "description": null,
                "code": "TFR"
            }
        },
        {
            "default": true,
            "id": "C2F591C9610382F3A37FAFBADE20B59E",
            "category":
            {
                "parent_id": "D3E8465639CAA0DA093FB96230B9B400",
                "id": "376C4D455CAA3F8F5A599A9F936EC738",
                "name": "Custom Change",
                "description": "test",
                "code": "CC"
            }
        }
    ]
}
 

 

GET service_requests/configuration/physical_goods/list

This method returns the physical goods that are allowed to be used by service requests of specific type. Multiple physical goods are returned by each call

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

service_request_type_identifier

(mandatory)

...

The identifier of the type of the service request that will be using the physical goods. The physical goods are filtered against the allowed physical goods of the specified type. The allowed service request 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
titleExample 1

HTTP Method: GET

 

Request:

Response:

 

Code Block
themeConfluence
languagejavascript
linenumberstrue
 

GET service_requests/configuration/services/list

This method returns the services that are allowed to be used by service requests 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

...

service_request_type_identifier

(mandatory)

...

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

HTTP Method: GET

 

Request:

Response:

 

Code Block
themeConfluence
languagejavascript
linenumberstrue
 

GET service_request/configuration/activity_types/list

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

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

service_request_type_identifier

(mandatory)

...

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

HTTP Method: GET

 

Request:

Response:

 

Code Block
themeConfluence
languagejavascript
linenumberstrue
 

GET service_requests/configuration/job_types/list

This method returns the job types that are allowed to be used by service requests of specific type. Multiple job types are returned by each call

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

service_request_type_identifier

(mandatory)

...

The identifier of the type of the service request that will be using the job types. The job types are filtered against the allowed job types of the specified type. The allowed service request 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
titleExample 1

HTTP Method: GET

 

Request:

Response:

 

Code Block
themeConfluence
languagejavascript
linenumberstrue
 

GET service_request/configuration/impact_levels/list

This method returns the impact levels that are allowed to be used by service requests of any type. Only impact levels defined in the active Service Request Definitions and set as Supported are retrieved. Multiple impact levels 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

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

 

Code Block
themeConfluence
languagejavascript
linenumberstrue
 

GET service_request/configuration/urgency_levels/list

This method returns the urgency levels that are allowed to be used by service requests of any type. Only urgency levels defined in the active Service Request Definitions and set as Supported are retrieved. Multiple urgency levels 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

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

 

Code Block
themeConfluence
languagejavascript
linenumberstrue
 

 

...

Panel
nameblue

Child pages (Children Display)
excerpttrue