You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 13
Next »
| Name | Type | Description |
|---|
id | String | The ID of the retrieved job type |
name | String | The name of the retrieved job type |
alternative_code | String | The alternative code of the retrieved job type |
| description | String | A description of the retrieved job type |
| billing_directive | String | The billing directive of the retrieved job type. The supported billing directives are the following: BILLABLE or NOT_BILLABLE |
| fulfillment_scope | String | The fulfillment scope of the retrieved job type. The supported fulfillment scopes are the following: GENERIC_PURPOSE, NEW_SUBSCRIPTION, ACTIVATE_SUBSCRIPTION, DEACTIVATE_SUBSCRIPTION, CANCEL_SUBSCRIPTION, ADD_SUBSCRIPTION_SERVICES, CANCEL_SUBSCRIPTION_SERVICES, CHANGE_SUBSCRIPTION_LOCATION, SWAP_SUBSCRIPTION_INSTALLED_ITEMS, SWAP_SUBSCRIPTION_SERVICES, REPLACE_PHYSICAL_GOODS
|
| fulfillment_method | String | The fulfillment method of the retrieved job type. The supported fulfillment methods are the following: BASED_ON_ORDERED_ITEMS, BASED_ON_DELIVERED_ITEMS |
| billing_method | String | The billing method of the retrieved job type. Applicable only for billable job types with fulfillment scope GENERIC_PURPOSE. The supported billing methods are the following: BILL_ON_STARTING_PROGRESS, BILL_ON_COMPLETION. |
| expiration_settings | String | The expiration settings of the retrieved job type. Applicable for all fulfillment scopes and methods. The supported expiration settings are the following: - NONE
- X_DAYS_AFTER_JOB_CREATION
- ON_PENDING_STATE
- ON_START_PROGRESS
|
udf_string_1 | String | User Defined Field of type String |
udf_string_2 | String | User Defined Field of type String |
udf_string_3 | String | User Defined Field of type String |
udf_string_4 | String | User Defined Field of type String |
udf_string_5 | String | User Defined Field of type String |
udf_string_6 | String | User Defined Field of type String |
udf_string_7 | String | User Defined Field of type String |
udf_string_8 | String | User Defined Field of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
| estimated_completion_time | Time Period Object | The time that is estimated to be required in order complete jobs of this type, measured in minutes, hours, days, weeks, years |
| subscription_type | Subscription Type Object | The type of subscription that will be delivered by jobs of this type. This information is available only if the fulfillment scope is set to NEW_SUBSCRIPTION |
| subscription_billing_term_scheme | Billing Term Scheme Object | The billing term scheme of the the subscription that will be delivered by jobs of this type. This information is available only if the fulfillment scope is set to NEW_SUBSCRIPTION |
| job_billing_term_scheme | Billing Term Scheme Object | The billing term scheme that will be used by jobs of this type. This information is available only if the fulfillment scope is set to NEW_SUBSCRIPTION |
| log_information | Log Information Object | The log information of the retrieved job type |
Referred Objects Response Data
period object response data
Name | Type | Description |
|---|
| time_period_value | Number | The time period value |
time_period_uot | String | The time period unit of time. The supported values are the following: MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS |
subscription type object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved subscription type |
name | String | The name of the retrieved subscription type |
alternative_code | String | The alternative code of the retrieved subscription type |
| description | String | A description of the retrieved subscription type |
| classification | String | The classification of the retrieved subscription type, Flexible or Package |
billing_term_scheme object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved billing term scheme |
| code | String | The code of the retrieved billing term scheme |
| name | String | The name of the retrieved billing term scheme |
| life_cycle_state | String | The life cycle state of the retrieved billing term scheme. The supported life cycle states are the following DRAFT, EFFECTIVE, TERMINATED |
| classification | String | The classification of the retrieved billing term scheme which can be either NORMAL or PREPAID |
| billing_type | String | The billing type of the billing term scheme which can be PRE_BILL or POST_BILL for NORMAL billing term schemes and PRE_RATED or POST_RATED for PREPAID billing term schemes |
| billing_method | String | The billing method of the billing term scheme which can be ANNIVERSARY or PERIOD |
log_information object response data
Name | Type | Description |
created_date | Date | The date that the retrieved record was created |
updated_date | Date | The last date that the retrieved record was updated |
created_by_unit | Unit Object | The unit that created the retrieved record |
created_by_business_unit | Unit Object | The unit that created the retrieved record |
created_by_user | User Object | The user that created the retrieved record |
updated_by_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_business_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_user | User Object | The last user that updated the retrieved record |
Referred Objects Response Data
unit object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved unit |
name | String | The name of the retrieved unit |
group_name | String | The name of the group that the retrieved unit belongs to |
community_name | String | The name of the community that the retrieved unit belongs to |
alternative_code | String | The alternative code of the retrieved unit |
description | String | The description of the retrieved unit |
business unit object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved business unit |
name | String | The name of the retrieved business unit |
| code | String | The code of the retrieved business unit |
| unified_code | String | The unified code of the retrieved business unit |
description | String | The description of the retrieved business unit |
| parent_business_unit_name | String | The name of the parent business unit that the retrieved business unit belongs to |
user object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved user |
username | String | The user name of the retrieved user |
person_name | String | The full name of the retrieved user |
email | String | The email of the retrieved user |