Skip to end of metadata
Go to start of metadata
job_requested_subscription_physical_good object parameter data
Name | Type | Description |
|---|
product_identifier
(mandatory based on conditions) | Product Identifier | The identifier of the physical good related with the requested subscription physical good. This is applicable and mandatory if the job type's fulfillment scope is not set to Swap Subscription Installed Items. The allowed physical good 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 |
|
installed_item_identifier (mandatory based on conditions) | Installed Item Identifier | The identifier of the installed item which is requested to be swapped with another installed item. This is applicable and mandatory only if the job type fulfillment scope is set to Swap Subscription Installed Items. The allowed installed item identifier fields are the following: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the installed item | serial_number (semi-optional) | String | The serial number of the installed item | alternative_code (semi-optional) | String | The alternative code of a installed item |
|
set_as_not_effective (optional) | Boolean | Defines whether the installed item will be set as Not Effective. This is applicable only if the job type fulfillment scope is set to Swap Subscription Installed Items.
|
state_classification_identifier (mandatory on conditions) | State Classification Identifier | Defines the state classification of a Not Effective installed item. Applicable and mandatory only if set_as_not_effective is set to True. This is applicable only if the job type fulfillment scope is set to Swap Subscription Installed Items. The allowed state classification identifier fields are the following: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the state classification | name (semi-optional) | String | The name of the state classification | alternative_code (semi-optional) | String | The alternative code of a state classification |
|
quantity
(optional) | Number | The quantity of the requested subscription physical good. If not specified then it is set to 1 |
warranty_coverage_reason_identifier (mandatory based on conditions) | Warranty Coverage Reason Identifier | The Warranty Coverage Reason which indicates if the requested to be swapped subscription installed item's warranty will eventually cover the replacement or not. This is applicable and mandatory in Swap Subscription Installed Items jobs and only if the requested to be swapped installed item is still under warranty. Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the warranty coverage reason | name (semi-optional) | String | The name of the warranty coverage reason | alternative_code (semi-optional) | String | The alternative code of the warranty coverage reason |
|
notes (optional) | String | The notes of the job requested subscription physical goods |
provisioning_distribution_set (optional) | Set of Subscription Physical Good Provisioning Distribution objects | The distribution of the requested subscription physical good |
Referred Parameter Objects Data
subscription_physical_good_distribution object parameter data
| | |
|---|
provisioning_distributor_identifier (mandatory) | Provisioning distributor identifier | The identifier of the provisioning distributor. The allowed provisioning distributor identifier fields are the following: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the provisioning distributor | name (semi-optional) | String | The name of the provisioning distributor | alternative_code (semi-optional) | String | The alternative code of the provisioning distributor |
|