Versions Compared

Key

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

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...


Tip

Available from CRM.COM R4.0.0

Excerpt
Excerpt

This method creates new resource requests. A single resource request can be created by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

requested_by_group_identifier

(mandatory)

Group Identifier

The Identifier of the Group that is requesting the resource. The available Group Identifier fields are the following:

Include Page
V4:group_identifier
V4:group

_identifier

_identifier

requested_by_unit_identifier

(mandatory)

Unit Identifier

The Identifier of the Unit that is requesting the resource. The available Unit Identifier fields are the following:

Include Page
V4:unit_identifier
V4:unit_identifier

Tip

Deprecated from CRM.COM R18.0.0


requested_by_business_unit_identifier

(mandatory)

Business Unit Identifier

The Identifier of the business unit that is requesting the resource. The available business unit Identifier fields are the following:

Include Page
V4:business_unit_identifier
V4:business_unit_identifier

Tip

Available from CRM.COM R18.0.0


requested_by_

unit

user_identifier

(mandatory)

Unit
User Identifier

The Identifier of the

Unit

User that is requesting the resource. The available

Unit

User Identifier fields are the following:

Include Page
V4:

unit

user_identifier
V4:

unit

user_identifier

requested_

by

business_

user

unit_identifier

(mandatory)

User
Business Unit Identifier

The Identifier of the

User

business unit that is

requesting the

requested as a resource. The available

User

business unit Identifier fields are the following:

Include Page
V4:

user

unit_identifier
V4:

user

unit_identifier

Tip

Available from CRM.COM R18.0.0


requested_unit_identifier

(mandatory)

Unit Identifier

The Identifier of the Unit that is requested as a resource. The available Unit Identifier fields are the following:

Include Page
V4:unit_identifier
V4:unit_identifier

Tip

Deprecated from CRM.COM R18.0.0


number_of_resources

(mandatory)

Number

The number of required resources

planned_date

(mandatory)

DateThe planned date

from_time

(mandatory)

StringThe from time that the required resource should be start.

to_time

(mandatory)

StringThe from time that the required resource should be end.

requested_resource_plan_entry _identifier

(mandatory)

Resource Plan Entry Identifier

The identifier of the resource plan entry which should be reserved for this resource request, in the case were the resource request was accepted. The available resource plan entry identifier fields are the following:

Include Page
V4:resource_plan_entry_identifier
V4:resource_plan_entry_identifier

to_be_used_by_activity _identifier

(mandatory)

Activity Identifier

The identifier of the Activity for which the requested resource should be provided for. The available activity identifier fields are the following:

Include Page
V4:activity_identifier
V4:activity_identifier

to_be_used_by_activity_service _identifier

(mandatory)

Activity Services to be Provided Identifier

The identifier of the Activity service for which the requested resource should be provided for. The available activity service identifier fields are the following:

Include Page
V4:activity_service_identifier
V4:activity_service_identifier

description

(optional)

StringThe description of the resource request

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

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

...

Expand
titleExample 1

HTTP Method: POST

http://localhost:9080/crmapi/rest/v2/resource_requests/create

Request:

Body

Code Block
languagejs
themeConfluence
languagejs
linenumberstrue
{
    "token"    : "56272B2915C118117ABEB216E77BB518",
    "requested_by_group_identifier" : {"name" : "Main Group"},
    "requested_by_unit_identifier" : {"name" : "Admin Unit"},
    "requested_by_user_identifier" : {"username" : "MPAdministrator"},
    "requested_unit_identifier" : { "name" : "Team 4 (Installations)" },
    "requested_one_time_service_identifier" : { "code" : "Installation"},
    "number_of_resources" : 1 ,
    "planned_date" : "2014-12-04T00:00:00",
    "from_time" : "14:00",
    "to_time" : "18:00",
    "requested_resource_plan_entry_identifier" : { "number" : "1690"},
    "to_be_used_by_activity_identifier" : { "number" : "9"},
    "to_be_used_by_activity_service_identifier" : { "id" : "865FEE574CD1A24921E07FD0625AF4BD"},
    "description" : "Web Api Description Test"
}


Response:

Code Block
languagejs
themeConfluencelanguagejs
linenumberstrue
    {
       "status":
       {
           "message": null,
           "description": null,
           "code": "OK"
       },
       "data":
       {
           "udf_float_1": null,
           "udf_float_2": null,
           "requested_by_group":
           {
               "community_name": null,
               "name": "Main Group",
               "id": "84F33366CB592BAAE7E2044D93611C6A",
               "description": "Main Group",
               "alternative_code": "das"
           },
           "udf_float_3": null,
           "udf_float_4": null,
           "number": "60",
           "udf_string_1": null,
           "udf_string_2": null,
           "udf_string_3": null,
           "udf_string_4": null,
           "udf_string_5": null,
           "udf_string_6": null,
           "udf_string_7": null,
           "udf_string_8": null,
           "id": "92D30153AE02C7F15E26C3CD2F2AACD6",
           "requested_by_unit":
           {
               "community_name": null,
               "group_name": "Main Group",
               "name": "Admin Unit",
               "id": "48305F8849E3C18B227C5BE3A27BA6DF",
               "description": "r1",
               "alternative_code": "MG"
           },
           "requested_resource_plan_entry":
           {
               "effective_date": "2014-12-04T00:00:00",
               "number": "1690",
               "resource_plan":
               {
                   "effective_from": "2014-12-01T00:00:00",
                   "effective_to": "2014-12-07T00:00:00",
                   "planned_for_unit":
                   {
                       "group_name": null,
                       "name": "Team 4 (Installations)",
                       "id": "4B72C0B3BF5C38B002C8B6EA68B5852C",
                       "description": null,
                       "alternative_code": "T4I"
                   },
                   "number": "16",
                   "id": "BDFD9EFA018B3B4E587D4CD9DDA86B9A",
                   "description": null
               },
               "id": "0186B209103738494C4BC3B06D06C564",
               "description": null
           },
           "requested_by_user":
           {
               "person_name": "MPAdministrator",
               "username": "MPAdministrator",
               "id": "1",
               "email": null
           },
           "from_date": "2014-12-04T14:00:00",
           "to_be_used_by_activity_service":
           {
               "service":
               {
                   "product_type": null,
                   "id": "8E990D550CC2F4D2951A273E9D84F9E6",
                   "description": null,
                   "code": "Installation",
                   "alternative_code": "IN"
               },
               "id": "865FEE574CD1A24921E07FD0625AF4BD",
               "time_spend":
               {
                   "time_period_value": 2,
                   "time_period_uot": null
               }
           },
           "udf_date_1": null,
           "udf_date_2": null,
           "udf_date_3": null,
           "udf_date_4": null,
           "to_be_used_by_activity":
           {
               "life_cycle_state": "PENDING",
               "number": "9",
               "type":
               {
                   "name": "Installations",
                   "id": "BF60960C7FC5B0E5B81DB7E5BCC7F140",
                   "description": null,
                   "alternative_code": "IN"
               },
               "id": "D9C6BE3D7817C8DA8E16703CAAEC1A9A",
               "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
                   }
               }
           },
           "requested_one_time_service":
           {
               "product_type": null,
               "id": "8E990D550CC2F4D2951A273E9D84F9E6",
               "description": null,
               "code": "Installation",
               "alternative_code": "IN"
           },
           "to_date": "2014-12-04T18:00:00",
           "number_of_resources": 1,
           "life_cycle_state": "PENDING",
           "description": "Web Api Description Test"
       }
    }


...