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

group_identifier

(optional)

Group Identifier

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:

Include Page
V4:group_identifier
V4:group_identifier

unit_identifier

(optional)

Unit Identifier

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:

Include Page
V4:unit_identifier
V4:unit_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

service_request_type_identifier

(mandatory)

Service Request Type Identifier

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:

Include Page
v4:service_request_type_identifier
v4:service_request_type_identifier

life_cycle_state

(optional)

Sting

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

...

Name

Type

Description

token

String

The token retrieved from the login method

service_request_type_identifier

(mandatory)

Service Request Type Identifier

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:

Include Page
v4:service_request_type_identifier
v4:service_request_type_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:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 

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
 

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": "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)

Service Request Type Identifier

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:

Include Page
v4:service_request_type_identifier
v4:service_request_type_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

Response Data

Include Page
V4:service_request_type_response_category_complete
V4:service_request_type_response_category_complete

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)

Service Request Type Identifier

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:

Include Page
v4:service_request_type_identifier
v4:service_request_type_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

Response Data

Include Page
V4:service_request_type_temporary_resolution_category_complete
V4:service_request_type_temporary_resolution_category_complete

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

...

Name

Type

Description

token

String

The token retrieved from the login method

service_request_type_identifier

(mandatory)

Service Request Type Identifier

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:

Include Page
v4:service_request_type_identifier
v4:service_request_type_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

service_request_type_identifier

(mandatory)

Service Request Type Identifier

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:

Include Page
v4:service_request_type_identifier
v4:service_request_type_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

service_request_type_identifier

(mandatory)

Service Request Type Identifier

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:

Include Page
v4:service_request_type_identifier
v4:service_request_type_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

service_request_type_identifier

(mandatory)

Service Request Type Identifier

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:

Include Page
v4:service_request_type_identifier
v4:service_request_type_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

service_request_type_identifier

(mandatory)

Service Request Type Identifier

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:

Include Page
v4:service_request_type_identifier
v4:service_request_type_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

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

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

...