installed_item_parameters

 installed_item parameter object data

Name

Type

Description

serial_number

(mandatory)

String

The serial number of the installed item to be created

alternative_code

(mandatory)

StringThe alternative code of the installed item to be created

product_identifier

(mandatory)

Products identifierThe product that will be related with the installed item. The allowed product identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the product

code

(semi-optional)

String

The code of the product

alternative_code

(semi-optional)

String

The alternative code of  the product

category_identifier

(optional)

Installed item category identifierThe installed item category that will be related with the installed item. The allowed installed item category identifier fields are the following:

Deprecated from R18.0.0

Name

Type

Description

id

(semi-optional)

String

The ID of the installed item category

name

(semi-optional)

String

The name of the installed item category

code

(semi-optional)

String

The code of  the installed item category

state

(mandatory)

StringThe state of the installed item to be created, which can be EFFECTIVE or NOT_EFFECTIVE

notes

(optional)

StringNotes for the installed item to be created

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_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

components_set

(mandatory and applicable on conditions)

Set of Installed Item Components

The components that should be added on the installed item that will be created. This information is applicable and mandatory if the installed item that will be created has a product type classified as fixed product bundle

 

Referred Parameter Objects

 installed_item_component parameter object data

Name

Type

Description

serial_number

(mandatory)

String

The serial number of the installed item to be created

alternative_code

(mandatory)

StringThe alternative code of the installed item to be created

product_identifier

(mandatory)

Products identifierThe product that will be related with the installed item. The allowed product identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the product

code

(semi-optional)

String

The code of the product

alternative_code

(semi-optional)

String

The alternative code of  the product

category_identifier

(optional)

Installed item category identifierThe installed item category that will be related with the installed item. The allowed installed item category identifier fields are the following:

Deprecated from R18.0.0

Name

Type

Description

id

(semi-optional)

String

The ID of the installed item category

name

(semi-optional)

String

The name of the installed item category

code

(semi-optional)

String

The code of  the installed item category

state

(mandatory)

StringThe state of the installed item to be created, which can be EFFECTIVE or NOT_EFFECTIVE

notes

(optional)

StringNotes for the installed item to be created

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_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