GET jobs/all_scopes/list

Available from CRM.COM R10.0.0

This method returns information related with jobs of all fulfillment scopes. Multiple jobs are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(semi-optional)

Accounts receivable identifier

The identifier of the account related with the job that should be returned as a result. The allowed account identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the accounts receivable

number

(semi-optional)

String

The number of the accounts receivable

name

(semi-optional)

String

The name of the accounts receivable

type_identifier
(semi-optional)

Job type identifier

The identifier of the job type related with the jobs that should be returned as a result. 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

number_of_results

(optional)

Number

The number of results that can be retrieved through each call

Available from CRM.COM R13.0.0

offset

(optional)

Number

Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number

Available from CRM.COM R13.0.0

From R14.5.0, the results are retrieved sorted by their created date, descending

fields_set

(optional)

List of Strings, comma separated

A list of fields that should be included in the results. If not specified then all the available fields will be returned

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

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
expiration_date	Date	The date on which the job expires. Available form CRM.COM R13.0.0
scheduled_date	Date	The date on which the job is scheduled to be performed. Applicable only for fulfillment scopes that deliver Subscription amendments: Swap Subscription Service Cancel Subscription Cancel Subscription Services Subscription Maintenance Available form CRM.COM R13.0.0
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 Available from CRM.COM R18.0.0
unit	Unit object	The unit which is assigned with the retrieved activity Deprecated from CRM.COM R18.0.0

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 BILLABLE NOT_BILLABLE Available from CRM.COM R10.0.0
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 Available from CRM.COM R10.0.0 From CRM.COM R15.0.0 and onward, this attribute will be deprecated
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 The following fulfillment scopes will be available from CRM.COM R8.0.0 ACTIVATE_SUBSCRIPTION, DEACTIVATE_SUBSCRIPTION, CANCEL_SUBSCRIPTION, ADD_SUBSCRIPTION_SERVICES, CANCEL_SUBSCRIPTION_SERVICES, CHANGE_SUBSCRIPTION_LOCATION The following fulfillment scopes will be available from CRM.COM R9.0.0 SWAP_SUBSCRIPTION_SERVICES, SWAP_SUBSCRIPTION_INSTALLED_ITEMS The following fulfillment scope will be available from CRM.COM R11.0.0 REPLACE_PHYSICAL_GOODS From CRM.COM R15.0.0 and onward, all fulfillment scopes* will be deprecated*
fulfillment_method	String	The fulfillment method of the retrieved job type The supported fulfillment methods are BASED_ON_ORDERED_ITEMS BASED_ON_DELIVERED_ITEMS From CRM.COM R15.0.0 and onward, this attribute will be deprecated

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 From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
created_by_business_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Available from CRM.COM R18.0.0
created_by_user	User Object	The user that created the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled
updated_by_unit	Unit Object	The last unit that updated the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
updated_by_business_unit	Unit Object	The last unit that updated the retrieved record Available from CRM.COM R18.0.0
updated_by_user	User Object	The last user that updated the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

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

Examples

Example 1

HTTP Method: GET

Request:

Response:

 {
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": [
    {
      "log_information": {
        "updated_date": "2016-07-13T17:04:22",
        "created_date": "2016-07-13T16:46:02",
        "created_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "updated_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1"
        },
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1"
        }
      },
      "status": {
        "life_cycle_state": "COMPLETED",
        "id": "JobStatus4",
        "name": "Closed",
        "description": "Completed",
        "alternative_code": "CL"
      },
      "life_cycle_state": "COMPLETED",
      "number": "JOB000720",
      "type": {
        "fulfillment_method": "BASED_ON_ORDERED_ITEMS",
        "fulfillment_scope": "GENERIC_PURPOSE",
        "billing_method": null,
        "id": "JOBTYPE2",
        "name": "Not Billable Job",
        "billing_directive": "NOT_BILLABLE",
        "description": null,
        "alternative_code": "NBJ"
      },
      "id": "BAA12CF1C16A451F984CF92DBC0D9777",
      "description": null,
      "assigned_to": {
        "unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1"
        }
      },
      "rating_state": "PENDING"
    },
    {
      "log_information": {
        "updated_date": "2016-07-15T19:19:53",
        "created_date": "2016-07-15T19:15:49",
        "created_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "updated_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1"
        },
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1"
        }
      },
      "status": {
        "life_cycle_state": "COMPLETED",
        "id": "JobStatus4",
        "name": "Closed",
        "description": "Completed",
        "alternative_code": "CL"
      },
      "life_cycle_state": "COMPLETED",
      "number": "JOB000735",
      "type": {
        "fulfillment_method": "BASED_ON_ORDERED_ITEMS",
        "fulfillment_scope": "DEACTIVATE_SUBSCRIPTION",
        "billing_method": null,
        "id": "40F231681B984DA28EDBDA8B698E229E",
        "name": "Deactivate Subscription",
        "billing_directive": "BILLABLE",
        "description": null,
        "alternative_code": "DS"
      },
      "id": "DD237C07A1FD4CCA91B609FD7DD6B0CF",
      "description": null,
      "assigned_to": {
        "unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1"
        }
      },
      "rating_state": "PENDING"
    },
    {
      "log_information": {
        "updated_date": "2016-07-15T19:30:50",
        "created_date": "2016-07-15T19:28:24",
        "created_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "updated_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1"
        },
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1"
        }
      },
      "status": {
        "life_cycle_state": "COMPLETED",
        "id": "JobStatus4",
        "name": "Closed",
        "description": "Completed",
        "alternative_code": "CL"
      },
      "life_cycle_state": "COMPLETED",
      "number": "JOB000736",
      "type": {
        "fulfillment_method": "BASED_ON_ORDERED_ITEMS",
        "fulfillment_scope": "CANCEL_SUBSCRIPTION",
        "billing_method": null,
        "id": "CB698F72C9B9432F949CA5BCBA68828F",
        "name": "Cancel Subscription",
        "billing_directive": "BILLABLE",
        "description": null,
        "alternative_code": "CS"
      },
      "id": "4059D3582E304F45B451712CFD7FEA4A",
      "description": null,
      "assigned_to": {
        "unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1"
        }
      },
      "rating_state": "PENDING"
    },
    {
      "log_information": {
        "updated_date": "2016-07-19T13:42:37",
        "created_date": "2016-07-19T13:13:11",
        "created_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "updated_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1"
        },
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1"
        }
      },
      "status": {
        "life_cycle_state": "CANCELLED",
        "id": "A1E10920D28A4496BCA2811A94783BDF",
        "name": "Cancelled",
        "description": null,
        "alternative_code": "C"
      },
      "life_cycle_state": "CANCELLED",
      "number": "JOB000743",
      "type": {
        "fulfillment_method": "BASED_ON_ORDERED_ITEMS",
        "fulfillment_scope": "ACTIVATE_SUBSCRIPTION",
        "billing_method": null,
        "id": "A27C03160F22451DB67A090495E69E45",
        "name": "Activate Subscription",
        "billing_directive": "BILLABLE",
        "description": null,
        "alternative_code": "AS"
      },
      "id": "2EEFE8F7646F4B84B515446C5B59EBA0",
      "description": "Activate Subscription S61007 for Anton Mara",
      "assigned_to": {
        "unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1"
        }
      },
      "rating_state": "PENDING"
    },
    {
      "log_information": {
        "updated_date": "2016-07-19T13:46:32",
        "created_date": "2016-07-19T13:43:01",
        "created_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "updated_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1"
        },
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1"
        }
      },
      "status": {
        "life_cycle_state": "CANCELLED",
        "id": "A1E10920D28A4496BCA2811A94783BDF",
        "name": "Cancelled",
        "description": null,
        "alternative_code": "C"
      },
      "life_cycle_state": "CANCELLED",
      "number": "JOB000744",
      "type": {
        "fulfillment_method": "BASED_ON_ORDERED_ITEMS",
        "fulfillment_scope": "ACTIVATE_SUBSCRIPTION",
        "billing_method": null,
        "id": "A27C03160F22451DB67A090495E69E45",
        "name": "Activate Subscription",
        "billing_directive": "BILLABLE",
        "description": null,
        "alternative_code": "AS"
      },
      "id": "2FF7C59CACD543CC8C019AD74FD0AF2B",
      "description": "Activate Subscription S61007 for Anton Mara",
      "assigned_to": {
        "unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1"
        }
      },
      "rating_state": "PENDING"
    },
    {
      "log_information": {
        "updated_date": "2016-07-19T14:06:26",
        "created_date": "2016-07-19T14:03:46",
        "created_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "updated_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1"
        },
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1"
        }
      },
      "status": {
        "life_cycle_state": "CANCELLED",
        "id": "A1E10920D28A4496BCA2811A94783BDF",
        "name": "Cancelled",
        "description": null,
        "alternative_code": "C"
      },
      "life_cycle_state": "CANCELLED",
      "number": "JOB000747",
      "type": {
        "fulfillment_method": "BASED_ON_ORDERED_ITEMS",
        "fulfillment_scope": "ACTIVATE_SUBSCRIPTION",
        "billing_method": null,
        "id": "A27C03160F22451DB67A090495E69E45",
        "name": "Activate Subscription",
        "billing_directive": "BILLABLE",
        "description": null,
        "alternative_code": "AS"
      },
      "id": "FC1FD68B128344DAA61FF199AE98538E",
      "description": "Activate Subscription S61007 for Anton Mara",
      "assigned_to": {
        "unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1"
        }
      },
      "rating_state": "PENDING"
    },
    {
      "log_information": {
        "updated_date": "2016-07-19T14:31:19",
        "created_date": "2016-07-19T14:30:57",
        "created_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "updated_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1"
        },
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1"
        }
      },
      "status": {
        "life_cycle_state": "DRAFT",
        "id": "0F1EE97BD63642699FFAEB461F471147",
        "name": "Draft",
        "description": null,
        "alternative_code": "D"
      },
      "life_cycle_state": "DRAFT",
      "number": "JOB000755",
      "type": {
        "fulfillment_method": "BASED_ON_ORDERED_ITEMS",
        "fulfillment_scope": "ACTIVATE_SUBSCRIPTION",
        "billing_method": null,
        "id": "A27C03160F22451DB67A090495E69E45",
        "name": "Activate Subscription",
        "billing_directive": "BILLABLE",
        "description": null,
        "alternative_code": "AS"
      },
      "id": "14FBD0ADE2A04C0B888665DB03FFBC74",
      "description": "Activate Subscription S61007 for Anton Mara",
      "assigned_to": {
        "unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1"
        }
      },
      "rating_state": "PENDING"
    },
    {
      "log_information": {
        "updated_date": "2016-07-19T16:18:02",
        "created_date": "2016-07-19T16:10:39",
        "created_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "updated_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1"
        },
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1"
        }
      },
      "status": {
        "life_cycle_state": "CANCELLED",
        "id": "A1E10920D28A4496BCA2811A94783BDF",
        "name": "Cancelled",
        "description": null,
        "alternative_code": "C"
      },
      "life_cycle_state": "CANCELLED",
      "number": "JOB000758",
      "type": {
        "fulfillment_method": "BASED_ON_ORDERED_ITEMS",
        "fulfillment_scope": "GENERIC_PURPOSE",
        "billing_method": "BILL_ON_COMPLETION",
        "id": "98523D8F88354CFAA8BF66E51DEA0A40",
        "name": "Installation Job 2",
        "billing_directive": "BILLABLE",
        "description": "Job for installing Smartcard and Set Top Box on Subscriber's house if requested",
        "alternative_code": "002"
      },
      "id": "0B93B5DF831943D18EDCF8C5A82ECC67",
      "description": null,
      "assigned_to": {
        "unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1"
        }
      },
      "rating_state": "PENDING"
    }
  ]
}

Example 2

HTTP Method: GET

Request:

Response:

 
  {
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": [
    {
      "log_information": {
        "updated_date": "2016-06-21T15:18:31",
        "created_date": "2016-06-21T15:16:27",
        "created_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "updated_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1"
        },
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1"
        }
      },
      "status": {
        "life_cycle_state": "PENDING",
        "id": "59310E86D1DD626A04102462FC3E9D1B",
        "name": "To be Approved",
        "description": "To be Accepted",
        "alternative_code": "TBA"
      },
      "life_cycle_state": "PENDING",
      "number": "JOB000630",
      "type": {
        "fulfillment_method": "BASED_ON_ORDERED_ITEMS",
        "fulfillment_scope": "NEW_SUBSCRIPTION",
        "billing_method": null,
        "id": "6765026B08E74273970FCDCB490B982F",
        "name": "New Prepaid Subscription",
        "billing_directive": "BILLABLE",
        "description": null,
        "alternative_code": "NPS"
      },
      "id": "DE9353AFF23942C6B7B02245BC1BAA96",
      "description": null,
      "assigned_to": {
        "unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1"
        }
      },
      "rating_state": "PENDING"
    },
    {
      "log_information": {
        "updated_date": "2016-06-22T15:04:22",
        "created_date": "2016-06-22T14:47:09",
        "created_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "updated_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1"
        },
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1"
        }
      },
      "status": {
        "life_cycle_state": "IN_PROGRESS",
        "id": "7DF6892091E5462A80B3B5964D18DB3C",
        "name": "Approved",
        "description": null,
        "alternative_code": "Ap"
      },
      "life_cycle_state": "IN_PROGRESS",
      "number": "JOB000637",
      "type": {
        "fulfillment_method": "BASED_ON_ORDERED_ITEMS",
        "fulfillment_scope": "NEW_SUBSCRIPTION",
        "billing_method": null,
        "id": "6765026B08E74273970FCDCB490B982F",
        "name": "New Prepaid Subscription",
        "billing_directive": "BILLABLE",
        "description": null,
        "alternative_code": "NPS"
      },
      "id": "E24BAB61693D4F17A763EFC320129E2A",
      "description": null,
      "assigned_to": {
        "unit": null,
        "user": {
          "person_name": "Meri",
          "username": "Meri",
          "id": "573150C4CE1882B98D3D65DB9390D851",
          "email": null
        }
      },
      "rating_state": "PENDING"
    },
    {
      "log_information": {
        "updated_date": "2016-07-22T16:22:08",
        "created_date": "2016-07-22T14:55:12",
        "created_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "updated_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1"
        },
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1"
        }
      },
      "status": {
        "life_cycle_state": "CANCELLED",
        "id": "A1E10920D28A4496BCA2811A94783BDF",
        "name": "Cancelled",
        "description": null,
        "alternative_code": "C"
      },
      "life_cycle_state": "CANCELLED",
      "number": "JOB000772",
      "type": {
        "fulfillment_method": "BASED_ON_ORDERED_ITEMS",
        "fulfillment_scope": "NEW_SUBSCRIPTION",
        "billing_method": null,
        "id": "6765026B08E74273970FCDCB490B982F",
        "name": "New Prepaid Subscription",
        "billing_directive": "BILLABLE",
        "description": null,
        "alternative_code": "NPS"
      },
      "id": "7BDC8E48394B4CEDA1109D0ACA800854",
      "description": null,
      "assigned_to": {
        "unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1"
        }
      },
      "rating_state": "PENDING"
    },
	...
 
}

CRM.COM Development

GET jobs/all_scopes/list

Resource URL

Parameters

Restrictions

Response Data

Examples

Related pages