Skip to end of metadata
Go to start of metadata
You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 4
Next »
job_parameter object data
Name | Type | Description |
type_identifier (mandatory) | Job type identifier | The type of the job. The allowed job type identifier fields are the following: Name | Type | Description |
---|
id (semi-optional) | String | The ID of the job type | name (semi-optional) | String | The name of the job type | alternative_code (semi-optional) | String | The alternative code of the job type |
|
owned_by_group_identifier (optional) | Group identifier | The group that will be owning the job. The allowed group identifier fields are the following: Name | Type | Description |
---|
id (semi-optional) | String | The ID of the group | name (semi-optional) | String | The code of the group | alternative_code (semi-optional) | String | The alternative code of the group |
|
billing_terms (mandatory) | Billing terms object | The billing terms of the job |
services_set (mandatory) | Set of Subscription Services | The services that will be added on the subscription through the Job. Applicable only if the job's fulfillment scope is set to ADD_SUBSCRIPTION_SERVICES |
Referred Parameter Objects Data
Unable to render {include} The included page could not be found.
new subscription service object parameter data
| | |
---|
service_identifier
(mandatory) | Service identifier | The identifier of the service. Only products classified as services are retrieved. The allowed service 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 |
|
period_billed_in_advance (mandatory on conditions) | Integer | The period that the specified service will be billed in advance. Applicable and mandatory only for prepaid and pre-rated services. If nothing is specified then the default value will be provided
|
period_billed_in_advance_uot (mandatory on conditions) | String | The unit of time for the period that the specified service will be billed in advance. Applicable and mandatory only for prepaid and pre-rated services. The supported values are DAYS, WEEKS or MONTHS.
|
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 |
services_distribution_set (optional) | Set of subscription service distribution objects | The distribution of the services that will be added on the subscription |
components_set (mandatory on conditions) | Set of subscription service components objects | The service components that should be composing the specified service. This information is available and mandatory if the specified service is a flexible product bundle |
Referred Parameter Objects Data
subscription_service_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 |
|
subscription_service_component object parameter data
| | |
---|
service_identifier
(mandatory) | Service identifier | The identifier of the service. Only products classified as services, which are also included in the product components of the related flexible product bundle are retrieved. The allowed service 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 |
|