You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
Version 1
Next »
Name | Type | Description |
---|
id | String | The ID of the retrieved job |
number | String | The number of the retrieved job |
description | String | The description of the retrieved job |
life_cycle_state | String | The life cycle state of the retrieved job which can be DRAFT, PENDING, IN PROGRESS, COMPLETED, CANCELLED |
rating_state | String | The rating state of the job that can be PENDING or COMPLETED |
assigned_to | Assign Object | The assignment information of the retrieved job |
type | Job type object | The type information of the retrieved job |
status | Job Status object | The status information of the retrieved job |
log_information | Log Information Object | The log information related with the retrieved job |
Referred Objects Response Data
assigned_to object response data
Name | Type | Description |
---|
user | User object | The user which is assigned with the retrieved activity |
business_unit | Business Unit object | The business unit which is assigned with the retrieved activity |
unit | Unit object | The unit which is assigned with the retrieved activity |
Referred Objects Response Data
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 |
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 |
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 |
job_type response data object
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 | The Description of the retrieved job type |
billing_directive | String | The billing directive of the retrieved job type The supported billing directive options are |
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 - BILL_ON_STARTING_PROGRESS
- BILL_ON_COMPLETION
|
fulfillment_scope | String | The fulfillment scope of the retrieved job type The supported fulfillment scopes are - GENERIC_PURPOSE
- NEW_SUBSCRIPTION
- ACTIVATE_SUBSCRIPTION
- DEACTIVATE_SUBSCRIPTION
- CANCEL_SUBSCRIPTION
- ADD_SUBSCRIPTION_SERVICES
- CANCEL_SUBSCRIPTION_SERVICES
- CHANGE_SUBSCRIPTION_LOCATION
- SWAP_SUBSCRIPTION_SERVICES
- SWAP_SUBSCRIPTION_INSTALLED_ITEMS
- REPLACE_PHYSICAL_GOODS
|
fulfillment_method | String | The fulfillment method of the retrieved job type The supported fulfillment methods are - BASED_ON_ORDERED_ITEMS
- BASED_ON_DELIVERED_ITEMS
|
job_status object response data
Name | Type | Description |
---|
id | String | The ID of the retrieved job status |
name | String | The name of the retrieved job status |
alternative_code | String | The alternative code of the retrieved job status |
description | String | A description of the retrieved job status |
life_cycle_state | String | The life cycle state related with the retrieved job status The supported life cycle states are the following: DRAFT, PENDING, IN_PROGRESS,COMPLETED,CANCELLED |
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 |