Service Contract API

Release version: Yokohama

Updated January 30, 2025

94 minutes to read

The Service Contract API provides endpoints to create and retrieve service contract records.

Note:

This API is for creating data in the tables for the Customer Contracts and Entitlements application. It is not a general purpose API.

To access this API the following plugins must be activated on the associated instance:

Customer Contracts and Entitlements (com.sn_pss_core)
Customer Service Install Base Management (com.snc.install)
Product Catalog Management Core (com.sn_prd)

In addition, to successfully call this API you must have the sn_pss_core.pss_integrator role. This API runs in the sn_pss_core namespace.

Before using this API, you should have associated data in the following tables. For additional information, see Create service contracts.

Account [customer_account]
Consumer [csm_consumer]
Household [csm_household]
Install Base [sn_install_base_item]
Product Specification [sn_prd_pm_product_specification]
Product Offering [sn_prd_pm_product_offering]
Product Model [cmdb_model]
Sold Product [sn_install_base_sold_product]

Service Contract - GET /sn_pss_core/servicecontract/{id}

Retrieves a specified service contract record.

This endpoint retrieves data from the following tables when processing the request:

Characteristic [sn_pss_core_entitlement_characteristic]
Entitlement [service_entitlement]
Entitlement Usage [sn_pss_core_entitlement_usage]
Sold Product Covered [sn_install_base_m2m_contract_sold_product] - This table contains information for both sold products covered and install base items covered.
Service Contract [sn_pss_core_service_contract]
Service Contract Line [sn_pss_core_service_contract_line]

URL format

Versioned URL: /api/sn_pss_core/{api_version}/servicecontract/{id}

Default URL: /api/sn_pss_core/servicecontract/{id}

Note:

Available versions are specified in the REST API Explorer. For scripted REST APIs there is additional version information on the Scripted REST Service form.

Supported request parameters

Table 1. Path parameters
Name	Description
api_version	Optional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String
id	Sys_id of the service contract to retrieve. Data type: String Table: Service Contract [sn_pss_core_service_contract]

Table 2. Query parameters
Name	Description
display_value	Type of data to return. Valid values: false: Return the `value` for all fields. For example, `"state":"draft"`. true: Return the `display_value` for all fields. For example, `"state":"Draft"` all: Return all information for all fields. Data type: String Default: false

Table 3. Request body parameters (XML or JSON)
Name	Description
None

Headers

The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.

Table 4. Request headers
Header	Description
Accept	Data format of the response body. Supported types: application/json or application/xml. Default: application/json

Table 5. Response headers
Header	Description
None

Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.

Table 6. Status codes
Status code	Description
200	Successful. The request was successfully processed.
400	Bad Request. A bad request type or malformed request was detected.
403	Forbidden. The user doesn't have permission to access the API.
404	Not found. The requested item wasn't found.
500	Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.

Response body parameters (JSON or XML)


Name	Description
account	Sys_id of the account record to which the service contract belongs. Data type: String Table: Account [customer_account]
consumer	Sys_id of the consumer record to which the service contract belongs. Data type: String Table: Consumer [csm_consumer]
ends	Date on which the service contract ends. Data type: String Format: yyyy-mm-dd
household	Sys_id of the household associated with the service contract. Data type: String Table: Household [csm_household]
install_base_items_covered	List of install base items covered under the service contract line. Data type: Array of Objects `"install_base_items_covered": [ { "added": "String", "contract": "String", "entitlement": "String", "install_base": "String", "removed": "String", "service_contract_line": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" } ]`
install_base_items_covered.added	Date that the associated service contract starts to cover the install base item. Data type: String Format: yyyy-mm-dd
install_base_items_covered.contract	Sys_id of the service contract record associated with the install base item. Data type: String Table: Service Contract [sn_pss_core_service_contract]
install_base_items_covered.entitlement	Sys_id of the entitlement record associated with the install base item. Data type: String Table: Entitlement [service_entitlement]
install_base_items_covered.install_base	Sys_id of the associated install base item record. Data type: String Table: Install Base Item [sn_install_base_item]
install_base_items_covered.removed	Date that the associated service contract ends coverage of the install base item. Data type: String Format: yyyy-mm-dd
install_base_items_covered.service_contract_line	Sys_id of the associated service contract line record. Data type: String Table: Service Contract Line [sn_pss_core_service_contract_line]
install_base_items_covered.sys_created_by	Name of the user that created the install base item record. Data type: String
install_base_items_covered.sys_created_on	Date and time that the install base item record was created. Data type: String
install_base_items_covered.sys_id	Sys_id of the install base item covered. Data type: String Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
install_base_items_covered.sys_updated_by	Name of the user that last updated the install base item record. Data type: String
install_base_items_covered.sys_updated_on	Date and time that the install base item record was last updated. Data type: String
number	Auto-generated service contract number. Data type: String
service_contract_lines	List of service contract lines (services) associated with the service contract. Data type: Array of Objects "service_contract_lines": [ { "child_contract_lines": [Array], "contract": "String", "ends": "String", "entitlements": [Array], "entitlement_characteristics": [Array], "install_base_items_covered": [Array], "name": "String", "number": "String", "parent_contract_line": "String", "product_model": "String", "product_offering": "String", "product_specification": "String", "sold_product": "String", "sold_products_covered": [Array], "starts": "String", "state": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_update_on": "String" } ]
service_contract_lines.child_contract_lines	List of child service contract lines associated with the service contract line. Data type: Array of Objects "child_contract_lines": [ { "child_contract_lines": [Array], "contract": "String", "ends": "String", "entitlements": [Array], "entitlement_characteristics": [Array], "install_base_items_covered": [Array], "name": "String", "number": "String", "parent_contract_line": "String", "product_model": "String", "product_offering": "String", "product_specification": "String", "sold_product": "String", "sold_products_covered": [Array], "starts": "String", "state": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_update_on": "String" } ]
service_contract_lines.child_contract_lines.child_contract_lines	List of child service contract lines associated with the child service contract line. Same parameters as in child_contract_lines. Data type: Array
service_contract_lines.child_contract_lines.contract	Sys_id of the service contract associated with the child service contract line. Data type: String Table: Service Contract [sn_pss_core_service_contract]
service_contract_lines.child_contract_lines.ends	Date on which the child service contract line ends. Data type: String Format: yyyy-mm-dd Default: Never ends until manually removed.
service_contract_lines.child_contract_lines.entitlements	List of entitlements associated with the child service contract line. Data type: Array of Objects "entitlements": [ { "account": "String", "consumer": "String", "contract": "String", "end_date": "String", "entitlement_characteristics": [Array], "entitlement_name": "String", "household": "String", "install_base_items_covered": [Array], "product": "String", "product_offering": "String", "product_specification": "String", "service_contract_line": "String", "sold_entitlement": "String", "sold_products_covered": [Array], "start_date": "String", "state": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" } ]
service_contract_lines.child_contract_lines.entitlements.account	Sys_id of the account record to which the entitlement belongs. Data type: String Table: Account [customer_account]
service_contract_lines.child_contract_lines.entitlements.consumer	Sys_id of the consumer record to which the entitlement belongs. Data type: String Table: Consumer [csm_consumer]
service_contract_lines.child_contract_lines.entitlements.contract	Sys_id of the contract record to which the entitlement belongs. Data type: String Table: Service Contract [sn_pss_core_service_contract]
service_contract_lines.child_contract_lines.entitlements.end_date	End date of the entitlement. Data type: String Format: yyyy-mm-dd Default: Never ends until manually removed.
service_contract_lines.child_contract_lines.entitlements.entitlement_characteristics	List of characteristics associated with the entitlement. Data type: Array of Objects `"entitlement_characteristics": [ { "characteristic": "String", "characteristic_option": "String", "entitlement": "String", "service_contract_line": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String", "type": "String", "value": "String" } ]`
service_contract_lines.child_contract_lines.entitlements.entitlement_characteristics.characteristic	Sys_id of the characteristic record associated with the entitlement. Data type: String Table: Characteristic [sn_prd_pm_characteristic]
service_contract_lines.child_contract_lines.entitlements.entitlement_characteristics.characteristic_option	Sys_id of the characteristic option record associated with the entitlement. Data type: String Table: Characteristic Option [sn_prd_pm_characteristic_option]
service_contract_lines.child_contract_lines.entitlements.entitlement_characteristics.entitlement	Sys_id of the entitlement record. Data type: String Table: Entitlement [service_entitlement]
service_contract_lines.child_contract_lines.entitlements.entitlement_characteristics.entitlement_usage	List of usage values for the associated product. Data type: Array of Objects `"entitlement_usage": [ { "entitlement": "String", "entitlement_characteristic": "String", "period_end": "String", "period_start": "String", "service_contract_line": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_update_on": "String", "total_units": "String", "used_units": "String" } ]`
service_contract_lines.child_contract_lines.entitlements.entitlement_characteristics.entitlement_usage.entitlement	Sys_id of the entitlement record associated with the entitlement usage. Data type: String Table: Entitlement [service_entitlement]
service_contract_lines.child_contract_lines.entitlements.entitlement_characteristics.entitlement_usage.entitlement_characteristic	Sys_id of the entitlement characteristic record associated with the entitlement usage. Data type: String Table: Characteristic [sn_pss_core_entitlement_characteristic]
service_contract_lines.child_contract_lines.entitlements.entitlement_characteristics.entitlement_usage.period_end	End date when the entitlement usage is no longer tracked. Data type: String Format: yyyy-mm-dd
service_contract_lines.child_contract_lines.entitlements.entitlement_characteristics.entitlement_usage.period_start	Starting date of when the entitlement usage is tracked. Data type: String Format: yyyy-mm-dd
service_contract_lines.child_contract_lines.entitlements.entitlement_characteristics.entitlement_usage.service_contract_line	Sys_id of the service contract line to which the current entitlement usage belongs. Data type: String
service_contract_lines.child_contract_lines.entitlements.entitlement_characteristics.entitlement_usage.sys_created_by	Name of the user that created the entitlement usage record. Data type: String
service_contract_lines.child_contract_lines.entitlements.entitlement_characteristics.entitlement_usage.sys_created_on	Date and time that the entitlement usage record was created. Data type: String
service_contract_lines.child_contract_lines.entitlements.entitlement_characteristics.entitlement_usage.sys_id	Sys_id of the entitlement usage record. Data type: String Table: Entitlement Usage [sn_pss_core_entitlement_usage]
service_contract_lines.child_contract_lines.entitlements.entitlement_characteristics.entitlement_usage.sys_updated_by	Name of the user that last updated the entitlement usage record. Data type: String
service_contract_lines.child_contract_lines.entitlements.entitlement_characteristics.entitlement_usage.sys_updated_on	Date and time that the entitlement usage record was last updated. Data type: String
service_contract_lines.child_contract_lines.entitlements.entitlement_characteristics.entitlement_usage.total_units	Total coverage value of the associated entitlement characteristic. Data type: String
service_contract_lines.child_contract_lines.entitlements.entitlement_characteristics.entitlement_usage.used_units	Number of units used by the account or consumer between the period_start and the period_end. Data type: String
service_contract_lines.child_contract_lines.entitlements.entitlement_characteristics.service_contract_line	Child contract line to which the current entitlement characteristic belongs to. Data type: String
service_contract_lines.child_contract_lines.entitlements.entitlement_characteristics.sys_created_by	Name of the user who created the entitlement characteristic. Data type: String
service_contract_lines.child_contract_lines.entitlements.entitlement_characteristics.sys_created_on	Date and time when the entitlement characteristic was created. Data type: String
service_contract_lines.child_contract_lines.entitlements.entitlement_characteristics.sys_id	Sys_id of the entitlement characteristic record. Data type: String
service_contract_lines.child_contract_lines.entitlements.entitlement_characteristics.sys_updated_by	Name of the user who last updated the entitlement characteristic. Data type: String
service_contract_lines.child_contract_lines.entitlements.entitlement_characteristics.sys_updated_on	Date and time when the entitlement characteristic was last updated. Data type: String
service_contract_lines.child_contract_lines.entitlements.entitlement_characteristics.type	Type of entitlement characteristic. Valid values: coverage coverage_and_usage Data type: String
service_contract_lines.child_contract_lines.entitlements.entitlement_characteristics.value	Value of the characteristic. Data type: String
service_contract_lines.child_contract_lines.entitlements.entitlement_name	Name of the entitlement. Data type: String
service_contract_lines.child_contract_lines.entitlements.household	Sys_id of the household record associated with the entitlement. Data type: String Table: Household [csm_household]
service_contract_lines.child_contract_lines.entitlements.install_base_items_covered	List of install base items covered under the  child service contract line. Data type: Array of Objects `"install_base_items_covered": [ { "added": "String", "contract": "String", "entitlement": "String", "install_base": "String", "removed": "String", "service_contract_line": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" } ]` Table: Sold Product Covered  [sn_install_base_m2m_contract_sold_product]
service_contract_lines.child_contract_lines.entitlements.install_base_items_covered.added	Date that the associated install base item was added to the service contract line. Data type: String Format: yyyy-mm-dd
service_contract_lines.child_contract_lines.entitlements.install_base_items_covered.contract	Sys_id of the service contract record associated with the install base item. Data type: String Table: Service Contract [sn_pss_core_service_contract]
service_contract_lines.child_contract_lines.entitlements.install_base_items_covered.entitlement	Sys_id of the entitlement record associated with the install base item. Data type: String Table: Service Contract [sn_pss_core_service_contract]
service_contract_lines.child_contract_lines.entitlements.install_base_items_covered.install_base	Sys_id of the associated install base item record. Data type: String Table: Install Base Item [sn_install_base_item]
service_contract_lines.child_contract_lines.entitlements.install_base_items_covered.removed	Date that the associated service contract line ends coverage of the install base item. Data type: String Format: yyyy-mm-dd
service_contract_lines.child_contract_lines.entitlements.install_base_items_covered.service_contract_line	Sys_id of the associated service contract line record. Data type: String Table: Service Contract Line [sn_pss_core_service_contract_line]
service_contract_lines.child_contract_lines.entitlements.install_base_items_covered.sys_created_by	Name of the user that created the install base item record. Data type: String
service_contract_lines.child_contract_lines.entitlements.install_base_items_covered.sys_created_on	Date and time that the install base item record was created. Data type: String
service_contract_lines.child_contract_lines.entitlements.install_base_items_covered.sys_id	Sys_id of the install base item covered. Data type: String Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
service_contract_lines.child_contract_lines.entitlements.install_base_items_covered.sys_updated_by	Name of the user that last updated the install base item record. Data type: String
service_contract_lines.child_contract_lines.entitlements.install_base_items_covered.sys_updated_on	Date and time that the install base item record was last updated. Data type: String
service_contract_lines.child_contract_lines.entitlements.product	Sys_id of the product model record associated with the entitlement. Data type: String Table: Product Model [cmdb_model]
service_contract_lines.child_contract_lines.entitlements.product_offering	Sys_id of the product offering record associated with the entitlement. Data type: String Table: Product Offering [sn_prd_pm_product_offering]
service_contract_lines.child_contract_lines.entitlements.product_specification	Sys_id of the product specification record associated with the entitlement. Data type: String Table: Product Specification [sn_prd_pm_product_specification]
service_contract_lines.child_contract_lines.entitlements.service_contract_line	Sys_id of the service contract line record associated with the entitlement. Data type: String Table: Service Contract Line [sn_pss_core_service_contract_line]
service_contract_lines.child_contract_lines.entitlements.sold_entitlement	Sys_id of the sold product record associated with the entitlement. Data type: String Table: Sold Product [sn_install_base_sold_product]
service_contract_lines.child_contract_lines.entitlements.sold_products_covered	List of products covered. Data type: Array of Objects `"sold_products_covered": [ { "added": "String", "contract": "String", "entitlement": "String", "removed": "String", "service_contract_line": "String", "sold_product": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" } ]` Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
service_contract_lines.child_contract_lines.entitlements.sold_products_covered.added	Date that the associated service contract starts to cover the product. Data type: String Format: yyyy-mm-dd Default: Current date
service_contract_lines.child_contract_lines.entitlements.sold_products_covered.contract	Sys_id of the service contract record associated with the sold product covered. Data type: String Table: Service Contract [sn_pss_core_service_contract]
service_contract_lines.child_contract_lines.entitlements.sold_products_covered.entitlement	Sys_id of the entitlement record associated with the sold product covered. Data type: String Table: Entitlement [service_entitlement]
service_contract_lines.child_contract_lines.entitlements.sold_products_covered.removed	Date that the associated service contract ends coverage of the associated product. Data type: String Format: yyyy-mm-dd Default: No end date
service_contract_lines.child_contract_lines.entitlements.sold_products_covered.service_contract_line	Sys_id of the service contract line record associated with the sold product covered. Data type: String Table: Service Contract Line [sn_pss_core_service_contract_line]
service_contract_lines.child_contract_lines.entitlements.sold_products_covered.sold_product	Sys_id of the product covered by the service contract. Data type: String Table: Sold Product [sn_install_base_sold_product]
service_contract_lines.child_contract_lines.entitlements.sold_products_covered.sys_created_by	Name of the user that created the sold product covered record. Data type: String
service_contract_lines.child_contract_lines.sold_products_covered.sys_created_on	Date and time that the sold product covered record was created. Data type: String
service_contract_lines.child_contract_lines.entitlements.sold_products_covered.sys_id	Sys_id of the product covered by this service contract. Data type: String Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
service_contract_lines.child_contract_lines.entitlements.sold_products_covered.sys_updated_by	Name of the user that last updated the sold product covered record. Data type: String
service_contract_lines.child_contract_lines.entitlements.sold_products_covered.sys_updated_on	Name of the user that last updated the sold product covered record. Data type: String
service_contract_lines.child_contract_lines.entitlements.start_date	Start date of the entitlement. Data type: String Format: yyyy-mm-dd
service_contract_lines.child_contract_lines.entitlements.state	Current state of the entitlement. Valid values: (case-sensitive) active cancelled draft expired suspended Data type: String
service_contract_lines.child_contract_lines.entitlements.sys_created_by	Name of the user that created the entitlement record. Data type: String
service_contract_lines.child_contract_lines.entitlements.sys_created_on	Date and time that the entitlement record was created. Data type: String
service_contract_lines.child_contract_lines.entitlements.sys_id	Sys_id of the associated entitlement record. Data type: String Table: Entitlement [service_entitlement]
service_contract_lines.child_contract_lines.entitlements.sys_updated_by	Name of the user that last updated the entitlement record. Data type: String
service_contract_lines.child_contract_lines.entitlements.sys_updated_on	Date and time that the entitlement record was created. Data type: String
service_contract_lines.child_contract_lines.entitlement_characteristics	List of characteristics associated with the entitlement. Data type: Array of Objects `"entitlement_characteristics": [ { "characteristic": "String", "characteristic_option": "String", "entitlement": "String", "entitlement_usage": [Array], "service_contract_line": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" "type": "String", "value": "String" } ]`
service_contract_lines.child_contract_lines.entitlement_characteristics.characteristic	Sys_id of the characteristic record associated with the entitlement. Data type: String Table: Characteristic [sn_prd_pm_characteristic]
service_contract_lines.child_contract_lines.entitlement_characteristics.characteristic_option	Sys_id of the characteristic option record associated with the entitlement. Data type: String Table: Characteristic Option [sn_prd_pm_characteristic_option]
service_contract_lines.child_contract_lines.entitlement_characteristics.entitlement	Sys_id of the entitlement record. Data type: String Table: Entitlement [service_entitlement]
service_contract_lines.child_contract_lines.entitlement_characteristics.service_contract_line	Sys_id of the service contract line record associated with the entitlement characteristic. Data type: String Table: Service Contract Line [sn_pss_core_service_contract_line]
service_contract_lines.child_contract_lines.entitlement_characteristics.sys_created_by	Name of the user that created the entitlement characteristics record. Data type: String
service_contract_lines.child_contract_lines.entitlement_characteristics.sys_created_on	Date and time that the entitlement characteristics record was created. Data type: String
service_contract_lines.child_contract_lines.entitlement_characteristics.sys_id	Sys_id of the entitlement characteristics record. Data type: String
service_contract_lines.child_contract_lines.entitlement_characteristics.sys_updated_by	Name of the user that last updated the entitlement characteristics record. Data type: String
service_contract_lines.child_contract_lines.entitlement_characteristics.sys_updated_on	Date and time that the entitlement characteristics record was last updated. Data type: String
service_contract_lines.child_contract_lines.entitlement_characteristics.type	Type of entitlement characteristic. Valid values: coverage coverage_and_usage Data type: String
service_contract_lines.child_contract_lines.entitlement_characteristics.value	Value of the characteristic. Data type: String
service_contract_lines.child_contract_lines.install_base_items_covered	List of install base items covered under the  child service contract line. Data type: Array of Objects `"install_base_items_covered": [ { "added": "String", "contract": "String", "entitlement": "String", "install_base": "String", "removed": "String", "service_contract_line": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" } ]` Table: Sold Product Covered  [sn_install_base_m2m_contract_sold_product]
service_contract_lines.child_contract_lines.install_base_items_covered.added	Date that the associated install base item was added to the service contract line. Data type: String Format: yyyy-mm-dd
service_contract_lines.child_contract_lines.install_base_items_covered.contract	Sys_id of the service contract record associated with the install base item. Data type: String Table: Service Contract [sn_pss_core_service_contract]
service_contract_lines.child_contract_lines.install_base_items_covered.entitlement	Sys_id of the entitlement record associated with the install base item. Data type: String Table: Service Contract [sn_pss_core_service_contract]
service_contract_lines.child_contract_lines.install_base_items_covered.install_base	Sys_id of the associated install base item record. Data type: String Table: Install Base Item [sn_install_base_item]
service_contract_lines.child_contract_lines.install_base_items_covered.removed	Date that the associated service contract line ends coverage of the install base item. Data type: String Format: yyyy-mm-dd
service_contract_lines.child_contract_lines.install_base_items_covered.service_contract_line	Sys_id of the associated service contract line record. Data type: String Table: Service Contract Line [sn_pss_core_service_contract_line]
service_contract_lines.child_contract_lines.install_base_items_covered.sys_created_by	Name of the user that created the install base item record. Data type: String
service_contract_lines.child_contract_lines.install_base_items_covered.sys_created_on	Date and time that the install base item record was created. Data type: String
service_contract_lines.child_contract_lines.install_base_items_covered.sys_id	Sys_id of the install base item covered. Data type: String Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
service_contract_lines.child_contract_lines.install_base_items_covered.sys_updated_by	Name of the user that last updated the install base item record. Data type: String
service_contract_lines.child_contract_lines.install_base_items_covered.sys_updated_on	Date and time that the install base item record was last updated. Data type: String
service_contract_lines.child_contract_lines.name	Name of the child service contract line. Data type: String
service_contract_lines.child_contract_lines.parent_contract_line	Sys_id of the parent contract line record associated with the child service contract line. Data type: String
service_contract_lines.child_contract_lines.product_model	Sys_id of the product associated with the child service contract line. Data type: String Table: Product Model [cmdb_model]
service_contract_lines.child_contract_lines.product_offering	Sys_id of the product offering record associated with the child service contract line. Data type: String Table: Product Offering [sn_prd_pm_product_offering]
service_contract_lines.child_contract_lines.sold_product	Sys_id of the sold product record associated with the child service contract line. Data type: String Table: Sold Product [sn_install_base_sold_product]
service_contract_lines.child_contract_lines.sold_products_covered	List of products covered. Data type: Array of Objects `"sold_products_covered": [ { "added": "String", "contract": "String", "entitlement": "String", "removed": "String", "service_contract_line": "String", "sold_product": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" } ]` Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
service_contract_lines.child_contract_lines.sold_products_covered.added	Date that the associated service contract starts to cover the product. Data type: String Format: yyyy-mm-dd Default: Current date
service_contract_lines.child_contract_lines.sold_products_covered.contract	Sys_id of the service contract record associated with the sold product covered. Data type: String Table: Service Contract [sn_pss_core_service_contract]
service_contract_lines.child_contract_lines.sold_products_covered.entitlement	Sys_id of the entitlement record associated with the sold product covered. Data type: String Table: Entitlement [service_entitlement]
service_contract_lines.child_contract_lines.sold_products_covered.removed	Date that the associated service contract ends coverage of the associated product. Data type: String Format: yyyy-mm-dd Default: No end date
service_contract_lines.child_contract_lines.sold_products_covered.service_contract_line	Sys_id of the service contract line record associated with the sold product covered. Data type: String Table: Service Contract Line [sn_pss_core_service_contract_line]
service_contract_lines.child_contract_lines.sold_products_covered.sold_product	Sys_id of the product covered by the service contract. Data type: String Table: Sold Product [sn_install_base_sold_product]
service_contract_lines.child_contract_lines.sold_products_covered.sys_created_by	Name of the user that created the sold product covered record. Data type: String
service_contract_lines.child_contract_lines.sold_products_covered.sys_created_on	Date and time that the sold product covered record was created. Data type: String
service_contract_lines.child_contract_lines.sold_products_covered.sys_id	Sys_id of the product covered by this service contract. Data type: String Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
service_contract_lines.child_contract_lines.sold_products_covered.sys_updated_by	Name of the user that last updated the sold product covered record. Data type: String
service_contract_lines.child_contract_lines.sold_products_covered.sys_updated_on	Name of the user that last updated the sold product covered record. Data type: String
service_contract_lines.child_contract_lines.starts	Start date of the child service contract line. Data type: String Format: yyyy-mm-dd
service_contract_lines.child_contract_lines.sys_created_by	Name of the user that created the child service contract line record. Data type: String
service_contract_lines.child_contract_lines.sys_created_on	Date and time that the child service contract line record was created. Data type: String
service_contract_lines.child_contract_lines.sys_id	Sys_id of a child service contract line record. Data type: String Table: Service Contract Line [sn_pss_core_service_contract_line]
service_contract_lines.child_contract_lines.sys_updated_by	Name of the user that last updated the child service contract line record. Data type: String
service_contract_lines.child_contract_lines.sys_updated_on	Date and time that the child service contract line record was last updated. Data type: String
service_contract_lines.contract	Sys_id of the service contract associated with the service contract line. Data type: String Table: Service Contract [sn_pss_core_service_contract]
service_contract_lines.ends	Date on which the service contract line ends. Data type: String Format: yyyy-mm-dd Default: Never ends until manually removed.
service_contract_lines.entitlements	List of entitlements associated with the service contract. Data type: Array of Objects "entitlements": [ { "account": "String", "consumer": "String", "contract": "String", "end_date": "String", "entitlement_characteristics": [Array], "entitlement_name": "String", "household": "String", "install_base_items_covered": [Array], "product": "String", "product_offering": "String", "product_specification": "String", "service_contract_line": "String", "sold_entitlement": "String", "sold_products_covered": [Array], "start_date": "String", "state": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" } ] Table: Entitlement [service_entitlement]
service_contract_lines.entitlements.account	Sys_id of the account record to which the entitlement belongs. Data type: String Table: Account [customer_account]
service_contract_lines.entitlements.consumer	Sys_id of the consumer record to which the entitlement belongs. Data type: String Table: Consumer [csm_consumer]
service_contract_lines.entitlements.contract	Sys_id of the contract record to which the entitlement belongs. Data type: String Table: Service Contract [sn_pss_core_service_contract]
service_contract_lines.entitlements.end_date	End date of the entitlement. Data type: String Format: yyyy-mm-dd Default: Never ends until manually removed.
service_contract_lines.entitlements.entitlement_characteristics	List of characteristics associated with the entitlement. Data type: Array of Objects `"entitlement_characteristics": [ { "characteristic": "String", "characteristic_option": "String", "entitlement": "String", "entitlement_usage": [Array] "service_contract_line": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String", "type": "String", "value": "String" } ]` Table: Characteristic [sn_pss_core_entitlement_characteristic]
service_contract_lines.entitlements.entitlement_characteristics.characteristic	Sys_id of the characteristic record associated with the entitlement. Data type: String Table: Characteristic [sn_prd_pm_characteristic]
service_contract_lines.entitlements.entitlement_characteristics.characteristic_option	Sys_id of the characteristic option record associated with the entitlement. Data type: String Table: Characteristic Option [sn_prd_pm_characteristic_option]
service_contract_lines.entitlements.entitlement_characteristics.entitlement	Sys_id of the associated entitlement record. Data type: String Table: Entitlement [service_entitlement]
service_contract_lines.entitlements.entitlement_characteristics.entitlement_usage	List of usage values for the associated product. Data type: Array of Objects `"entitlement_usage": [ { "entitlement": "String", "entitlement_characteristic": "String", "period_end": "String", "period_start": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_update_on": "String", "total_units": "String", "used_units": "String" } ]`
service_contract_lines.entitlements.entitlement_characteristics.entitlement_usage.entitlement	Sys_id of the entitlement record associated with the entitlement usage. Data type: String Table: Entitlement [service_entitlement]
service_contract_lines.entitlements.entitlement_characteristics.entitlement_usage.entitlement_characteristic	Sys_id of the entitlement characteristic record associated with the entitlement usage. Data type: String Table: Characteristic [sn_pss_core_entitlement_characteristic]
service_contract_lines.entitlements.entitlement_characteristics.entitlement_usage.period_end	End date when the entitlement usage is no longer tracked. Data type: String Format: yyyy-mm-dd
service_contract_lines.entitlements.entitlement_characteristics.entitlement_usage.period_start	Starting date of when the entitlement usage is tracked. Data type: String Format: yyyy-mm-dd
service_contract_lines.entitlements.entitlement_characteristics.entitlement_usage.sys_created_by	Name of the user that created the entitlement usage record. Data type: String
service_contract_lines.entitlements.entitlement_characteristics.entitlement_usage.sys_created_on	Date and time that the entitlement usage record was created. Data type: String
service_contract_lines.entitlements.entitlement_characteristics.entitlement_usage.sys_id	Sys_id of the entitlement usage record. Data type: String Table: Entitlement Usage [sn_pss_core_entitlement_usage]
service_contract_lines.entitlements.entitlement_characteristics.entitlement_usage.sys_updated_by	Name of the user that last updated the entitlement usage record. Data type: String
service_contract_lines.entitlements.entitlement_characteristics.entitlement_usage.sys_updated_on	Date and time that the entitlement usage record was last updated. Data type: String
service_contract_lines.entitlements.entitlement_characteristics.entitlement_usage.total_units	Total coverage value of the associated entitlement characteristic. Data type: String
service_contract_lines.entitlements.entitlement_characteristics.entitlement_usage.used_units	Number of units used by the account or consumer between the period_start and the period_end. Data type: String
service_contract_lines.entitlements.entitlement_characteristics.service_contract_line	Sys_id of the service contract line record associated with the entitlement characteristic. Data type: String Table: Service Contract Line [sn_pss_core_service_contract_line]
service_contract_lines.entitlements.entitlement_characteristics.sys_created_by	Name of the user that created the entitlement characteristics record. Data type: String
service_contract_lines.entitlements.entitlement_characteristics.sys_created_on	Date and time that the entitlement characteristics record was created. Data type: String
service_contract_lines.entitlements.entitlement_characteristics.sys_id	Sys_id of the entitlement characteristics record. Data type: String
service_contract_lines.entitlements.entitlement_characteristics.sys_updated_by	Name of the user that last updated the entitlement characteristics record. Data type: String
service_contract_lines.entitlements.entitlement_characteristics.sys_updated_on	Date and time that the entitlement characteristics record was last updated. Data type: String
service_contract_lines.entitlements.entitlement_characteristics.type	Type of entitlement characteristic. Valid values: coverage coverage_and_usage Data type: String
service_contract_lines.entitlements.entitlement_characteristics.value	Value of the characteristic. Data type: String
service_contract_lines.entitlements.entitlement_name	Name of the entitlement. Data type: String
service_contract_lines.entitlements.household	Sys_id of the household record associated with the entitlement. Data type: String Table: Household [csm_household]
service_contract_lines.entitlements.install_base_items_covered	List of install base items covered under the service contract line. Data type: Array of Objects `"install_base_items_covered": [ { "added": "String", "contract": "String", "entitlement": "String", "install_base": "String", "removed": "String", "service_contract_line": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" } ]`
service_contract_lines.entitlements.install_base_items_covered.added	Date that the associated install base item was added to the entitlement. Data type: String
service_contract_lines.entitlements.install_base_items_covered.contract	Sys_id of the service contract record associated with the install base item. Data type: String Table: Service Contract [sn_pss_core_service_contract]
service_contract_lines.entitlements.install_base_items_covered.entitlement	Sys_id of the entitlement record associated with the install base item. Data type: String Table: Entitlement [service_entitlement]
service_contract_lines.entitlements.install_base_items_covered.install_base	Sys_id of the associated install base item record. Data type: String Table: Install Base Item [sn_install_base_item]
service_contract_lines.entitlements.install_base_items_covered.removed	Date that the associated install base item was removed from the entitlement. Data type: String
service_contract_lines.entitlements.install_base_items_covered.service_contract_line	Sys_id of the associated service contract line record. Data type: String Table: Service Contract Line [sn_pss_core_service_contract_line]
service_contract_lines.entitlements.install_base_items_covered.sys_created_by	Name of the user that created the install base item record. Data type: String
service_contract_lines.entitlements.install_base_items_covered.sys_created_on	Date and time that the install base item record was created. Data type: String
service_contract_lines.entitlements.install_base_items_covered.sys_id	Sys_id of the install base item covered. Data type: String Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
service_contract_lines.entitlements.install_base_items_covered.sys_updated_by	Name of the user that last updated the install base item record. Data type: String
service_contract_lines.entitlements.install_base_items_covered.sys_updated_on	Date and time that the install base item record was last updated. Data type: String
service_contract_lines.entitlements.product	Sys_id of the product model record associated with the entitlement. Data type: String Table: Product Model [cmdb_model]
service_contract_lines.entitlements.product_offering	Sys_id of the product offering record associated with the entitlement. Data type: String Table: Product Offering [sn_prd_pm_product_offering]
service_contract_lines.entitlements.product_specification	Sys_id of the product specification record associated with the entitlement. Data type: String Table: Product Specification [sn_prd_pm_product_specification]
service_contract_lines.entitlements.service_contract_line	Sys_id of the service contract line record associated with the entitlement. Data type: String Table: Service Contract Line [sn_pss_core_service_contract_line]
service_contract_lines.entitlements.sold_entitlement	Sys_id of the sold product record associated with the entitlement. Data type: String Table: Sold Product [sn_install_base_sold_product]
service_contract_lines.entitlements.sold_products_covered	List of products covered. Data type: Array of Objects `"sold_products_covered": [ { "added": "String", "contract": "String", "entitlement": "String", "removed": "String", "service_contract_line": "String", "sold_product": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" } ]` Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
service_contract_lines.entitlements.sold_products_covered.added	Date that the associated sold product was added to the entitlement. Data type: String Format: yyyy-mm-dd Default: Current date
service_contract_lines.entitlements.sold_products_covered.contract	Sys_id of the service contract record associated with the sold product covered. Data type: String Table: Service Contract [sn_pss_core_service_contract]
service_contract_lines.entitlements.sold_products_covered.entitlement	Sys_id of the entitlement record associated with the sold product covered. Data type: String Table: Entitlement [service_entitlement]
service_contract_lines.entitlements.sold_products_covered.removed	Date that the associated sold product was removed from the entitlement. Data type: String Format: yyyy-mm-dd Default: No end date
service_contract_lines.entitlements.sold_products_covered.service_contract_line	Sys_id of the service contract line record associated with the sold product covered. Data type: String Table: Service Contract Line [sn_pss_core_service_contract_line]
service_contract_lines.entitlements.sold_products_covered.sold_product	Sys_id of the product covered by the entitlement. Data type: String Table: Sold Product [sn_install_base_sold_product]
service_contract_lines.entitlements.sold_products_covered.sys_created_by	Name of the user that created the sold product covered record. Data type: String
service_contract_lines.entitlements.sold_products_covered.sys_created_on	Date and time that the sold product covered record was created. Data type: String
service_contract_lines.entitlements.sold_products_covered.sys_id	Sys_id of the product covered by this service contract. Data type: String Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
service_contract_lines.entitlements.sold_products_covered.sys_updated_by	Name of the user that last updated the sold product covered record. Data type: String
service_contract_lines.entitlements.sold_products_covered.sys_updated_on	Date and time that the sold product covered record was last updated. Data type: String
service_contract_lines.entitlements.start_date	Start date of the entitlement. Data type: String Format: yyyy-mm-dd
service_contract_lines.entitlements.state	Current state of the entitlement. Valid values: (case-sensitive) active cancelled draft expired suspended Data type: String
service_contract_lines.entitlements.sys_created_by	Name of the user that created the entitlement record. Data type: String
service_contract_lines.entitlements.sys_created_on	Date and time that the entitlement record was created. Data type: String
service_contract_lines.entitlements.sys_id	Sys_id of the associated entitlement record. Data type: String Table: Entitlement [service_entitlement]
service_contract_lines.entitlements.sys_updated_by	Name of the user that last updated the entitlement record. Data type: String
service_contract_lines.entitlements.sys_updated_on	Date and time that the entitlement record was created. Data type: String
service_contract_lines.entitlement_characteristics	List of characteristics associated with the service contract line. Data type: Array of Objects `"entitlement_characteristics": [ { "characteristic": "String", "characteristic_option": "String", "entitlement": "String", "entitlement_usage": [Array], "service_contract_line": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String", "type": "String", "value": "String" } ]` Table: Characteristic [sn_pss_core_entitlement_characteristic]
service_contract_lines.entitlement_characteristics.characteristic	Sys_id of the characteristic record associated with the entitlement. Data type: String Table: Characteristic [sn_prd_pm_characteristic]
service_contract_lines.entitlement_characteristics.characteristic_option	Sys_id of the characteristic option record associated with the entitlement. Data type: String Table: Characteristic Option [sn_prd_pm_characteristic_option]
service_contract_lines.entitlement_characteristics.entitlement	Sys_id of the associated entitlement record. Data type: String Table: Entitlement [service_entitlement]
service_contract_lines.entitlement_characteristics.entitlement_usage	List of usage values for the associated product. Data type: Array of Objects `"entitlement_usage": [ { "entitlement": "String", "entitlement_characteristic": "String", "period_end": "String", "period_start": "String", "service_contract_line": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_update_on": "String", "total_units": "String", "used_units": "String" } ]`
service_contract_lines.entitlement_characteristics.entitlement_usage.entitlement	Sys_id of the entitlement record associated with the entitlement usage. Data type: String Table: Entitlement [service_entitlement]
service_contract_lines.entitlement_characteristics.entitlement_usage.entitlement_characteristic	Sys_id of the entitlement characteristic record associated with the entitlement usage. Data type: String Table: Characteristic [sn_pss_core_entitlement_characteristic]
service_contract_lines.entitlement_characteristics.entitlement_usage.period_end	End date when the entitlement usage is no longer tracked. Data type: String Format: yyyy-mm-dd
service_contract_lines.entitlement_characteristics.entitlement_usage.period_start	Starting date of when the entitlement usage is tracked. Data type: String Format: yyyy-mm-dd
service_contract_lines.entitlement_characteristics.entitlement_usage.sys_created_by	Name of the user that created the entitlement usage record. Data type: String
service_contract_lines.entitlement_characteristics.entitlement_usage.sys_created_on	Date and time that the entitlement usage record was created. Data type: String
service_contract_lines.entitlement_characteristics.entitlement_usage.sys_id	Sys_id of the entitlement usage record. Data type: String Table: Entitlement Usage [sn_pss_core_entitlement_usage]
service_contract_lines.entitlement_characteristics.entitlement_usage.sys_updated_by	Name of the user that last updated the entitlement usage record. Data type: String
service_contract_lines.entitlement_characteristics.entitlement_usage.sys_updated_on	Date and time that the entitlement usage record was last updated. Data type: String
service_contract_lines.entitlement_characteristics.entitlement_usage.total_units	Total number of units purchased. Data type: String
service_contract_lines.entitlement_characteristics.entitlement_usage.used_units	Number of units that have been used. Data type: String
service_contract_lines.entitlement_characteristics.service_contract_line	Sys_id of the service contract line record associated with the entitlement characteristic. Data type: String Table: Service Contract Line [sn_pss_core_service_contract_line]
service_contract_lines.entitlement_characteristics.sys_created_by	Name of the user that created the entitlement characteristics record. Data type: String
service_contract_lines.entitlement_characteristics.sys_created_on	Date and time that the entitlement characteristics record was created. Data type: String
service_contract_lines.entitlement_characteristics.sys_id	Sys_id of the entitlement characteristics record. Data type: String
service_contract_lines.entitlement_characteristics.sys_updated_by	Name of the user that last updated the entitlement characteristics record. Data type: String
service_contract_lines.entitlement_characteristics.sys_updated_on	Date and time that the entitlement characteristics record was last updated. Data type: String
service_contract_lines.entitlement_characteristics.type	Type of entitlement characteristic. Valid values: coverage coverage_and_usage Data type: String
service_contract_lines.entitlement_characteristics.value	Value of the characteristic. Data type: String
service_contract_lines.install_base_items_covered	List of install base items covered under the  service contract line. Data type: Array of Objects `"install_base_items_covered": [ { "added": "String", "contract": "String", "entitlement": "String", "install_base": "String", "removed": "String", "service_contract_line": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" } ]` Table: Sold Product Covered  [sn_install_base_m2m_contract_sold_product]
service_contract_lines.install_base_items_covered.added	Date that the associated install base item was added to the service contract line. Data type: String
service_contract_lines.install_base_items_covered.contract	Sys_id of the service contract record associated with the install base item. Data type: String Table: Service Contract [sn_pss_core_service_contract]
service_contract_lines.install_base_items_covered.entitlement	Sys_id of the entitlement record associated with the install base item. Data type: String Table: Entitlement [service_entitlement]
service_contract_lines.install_base_items_covered.install_base	Sys_id of the install base item covered by the service contract line. Data type: String Table: Install Base Item [sn_install_base_item]
service_contract_lines.install_base_items_covered.removed	Date that the associated service contract line ends coverage of the install base item. Data type: String
service_contract_lines.install_base_items_covered.service_contract_line	Sys_id of the associated service contract line record. Data type: String Table: Service Contract Line [sn_pss_core_service_contract_line]
service_contract_lines.install_base_items_covered.sys_created_by	Name of the user that created the install base item record. Data type: String
service_contract_lines.install_base_items_covered.sys_created_on	Date and time that the install base item record was created. Data type: String
service_contract_lines.install_base_items_covered.sys_id	Sys_id of the install base item covered. Data type: String Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
service_contract_lines.install_base_items_covered.sys_updated_by	Name of the user that last updated the install base item record. Data type: String
service_contract_lines.install_base_items_covered.sys_updated_on	Date and time that the install base item record was last updated. Data type: String
service_contract_lines.name	Name of the service contract line. Data type: String
service_contract_lines.number	Unique number of the service contract line. Automatically generated by the endpoint. For example: CTRL9812347. Data type: String
service_contract_lines.parent_contract_line	Sys_id of the service contract line to which the current service contract line is a child of. Null for the contract lines created under a contract. Data type: String Table: Service Contract Line [sn_pss_core_service_contract_line]
service_contract_lines.product_model	Sys_id of the product associated with the service contract line. Data type: String Table: Product Model [cmdb_model]
service_contract_lines.product_offering	Sys_id of the product offering record associated with the service contract line. Data type: String Table: Product Offering [sn_prd_pm_product_offering]
service_contract_lines.product_specification	Sys_id of the product specification record associated with the service contract line. Data type: String Table: Product Specification [sn_prd_pm_product_specification]
service_contract_lines.sold_product	Sys_id of the sold product record associated with the service contract line. Data type: String Table: Sold Product [sn_install_base_sold_product]
service_contract_lines.sold_products_covered	List of products covered. Data type: Array of Objects `"sold_products_covered": [ { "added": "String", "contract": "String", "entitlement": "String", "removed": "String", "service_contract_line": "String", "sold_product": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" } ]` Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
service_contract_lines.sold_products_covered.added	Date that the associated sold product was added to the service contract line. Data type: String Format: yyyy-mm-dd
service_contract_lines.sold_products_covered.contract	Sys_id of the service contract record associated with the sold product covered. Data type: String Table: Service Contract [sn_pss_core_service_contract]
service_contract_lines.sold_products_covered.entitlement	Sys_id of the entitlement record associated with the sold product covered. Data type: String Table: Entitlement [service_entitlement]
service_contract_lines.sold_products_covered.removed	Date that the associated sold product was removed from the service contract line. Data type: String Format: yyyy-mm-dd
service_contract_lines.sold_products_covered.service_contract_line	Sys_id of the service contract line record associated with the sold product covered. Data type: String Table: Service Contract Line [sn_pss_core_service_contract_line]
service_contract_lines.sold_products_covered.sold_product	Sys_id of the product covered by the entitlement. Data type: String Table: Sold Product [sn_install_base_sold_product]
service_contract_lines.sold_products_covered.sys_created_by	Name of the user that created the sold product covered record. Data type: String
service_contract_lines.sold_products_covered.sys_created_on	Date and time that the sold product covered record was created. Data type: String
service_contract_lines.sold_products_covered.sys_id	Sys_id of the product covered by this service contract. Data type: String Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
service_contract_lines.sold_products_covered.sys_updated_by	Name of the user that last updated the sold product covered record. Data type: String
service_contract_lines.sold_products_covered.sys_updated_on	Date and time that the sold product covered record was last updated. Data type: String
service_contract_lines.starts	Start date of the service contract line. Data type: String Format: yyyy-mm-dd
service_contract_lines.state	Current state of the contract line. Valid values: (case-sensitive) active cancelled draft expired suspended Data type: String
service_contract_lines.sys_created_by	Name of the user that created the service contract line record. Data type: String
service_contract_lines.sys_created_on	Date and time that the service contract line record was created. Data type: String
service_contract_lines.sys_id	Sys_id of a service contract line record. Data type: String Table: Service Contract Line [sn_pss_core_service_contract_line]
service_contract_lines.sys_updated_by	Name of the user that last updated the service contract line record. Data type: String
service_contract_lines.sys_updated_on	Date and time that the service contract line record was last updated. Data type: String
short_description	Brief description or name of the service contract. Data type: String
sold_products_covered	List of products covered. Data type: Array of Objects `"sold_products_covered": [ { "added": "String", "contract": "String", "entitlement": "String", "removed": "String", "service_contract_line": "String", "sold_product": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" } ]` Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
sold_products_covered.added	Date that the associated sold product was added to the contract. Data type: String
sold_products_covered.contract	Sys_id of the service contract record associated with the sold product covered. Data type: String Table: Service Contract [sn_pss_core_service_contract]
sold_products_covered.entitlement	Sys_id of the entitlement record associated with the sold product covered. Data type: String Table: Entitlement [service_entitlement]
sold_products_covered.removed	Date that the associated sold product was removed from the contract. Data type: String
sold_products_covered.service_line_contract	Sys_id of the service contract line record associated with the sold product covered. Data type: String Table: Service Contract Line [sn_pss_core_service_contract_line]
sold_products_covered.sold_product	Sys_id of the product covered by the service contract. Data type: String Table: Sold Product [sn_install_base_sold_product]
sold_products_covered.sys_created_by	Name of the user that created the sold product covered record. Data type: String
sold_products_covered.sys_created_on	Date and time that the sold product covered record was created. Data type: String
sold_products_covered.sys_id	Sys_id of the product covered by this service contract. Data type: String Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
sold_products_covered.sys_updated_by	Name of the user that last updated the sold product covered record. Data type: String
sold_products_covered.sys_updated_on	Date and time that the sold product covered record was last updated. Data type: String
starts	Date on which the service contract begins. Data type: String Format: yyyy-mm-dd Default: Starts as soon as approved.
state	Current state of the service contract. Valid values: (case-sensitive) active cancelled draft expired Data type: String
sys_created_by	Name of the user that created the service contract record. Data type: String
sys_created_on	Date and time that the service contract was created record. Data type: String
sys_id	Sys_id of the service contract record. Data type: String Table: Service Contract [sn_pss_core_service_contract]
sys_updated_by	Name of the user that last updated the service contract record. Data type: String
sys_updated_on	Date and time that the service contract record was last updated. Data type: String
vendor_contract	Unique identifier for an associated external contract. Data type: String

cURL request

The following code example shows how to call this endpoint.

curl "https://instance.servicenow.com/api/sn_pss_core/servicecontract/fc73d2de89226110f877430a4e008add" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

Response:

{
  "result": {
    "sys_id": "d8641151d1f53110f8776589fa411fde",
    "sys_created_by": "admin",
    "sys_updated_by": "admin",
    "sys_created_on": "2023-10-09 11:27:29",
    "sys_updated_on": "2023-10-09 11:27:29",
    "account": "4c325111d1f53110f8776589fa411f3d",
    "consumer": null,
    "household": null,
    "number": "CNTR0010004",
    "state": "active",
    "starts": "2022-12-03",
    "ends": "",
    "short_description": null,
    "vendor_contract": "External Reference",
    "service_contract_lines": [
      {
        "sys_id": "d4641d91d1f53110f8776589fa411fbb",
        "sys_created_by": "admin",
        "sys_updated_by": "admin",
        "sys_created_on": "2023-10-09 11:27:29",
        "sys_updated_on": "2023-10-09 11:27:29",
        "name": "CLI",
        "number": "CNTRL0000001",
        "contract": "d8641151d1f53110f8776589fa411fde",
        "parent_contract_line": null,
        "sold_product": null,
        "starts": "2022-12-03",
        "ends": "",
        "product_offering": null,
        "product_specification": null,
        "product_model": null,
        "child_contract_lines": [
          {
            "sys_id": "3a39ecdc01154f4ab782da0169c9c922",
            "sys_created_by": "admin",
            "sys_updated_by": "admin",
            "sys_created_on": "2023-10-09 11:27:29",
            "sys_updated_on": "2023-10-09 11:27:29",
            "name": "Child CLI",
            "number": "CNTRL0000002",
            "contract": "d8641151d1f53110f8776589fa411fde",
            "parent_contract_line": "d4641d91d1f53110f8776589fa411fbb",
            "sold_product": null,
            "starts": "2022-12-03",
            "ends": "",
            "product_offering": null,
            "product_specification": null,
            "product_model": null,
            "child_contract_lines": [],
            "entitlements": [
              {
                "sys_id": "7439fd84c2494ba6951e58f333cfe8d4",
                "sys_created_by": "admin",
                "sys_updated_by": "admin",
                "sys_created_on": "2023-10-09 11:27:29",
                "sys_updated_on": "2023-10-09 11:27:29",
                "entitlement_name": "Child CLI - ENTL",
                "account": "4c325111d1f53110f8776589fa411f3d",
                "consumer": null,
                "household": null,
                "contract": "d8641151d1f53110f8776589fa411fde",
                "service_contract_line": "3a39ecdc01154f4ab782da0169c9c922",
                "state": "active",
                "product_offering": null,
                "product_specification": null,
                "sold_entitlement": null,
                "product": null,
                "start_date": "2022-12-03",
                "end_date": "",
                "entitlement_characteristics": [],
                "sold_products_covered": [],
                "install_base_items_covered": []
              }
            ],
            "sold_products_covered": [
              {
                "sys_id": "dfb62e9c4c6843009be02a68f65b9118",
                "sys_created_by": "admin",
                "sys_updated_by": "admin",
                "sys_created_on": "2023-10-09 11:27:29",
                "sys_updated_on": "2023-10-09 11:27:29",
                "contract": "d8641151d1f53110f8776589fa411fde",
                "service_contract_line": "d4641d91d1f53110f8776589fa411fbb",
                "entitlement": null,
                "sold_product": "ec235d9dd1b53110f8776589fa411fe2",
                "added": "2023-12-03",
                "removed": "2023-12-03"
              }
            ],
            "install_base_items_covered": [
              {
                "sys_id": "2583912e81964501b52a2e44d4797a28",
                "sys_created_by": "admin",
                "sys_updated_by": "admin",
                "sys_created_on": "2023-10-09 11:27:29",
                "sys_updated_on": "2023-10-09 11:27:29",
                "contract": "d8641151d1f53110f8776589fa411fde",
                "service_contract_line": "d4641d91d1f53110f8776589fa411fbb",
                "entitlement": null,
                "install_base": "a1731551d1f53110f8776589fa411f8d",
                "added": "2023-12-03",
                "removed": "2023-12-03"
              }
            ],
            "entitlement_characteristics": [
              {
                "sys_id": "3a00c975bb49412cae169200c7f6236e",
                "sys_created_by": "admin",
                "sys_updated_by": "admin",
                "sys_created_on": "2023-10-09 11:27:29",
                "sys_updated_on": "2023-10-09 11:27:29",
                "service_contract_line": "d4641d91d1f53110f8776589fa411fbb",
                "entitlement": null,
                "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
                "value": "5",
                "characteristic": "63418db7539e61106bfcddeeff7b1238",
                "type": "coverage"
              }
            ]
          }
        ],
        "entitlements": [
          {
            "sys_id": "a8641d91d1f53110f8776589fa411fc0",
            "sys_created_by": "admin",
            "sys_updated_by": "admin",
            "sys_created_on": "2023-10-09 11:27:29",
            "sys_updated_on": "2023-10-09 11:27:29",
            "entitlement_name": "ENTL",
            "account": "4c325111d1f53110f8776589fa411f3d",
            "consumer": null,
            "household": null,
            "contract": "d8641151d1f53110f8776589fa411fde",
            "service_contract_line": "d4641d91d1f53110f8776589fa411fbb",
            "state": "active",
            "product_offering": null,
            "product_specification": null,
            "sold_entitlement": null,
            "product": null,
            "start_date": "2022-12-03",
            "end_date": "",
            "sold_products_covered": [
              {
                "sys_id": "a0641d91d1f53110f8776589fa411fc2",
                "sys_created_by": "admin",
                "sys_updated_by": "admin",
                "sys_created_on": "2023-10-09 11:27:29",
                "sys_updated_on": "2023-10-09 11:27:29",
                "contract": "d8641151d1f53110f8776589fa411fde",
                "service_contract_line": "d4641d91d1f53110f8776589fa411fbb",
                "entitlement": "a8641d91d1f53110f8776589fa411fc0",
                "sold_product": "da23d151d1f53110f8776589fa411f27",
                "added": "",
                "removed": ""
              }
            ],
            "install_base_items_covered": [
              {
                "sys_id": "e0641d91d1f53110f8776589fa411fc3",
                "sys_created_by": "admin",
                "sys_updated_by": "admin",
                "sys_created_on": "2023-10-09 11:27:29",
                "sys_updated_on": "2023-10-09 11:27:29",
                "contract": "d8641151d1f53110f8776589fa411fde",
                "service_contract_line": "d4641d91d1f53110f8776589fa411fbb",
                "entitlement": "a8641d91d1f53110f8776589fa411fc0",
                "install_base": "43739151d1f53110f8776589fa411fc1",
                "added": "2023-12-03",
                "removed": "2023-12-03"
              }
            ],
            "entitlement_characteristics": [
              {
                "sys_id": "a8641d91d1f53110f8776589fa411fd0",
                "sys_created_by": "admin",
                "sys_updated_by": "admin",
                "sys_created_on": "2023-10-09 11:27:29",
                "sys_updated_on": "2023-10-09 11:27:29",
                "service_contract_line": null,
                "entitlement": "a8641d91d1f53110f8776589fa411fc0",
                "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
                "value": "5",
                "characteristic": "63418db7539e61106bfcddeeff7b1238",
                "type": "coverage_and_usage",
                "entitlement_usage": [
                  {
                    "sys_id": "a8641d91d1f53110f8776589fa411fd1",
                    "sys_created_by": "admin",
                    "sys_updated_by": "admin",
                    "sys_created_on": "2023-10-09 11:27:29",
                    "sys_updated_on": "2023-10-09 11:27:29",
                    "entitlement": "a8641d91d1f53110f8776589fa411fc0",
                    "service_contract_line": null,
                    "entitlement_characteristic": "a8641d91d1f53110f8776589fa411fd0",
                    "period_start": "2022-12-03",
                    "period_end": "",
                    "total_units": "5",
                    "used_units": "3"
                  }
                ]
              }
            ]
          }
        ],
        "sold_products_covered": [
          {
            "sys_id": "98641d91d1f53110f8776589fa411fbc",
            "sys_created_by": "admin",
            "sys_updated_by": "admin",
            "sys_created_on": "2023-10-09 11:27:29",
            "sys_updated_on": "2023-10-09 11:27:29",
            "contract": "d8641151d1f53110f8776589fa411fde",
            "service_contract_line": "d4641d91d1f53110f8776589fa411fbb",
            "entitlement": null,
            "sold_product": "ec235d9dd1b53110f8776589fa411fe2",
            "added": "2023-12-03",
            "removed": "2023-12-03"
          }
        ],
        "install_base_items_covered": [
          {
            "sys_id": "58641d91d1f53110f8776589fa411fbd",
            "sys_created_by": "admin",
            "sys_updated_by": "admin",
            "sys_created_on": "2023-10-09 11:27:29",
            "sys_updated_on": "2023-10-09 11:27:29",
            "contract": "d8641151d1f53110f8776589fa411fde",
            "service_contract_line": "d4641d91d1f53110f8776589fa411fbb",
            "entitlement": null,
            "install_base": "a1731551d1f53110f8776589fa411f8d",
            "added": "2023-12-03",
            "removed": "2023-12-03"
          }
        ],
        "entitlement_characteristics": [
          {
            "sys_id": "e0641d91d1f53110f8776589fa411fbf",
            "sys_created_by": "admin",
            "sys_updated_by": "admin",
            "sys_created_on": "2023-10-09 11:27:29",
            "sys_updated_on": "2023-10-09 11:27:29",
            "service_contract_line": "d4641d91d1f53110f8776589fa411fbb",
            "entitlement": null,
            "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
            "value": "5",
            "characteristic": "63418db7539e61106bfcddeeff7b1238",
            "type": "coverage"
          }
        ]
      },
      {
        "sys_id": "e4641d91d1f53110f8776589fa411fd2",
        "sys_created_by": "admin",
        "sys_updated_by": "admin",
        "sys_created_on": "2023-10-09 11:27:29",
        "sys_updated_on": "2023-10-09 11:27:29",
        "name": "CLI 2",
        "number": "CNTRL0000003”,
        "contract": "d8641151d1f53110f8776589fa411fde",
        "parent_contract_line": null,
        "sold_product": null,
        "starts": "2022-12-03",
        "ends": "",
        "product_offering": null,
        "product_specification": null,
        "product_model": null,
        "child_contract_lines": [],
        "entitlements": [],
        "sold_products_covered": [
          {
            "sys_id": "e8641d91d1f53110f8776589fa411fd3",
            "sys_created_by": "admin",
            "sys_updated_by": "admin",
            "sys_created_on": "2023-10-09 11:27:29",
            "sys_updated_on": "2023-10-09 11:27:29",
            "contract": "d8641151d1f53110f8776589fa411fde",
            "service_contract_line": "e4641d91d1f53110f8776589fa411fd2",
            "entitlement": null,
            "sold_product": "7f23995dd1b53110f8776589fa411f66",
            "added": "2023-12-03",
            "removed": "2023-12-03"
          }
        ],
        "install_base_items_covered": [
          {
            "sys_id": "a8641d91d1f53110f8776589fa411fd4",
            "sys_created_by": "admin",
            "sys_updated_by": "admin",
            "sys_created_on": "2023-10-09 11:27:29",
            "sys_updated_on": "2023-10-09 11:27:29",
            "contract": "d8641151d1f53110f8776589fa411fde",
            "service_contract_line": "e4641d91d1f53110f8776589fa411fd2",
            "entitlement": null,
            "install_base": "a483d951d1f53110f8776589fa411fad",
            "added": "2023-12-03",
            "removed": "2023-12-03"
          }
        ],
        "entitlement_characteristics": [
          {
            "sys_id": "a8641d91d1f53110f8776589fa411fd5",
            "sys_created_by": "admin",
            "sys_updated_by": "admin",
            "sys_created_on": "2023-10-09 11:27:29",
            "sys_updated_on": "2023-10-09 11:27:29",
            "service_contract_line": "e4641d91d1f53110f8776589fa411fd2",
            "entitlement": null,
            "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
            "value": "5",
            "characteristic": "63418db7539e61106bfcddeeff7b1238",
            "type": "coverage"
          }
        ]
      }
    ],
    "sold_products_covered": [
      {
        "sys_id": "9c641d91d1f53110f8776589fa411fb9",
        "sys_created_by": "admin",
        "sys_updated_by": "admin",
        "sys_created_on": "2023-10-09 11:27:29",
        "sys_updated_on": "2023-10-09 11:27:29",
        "contract": "d8641151d1f53110f8776589fa411fde",
        "service_contract_line": null,
        "entitlement": null,
        "sold_product": "0df21151d1f53110f8776589fa411f1b",
        "added": "2023-12-03",
        "removed": "2023-12-03"
      }
    ],
    "install_base_items_covered": [
      {
        "sys_id": "d8641d91d1f53110f8776589fa411fba",
        "sys_created_by": "admin",
        "sys_updated_by": "admin",
        "sys_created_on": "2023-10-09 11:27:29",
        "sys_updated_on": "2023-10-09 11:27:29",
        "contract": "d8641151d1f53110f8776589fa411fde",
        "service_contract_line": null,
        "entitlement": null,
        "install_base": "e2639951d1f53110f8776589fa411f2b",
        "added": "2023-12-03",
        "removed": "2023-12-03"
      }
    ]
  }
}

Service Contract - GET /sn_pss_core/servicecontract/contractline/{id}

Retrieves the details of a specified service contract line record and its related entities.

This endpoint retrieves data in the following tables when processing the request:

Characteristic [sn_pss_core_entitlement_characteristic]
Entitlement [service_entitlement]
Entitlement Usage [sn_pss_core_entitlement_usage]
Sold Product Covered [sn_install_base_m2m_contract_sold_product] - This table contains information for both sold products covered and install base items covered.
Service Contract Line [sn_pss_core_service_contract_line]

URL format

Versioned URL: /api/sn_pss_core/{api_version}/servicecontract/contractline/{id}

Default URL: /api/sn_pss_core/servicecontract/contractline/{id}

Note:

Available versions are specified in the REST API Explorer. For scripted REST APIs there is additional version information on the Scripted REST Service form.

Supported request parameters

Table 7. Path parameters
Name	Description
api_version	Optional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String
id	Sys_id of the service contract line record to retrieve. Data type: String Table: Service Contract Line [sn_pss_core_service_contract_line]

Table 8. Query parameters
Name	Description
display_value	Type of data to return. Valid values: false: Return the `value` for all fields. For example, `"state":"draft"`. true: Return the `display_value` for all fields. For example, `"state":"Draft"` all: Return all information for all fields. Data type: String Default: false

Table 9. Request body parameters (XML or JSON)
Name	Description
None

Headers

Table 10. Request headers
Header	Description
Accept	Data format of the response body. Supported types: application/json or application/xml. Default: application/json

Table 11. Response headers
Header	Description
None

Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.

Table 12. Status codes
Status code	Description
200	Successful. The request was successfully processed.
400	Bad Request. A bad request type or malformed request was detected.
403	Forbidden. The user doesn't have permission to access the API.
404	Not found. The requested item wasn't found.
500	Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.

Response body parameters (JSON or XML)


Name	Description
child_contract_lines	List of child service contract lines associated with the service contract line. Data type: Array of Objects "child_contract_lines": [ { "child_contract_lines": [Array], "contract": "String", "ends": "String", "entitlements": [Array], "entitlement_characteristics": [Array], "install_base_items_covered": [Array], "name": "String", "number": "String", "parent_contract_line": "String", "product_model": "String", "product_offering": "String", "product_specification": "String", "sold_product": "String", "sold_products_covered": [Array], "starts": "String", "state": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_update_on": "String" } ]
child_contract_lines.child_contract_lines	List of child service contract line objects created under the child service contract line. The objects in this array have the same elements as the objects in the child_contract_lines parameter. Data type: Array of Objects
child_contract_lines.contract	Sys_id of the service contract associated with the child service contract line. Data type: String Table: Service Contract [sn_pss_core_service_contract]
child_contract_lines.ends	Date on which the child service contract line ends. Data type: String Format: yyyy-mm-dd Default: Never ends until manually removed.
child_contract_lines.entitlements	List of entitlements associated with the child service contract line. Data type: Array of Objects "entitlements": [ { "account": "String", "consumer": "String", "contract": "String", "end_date": "String", "entitlement_characteristics": [Array], "entitlement_name": "String", "household": "String", "install_base_items_covered": [Array], "product": "String", "product_offering": "String", "product_specification": "String", "service_contract_line": "String", "sold_entitlement": "String", "sold_products_covered": [Array], "start_date": "String", "state": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" } ]
child_contract_lines.entitlements.account	Sys_id of the account record to which the entitlement belongs. Data type: String Table: Account [customer_account]
child_contract_lines.entitlements.consumer	Sys_id of the consumer record to which the entitlement belongs. Data type: String Table: Consumer [csm_consumer]
child_contract_lines.entitlements.contract	Sys_id of the contract record to which the entitlement belongs. Data type: String Table: Service Contract [sn_pss_core_service_contract]
child_contract_lines.entitlements.end_date	End date of the entitlement. Data type: String Format: yyyy-mm-dd Default: Never ends until manually removed.
child_contract_lines.entitlements.entitlement_characteristics	List of characteristics associated with the entitlement. Data type: Array of Objects `"entitlement_characteristics": [ { "characteristic": "String", "characteristic_option": "String", "entitlement": "String", "entitlement_usage": [Array], "service_contract_line": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" "type": "String", "value": "String" } ]`
child_contract_lines.entitlements.entitlement_characteristics.characteristic	Sys_id of the characteristic record associated with the entitlement. Data type: String Table: Characteristic [sn_prd_pm_characteristic]
child_contract_lines.entitlements.entitlement_characteristics.characteristic_option	Sys_id of the characteristic option record associated with the entitlement. Data type: String Table: Characteristic Option [sn_prd_pm_characteristic_option]
child_contract_lines.entitlements.entitlement_characteristics.entitlement	Sys_id of the entitlement record. Data type: String Table: Entitlement [service_entitlement]
child_contract_lines.entitlements.entitlement_characteristics.entitlement_usage	List of entitlement usages associated with the entitlement characteristic. Data type: Array of Objects `"entitlement_usage": [ { "entitlement": "String", "entitlement_characteristic": "String", "period_end": "String", "period_start": "String", "service_contract_line": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String", "total_units": "String", "used_units": "String" } ]`
child_contract_lines.entitlements.entitlement_characteristics.entitlement_usage.entitlement	Sys_id of the entitlement record associated with the entitlement usage. Data type: String Table: Entitlement [service_entitlement]
child_contract_lines.entitlements.entitlement_characteristics.entitlement_usage.entitlement_characteristic	Sys_id of the entitlement characteristic record associated with the entitlement usage. Data type: String Table: Characteristic [sn_pss_core_entitlement_characteristic]
cchild_contract_lines.entitlements.entitlement_characteristics.entitlement_usage.period_end	End date when the entitlement usage is no longer tracked. Data type: String Format: yyyy-mm-dd
child_contract_lines.entitlements.entitlement_characteristics.entitlement_usage.period_start	Starting date of when the entitlement usage is tracked. Data type: String Format: yyyy-mm-dd
child_contract_lines.entitlements.entitlement_characteristics.entitlement_usage.service_contract_line	Sys_id of the service contract line to which the current entitlement usage belongs. Data type: String Table: Service Contract Line [sn_pss_core_service_contract_line]
child_contract_lines.entitlements.entitlement_characteristics.entitlement_usage.sys_created_by	Name of the user that created the entitlement usage record. Data type: String
child_contract_lines.entitlements.entitlement_characteristics.entitlement_usage.sys_created_on	Date and time that the entitlement usage record was created. Data type: String
child_contract_lines.entitlements.entitlement_characteristics.entitlement_usage.sys_id	Sys_id of the entitlement usage record. Data type: String Table: Entitlement Usage [sn_pss_core_entitlement_usage]
child_contract_lines.entitlements.entitlement_characteristics.entitlement_usage.sys_updated_by	Name of the user that last updated the entitlement usage record. Data type: String
child_contract_lines.entitlements.entitlement_characteristics.entitlement_usage.sys_updated_on	Date and time that the entitlement usage record was last updated. Data type: String
child_contract_lines.entitlements.entitlement_characteristics.entitlement_usage.total_units	Total coverage value of the associated entitlement characteristic. Data type: String
child_contract_lines.entitlements.entitlement_characteristics.entitlement_usage.used_units	Number of units used by the account or consumer between the period_start and the period_end. Data type: String
child_contract_lines.entitlements.entitlement_characteristics.type	Type of entitlement characteristic. Valid values: coverage coverage_and_usage Data type: String
child_contract_lines.entitlements.entitlement_characteristics.value	Value of the characteristic. Data type: String
child_contract_lines.entitlements.entitlement_name	Name of the entitlement. Data type: String
child_contract_lines.entitlements.household	Sys_id of the household record associated with the entitlement. Data type: String Table: Household [csm_household]
child_contract_lines.entitlements.install_base_items_covered	List of install base items covered under the  child service contract line. Data type: Array of Objects `"install_base_items_covered": [ { "added": "String", "contract": "String", "entitlement": "String", "install_base": "String", "removed": "String", "service_contract_line": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" } ]` Table: Sold Product Covered  [sn_install_base_m2m_contract_sold_product]
child_contract_lines.entitlements.install_base_items_covered.added	Date that the associated install base item was added to the service contract line. Data type: String Format: yyyy-mm-dd
child_contract_lines.entitlements.install_base_items_covered.contract	Sys_id of the service contract record associated with the install base item. Data type: String Table: Service Contract [sn_pss_core_service_contract]
child_contract_lines.entitlements.install_base_items_covered.entitlement	Sys_id of the entitlement record associated with the install base item. Data type: String Table: Service Contract [sn_pss_core_service_contract]
child_contract_lines.entitlements.install_base_items_covered.install_base	Sys_id of the associated install base item record. Data type: String Table: Install Base Item [sn_install_base_item]
child_contract_lines.entitlements.install_base_items_covered.removed	Date that the associated service contract line ends coverage of the install base item. Data type: String Format: yyyy-mm-dd
child_contract_lines.entitlements.install_base_items_covered.service_contract_line	Sys_id of the associated service contract line record. Data type: String Table: Service Contract Line [sn_pss_core_service_contract_line]
child_contract_lines.entitlements.install_base_items_covered.sys_created_by	Name of the user that created the install base item record. Data type: String
child_contract_lines.entitlements.install_base_items_covered.sys_created_on	Date and time that the install base item record was created. Data type: String
child_contract_lines.entitlements.install_base_items_covered.sys_id	Sys_id of the install base item covered. Data type: String Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
child_contract_lines.entitlements.install_base_items_covered.sys_updated_by	Name of the user that last updated the install base item record. Data type: String
child_contract_lines.entitlements.install_base_items_covered.sys_updated_on	Date and time that the install base item record was last updated. Data type: String
child_contract_lines.entitlements.product	Sys_id of the product model record associated with the entitlement. Data type: String Table: Product Model [cmdb_model]
child_contract_lines.entitlements.product_offering	Sys_id of the product offering record associated with the entitlement. Data type: String Table: Product Offering [sn_prd_pm_product_offering]
child_contract_lines.entitlements.product_specification	Sys_id of the product specification record associated with the entitlement. Data type: String Table: Product Specification [sn_prd_pm_product_specification]
child_contract_lines.entitlements.service_contract_line	Sys_id of the service contract line record associated with the entitlement. Data type: String Table: Service Contract Line [sn_pss_core_service_contract_line]
child_contract_lines.entitlements.sold_entitlement	Sys_id of the sold product record associated with the entitlement. Data type: String Table: Sold Product [sn_install_base_sold_product]
child_contract_lines.entitlements.sold_products_covered	List of products covered. Data type: Array of Objects `"sold_products_covered": [ { "added": "String", "contract": "String", "entitlement": "String", "removed": "String", "service_contract_line": "String", "sold_product": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" } ]` Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
child_contract_lines.entitlements.sold_products_covered.added	Date that the associated service contract starts to cover the product. Data type: String Format: yyyy-mm-dd Default: Current date
child_contract_lines.entitlements.sold_products_covered.contract	Sys_id of the service contract record associated with the sold product covered. Data type: String Table: Service Contract [sn_pss_core_service_contract]
child_contract_lines.entitlements.sold_products_covered.entitlement	Sys_id of the entitlement record associated with the sold product covered. Data type: String Table: Entitlement [service_entitlement]
child_contract_lines.entitlements.sold_products_covered.removed	Date that the associated service contract ends coverage of the associated product. Data type: String Format: yyyy-mm-dd Default: No end date
child_contract_lines.entitlements.sold_products_covered.service_contract_line	Sys_id of the service contract line record associated with the sold product covered. Data type: String Table: Service Contract Line [sn_pss_core_service_contract_line]
child_contract_lines.entitlements.sold_products_covered.sold_product	Sys_id of the product covered by the service contract. Data type: String Table: Sold Product [sn_install_base_sold_product]
child_contract_lines.entitlements.sold_products_coveredsys_created_by	Name of the user that created the sold product covered record. Data type: String
child_contract_lines.entitlements.sold_products_covered.sys_created_on	Date and time that the sold product covered record was created. Data type: String
child_contract_lines.entitlements.sold_products_covered.sys_id	Sys_id of the product covered by this service contract. Data type: String Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
child_contract_lines.entitlements.sold_products_covered.sys_updated_by	Name of the user that last updated the sold product covered record. Data type: String
child_contract_lines.entitlements.sold_products_covered.sys_updated_on	Name of the user that last updated the sold product covered record. Data type: String
child_contract_lines.entitlements.start_date	Start date of the entitlement. Data type: String Format: yyyy-mm-dd
child_contract_lines.entitlements.state	Current state of the entitlement. Valid values: (case-sensitive) active cancelled draft expired suspended Data type: String
child_contract_lines.entitlements.sys_created_by	Name of the user that created the entitlement record. Data type: String
child_contract_lines.entitlements.sys_created_on	Date and time that the entitlement record was created. Data type: String
child_contract_lines.entitlements.sys_id	Sys_id of the associated entitlement record. Data type: String Table: Entitlement [service_entitlement]
child_contract_lines.entitlements.sys_updated_by	Name of the user that last updated the entitlement record. Data type: String
child_contract_lines.entitlements.sys_updated_on	Date and time that the entitlement record was created. Data type: String
child_contract_lines.entitlement_characteristics	List of characteristics associated with the entitlement. Data type: Array of Objects `"entitlement_characteristics": [ { "characteristic": "String", "characteristic_option": "String", "entitlement": "String", "entitlement_usage": [Array], "service_contract_line": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" "type": "String", "value": "String" } ]`
child_contract_lines.entitlement_characteristics.characteristic	Sys_id of the characteristic record associated with the entitlement. Data type: String Table: Characteristic [sn_prd_pm_characteristic]
child_contract_lines.entitlement_characteristics.characteristic_option	Sys_id of the characteristic option record associated with the entitlement. Data type: String Table: Characteristic Option [sn_prd_pm_characteristic_option]
child_contract_lines.entitlement_characteristics.entitlement	Sys_id of the entitlement record. Data type: String Table: Entitlement [service_entitlement]
child_contract_lines.entitlement_characteristics.entitlement_usage	List of entitlement usages associated with the entitlement characteristic. Data type: Array of Objects `"entitlement_usage": [ { "entitlement": "String", "entitlement_characteristic": "String", "period_end": "String", "period_start": "String", "service_contract_line": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String", "total_units": "String", "used_units": "String" } ]`
child_contract_lines.entitlement_characteristics.entitlement_usage.entitlement	Sys_id of the entitlement record associated with the entitlement usage. Data type: String Table: Entitlement [service_entitlement]
child_contract_lines.entitlement_characteristics.entitlement_usage.entitlement_characteristic	Sys_id of the entitlement characteristic record associated with the entitlement usage. Data type: String Table: Characteristic [sn_pss_core_entitlement_characteristic]
child_contract_lines.entitlement_characteristics.entitlement_usage.period_end	End date when the entitlement usage is no longer tracked. Data type: String Format: yyyy-mm-dd
child_contract_lines.entitlement_characteristics.entitlement_usage.period_start	Starting date of when the entitlement usage is tracked. Data type: String Format: yyyy-mm-dd
child_contract_lines.entitlement_characteristics.entitlement_usage.service_contract_line	Sys_id of the service contract line to which the current entitlement usage belongs. Data type: String
child_contract_lines.entitlement_characteristics.entitlement_usage.sys_created_by	Name of the user that created the entitlement usage record. Data type: String
child_contract_lines.entitlement_characteristics.entitlement_usage.sys_created_on	Date and time that the entitlement usage record was created. Data type: String
child_contract_lines.entitlement_characteristics.entitlement_usage.sys_id	Sys_id of the entitlement usage record. Data type: String Table: Entitlement Usage [sn_pss_core_entitlement_usage]
child_contract_lines.entitlement_characteristics.entitlement_usage.sys_updated_by	Name of the user that last updated the entitlement usage record. Data type: String
child_contract_lines.entitlement_characteristics.entitlement_usage.sys_updated_on	Date and time that the entitlement usage record was last updated. Data type: String
child_contract_lines.entitlement_characteristics.entitlement_usage.total_units	Total coverage value of the associated entitlement characteristic. Data type: String
child_contract_lines.entitlement_characteristics.entitlement_usage.used_units	Number of units used by the account or consumer between the period_start and the period_end. Data type: String
child_contract_lines.entitlement_characteristics.service_contract_line	Sys_id of the service contract line record associated with the entitlement characteristic. Data type: String Table: Service Contract Line [sn_pss_core_service_contract_line]
child_contract_lines.entitlement_characteristics.sys_created_by	Name of the user that created the entitlement characteristics record. Data type: String
child_contract_lines.entitlement_characteristics.sys_created_on	Date and time that the entitlement characteristics record was created. Data type: String
child_contract_lines.entitlement_characteristics.sys_id	Sys_id of the entitlement characteristics record. Data type: String
child_contract_lines.entitlement_characteristics.sys_updated_by	Name of the user that last updated the entitlement characteristics record. Data type: String
child_contract_lines.entitlement_characteristics.sys_updated_on	Date and time that the entitlement characteristics record was last updated. Data type: String
child_contract_lines.entitlement_characteristics.type	Type of entitlement characteristic. Valid values: coverage coverage_and_usage Data type: String
child_contract_lines.entitlement_characteristics.value	Value of the characteristic. Data type: String
child_contract_lines.install_base_items_covered	List of install base items covered under the  child service contract line. Data type: Array of Objects `"install_base_items_covered": [ { "added": "String", "contract": "String", "entitlement": "String", "install_base": "String", "removed": "String", "service_contract_line": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" } ]` Table: Sold Product Covered  [sn_install_base_m2m_contract_sold_product]
child_contract_lines.install_base_items_covered.added	Date that the associated install base item was added to the service contract line. Data type: String Format: yyyy-mm-dd
child_contract_lines.install_base_items_covered.contract	Sys_id of the service contract record associated with the install base item. Data type: String Table: Service Contract [sn_pss_core_service_contract]
child_contract_lines.install_base_items_covered.entitlement	Sys_id of the entitlement record associated with the install base item. Data type: String Table: Service Contract [sn_pss_core_service_contract]
child_contract_lines.install_base_items_covered.install_base	Sys_id of the associated install base item record. Data type: String Table: Install Base Item [sn_install_base_item]
child_contract_lines.install_base_items_covered.removed	Date that the associated service contract line ends coverage of the install base item. Data type: String Format: yyyy-mm-dd
child_contract_lines.install_base_items_covered.service_contract_line	Sys_id of the associated service contract line record. Data type: String Table: Service Contract Line [sn_pss_core_service_contract_line]
child_contract_lines.install_base_items_covered.sys_created_by	Name of the user that created the install base item record. Data type: String
child_contract_lines.install_base_items_covered.sys_created_on	Date and time that the install base item record was created. Data type: String
child_contract_lines.install_base_items_covered.sys_id	Sys_id of the install base item covered. Data type: String Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
child_contract_lines.install_base_items_covered.sys_updated_by	Name of the user that last updated the install base item record. Data type: String
child_contract_lines.install_base_items_covered.sys_updated_on	Date and time that the install base item record was last updated. Data type: String
child_contract_lines.name	Name of the child service contract line. Data type: String
child_contract_lines.number	Unique number of the service contract line. Automatically generated by the endpoint. For example: CTRL000001. Data type: String
child_contract_lines.parent_contract_line	Sys_id of the parent contract line record associated with the child service contract line. Data type: String
child_contract_lines.product_model	Sys_id of the product associated with the child service contract line. Data type: String Table: Product Model [cmdb_model]
child_contract_lines.product_offering	Sys_id of the product offering record associated with the child service contract line. Data type: String Table: Product Offering [sn_prd_pm_product_offering]
child_contract_lines.product_specification	Sys_id of the product specification record associated with the child service contract line. Data type: String Table: Product Specification [sn_prd_pm_product_specification]
child_contract_lines.sold_product	Sys_id of the sold product record associated with the child service contract line. Data type: String Table: Sold Product [sn_install_base_sold_product]
child_contract_lines.sold_products_covered	List of products covered. Data type: Array of Objects `"sold_products_covered": [ { "added": "String", "contract": "String", "entitlement": "String", "removed": "String", "service_contract_line": "String", "sold_product": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" } ]` Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
child_contract_lines.sold_products_covered.added	Date that the associated service contract starts to cover the product. Data type: String Format: yyyy-mm-dd Default: Current date
child_contract_lines.sold_products_covered.contract	Sys_id of the service contract record associated with the sold product covered. Data type: String Table: Service Contract [sn_pss_core_service_contract]
child_contract_lines.sold_products_covered.entitlement	Sys_id of the entitlement record associated with the sold product covered. Data type: String Table: Entitlement [service_entitlement]
child_contract_lines.sold_products_covered.removed	Date that the associated service contract ends coverage of the associated product. Data type: String Format: yyyy-mm-dd Default: No end date
child_contract_lines.sold_products_covered.service_contract_line	Sys_id of the service contract line record associated with the sold product covered. Data type: String Table: Service Contract Line [sn_pss_core_service_contract_line]
child_contract_lines.sold_products_covered.sold_product	Sys_id of the product covered by the service contract. Data type: String Table: Sold Product [sn_install_base_sold_product]
child_contract_lines.sold_products_covered.sys_created_by	Name of the user that created the sold product covered record. Data type: String
child_contract_lines.sold_products_covered.sys_created_on	Date and time that the sold product covered record was created. Data type: String
child_contract_lines.sold_products_covered.sys_id	Sys_id of the product covered by this service contract. Data type: String Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
child_contract_lines.sold_products_covered.sys_updated_by	Name of the user that last updated the sold product covered record. Data type: String
child_contract_lines.sold_products_covered.sys_updated_on	Name of the user that last updated the sold product covered record. Data type: String
child_contract_lines.starts	Start date of the child service contract line. Data type: String Format: yyyy-mm-dd
child_contract_lines.state	Current state of the contract line. Valid values: (case-sensitive) active cancelled draft expired suspended Data type: String
child_contract_lines.sys_created_by	Name of the user that created the child service contract line record. Data type: String
child_contract_lines.sys_created_on	Date and time that the child service contract line record was created. Data type: String
child_contract_lines.sys_id	Sys_id of a child service contract line record. Data type: String Table: Service Contract Line [sn_pss_core_service_contract_line]
child_contract_lines.sys_updated_by	Name of the user that last updated the child service contract line record. Data type: String
child_contract_lines.sys_updated_on	Date and time that the child service contract line record was last updated. Data type: String
contract	Sys_id of the service contract associated with the service contract line. Data type: String Table: Service Contract [sn_pss_core_service_contract]
ends	Date on which the service contract line ends. Data type: String Format: yyyy-mm-dd Default: Never ends until manually removed.
entitlements	List of entitlements associated with the service contract line. Data type: Array of Objects "entitlements": [ { "account": "String", "consumer": "String", "contract": "String", "end_date": "String", "entitlement_characteristics": [Array], "entitlement_name": "String", "household": "String", "install_base_items_covered": [Array], "product": "String", "product_offering": "String", "product_specification": "String", "service_contract_line": "String", "sold_entitlement": "String", "sold_products_covered": [Array], "start_date": "String", "state": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" } ] Table: Entitlement [service_entitlement]
entitlements.account	Sys_id of the account record to which the entitlement belongs. Data type: String Table: Account [customer_account]
entitlements.consumer	Sys_id of the consumer record to which the entitlement belongs. Data type: String Table: Consumer [csm_consumer]
entitlements.contract	Sys_id of the contract record to which the entitlement belongs. Data type: String Table: Service Contract [sn_pss_core_service_contract]
entitlements.end_date	End date of the entitlement. Data type: String Format: yyyy-mm-dd Default: Never ends until manually removed.
entitlements.entitlement_characteristics	List of characteristics associated with the entitlement. Data type: Array of Objects `"entitlement_characteristics": [ { "characteristic": "String", "characteristic_option": "String", "entitlement": "String", "entitlement_usage": [Array], "service_contract_line": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String", "type": "String", "value": "String" } ]` Table: Characteristic [sn_pss_core_entitlement_characteristic]
entitlements.entitlement_characteristics.characteristic	Sys_id of the characteristic record associated with the entitlement. Data type: String Table: Characteristic [sn_prd_pm_characteristic]
entitlements.entitlement_characteristics.characteristic_option	Sys_id of the characteristic option record associated with the entitlement. Data type: String Table: Characteristic Option [sn_prd_pm_characteristic_option]
entitlements.entitlement_characteristics.entitlement	Sys_id of the associated entitlement record. Data type: String Table: Entitlement [service_entitlement]
entitlements.entitlement_characteristics.entitlement_usage	Entitlement usage details. Data type: Array of Objects `"entitlement_usage": [ { "entitlement": "String", "entitlement_characteristic": [Array], "period_end": "String", "period_start": "String", "service_contract_line": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String", "total_units": "String", "used_units": "String" } ]`
entitlements.entitlement_characteristics.entitlement_usage.entitlement	Sys_id of the entitlement record associated with the entitlement usage. Data type: String Table: Entitlement [service_entitlement]
entitlements.entitlement_characteristics.entitlement_usage.entitlement_characteristic	Sys_id of the entitlement characteristic record associated with the entitlement usage. Data type: String Table: Characteristic [sn_pss_core_entitlement_characteristic]
entitlements.entitlement_characteristics.entitlement_usage.period_end	End date when the entitlement usage is no longer tracked. Data type: String Format: yyyy-mm-dd
entitlements.entitlement_characteristics.entitlement_usage.period_start	Starting date of when the entitlement usage is tracked. Data type: String Format: yyyy-mm-dd
entitlements.entitlement_characteristics.entitlement_usage.service_contract_line	Service contract line to which the current entitlement usage belongs. Data type: String
entitlements.entitlement_characteristics.entitlement_usage.sys_created_by	Name of the user that created the entitlement usage record. Data type: String
entitlements.entitlement_characteristics.entitlement_usage.sys_created_on	Date and time that the entitlement usage record was created. Data type: String
entitlements.entitlement_characteristics.entitlement_usage.sys_id	Sys_id of the entitlement usage record. Data type: String Table: Entitlement Usage [sn_pss_core_entitlement_usage]
entitlements.entitlement_characteristics.entitlement_usage.sys_updated_by	Name of the user that last updated the entitlement usage record. Data type: String
entitlements.entitlement_characteristics.entitlement_usage.sys_updated_on	Date and time that the entitlement usage record was last updated. Data type: String
entitlements.entitlement_characteristics.entitlement_usage.total_units	Total coverage value of the associated entitlement characteristic. Data type: String
entitlements.entitlement_characteristics.entitlement_usage.used_units	Number of units used by the account or consumer between the period_start and the period_end. Data type: String
entitlements.entitlement_characteristics.service_contract_line	Sys_id of the service contract line record associated with the entitlement characteristic. Data type: String Table: Service Contract Line [sn_pss_core_service_contract_line]
entitlements.entitlement_characteristics.sys_created_by	Name of the user that created the entitlement characteristics record. Data type: String
entitlements.entitlement_characteristics.sys_created_on	Date and time that the entitlement characteristics record was created. Data type: String
entitlements.entitlement_characteristics.sys_id	Sys_id of the entitlement characteristics record. Data type: String
entitlements.entitlement_characteristics.sys_updated_by	Name of the user that last updated the entitlement characteristics record. Data type: String
entitlements.entitlement_characteristics.sys_updated_on	Date and time that the entitlement characteristics record was last updated. Data type: String
entitlements.entitlement_characteristics.type	Type of entitlement characteristic. Valid values: coverage coverage_and_usage Data type: String
entitlements.entitlement_characteristics.value	Value of the characteristic. Data type: String
entitlements.entitlement_name	Name of the entitlement. Data type: String
entitlements.household	Sys_id of the household record associated with the entitlement. Data type: String Table: Household [csm_household]
entitlements.install_base_items_covered	List of install base items covered under the service contract line. Data type: Array of Objects `"install_base_items_covered": [ { "added": "String", "contract": "String", "entitlement": "String", "install_base": "String", "removed": "String", "service_contract_line": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" } ]`
entitlements.install_base_items_covered.added	Date that the associated install base item was added to the entitlement. Data type: String
entitlements.install_base_items_covered.contract	Sys_id of the service contract record associated with the install base item. Data type: String Table: Service Contract [sn_pss_core_service_contract]
entitlements.install_base_items_covered.entitlement	Sys_id of the entitlement record associated with the install base item. Data type: String Table: Entitlement [service_entitlement]
entitlements.install_base_items_covered.install_base	Sys_id of the associated install base item record. Data type: String Table: Install Base Item [sn_install_base_item]
entitlements.install_base_items_covered.removed	Date that the associated install base item was removed from the entitlement. Data type: String
entitlements.install_base_items_covered.service_contract_line	Sys_id of the associated service contract line record. Data type: String Table: Service Contract Line [sn_pss_core_service_contract_line]
entitlements.install_base_items_covered.sys_created_by	Name of the user that created the install base item record. Data type: String
entitlements.install_base_items_covered.sys_created_on	Date and time that the install base item record was created. Data type: String
entitlements.install_base_items_covered.sys_id	Sys_id of the install base item covered. Data type: String Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
entitlements.install_base_items_covered.sys_updated_by	Name of the user that last updated the install base item record. Data type: String
entitlements.install_base_items_covered.sys_updated_on	Date and time that the install base item record was last updated. Data type: String
entitlements.product	Sys_id of the product model record associated with the entitlement. Data type: String Table: Product Model [cmdb_model]
entitlements.product_offering	Sys_id of the product offering record associated with the entitlement. Data type: String Table: Product Offering [sn_prd_pm_product_offering]
entitlements.product_specification	Sys_id of the product specification record associated with the entitlement. Data type: String Table: Product Specification [sn_prd_pm_product_specification]
entitlements.service_contract_line	Sys_id of the service contract line record associated with the entitlement. Data type: String Table: Service Contract Line [sn_pss_core_service_contract_line]
entitlements.sold_entitlement	Sys_id of the sold product record associated with the entitlement. Data type: String Table: Sold Product [sn_install_base_sold_product]
entitlements.sold_products_covered	List of products covered. Data type: Array of Objects `"sold_products_covered": [ { "added": "String", "contract": "String", "entitlement": "String", "removed": "String", "service_contract_line": "String", "sold_product": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" } ]` Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
entitlements.sold_products_covered.added	Date that the associated sold product was added to the entitlement. Data type: String Format: yyyy-mm-dd Default: Current date
entitlements.sold_products_covered.contract	Sys_id of the service contract record associated with the sold product covered. Data type: String Table: Service Contract [sn_pss_core_service_contract]
entitlements.sold_products_covered.entitlement	Sys_id of the entitlement record associated with the sold product covered. Data type: String Table: Entitlement [service_entitlement]
entitlements.sold_products_covered.removed	Date that the associated sold product was removed from the entitlement. Data type: String Format: yyyy-mm-dd Default: No end date
entitlements.sold_products_covered.service_contract_line	Sys_id of the service contract line record associated with the sold product covered. Data type: String Table: Service Contract Line [sn_pss_core_service_contract_line]
entitlements.sold_products_covered.sold_product	Sys_id of the product covered by the entitlement. Data type: String Table: Sold Product [sn_install_base_sold_product]
entitlements.sold_products_covered.sys_created_by	Name of the user that created the sold product covered record. Data type: String
entitlements.sold_products_covered.sys_created_on	Date and time that the sold product covered record was created. Data type: String
entitlements.sold_products_covered.sys_id	Sys_id of the product covered by this service contract. Data type: String Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
entitlements.sold_products_covered.sys_updated_by	Name of the user that last updated the sold product covered record. Data type: String
entitlements.sold_products_covered.sys_updated_on	Date and time that the sold product covered record was last updated. Data type: String
entitlements.start_date	Start date of the entitlement. Data type: String Format: yyyy-mm-dd
entitlements.state	Current state of the entitlement. Valid values: (case-sensitive) active cancelled draft expired suspended Data type: String
entitlements.sys_created_by	Name of the user that created the entitlement record. Data type: String
entitlements.sys_created_on	Date and time that the entitlement record was created. Data type: String
entitlements.sys_id	Sys_id of the associated entitlement record. Data type: String Table: Entitlement [service_entitlement]
entitlements.sys_updated_by	Name of the user that last updated the entitlement record. Data type: String
entitlements.sys_updated_on	Date and time that the entitlement record was created. Data type: String
entitlement_characteristics	List of entitlement characteristics associated with the service contract line. Data type: Array of Objects `"entitlement_characteristics": [ { "characteristic": "String", "characteristic_option": "String", "entitlement": "String", "service_contract_line": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String", "type": "String", "value": "String" } ]` Table: Characteristic [sn_pss_core_entitlement_characteristic]
entitlement_characteristics.characteristic	Sys_id of the characteristic record associated with the entitlement. Data type: String Table: Characteristic [sn_prd_pm_characteristic]
entitlement_characteristics.characteristic_option	Sys_id of the characteristic option record associated with the entitlement. Data type: String Table: Characteristic Option [sn_prd_pm_characteristic_option]
entitlement_characteristics.entitlement	Sys_id of the entitlement record. Data type: String Table: Entitlement [service_entitlement]
entitlement_characteristics.service_contract_line	Sys_id of the service contract line record associated with the entitlement characteristic. Data type: String Table: Service Contract Line [sn_pss_core_service_contract_line]
entitlement_characteristics.sys_created_by	Name of the user that created the entitlement characteristics record. Data type: String
entitlement_characteristics.sys_created_on	Date and time that the entitlement characteristics record was created. Data type: String
entitlement_characteristics.sys_id	Sys_id of the entitlement characteristics record. Data type: String
entitlement_characteristics.sys_updated_by	Name of the user that last updated the entitlement characteristics record. Data type: String
entitlement_characteristics.sys_updated_on	Date and time that the entitlement characteristics record was last updated. Data type: String
entitlement_characteristics.type	Type of entitlement characteristic. Valid values: coverage coverage_and_usage Data type: String
entitlement_characteristics.value	Value of the characteristic. Data type: String
install_base_items_covered	List of install base items covered under the  service contract line. Data type: Array of Objects `"install_base_items_covered": [ { "added": "String", "contract": "String", "entitlement": "String", "install_base": "String", "removed": "String", "service_contract_line": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" } ]` Table: Sold Product Covered  [sn_install_base_m2m_contract_sold_product]
install_base_items_covered.added	Date that the associated install base item was added to the service contract line. Data type: String
install_base_items_covered.contract	Sys_id of the service contract record associated with the install base item. Data type: String Table: Service Contract [sn_pss_core_service_contract]
install_base_items_covered.entitlement	Sys_id of the entitlement record associated with the install base item. Data type: String Table: Entitlement [service_entitlement]
install_base_items_covered.install_base	Sys_id of the install base item covered by the service contract line. Data type: String Table: Install Base Item [sn_install_base_item]
install_base_items_covered.removed	Date that the associated service contract line ends coverage of the install base item. Data type: String
install_base_items_covered.service_contract_line	Sys_id of the associated service contract line record. Data type: String Table: Service Contract Line [sn_pss_core_service_contract_line]
install_base_items_covered.sys_created_by	Name of the user that created the install base item record. Data type: String
install_base_items_covered.sys_created_on	Date and time that the install base item record was created. Data type: String
install_base_items_covered.sys_id	Sys_id of the install base item covered. Data type: String Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
install_base_items_covered.sys_updated_by	Name of the user that last updated the install base item record. Data type: String
install_base_items_covered.sys_updated_on	Date and time that the install base item record was last updated. Data type: String
name	Name of the service contract line. Data type: String
number	Unique number of the service contract line. Automatically generated by the endpoint. For example: CTRL9812347. Data type: String
parent_contract_line	Sys_id of the service contract line to which the current service contract line is a child of. Null for the contract lines created under a contract. Data type: String Table: Service Contract Line [sn_pss_core_service_contract_line]
product_model	Sys_id of the product associated with the service contract line. Data type: String Table: Product Model [cmdb_model]
product_offering	Sys_id of the product offering record associated with the service contract line. Data type: String Table: Product Offering [sn_prd_pm_product_offering]
product_specification	Sys_id of the product specification record associated with the service contract line. Data type: String Table: Product Specification [sn_prd_pm_product_specification]
sold_product	Sys_id of the sold product record associated with the service contract line. Data type: String Table: Sold Product [sn_install_base_sold_product]
sold_products_covered	List of products covered. Data type: Array of Objects `"sold_products_covered": [ { "added": "String", "contract": "String", "entitlement": "String", "removed": "String", "service_contract_line": "String", "sold_product": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" } ]` Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
sold_products_covered.added	Date that the associated sold product was added to the service contract line. Data type: String Format: yyyy-mm-dd
sold_products_covered.contract	Sys_id of the service contract record associated with the sold product covered. Data type: String Table: Service Contract [sn_pss_core_service_contract]
sold_products_covered.entitlement	Sys_id of the entitlement record associated with the sold product covered. Data type: String Table: Entitlement [service_entitlement]
sold_products_covered.removed	Date that the associated sold product was removed from the service contract line. Data type: String Format: yyyy-mm-dd
sold_products_covered.service_contract_line	Sys_id of the service contract line record associated with the sold product covered. Data type: String Table: Service Contract Line [sn_pss_core_service_contract_line]
sold_products_covered.sold_product	Sys_id of the product covered by the entitlement. Data type: String Table: Sold Product [sn_install_base_sold_product]
sold_products_covered.sys_created_by	Name of the user that created the sold product covered record. Data type: String
sold_products_covered.sys_created_on	Date and time that the sold product covered record was created. Data type: String
sold_products_covered.sys_id	Sys_id of the product covered by this service contract. Data type: String Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
sold_products_covered.sys_updated_by	Name of the user that last updated the sold product covered record. Data type: String
sold_products_covered.sys_updated_on	Date and time that the sold product covered record was last updated. Data type: String
starts	Start date of the service contract line. Data type: String Format: yyyy-mm-dd
state	Current state of the contract line. Valid values: (case-sensitive) active cancelled draft expired suspended Data type: String
sys_created_by	Name of the user that created the service contract line record. Data type: String
sys_created_on	Date and time that the service contract line record was created. Data type: String
sys_id	Sys_id of a service contract line record. Data type: String Table: Service Contract Line [sn_pss_core_service_contract_line]
sys_updated_by	Name of the user that last updated the service contract line record. Data type: String
sys_updated_on	Date and time that the service contract line record was last updated. Data type: String

cURL request

The following code example shows how to call this endpoint.

curl "https://instance.servicenow.com/api/sn_pss_core/servicecontract/contractline/fc73d2de89226110f877430a4e008add" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

Response:

{
  "result": {
    "sys_id": "16e451d1d1f53110f8776589fa411f80",
    "sys_created_by": "admin",
    "sys_updated_by": "admin",
    "sys_created_on": "2023-10-09 11:29:47",
    "sys_updated_on": "2023-10-09 11:29:47",
    "name": "CLI",
    "number": "CTRL0000001",
    "contract": "a4b415d1d1f53110f8776589fa411f20",
    "parent_contract_line": null,
    "sold_product": null,
    "starts": "2022-12-03",
    "ends": "",
    "product_offering": null,
    "product_specification": null,
    "product_model": null,
    "child_contract_lines": [
      {
        "sys_id": "3a39ecdc01154f4ab782da0169c9c922",
        "sys_created_by": "admin",
        "sys_updated_by": "admin",
        "sys_created_on": "2023-10-09 11:27:29",
        "sys_updated_on": "2023-10-09 11:27:29",
        "name": "Child CLI",
        "number": "CTRL0000002",
        "contract": "a4b415d1d1f53110f8776589fa411f20",
        "parent_contract_line": "16e451d1d1f53110f8776589fa411f80",
        "sold_product": null,
        "starts": "2022-12-03",
        "ends": "",
        "product_offering": null,
        "product_model": null,
        "product_specification": null,
        "child_contract_lines": [],
        "entitlements": [
          {
            "sys_id": "7439fd84c2494ba6951e58f333cfe8d4",
            "sys_created_by": "admin",
            "sys_updated_by": "admin",
            "sys_created_on": "2023-10-09 11:27:29",
            "sys_updated_on": "2023-10-09 11:27:29",
            "entitlement_name": "Child CLI - ENTL",
            "account": "4c325111d1f53110f8776589fa411f3d",
            "consumer": null,
            "household": null,
            "contract": "a4b415d1d1f53110f8776589fa411f20",
            "service_contract_line": "3a39ecdc01154f4ab782da0169c9c922",
            "state": "active",
            "product_offering": null,
            "product_specification": null,
            "sold_entitlement": null,
            "product": null,
            "start_date": "2022-12-03",
            "end_date": "",
            "entitlement_characteristics": [],
            "sold_products_covered": [],
            "install_base_items_covered": []
          }
        ],
        "sold_products_covered": [
          {
            "sys_id": "dfb62e9c4c6843009be02a68f65b9118",
            "sys_created_by": "admin",
            "sys_updated_by": "admin",
            "sys_created_on": "2023-10-09 11:27:29",
            "sys_updated_on": "2023-10-09 11:27:29",
            "contract": "a4b415d1d1f53110f8776589fa411f20",
            "service_contract_line": "3a39ecdc01154f4ab782da0169c9c922",
            "entitlement": null,
            "sold_product": "ec235d9dd1b53110f8776589fa411fe2",
            "added": "2023-12-03",
            "removed": "2023-12-03"
          }
        ],
        "install_base_items_covered": [
          {
            "sys_id": "2583912e81964501b52a2e44d4797a28",
            "sys_created_by": "admin",
            "sys_updated_by": "admin",
            "sys_created_on": "2023-10-09 11:27:29",
            "sys_updated_on": "2023-10-09 11:27:29",
            "contract": "a4b415d1d1f53110f8776589fa411f20",
            "service_contract_line": "3a39ecdc01154f4ab782da0169c9c922",
            "entitlement": null,
            "install_base": "a1731551d1f53110f8776589fa411f8d",
            "added": "2023-12-03",
            "removed": "2023-12-03"
          }
        ],
        "entitlement_characteristics": [
          {
            "sys_id": "3a00c975bb49412cae169200c7f6236e",
            "sys_created_by": "admin",
            "sys_updated_by": "admin",
            "sys_created_on": "2023-10-09 11:27:29",
            "sys_updated_on": "2023-10-09 11:27:29",
            "service_contract_line": "3a39ecdc01154f4ab782da0169c9c922",
            "entitlement": null,
            "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
            "value": "5",
            "characteristic": "63418db7539e61106bfcddeeff7b1238",
            "type": "coverage"
          }
        ]
      }
    ],
    "entitlements": [
      {
        "sys_id": "16e419d1d1f53110f8776589fa411f3c",
        "sys_created_by": "admin",
        "sys_updated_by": "admin",
        "sys_created_on": "2023-10-09 11:29:48",
        "sys_updated_on": "2023-10-09 11:29:48",
        "entitlement_name": "ENTL 2",
        "account": "4c325111d1f53110f8776589fa411f3d",
        "consumer": null,
        "household": null,
        "contract": "a4b415d1d1f53110f8776589fa411f20",
        "service_contract_line": "16e451d1d1f53110f8776589fa411f80",
        "state": "active",
        "product_offering": null,
        "product_specification": null,
        "sold_entitlement": null,
        "product": null,
        "start_date": "2022-12-03",
        "end_date": "",
        "sold_products_covered": [
          {
            "sys_id": "1ae419d1d1f53110f8776589fa411f3d",
            "sys_created_by": "admin",
            "sys_updated_by": "admin",
            "sys_created_on": "2023-10-09 11:29:48",
            "sys_updated_on": "2023-10-09 11:29:48",
            "contract": "a4b415d1d1f53110f8776589fa411f20",
            "service_contract_line": "16e451d1d1f53110f8776589fa411f80",
            "entitlement": "16e419d1d1f53110f8776589fa411f3c",
            "sold_product": "da23d151d1f53110f8776589fa411f27",
            "added": "",
            "removed": ""
          }
        ],
        "install_base_items_covered": [],
        "entitlement_characteristics": [
          {
            "sys_id": "1ae419d1d1f53110f8776589fa411f3e",
            "sys_created_by": "admin",
            "sys_updated_by": "admin",
            "sys_created_on": "2023-10-09 11:29:48",
            "sys_updated_on": "2023-10-09 11:29:48",
            "service_contract_line": null,
            "entitlement": "16e419d1d1f53110f8776589fa411f3c",
            "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
            "value": "5",
            "characteristic": "63418db7539e61106bfcddeeff7b1238",
            "type": "coverage_and_usage",
            "entitlement_usage": [
              {
                "sys_id": "56e419d1d1f53110f8776589fa411f3f",
                "sys_created_by": "admin",
                "sys_updated_by": "admin",
                "sys_created_on": "2023-10-09 11:29:48",
                "sys_updated_on": "2023-10-09 11:29:48",
                "entitlement": "16e419d1d1f53110f8776589fa411f3c",
                "service_contract_line": null,
                "entitlement_characteristic": "1ae419d1d1f53110f8776589fa411f3e",
                "period_start": "2022-12-03",
                "period_end": "",
                "total_units": "5",
                "used_units": "2"
              }
            ]
          }
        ]
      }
    ],
    "sold_products_covered": [
      {
        "sys_id": "5ae451d1d1f53110f8776589fa411f81",
        "sys_created_by": "admin",
        "sys_updated_by": "admin",
        "sys_created_on": "2023-10-09 11:29:47",
        "sys_updated_on": "2023-10-09 11:29:47",
        "contract": "a4b415d1d1f53110f8776589fa411f20",
        "service_contract_line": "16e451d1d1f53110f8776589fa411f80",
        "entitlement": null,
        "sold_product": "0df21151d1f53110f8776589fa411f1b",
        "added": "2023-12-03",
        "removed": "2023-12-03"
      }
    ],
    "install_base_items_covered": [],
    "entitlement_characteristics": [
      {
        "sys_id": "dae451d1d1f53110f8776589fa411f82",
        "sys_created_by": "admin",
        "sys_updated_by": "admin",
        "sys_created_on": "2023-10-09 11:29:47",
        "sys_updated_on": "2023-10-09 11:29:47",
        "service_contract_line": "16e451d1d1f53110f8776589fa411f80",
        "entitlement": null,
        "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
        "value": "5",
        "characteristic": "63418db7539e61106bfcddeeff7b1238",
        "type": "coverage"
      }
    ]
  }
}

Service Contract - POST /sn_pss_core/servicecontract

Creates a service contract record and all its related entities from a specified payload.

The Service Contract API stores data in various tables. The following is the list of tables in which records are created by this endpoint when creating a service contract:

Characteristic [sn_pss_core_entitlement_characteristic]
Entitlement [service_entitlement]
Entitlement Usage [sn_pss_core_entitlement_usage]
Sold Product Covered [sn_install_base_m2m_contract_sold_product] - This table contains information for both sold products covered and install base items covered.
Service Contract [sn_pss_core_service_contract]
Service Contract Line [sn_pss_core_service_contract_line]

The request body of this endpoint references fields in the following tables. This information needs to be added to your instance before utilizing this API. For additional information, see Create service contracts.

Account [customer_account]
Characteristic Option [sn_prd_pm_characteristic_option]
Consumer [csm_consumer]
Household [csm_household]

URL format

Versioned URL: /api/sn_pss_core/{api_version}/servicecontract

Default URL: /api/sn_pss_core/servicecontract

Note:

Available versions are specified in the REST API Explorer. For scripted REST APIs there is additional version information on the Scripted REST Service form.

Supported request parameters

Table 13. Path parameters
Name	Description
api_version	Optional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String

Table 14. Query parameters
Name	Description
None

Table 15. Request body parameters (XML or JSON)
Name	Description
account	Required if the consumer parameter is not specified. Sys_id of the account record to which the service contract belongs. Data type: String Table: Account [customer_account]
consumer	Required if the account parameter is not specified. Sys_id of the consumer record to which the service contract belongs. Data type: String Table: Consumer [csm_consumer]
ends	Date on which the service contract ends. Data type: String Format: yyyy-mm-dd Default: Never ends until manually removed.
household	Only valid for consumer service contracts. Sys_id of the household associated with the service contract. Data type: String Table: Household [csm_household] Default: null (no household)
install_base_items_covered	List of install base items covered under the service contract. For more information on Install Base Items Configure install base. Data type: Array of Objects `"install_base_items_covered": [ { "added": "String", "install_base": "String", "removed": "String" } ]` Stored in: The Sold Product Covered [sn_install_base_m2m_contract_sold_product] table.
install_base_items_covered.added	Date that the associated service contract starts to cover the install base item. Data type: String Format: yyyy-mm-dd Default: Current date
install_base_items_covered.install_base	Sys_id of the associated install base item record. Data type: String Table: Install Base Item [sn_install_base_item]
install_base_items_covered.removed	Date that the associated service contract ends coverage of the install base item. Data type: String Format: yyyy-mm-dd Default: No end date
service_contract_lines	List of service contract lines associated with the service contract. Data type: Array of Objects `"service_contract_lines": [ { "child_contract_lines": [Array], "ends": "String", "entitlements": [Array], "entitlement_characteristics": [Array], "install_base_items_covered": [Array], "name": "String", "number": "String", "product_model": "String", "product_offering": "String", "product_specification": "String", "sold_product": "String", "sold_products_covered": [Array], "starts": "String", "state": "String" } ]` Stored in: Service Contract Line [sn_pss_core_service_contract_line]
service_contract_lines.child_contract_lines	List of child service contract lines under the service contract line. Data type: Array of Objects `"child_contract_lines": [ { "child_contract_lines": [Array], "ends": "String", "entitlements": [Array], "entitlement_characteristics": [Array], "install_base_items_covered": [Array], "name": "String", "product_model": "String", "product_offering": "String", "product_specification": "String", "sold_product": "String", "sold_products_covered": [Array], "starts": "String", "state": "String" } ]` Stored in: Service Contract Line [sn_pss_core_service_contract_line]
service_contract_lines.child_contract_lines.child_contract_lines	List of child service contract line objects to create under the child service contract line. The objects in this array have the same elements as the objects in the service_contract_lines.child_contract_lines parameter. Data type: Array of Objects
service_contract_lines.child_contract_lines.ends	Date on which the service contract line ends. Data type: String Format: yyyy-mm-dd Default: Never ends until manually removed.
service_contract_lines.child_contract_lines.entitlements	List of entitlements to associate with the child service contract line. Data type: Array of Objects `"entitlements:" [ { "account": "String", "consumer": "String", "end_date": "String", "entitlement_characteristics": [Array], "entitlement_name": "String", "household": "String", "install_base_items_covered": [Array], "product": "String", "product_offering": "String", "product_specification": "String", "sold_entitlement": "String", "sold_products_covered": [Array], "start_date": "String", "state": "String" } ]` Stored in: Entitlement [service_entitlement]
service_contract_lines.child_contract_lines.entitlements.account	Sys_id of the account record to which the entitlement belongs. Data type: String Table: Account [customer_account]
service_contract_lines.child_contract_lines.entitlements.consumer	Sys_id of the consumer record to which the entitlement belongs. Data type: String Table: Consumer [csm_consumer]
service_contract_lines.child_contract_lines.entitlements.end_date	End date of the entitlement. Data type: String Format: yyyy-mm-dd Default: Never ends until manually removed.
service_contract_lines.child_contract_lines.entitlements.entitlement_characteristics	List of characteristics associated with the entitlement. Data type: Array of Objects `"entitlement_characteristics": [ { "characteristic": "String", "characteristic_option": "String", "entitlement_usage": {Object}, "type": "String", "value": "String" } ]` Stored in: Characteristic [sn_pss_core_entitlement_characteristic]
service_contract_lines.child_contract_lines.entitlements.entitlement_characteristics.characteristic	Required. Sys_id of the characteristic record associated with the entitlement. Data type: String Table: Characteristic [sn_prd_pm_characteristic]
service_contract_lines.child_contract_lines.entitlements.entitlement_characteristics.characteristic_option	Sys_id of the characteristic option record associated with the entitlement. Data type: String Table: Characteristic Option [sn_prd_pm_characteristic_option]
service_contract_lines.child_contract_lines.entitlements.entitlement_characteristics.entitlement_usage	Used unit value for the associated entitlement characteristic. Only pass this parameter if the entitlement_characteristics are under the entitlement. Data type: Object `"entitlement_usage": { "used_units": "String" }` Stored in: Entitlement Usage [sn_pss_core_entitlement_usage]
service_contract_lines.child_contract_lines.entitlements.entitlement_characteristics.entitlement_usage.used_units	Usage of the associated entitlement characteristic. Data type: String
service_contract_lines.child_contract_lines.entitlements.entitlement_characteristics.type	Type of entitlement characteristic. Valid values: coverage coverage_and_usage Data type: String
service_contract_lines.child_contract_lines.entitlements.entitlement_characteristics.value	Required if the input_type parameter contained in the record specified in the entitlement_characteristics.characteristic parameter, is not `choice`. Value of the characteristic. Data type: String
service_contract_lines.child_contract_lines.entitlements.entitlement_name	Required. Name of the entitlement. Data type: String
service_contract_lines.child_contract_lines.entitlements.household	Only passed when the household plugins are active and the consumer parameter is passed. Sys_id of the household record associated with the entitlement. Data type: String Table: Household [csm_household]
service_contract_lines.child_contract_lines.entitlements.install_base_items_covered	List of install base items covered under the entitlement. The information in this array is inserted in the Sold Product Covered  [sn_install_base_m2m_contract_sold_product] table. Data type: Array of Objects `"install_base_items_covered": [ { "added": "String", "install_base": "String", "removed": "String" } ]`
service_contract_lines.child_contract_lines.entitlements.install_base_items_covered.added	Date that the associated install base item was added to the entitlement. Data type: String Format: yyyy-mm-dd Default: Current date
service_contract_lines.child_contract_lines.entitlements.install_base_items_covered.install_base	Sys_id of the install base item covered by the entitlement. Data type: String Table: Install Base Item [sn_install_base_item]
service_contract_lines.child_contract_lines.entitlements.install_base_items_covered.removed	Date that the associated install base item was removed from the entitlement. Data type: String Format: yyyy-mm-dd Default: No end date
service_contract_lines.child_contract_lines.entitlements.product	Sys_id of the product model record associated with the entitlement. Data type: String Table: Product Model [cmdb_model]
service_contract_lines.child_contract_lines.entitlements.product_offering	Sys_id of the product offering record associated with the entitlement. Data type: String Table: Product Offering [sn_prd_pm_product_offering]
service_contract_lines.child_contract_lines.entitlements.product_specification	Sys_id of the product specification record associated with the entitlement. Data type: String Table: Product Specification [sn_prd_pm_product_specification]
service_contract_lines.child_contract_lines.entitlements.sold_entitlement	Sys_id of the sold product record associated with the entitlement. Data type: String Table: Sold Product [sn_install_base_sold_product]
service_contract_lines.child_contract_lines.entitlements.sold_products_covered	List of sold products covered under the entitlement. Data type: Array of Objects `"sold_products_covered": [ { "added": "String", "removed": "String", "sold_product": "String" } ]`
service_contract_lines.child_contract_lines.entitlements.sold_products_covered.added	Date that the associated sold product was added to the entitlement. Data type: String Format: yyyy-mm-dd Default: Current date
service_contract_lines.child_contract_lines.entitlements.sold_products_covered.removed	Date that the associated sold product was removed from the entitlement. Data type: String Format: yyyy-mm-dd Default: No end date
service_contract_lines.child_contract_lines.entitlements.start_date	Required. Start date of the entitlement. Data type: String Format: yyyy-mm-dd
service_contract_lines.child_contract_lines.entitlements.state	Required. Current state of the entitlement. Valid values: (case-sensitive) active cancelled draft expired suspended Data type: String
service_contract_lines.child_contract_lines.entitlement_characteristics	List of characteristics associated with the service contract line. Data type: Array of Objects `"entitlement_characteristics" [ { "characteristic": "String", "characteristic_option": "String", "entitlement_usage": {Object}, "type": "String", "value": "String" } ]` Stored in: Characteristic [sn_pss_core_entitlement_characteristic]
service_contract_lines.child_contract_lines.entitlement_characteristics.characteristic	Required. Sys_id of the characteristic record associated with the service contract line. Data type: String Table: Characteristic [sn_prd_pm_characteristic]
service_contract_lines.child_contract_lines.entitlement_characteristics.characteristic_option	Sys_id of the characteristic option record associated with the service contract line. Data type: String Table: Characteristic Option [sn_prd_pm_characteristic_option]
service_contract_lines.child_contract_lines.entitlement_characteristics.entitlement_usage	Used unit value for the associated service contract line characteristic. Data type: Object `"entitlement_usage": { "used_units": "String" }` Stored in: Entitlement Usage [sn_pss_core_entitlement_usage]
service_contract_lines.child_contract_lines.entitlement_characteristics.entitlement_usage.usage_units	Usage of the associated entitlement characteristic. Data type: String
service_contract_lines.child_contract_lines.entitlement_characteristics.type	Type of service contract line characteristic. Valid values: coverage coverage _and_usage Data type: String
service_contract_lines.child_contract_lines.entitlement_characteristics.value	Required if the entitlement_characteristics.type parameter is not passed. Value of the characteristic. Data type: String
service_contract_lines.child_contract_lines.install_base_items_covered	List of install base items covered under the  service contract line. Data type: Array of Objects `"install_base_items_covered": [ { "added": "String", "install_base": "String", "removed": "String" } ]` Stored in: Sold Product Covered  [sn_install_base_m2m_contract_sold_product]
service_contract_lines.child_contract_lines.install_base_items_covered.added	Date that the associated install base item was added to the service contract line. Data type: String Format: yyyy-mm-dd Default: Current date
service_contract_lines.child_contract_lines.install_base_items_covered.install_base	Sys_id of the install base item covered by the service contract line. Data type: String Table: Install Base Item [sn_install_base_item]
service_contract_lines.child_contract_lines.install_base_items_covered.removed	Date that the associated service contract line ends coverage of the install base item. Data type: String Format: yyyy-mm-dd Default: No end date
service_contract_lines.child_contract_lines.name	Name of the service contract line. Data type: String
service_contract_lines.child_contract_lines.product_model	Sys_id of the product associated with the service contract line. Data type: String Table: Product Model [cmdb_model]
service_contract_lines.child_contract_lines.product_offering	Sys_id of the product offering record associated with the service contract line. Data type: String Table: Product Offering [sn_prd_pm_product_offering]
service_contract_lines.child_contract_lines.product_specification	Sys_id of the product specification record associated with the service contract line. Data type: String Table: Product Specification [sn_prd_pm_product_specification]
service_contract_lines.child_contract_lines.sold_product	Sys_id of the sold product record associated with the service contract line. Data type: String Table: Sold Product [sn_install_base_sold_product]
service_contract_lines.child_contract_lines.sold_products_covered	List of products covered under the service contract line. Data type: Array of Objects `"sold_products_covered": [ { "added": "String", "removed": "String", "sold_product": "String" } ]`
service_contract_lines.child_contract_lines..sold_products_covered.added	Date that the associated service contract line starts to cover the associated product. Data type: String Format: yyyy-mm-dd Default: Current date
service_contract_lines.child_contract_lines.sold_products_covered.removed	Date that the associated service contract line ends coverage of the associated product. Data type: String Format: yyyy-mm-dd Default: No end date
service_contract_lines.child_contract_lines.sold_products_covered.sold_product	Sys_id of a product associated with the service contract line. Data type: String Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
service_contract_lines.child_contract_lines.starts	Required. Start date of the service contract line. Data type: String Format: yyyy-mm-dd
service_contract_lines.child_contract_lines.state	Required. Current state of the contract line. Valid values: (case-sensitive) active cancelled draft expired suspended Data type: String
service_contract_lines.ends	Date on which the service contract line ends. Data type: String Format: yyyy-mm-dd Default: Never ends until manually removed.
service_contract_lines.entitlements	List of entitlements to associate with the service contract line. These entitlements are inserted in the Entitlement [service_entitlement] table. Data type: Array of Objects `"entitlements:" [ { "account": "String", "consumer": "String", "end_date": "String", "entitlement_characteristics": [Array], "entitlement_name": "String", "household": "String", "install_base_items_covered": [Array], "product": "String", "product_offering": "String", "product_specification": "String", "sold_entitlement": "String", "sold_products_covered": [Array], "start_date": "String", "state": "String" } ]`
service_contract_lines.entitlements.account	Sys_id of the account record to which the entitlement belongs. Data type: String Table: Account [customer_account]
service_contract_lines.entitlements.consumer	Sys_id of the consumer record to which the entitlement belongs. Data type: String Table: Consumer [csm_consumer]
service_contract_lines.entitlements.end_date	End date of the entitlement. Data type: String Format: yyyy-mm-dd Default: Never ends until manually removed.
service_contract_lines.entitlements.entitlement_characteristics	List of characteristics associated with the entitlement. Data type: Array of Objects `"entitlement_characteristics": [ { "characteristic": "String", "characteristic_option": "String", "entitlement_usage": {Object}, "type": "String", "value": "String" } ]` Stored in: Characteristic [sn_pss_core_entitlement_characteristic]
service_contract_lines.entitlements.entitlement_characteristics.characteristic	Required. Sys_id of the characteristic record associated with the entitlement. Data type: String Table: Characteristic [sn_prd_pm_characteristic]
service_contract_lines.entitlements.entitlement_characteristics.characteristic_option	Sys_id of the characteristic option record associated with the entitlement. Data type: String Table: Characteristic Option [sn_prd_pm_characteristic_option]
service_contract_lines.entitlements.entitlement_characteristics.entitlement_usage	Used unit value for the associated entitlement characteristic. Only pass this parameter if the entitlement_characteristics are under the entitlement. Data type: Object `"entitlement_usage": { "used_units": "String" }` Stored in: Entitlement Usage [sn_pss_core_entitlement_usage]
service_contract_lines.entitlements.entitlement_characteristics.entitlement_usage.usage_units	Usage of the associated entitlement characteristic. Data type: String
service_contract_lines.entitlements.entitlement_characteristics.type	Type of entitlement characteristic. Valid values: coverage coverage_and_usage Data type: String
service_contract_lines.entitlements.entitlement_characteristics.value	Required if the input_type parameter contained in the record specified in the entitlement_characteristics.characteristic parameter, is not `choice`. Value of the characteristic. Data type: String
service_contract_lines.entitlements.entitlement_name	Required. Name of the entitlement. Data type: String
service_contract_lines.entitlements.household	Only passed when the household plugins are active and the consumer parameter is passed. Sys_id of the household record associated with the entitlement. Data type: String Table: Household [csm_household]
service_contract_lines.entitlements.install_base_items_covered	List of install base items covered under the entitlement. The information in this array is inserted in the Sold Product Covered  [sn_install_base_m2m_contract_sold_product] table. Data type: Array of Objects `"install_base_items_covered": [ { "added": "String", "install_base": "String", "removed": "String" } ]`
service_contract_lines.entitlements.install_base_items_covered.added	Date that the associated install base item was added to the entitlement. Data type: String Format: yyyy-mm-dd Default: Current date
service_contract_lines.entitlements.install_base_items_covered.install_base	Sys_id of the install base item covered by the entitlement. Data type: String Table: Install Base Item [sn_install_base_item]
service_contract_lines.entitlements.install_base_items_covered.removed	Date that the associated install base item was removed from the entitlement. Data type: String Format: yyyy-mm-dd Default: No end date
service_contract_lines.entitlements.product	Sys_id of the product model record associated with the entitlement. Data type: String Table: Product Model [cmdb_model]
service_contract_lines.entitlements.product_offering	Sys_id of the product offering record associated with the entitlement. Data type: String Table: Product Offering [sn_prd_pm_product_offering]
service_contract_lines.entitlements.product_specification	Sys_id of the product specification record associated with the entitlement. Data type: String Table: Product Specification [sn_prd_pm_product_specification]
service_contract_lines.entitlements.sold_entitlement	Sys_id of the sold product record associated with the entitlement. Data type: String Table: Sold Product [sn_install_base_sold_product]
service_contract_lines.entitlements.sold_products_covered	List of sold products covered under the entitlement. Data type: Array of Objects `"sold_products_covered": [ { "added": "String", "removed": "String", "sold_product": "String" } ]`
service_contract_lines.entitlements.sold_products_covered.added	Date that the associated sold product was added to the entitlement. Data type: String Format: yyyy-mm-dd Default: Current date
service_contract_lines.entitlements.sold_products_covered.removed	Date that the associated sold product was removed from the entitlement. Data type: String Format: yyyy-mm-dd Default: No end date
service_contract_lines.entitlements.sold_products_covered.sold_product	Sys_id of a product associated with the entitlement. Data type: String Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
service_contract_lines.entitlements.start_date	Required. Start date of the entitlement. Data type: String Format: yyyy-mm-dd
service_contract_lines.entitlements.state	Required. Current state of the entitlement. Valid values: (case-sensitive) active cancelled draft expired suspended Data type: String
service_contract_lines.entitlement_characteristics	List of characteristics associated with the service contract line. Data type: Array of Objects `"entitlement_characteristics" [ { "characteristic": "String", "characteristic_option": "String", "entitlement_usage": {Object}, "type": "String", "value": "String" } ]` Stored in: Characteristic [sn_pss_core_entitlement_characteristic]
service_contract_lines.entitlement_characteristics.characteristic	Required. Sys_id of the characteristic record associated with the service contract line. Data type: String Table: Characteristic [sn_prd_pm_characteristic]
service_contract_lines.entitlement_characteristics.characteristic_option	Sys_id of the characteristic option record associated with the service contract line. Data type: String Table: Characteristic Option [sn_prd_pm_characteristic_option]
service_contract_lines.entitlement_characteristics.entitlement_usage	Used unit value for the associated service contract line characteristic. Data type: Object `"entitlement_usage": { "used_units": "String" }` Stored in: Entitlement Usage [sn_pss_core_entitlement_usage]
service_contract_lines.entitlement_characteristics.entitlement_usage.usage_units	Usage of the associated entitlement characteristic. Data type: String
service_contract_lines.entitlement_characteristics.type	Type of service contract line characteristic. Valid values: coverage coverage _and_usage Data type: String
service_contract_lines.entitlement_characteristics.value	Required if the entitlement_characteristics.type parameter is not passed. Value of the characteristic. Data type: String
service_contract_lines.install_base_items_covered	List of install base items covered under the  service contract line. Data type: Array of Objects `"install_base_items_covered": [ { "added": "String", "install_base": "String", "removed": "String" } ]` Stored in: Sold Product Covered  [sn_install_base_m2m_contract_sold_product]
service_contract_lines.install_base_items_covered.added	Date that the associated install base item was added to the service contract line. Data type: String Format: yyyy-mm-dd Default: Current date
service_contract_lines.install_base_items_covered.install_base	Sys_id of the install base item covered by the service contract line. Data type: String Table: Install Base Item [sn_install_base_item]
service_contract_lines.install_base_items_covered.removed	Date that the associated service contract line ends coverage of the install base item. Data type: String Format: yyyy-mm-dd Default: No end date
service_contract_lines.name	Name of the service contract line. Data type: String
service_contract_lines.product_model	Sys_id of the product associated with the service contract line. Data type: String Table: Product Model [cmdb_model]
service_contract_lines.product_offering	Sys_id of the product offering record associated with the service contract line. Data type: String Table: Product Offering [sn_prd_pm_product_offering]
service_contract_lines.product_specification	Sys_id of the product specification record associated with the service contract line. Data type: String Table: Product Specification [sn_prd_pm_product_specification]
service_contract_lines.sold_product	Sys_id of the sold product record associated with the service contract line. Data type: String Table: Sold Product [sn_install_base_sold_product]
service_contract_lines.sold_products_covered	List of products covered under the service contract line. Data type: Array of Objects `"sold_products_covered": [ { "added": "String", "removed": "String", "sold_product": "String" } ]`
service_contract_lines.sold_products_covered.added	Date that the associated service contract line starts to cover the associated product. Data type: String Format: yyyy-mm-dd Default: Current date
service_contract_lines.sold_products_covered.removed	Date that the associated service contract line ends coverage of the associated product. Data type: String Format: yyyy-mm-dd Default: No end date
service_contract_lines.sold_products_covered.sold_product	Sys_id of a product associated with the service contract line. Data type: String Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
service_contract_lines.starts	Required. Start date of the service contract line. Data type: String Format: yyyy-mm-dd
service_contract_lines.state	Required. Current state of the contract line. Valid values: (case-sensitive) active cancelled draft expired suspended Data type: String
short_description	Brief description or name of the service contract. Data type: String Default: null (empty string)
sold_products_covered	Required if the install_base_items_covered parameter is not specified. List of products covered under the service contract. The data in this parameter is inserted in the Sold Product Covered [sn_install_base_m2m_contract_sold_product] table. Data type: Array of Objects `"sold_products_covered": [ { "added": "String", "removed": "String", "sold_product": "String" } ]`
sold_products_covered.added	Date that the associated service contract starts to cover the product. Data type: String Format: yyyy-mm-dd Default: Current date
sold_products_covered.removed	Date that the associated service contract ends coverage of the associated product. Data type: String Format: yyyy-mm-dd Default: No end date
sold_products_covered.sold_product	Sys_id of the product covered by the service contract. Data type: String Table: Sold Product [sn_install_base_sold_product]
starts	Required. Date on which the service contract begins. Data type: String Format: yyyy-mm-dd
state	Required. Current state of the service contract. Valid values: (case-sensitive) active cancelled draft expired Data type: String
vendor_contract	Required. Unique identifier for an associated external contract. Data type: String

Headers

Table 16. Request headers
Header	Description
Accept	Data format of the response body. Supported types: application/json or application/xml. Default: application/json
Content-Type	Data format of the request body. Supported types: application/json or application/xml. Default: application/json

Table 17. Response headers
Header	Description
None

Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.

Table 18. Status codes
Status code	Description
201	Successful. The request was successfully processed and the records were created.
400	Bad Request. A bad request type or malformed request was detected.
403	Forbidden. The user doesn't have permission to access the API.
500	Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.

Response body parameters (JSON or XML)


Name	Description
install_base_items_covered	List of sys_ids of the install base items covered under the service contract. Data type: Array of Objects `"install_base_items_covered": [ { "sys_id": "String" } ]`
install_base_items_covered.sys_id	Sys_id of the install base item covered. Data type: String Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
number	Auto-generated service contract number. Data type: String
service_contract_lines	List of service contract lines associated with the service contract. Data type: Array of Objects `"service_contract_lines": [ { "child_contract_lines": [Array], "entitlements": [Array], "entitlement_characteristics": [Array], "install_base_items_covered": [Array], "name": "String", "number": "String", "sold_products_covered": [Array], "sys_id": "String" } ]`
service_contract_lines.child_contract_lines	List of child service contract line objects created under the service contract line. Data type: Array of Objects `"child_contract_lines": [ { "child_contract_lines": [Array], "entitlements": [Array], "entitlement_characteristics": [Array], "install_base_items_covered": [Array], "name": "String", "number": "String", "sold_products_covered": [Array], "sys_id" "String" } ]`
service_contract_lines.child_contract_lines.child_contract_lines	List of child service contract line objects created under the child service contract line. The objects in this array have the same elements as the service_contract_lines.child_contract_lines parameter. Data type: Array of Objects
service_contract_lines.child_contract_lines.entitlements	List of entitlements associated with the child service contract line. Data type: Array of Objects `"entitlements": [ { "entitlement_name": "String", "entitlement_characteristics": [Array], "install_base_items_covered": [Array], "sold_products_covered": [Array], "sys_id": "String" } ]`
service_contract_lines.child_contract_lines.entitlements.entitlement_name	Name of the entitlement. Data type: String
service_contract_lines.child_contract_lines.entitlements.entitlement_characteristics	List of the entitlement characteristic objects  created under the entitlement. Data type: Array of Objects `"entitlement_characteristics": [ { "sys_id": "String" } ]`
service_contract_lines.child_contract_lines.entitlements.entitlement_characteristics.sys_id	Sys_id of an entitlement characteristics record associated with the child service contract line. Data type: String Table: Characteristic [sn_pss_core_entitlement_characteristic]
service_contract_lines.child_contract_lines.entitlements.install_base_items_covered	List of sys_ids of the install base items covered under the entitlement. Data type: Array of Objects `"install_base_items_covered": [ { "sys_id": "String" } ]`
service_contract_lines.child_contract_lines.entitlements.install_base_items_covered.sys_id	Sys_id of a install base items covered by the entitlement. Data type: String Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
service_contract_lines.child_contract_lines.entitlements.sold_products_covered	List of sys_ids of the products covered under the entitlement. Data type: Array of Objects `"sold_products_covered": [ { "sys_id": "String" } ]`
service_contract_lines.child_contract_lines.entitlements.sold_products_covered.sys_id	Sys_id of a product associated with the entitlement. Data type: String Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
service_contract_lines.child_contract_lines.entitlements.sys_id	Sys_id of the entitlement record associated with the child service contract line. Data type: String Table: Entitlement [service_entitlement]
service_contract_lines.child_contract_lines.entitlement_characteristics	List of characteristics associated with the chile contract line. Data type: Array of Objects `"entitlement_characteristics": [ { "entitlement_usage": {Object}, "sys_id": "String" } ]`
service_contract_lines.child_contract_lines.entitlement_characteristics.entitlement_usage	Entitlement usage object inserted under the entitlement_characteristic. Data type: Object `"entitlement_usage": { "sys_id": "String" }`
service_contract_lines.child_contract_lines.entitlement_characteristics.entitlement_usage.sys_id	Sys_id of the entitlement usage record. Data type: String Table: Entitlement Usage [sn_pss_core_entitlement_usage]
service_contract_lines.child_contract_lines.entitlement_characteristics.sys_id	Sys_id of a entitlement characteristics record associated with the child service contract line. Data type: String Table: Characteristic [sn_pss_core_entitlement_characteristic]
service_contract_lines.child_contract_lines.install_base_items_covered	List of sys_ids of the install base items covered under the child contract line. Data type: Array of Objects `"install_base_items_covered": [ { "sys_id": "String" } ]`
service_contract_lines.child_contract_lines.install_base_items_covered.sys_id	Sys_id of the install base item covered. Data type: String Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
service_contract_lines.child_contract_lines.name	Name of the child service contract line. Data type: String
service_contract_lines.child_contract_lines.number	Unique number of the service contract line. Automatically generated by the endpoint. For example: CTRL000001. Data type: String
service_contract_lines.child_contract_lines.sold_products_covered	List of sys_ids of the products covered under the child service contract line. Data type: Array of Objects `"sold_products_covered": [ { "sys_id": "String" } ]`
service_contract_lines.child_contract_lines.sold_products_covered.sys_id	Sys_id of a product covered by the child service contract line. Data type: String Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
service_contract_lines.child_contract_lines.sys_id	Sys_id of a child service contract line record. Data type: String Table: Service Contract Line [sn_pss_core_service_contract_line]
service_contract_lines.entitlements	List of entitlements associated with the service contract. Data type: Array of Objects `"entitlements" [ { "entitlement_name": "String", "entitlement_characteristics": [Array], "install_base_items_covered": [Array], "sold_products_covered": [Array], "sys_id": "String" } ]`
service_contract_lines.entitlements.entitlement_name	Name of the entitlement. Data type: String
service_contract_lines.entitlements.entitlement_characteristics	List of the entitlement characteristic objects  created under the entitlement. Data type: Array of Objects `"entitlement_characteristics" [ { "entitlement_usage": {Object}, "sys_id": "String" } ]`
service_contract_lines.entitlements.entitlement_characteristics.entitlement_usage	Entitlement usage object inserted under the entitlement_characteristic. Data type: Object `"entitlement_usage": { "sys_id": "String" }`
service_contract_lines.entitlements.entitlement_characteristics.entitlement_usage.sys_id	Sys_id of the entitlement usage record. Data type: String Table: Entitlement Usage [sn_pss_core_entitlement_usage]
service_contract_lines.entitlements.entitlement_characteristics.sys_id	Sys_id of a entitlement characteristics record associated with the service contract line. Data type: String Table: Characteristic [sn_pss_core_entitlement_characteristic]
service_contract_lines.entitlements.install_base_items_covered	List of sys_ids of the install base items covered under the entitlement. Data type: Array of Objects `"install_base_items_covered": [ { "sys_id": "String" } ]`
service_contract_lines.entitlements.install_base_items_covered.sys_id	Sys_id of a install base items covered by the entitlement. Data type: String Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
service_contract_lines.entitlements.sold_products_covered	List of sys_ids of the products covered under the entitlement. Data type: Array of Objects `"sold_products_covered": [ { "sys_id": "String" } ]`
service_contract_lines.entitlements.sold_products_covered.sys_id	Sys_id of a product associated with the entitlement. Data type: String Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
service_contract_lines.entitlements.sys_id	Sys_id of the entitlement record associated with the service contract line. Data type: String Table: Entitlement [service_entitlement]
service_contract_lines.entitlement_characteristics	List of characteristics associated with the chile contract line. Data type: Array of Objects `"entitlement_characteristics": [ { "entitlement_usage": {Object}, "sys_id": "String" } ]`
service_contract_lines.entitlement_characteristics.entitlement_usage	Entitlement usage object inserted under the entitlement_characteristic. Data type: Object `"entitlement_usage": { "sys_id": "String" }`
service_contract_lines.entitlement_characteristics.entitlement_usage.sys_id	Sys_id of the entitlement usage record. Data type: String Table: Entitlement Usage [sn_pss_core_entitlement_usage]
service_contract_lines.entitlement_characteristics.sys_id	Sys_id of a entitlement characteristics record associated with the child service contract line. Data type: String Table: Characteristic [sn_pss_core_entitlement_characteristic]
service_contract_lines.install_base_items_covered	List of sys_ids of the install base items covered under the child contract line. Data type: Array of Objects `"install_base_items_covered": [ { "sys_id": "String" } ]`
service_contract_lines.install_base_items_covered.sys_id	Sys_id of the install base item covered. Data type: String Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
service_contract_lines.name	Name of the child service contract line. Data type: String
service_contract_lines.number	Unique number of the service contract line. Automatically generated by the endpoint. For example: CTRL000001. Data type: String
service_contract_lines.sold_products_covered	List of sys_ids of the products covered under the service contract line. Data type: Array of Objects `"sold_products_covered": [ { "sys_id": "String" } ]`
service_contract_lines.sold_products_covered.sys_id	Sys_id of a product covered by the service contract line. Data type: String Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
service_contract_lines.sys_id	Sys_id of a service contract line record. Data type: String Table: Service Contract Line [sn_pss_core_service_contract_line]
short_description	Brief description or name of the service contract. Data type: String
sold_products_covered	List of sys_ids of the products covered under the service contract. Data type: Array of Objects `"sold_products_covered": [ { "sys_id": "String" } ]`
sold_products_covered.sys_id	Sys_id of a product covered by the service contract. Data type: String Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
sys_id	Sys_id of the service contract record. Data type: String Table: Service Contract [sn_pss_core_service_contract]

cURL request

The following is a code example that shows how to call this endpoint and create a service contract with one sold product covered record, one install base items covered record, and two service contract lines.

curl "https://instance.servicenow.com/api/sn_pss_core/servicecontract" \
--request POST \
--header "Accept:application/json" \
--data
{
  "state": "active",
  "account": "4c325111d1f53110f8776589fa411f3d",
  "vendor_contract": "External Reference",
  "starts": "2022-12-03",
  "service_contract_lines": [
    {
      "state": "active",
      "name": "CLI",
      "starts": "2022-12-03",
      "child_contract_lines": [
        {
          "state": "active",
          "name": "Child CLI",
          "starts": "2022-12-03",
          "entitlements": [
            {
              "state": "active",
              "entitlement_name": "Child CLI - ENTL",
              "start_date": "2022-12-03"
            }
          ],
          "sold_products_covered": [
            {
              "sold_product": "8db4258949f14ef7b90d90822dfc5800",
              "added": "2023-12-03",
              "removed": "2023-12-03"
            }
          ],
          "install_base_items_covered": [
            {
              "install_base": "2f270832699b46e78aa899a5a5dc6682",
              "added": "2023-12-03",
              "removed": "2023-12-03"
            }
          ],
          "entitlement_characteristics": [
            {
              "characteristic": "63418db7539e61106bfcddeeff7b1238",
              "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
              "value": "20",
              "type": "coverage"
            }
          ]
        }
      ],
      "entitlements": [
        {
          "state": "active",
          "entitlement_name": "ENTL",
          "start_date": "2022-12-03",
          "sold_products_covered": [
            {
              "sold_product": "da23d151d1f53110f8776589fa411f27"
            }
          ],
          "install_base_items_covered": [
            {
              "install_base": "43739151d1f53110f8776589fa411fc1",
              "added": "2023-12-03",
              "removed": "2023-12-03"
            }
          ],
          "entitlement_characteristics": [
            {
              "characteristic": "63418db7539e61106bfcddeeff7b1238",
              "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
              "value": "20",
              "type": "coverage_and_usage",
              "entitlement_usage": {
                "used_units": "3"
              }
            }
          ]
        }
      ],
      "sold_products_covered": [
        {
          "sold_product": "ec235d9dd1b53110f8776589fa411fe2",
          "added": "2023-12-03",
          "removed": "2023-12-03"
        }
      ],
      "install_base_items_covered": [
        {
          "install_base": "a1731551d1f53110f8776589fa411f8d",
          "added": "2023-12-03",
          "removed": "2023-12-03"
        }
      ],
      "entitlement_characteristics": [
        {
          "characteristic": "63418db7539e61106bfcddeeff7b1238",
          "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
          "value": "20",
          "type": "coverage"
        }
      ]
    },
    {
      "state": "active",
      "name": "CLI 2",
      "starts": "2022-12-03",
      "sold_products_covered": [
        {
          "sold_product": "7f23995dd1b53110f8776589fa411f66",
          "added": "2023-12-03",
          "removed": "2023-12-03"
        }
      ],
      "install_base_items_covered": [
        {
          "install_base": "a483d951d1f53110f8776589fa411fad",
          "added": "2023-12-03",
          "removed": "2023-12-03"
        }
      ],
      "entitlement_characteristics": [
        {
          "characteristic": "63418db7539e61106bfcddeeff7b1238",
          "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
          "value": "20",
          "type": "coverage"
        }
      ]
    }
  ],
  "sold_products_covered": [
    {
      "sold_product": "0df21151d1f53110f8776589fa411f1b",
      "added": "2023-12-03",
      "removed": "2023-12-03"
    }
  ],
  "install_base_items_covered": [
    {
      "install_base": "e2639951d1f53110f8776589fa411f2b",
      "added": "2023-12-03",
      "removed": "2023-12-03"
    }
  ]
} 
--user "username":"password"

Response:

{
  "result": {
    "sys_id": "d8641151d1f53110f8776589fa411fde",
    "number": "CNTR0010004",
    "short_description": null,
    "service_contract_lines": [
      {
        "sys_id": "d4641d91d1f53110f8776589fa411fbb",
        "name": "CLI",
        "number": "CTRL0000001,                                                                                                 
        "child_contract_lines": [
          {
            "sys_id": "3a39ecdc01154f4ab782da0169c9c922",
            "name": "Child CLI",
            "number": "CTRL0000002",
            "child_contract_lines": [],
            "entitlements": [
              {
                "sys_id": "7439fd84c2494ba6951e58f333cfe8d4",
                "entitlement_name": "Child CLI - ENTL",
                "sold_products_covered": [],
                "install_base_items_covered": [],
                "entitlement_characteristics": []
              }
            ],
            "sold_products_covered": [
              {
                "sys_id": "dfb62e9c4c6843009be02a68f65b9118"
              }
            ],
            "install_base_items_covered": [
              {
                "sys_id": "2583912e81964501b52a2e44d4797a28"
              }
            ],
            "entitlement_characteristics": [
              {
                "sys_id": "3a00c975bb49412cae169200c7f6236e",
                "entitlement_usage": {}
              }
            ]
          }
        ],
        "entitlements": [
          {
            "sys_id": "a8641d91d1f53110f8776589fa411fc0",
            "entitlement_name": "ENTL",
            "sold_products_covered": [
              {
                "sys_id": "a0641d91d1f53110f8776589fa411fc2"
              }
            ],
            "install_base_items_covered": [
              {
                "sys_id": "e0641d91d1f53110f8776589fa411fc3"
              }
            ],
            "entitlement_characteristics": [
              {
                "sys_id": "a8641d91d1f53110f8776589fa411fd0",
                "entitlement_usage": {
                  "sys_id": "a8641d91d1f53110f8776589fa411fd1"
                }
              }
            ]
          }
        ],
        "sold_products_covered": [
          {
            "sys_id": "98641d91d1f53110f8776589fa411fbc"
          }
        ],
        "install_base_items_covered": [
          {
            "sys_id": "58641d91d1f53110f8776589fa411fbd"
          }
        ],
        "entitlement_characteristics": [
          {
            "sys_id": "e0641d91d1f53110f8776589fa411fbf",
            "entitlement_usage": {}
          }
        ]
      },
      {
        "sys_id": "e4641d91d1f53110f8776589fa411fd2",
        "name": "CLI 2",
        "number": "CTRL0000003",
        "child_contract_lines": [],
        "entitlements": [],
        "sold_products_covered": [
          {
            "sys_id": "e8641d91d1f53110f8776589fa411fd3"
          }
        ],
        "install_base_items_covered": [
          {
            "sys_id": "a8641d91d1f53110f8776589fa411fd4"
          }
        ],
        "entitlement_characteristics": [
          {
            "sys_id": "a8641d91d1f53110f8776589fa411fd5",
            "entitlement_usage": {}
          }
        ]
      }
    ],
    "sold_products_covered": [
      {
        "sys_id": "9c641d91d1f53110f8776589fa411fb9"
      }
    ],
    "install_base_items_covered": [
      {
        "sys_id": "d8641d91d1f53110f8776589fa411fba"
      }
    ]
  }
}

Service Contract - POST /sn_pss_core/servicecontract/contractline

Creates a contract line record and all of its related entities.

This endpoint stores data in the following tables when processing the request:

Characteristic [sn_pss_core_entitlement_characteristic]
Entitlement [service_entitlement]
Entitlement Usage [sn_pss_core_entitlement_usage]
Sold Product Covered [sn_install_base_m2m_contract_sold_product] - This table contains information for both sold products covered and install base items covered.
Service Contract Line [sn_pss_core_service_contract_line]

URL format

Versioned URL: /api/sn_pss_core/{api_version}/servicecontract/contractline

Default URL: /api/sn_pss_core/servicecontract/contractline

Note:

Available versions are specified in the REST API Explorer. For scripted REST APIs there is additional version information on the Scripted REST Service form.

Supported request parameters

Table 19. Path parameters
Name	Description
api_version	Optional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String

Table 20. Query parameters
Name	Description
None

Table 21. Request body parameters (XML or JSON)
Name	Description
child_contract_lines	List of child service contract line objects created under the service contract line. Data type: Array of Objects `"child_contract_lines": [ { "child_contract_lines": [Array], "contract": "String", "ends": "String", "entitlements": [Array], "entitlement_characteristics": [Array], "install_base_items_covered": [Array], "name": "String", "parent_contract_line": "String", "product_model": "String", "product_offering": "String", "product_specification": "String", "sold_product": "String", "sold_products_covered": [Array], "starts": "String", "state": "String" } ]` Stored in: Service Contract [sn_pss_core_service_contract]
child_contract_lines.child_contract_lines	List of child service contract line objects to create under the child service contract line. The objects in this array have the same elements as the objects in the child_contract_lines parameter. Data type: Array of Objects
child_contract_lines.contract	Sys_id of the service contract associated with the child service contract line. Data type: String Table: Service Contract [sn_pss_core_service_contract]
child_contract_lines.ends	Date on which the child service contract line ends. Data type: String Format: yyyy-mm-dd Default: Never ends until manually removed.
child_contract_lines.entitlements	List of entitlements associated with the child service contract line. Data type: Array of Objects `"entitlements:" [ { "account": "String", "consumer": "String", "end_date": "String", "entitlement_characteristics": [Array], "entitlement_name": "String", "household": "String", "install_base_items_covered": [Array], "product": "String", "product_offering": "String", "product_specification": "String", "sold_entitlement": "String", "sold_products_covered": [Array], "start_date": "String", "state": "String" } ]` Stored in: Entitlement [service_entitlement]
child_contract_lines.entitlements.account	Required if the consumer parameter is not passed. Sys_id of the account record to which the entitlement belongs. Data type: String Table: Account [customer_account]
child_contract_lines.entitlements.consumer	Required if the account parameter is not passed. Sys_id of the consumer record to which the entitlement belongs. Data type: String Table: Consumer [csm_consumer]
child_contract_lines.entitlements.end_date	End date of the entitlement. Data type: String Format: yyyy-mm-dd Default: Never ends until manually removed.
child_contract_lines.entitlements.entitlement_characteristics	List of characteristics associated with the entitlement. Data type: Array of Objects `"entitlement_characteristics": [ { "characteristic": "String", "characteristic_option": "String", "entitlement_usage": {Object}, "type": "String", "value": "String" } ]` Stored in: Characteristic [sn_pss_core_entitlement_characteristic]
child_contract_lines.entitlements.entitlement_characteristics.characteristic	Required. Sys_id of the characteristic record associated with the entitlement. Data type: String Table: Characteristic [sn_prd_pm_characteristic]
child_contract_lines.entitlements.entitlement_characteristics.characteristic_option	Sys_id of the characteristic option record associated with the entitlement. Data type: String Table: Characteristic Option [sn_prd_pm_characteristic_option]
child_contract_lines.entitlements.entitlement_characteristics.entitlement_usage	Used unit value for the associated entitlement characteristic. Only pass this parameter if the entitlement_characteristics are under the entitlement. Data type: Object `"entitlement_usage": { "used_units": "String" }` Stored in: Entitlement Usage [sn_pss_core_entitlement_usage]
child_contract_lines.entitlements.entitlement_characteristics.entitlement_usage.used_units	Usage of the associated entitlement characteristic. Data type: String
child_contract_lines.entitlements.entitlement_characteristics.type	Type of entitlement characteristic. Valid values: coverage coverage_and_usage Data type: String
child_contract_lines.entitlements.entitlement_characteristics.value	Required if the input_type parameter contained in the record specified in the entitlement_characteristics.characteristic parameter, is not `choice`. Value of the characteristic. Data type: String
child_contract_lines.entitlements.entitlement_name	Required. Name of the entitlement. Data type: String
child_contract_lines.entitlements.household	Only passed when the household plugins are active and the consumer parameter is passed. Sys_id of the household record associated with the entitlement. Data type: String Table: Household [csm_household]
child_contract_lines.entitlements.install_base_items_covered	List of install base items covered under the entitlement. The information in this array is inserted in the Sold Product Covered  [sn_install_base_m2m_contract_sold_product] table. Data type: Array of Objects `"install_base_items_covered": [ { "added": "String", "install_base": "String", "removed": "String" } ]`
child_contract_lines.entitlements.install_base_items_covered.added	Date that the associated install base item was added to the entitlement. Data type: String Format: yyyy-mm-dd Default: Current date
child_contract_lines.entitlements.install_base_items_covered.install_base	Sys_id of the install base item covered by the entitlement. Data type: String Table: Install Base Item [sn_install_base_item]
child_contract_lines.entitlements.install_base_items_covered.removed	Date that the associated install base item was removed from the entitlement. Data type: String Format: yyyy-mm-dd Default: No end date
child_contract_lines.entitlements.product	Sys_id of the product model record associated with the entitlement. Data type: String Table: Product Model [cmdb_model]
child_contract_lines.entitlements.product_offering	Sys_id of the product offering record associated with the entitlement. Data type: String Table: Product Offering [sn_prd_pm_product_offering]
child_contract_lines.entitlements.product_specification	Sys_id of the product specification record associated with the entitlement. Data type: String Table: Product Specification [sn_prd_pm_product_specification]
child_contract_lines.entitlements.sold_entitlement	Sys_id of the sold product record associated with the entitlement. Data type: String Table: Sold Product [sn_install_base_sold_product]
child_contract_lines.entitlements.sold_products_covered	List of sold products covered under the entitlement. Data type: Array of Objects `"sold_products_covered": [ { "added": "String", "removed": "String", "sold_product": "String" } ]`
child_contract_lines.entitlements.sold_products_covered.added	Date that the associated sold product was added to the entitlement. Data type: String Format: yyyy-mm-dd Default: Current date
child_contract_lines.entitlements.sold_products_covered.removed	Date that the associated sold product was removed from the entitlement. Data type: String Format: yyyy-mm-dd Default: No end date
child_contract_lines.entitlements.sold_products_covered.sold_product	Sys_id of a product associated with the entitlement. Data type: String Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
child_contract_lines.entitlements.start_date	Required. Start date of the entitlement. Data type: String Format: yyyy-mm-dd
child_contract_lines.entitlements.state	Required. Current state of the entitlement. Valid values: (case-sensitive) active cancelled draft expired suspended Data type: String
child_contract_lines.entitlement_characteristics	List of characteristics associated with the entitlement. Data type: Array of Objects `"entitlement_characteristics": [ { "characteristic": "String", "characteristic_option": "String", "entitlement_usage": {Object}, "type": "String", "value": "String" } ]` Stored in: Characteristic [sn_pss_core_entitlement_characteristic]
child_contract_lines.entitlement_characteristics.characteristic	Sys_id of the characteristic record associated with the entitlement. Data type: String Table: Characteristic [sn_prd_pm_characteristic]
child_contract_lines.entitlement_characteristics.characteristic_option	Sys_id of the characteristic option record associated with the entitlement. Data type: String Table: Characteristic Option [sn_prd_pm_characteristic_option]
child_contract_lines.entitlement_characteristics.entitlement_usage	Used unit value for the associated entitlement characteristic. Only pass this parameter if the entitlement_characteristics are under the entitlement. Data type: Object `"entitlement_usage": { "used_units": "String" }` Stored in: Entitlement Usage [sn_pss_core_entitlement_usage]
child_contract_lines.entitlement_characteristics.entitlement_usage.used_units	Usage of the associated entitlement characteristic. Data type: String
child_contract_lines.entitlement_characteristics.type	Type of entitlement characteristic. Valid values: coverage coverage_and_usage Data type: String
child_contract_lines.entitlement_characteristics.value	Value of the characteristic. Data type: String
child_contract_lines.install_base_items_covered	List of install base items covered under the entitlement. The information in this array is inserted in the Sold Product Covered  [sn_install_base_m2m_contract_sold_product] table. Data type: Array of Objects `"install_base_items_covered": [ { "added": "String", "install_base": "String", "removed": "String" } ]`
child_contract_lines.install_base_items_covered.added	Date that the associated install base item was added to the child service contract line. Data type: String Format: yyyy-mm-dd Default: Current date
child_contract_lines.install_base_items_covered.install_base	Sys_id of the install base item covered by the child service contract line. Data type: String Table: Install Base Item [sn_install_base_item]
child_contract_lines.install_base_items_covered.removed	Date that the associated child service contract line ends coverage of the install base item. Data type: String Format: yyyy-mm-dd Default: No end date
child_contract_lines.name	Name of the child service contract line. Data type: String
child_contract_lines.parent_contract_line	Sys_id of the parent contract line record associated with the child service contract line. Data type: String
child_contract_lines.product_model	Sys_id of the product associated with the child service contract line. Data type: String Table: Product Model [cmdb_model]
child_contract_lines.product_offering	Sys_id of the product offering record associated with the child service contract line. Data type: String Table: Product Offering [sn_prd_pm_product_offering]
child_contract_lines.product_specification	Sys_id of the product specification record associated with the child service contract line. Data type: String Table: Product Specification [sn_prd_pm_product_specification]
child_contract_lines.sold_product	Sys_id of the sold product record associated with the child service contract line. Data type: String Table: Sold Product [sn_install_base_sold_product]
child_contract_lines.sold_products_covered	List of products covered under the child service contract line. Data type: Array of Objects `"sold_products_covered": [ { "added": "String", "removed": "String", "sold_product": "String" } ]`
child_contract_lines.sold_products_covered.added	Date that the associated child service contract line starts to cover the associated product. Data type: String Format: yyyy-mm-dd Default: Current date
child_contract_lines.sold_products_covered.removed	Date that the associated child service contract line ends coverage of the associated product. Data type: String Format: yyyy-mm-dd Default: No end date
child_contract_lines.sold_products_covered.sold_product	Sys_id of a product associated with the child service contract line. Data type: String Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
child_contract_lines.starts	Start date of the child service contract line. Data type: String Format: yyyy-mm-dd
child_contract_lines.state	Current state of the contract line. Valid values: (case-sensitive) active cancelled draft expired suspended Data type: String
contract	Sys_id of the service contract associated with the service contract line. Data type: String Table: Service Contract [sn_pss_core_service_contract]
ends	Date on which the service contract line ends. Data type: String Format: yyyy-mm-dd Default: Never ends until manually removed.
entitlements	List of entitlements to associate with the service contract line. These entitlements are inserted in the Entitlement [service_entitlement] table. Data type: Array of Objects `"entitlements:" [ { "account": "String", "consumer": "String", "end_date": "String", "entitlement_characteristics": [Array], "entitlement_name": "String", "household": "String", "install_base_items_covered": [Array], "product": "String", "product_offering": "String", "product_specification": "String", "sold_entitlement": "String", "sold_products_covered": [Array], "start_date": "String", "state": "String" } ]`
entitlements.account	Required if the consumer parameter is not passed. Sys_id of the account record to which the entitlement belongs. Data type: String Table: Account [customer_account]
entitlements.consumer	Required if the account parameter is not passed. Sys_id of the consumer record to which the entitlement belongs. Data type: String Table: Consumer [csm_consumer]
entitlements.end_date	End date of the entitlement. Data type: String Format: yyyy-mm-dd Default: Never ends until manually removed.
entitlements.entitlement_characteristics	List of characteristics associated with the entitlement. Data type: Array of Objects `"entitlement_characteristics": [ { "characteristic": "String", "characteristic_option": "String", "entitlement_usage": {Object}, "type": "String", "value": "String" } ]` Stored in: Characteristic [sn_pss_core_entitlement_characteristic]
entitlements.entitlement_characteristics.characteristic	Required. Sys_id of the characteristic record associated with the entitlement. Data type: String Table: Characteristic [sn_prd_pm_characteristic]
entitlements.entitlement_characteristics.characteristic_option	Sys_id of the characteristic option record associated with the entitlement. Data type: String Table: Characteristic Option [sn_prd_pm_characteristic_option]
entitlements.entitlement_characteristics.entitlement_usage	Used unit value for the associated entitlement characteristic. Only pass this parameter if the entitlement_characteristics are under the entitlement. Data type: Object `"entitlement_usage": { "used_units": "String" }` Stored in: Entitlement Usage [sn_pss_core_entitlement_usage]
entitlements.entitlement_characteristics.entitlement_usage.used_units	Usage of the associated entitlement characteristic. Data type: String
entitlements.entitlement_characteristics.type	Type of entitlement characteristic. Valid values: coverage coverage_and_usage Data type: String
entitlements.entitlement_characteristics.value	Required if the input_type parameter contained in the record specified in the entitlement_characteristics.characteristic parameter, is not `choice`. Value of the characteristic. Data type: String
entitlements.entitlement_name	Required. Name of the entitlement. Data type: String
entitlements.household	Only passed when the household plugins are active and the consumer parameter is passed. Sys_id of the household record associated with the entitlement. Data type: String Table: Household [csm_household]
entitlements.install_base_items_covered	List of install base items covered under the entitlement. The information in this array is inserted in the Sold Product Covered  [sn_install_base_m2m_contract_sold_product] table. Data type: Array of Objects `"install_base_items_covered": [ { "added": "String", "install_base": "String", "removed": "String" } ]`
entitlements.install_base_items_covered.added	Date that the associated install base item was added to the entitlement. Data type: String Format: yyyy-mm-dd Default: Current date
entitlements.install_base_items_covered.removed	Date that the associated install base item was removed from the entitlement. Data type: String Format: yyyy-mm-dd Default: No end date
entitlements.product	Sys_id of the product model record associated with the entitlement. Data type: String Table: Product Model [cmdb_model]
entitlements.product_offering	Sys_id of the product offering record associated with the entitlement. Data type: String Table: Product Offering [sn_prd_pm_product_offering]
entitlements.product_specification	Sys_id of the product specification record associated with the entitlement. Data type: String Table: Product Specification [sn_prd_pm_product_specification]
entitlements.sold_entitlement	Sys_id of the sold product record associated with the entitlement. Data type: String Table: Sold Product [sn_install_base_sold_product]
entitlements.sold_products_covered	List of sold products covered under the entitlement. Data type: Array of Objects `"sold_products_covered": [ { "added": "String", "removed": "String", "sold_product": "String" } ]`
entitlements.sold_products_covered.added	Date that the associated sold product was added to the entitlement. Data type: String Format: yyyy-mm-dd Default: Current date
entitlements.sold_products_covered.removed	Date that the associated sold product was removed from the entitlement. Data type: String Format: yyyy-mm-dd Default: No end date
entitlements.sold_products_covered.sold_product	Sys_id of a product associated with the entitlement. Data type: String Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
entitlements.start_date	Required. Start date of the entitlement. Data type: String Format: yyyy-mm-dd
entitlements.state	Required. Current state of the entitlement. Valid values: (case-sensitive) active cancelled draft expired suspended Data type: String
entitlement_characteristics	List of characteristics associated with the service contract line. Data type: Array of Objects `"entitlement_characteristics" [ { "characteristic": "String", "characteristic_option": "String", "entitlement_usage": {Object}, "type": "String", "value": "String" } ]` Stored in: Characteristic [sn_pss_core_entitlement_characteristic]
entitlement_characteristics.characteristic	Required. Sys_id of the characteristic record associated with the service contract line. Data type: String Table: Characteristic [sn_prd_pm_characteristic]
entitlement_characteristics.characteristic_option	Required if the input_type parameter contained in the record specified in the entitlement_characteristics.characteristic parameter, is set to `choice`. Sys_id of the characteristic option record associated with the service contract line. Data type: String Table: Characteristic Option [sn_prd_pm_characteristic_option]
entitlement_characteristics.entitlement_usage	Used unit value for the associated service contract line characteristic. Data type: Object `"entitlement_usage": { "used_units": "String" }` Stored in: Entitlement Usage [sn_pss_core_entitlement_usage]
entitlement_characteristics.entitlement_usage.used_units	Usage of the associated entitlement characteristic. Data type: String
entitlement_characteristics.type	Type of service contract line characteristic. Valid values: coverage coverage _and_usage Data type: String
entitlement_characteristics.value	Required if the entitlement_characteristics.type parameter is not passed. Value of the characteristic. Data type: String
install_base_items_covered	Required if the sold_products_covered parameter is not passed. List of install base items covered under the  service contract line. Data type: Array of Objects `"install_base_items_covered": [ { "added": "String", "install_base": "String", "removed": "String" } ]` Stored in: Sold Product Covered  [sn_install_base_m2m_contract_sold_product]
install_base_items_covered.added	Date that the associated install base item was added to the service contract line. Data type: String Format: yyyy-mm-dd Default: Current date
install_base_items_covered.install_base	Sys_id of the install base item covered by the service contract line. Data type: String Table: Install Base Item [sn_install_base_item]
install_base_items_covered.removed	Date that the associated service contract line ends coverage of the install base item. Data type: String Format: yyyy-mm-dd Default: No end date
name	Required. Name of the service contract line. Data type: String
parent_contract_line	Sys_id of the service contract line to which the current service contract line is a child of. Null for the contract lines created under a contract. Data type: String Table: Service Contract Line [sn_pss_core_service_contract_line]
product_model	Sys_id of the product associated with the service contract line. Data type: String Table: Product Model [cmdb_model]
product_offering	Sys_id of the product offering record associated with the service contract line. Data type: String Table: Product Offering [sn_prd_pm_product_offering]
product_specification	Sys_id of the product specification record associated with the service contract line. Data type: String Table: Product Specification [sn_prd_pm_product_specification]
sold_product	Sys_id of the sold product record associated with the service contract line. Data type: String Table: Sold Product [sn_install_base_sold_product]
sold_products_covered	Required if the install_base_items_covered parameter is not passed. List of products covered under the service contract line. Data type: Array of Objects `"sold_products_covered": [ { "added": "String", "removed": "String", "sold_product": "String" } ]` Data is stored in the Sold Products Covered  [sn_install_base_m2m_contract_sold_product] table.
sold_products_covered.added	Date that the associated service contract line starts to cover the associated product. Data type: String Format: yyyy-mm-dd Default: Current date
sold_products_covered.removed	Date that the associated service contract line ends coverage of the associated product. Data type: String Format: yyyy-mm-dd Default: No end date
sold_products_covered.sold_product	Sys_id of a product associated with the service contract line. Data type: String Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
starts	Required. Start date of the service contract line. Data type: String Format: yyyy-mm-dd
state	Required. Current state of the contract line. Valid values: (case-sensitive) active cancelled draft expired suspended Data type: String

Headers

Table 22. Request headers
Header	Description
Accept	Data format of the response body. Supported types: application/json or application/xml. Default: application/json
Content-Type	Data format of the request body. Supported types: application/json or application/xml. Default: application/json

Table 23. Response headers
Header	Description
None

Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.

Table 24. Status codes
Status code	Description
201	Successful. The request was successfully processed and the records were created.
400	Bad Request. A bad request type or malformed request was detected.
403	Forbidden. The user doesn't have permission to access the API.
500	Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.

Response body parameters (JSON or XML)


Name	Description
child_contract_lines	List of child service contract line objects created under the service contract line. Data type: Array of Objects `"child_contract_lines": [ { "child_contract_lines": [Array], "entitlements": [Array], "entitlement_characteristics": [Array], "install_base_items_covered": [Array], "name": "String", "number": "String", "sold_products_covered": [Array], "sys_id" "String" } ]`
child_contract_lines.child_contract_lines	List of child service contract line objects created under the child service contract line. The objects in this array have the same elements as the child_contract_lines parameter. Data type: Array of Objects
child_contract_lines.entitlements	List of entitlements associated with the child service contract line. Data type: Array of Objects `"entitlements": [ { "entitlement_name": "String", "entitlement_characteristics": [Array], "install_base_items_covered": [Array], "sold_products_covered": [Array], "sys_id": "String" } ]`
child_contract_lines.entitlements.entitlement_name	Name of the entitlement. Data type: String
child_contract_lines.entitlements.entitlement_characteristics	List of the entitlement characteristic objects  created under the entitlement. Data type: Array of Objects `"entitlement_characteristics": [ { "sys_id": "String" } ]`
child_contract_lines.entitlements.entitlement_characteristics.sys_id	Sys_id of an entitlement characteristics record associated with the child service contract line. Data type: String Table: Characteristic [sn_pss_core_entitlement_characteristic]
child_contract_lines.entitlements.install_base_items_covered	List of sys_ids of the install base items covered under the entitlement. Data type: Array of Objects `"install_base_items_covered": [ { "sys_id": "String" } ]`
child_contract_lines.entitlements.install_base_items_covered.sys_id	Sys_id of a install base items covered by the entitlement. Data type: String Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
child_contract_lines.entitlements.sold_products_covered	List of sys_ids of the products covered under the entitlement. Data type: Array of Objects `"sold_products_covered": [ { "sys_id": "String" } ]`
child_contract_lines.entitlements.sold_products_covered.sys_id	Sys_id of a product associated with the entitlement. Data type: String Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
child_contract_lines.entitlements.sys_id	Sys_id of the entitlement record associated with the child service contract line. Data type: String Table: Entitlement [service_entitlement]
child_contract_lines.entitlement_characteristics	List of characteristics associated with the chile contract line. Data type: Array of Objects `"entitlement_characteristics": [ { "entitlement_usage": {Object}, "sys_id": "String" } ]`
child_contract_lines.entitlement_characteristics.entitlement_usage	Entitlement usage object inserted under the entitlement_characteristic. Data type: Object `"entitlement_usage": { "sys_id": "String" }`
child_contract_lines.entitlement_characteristics.entitlement_usage.sys_id	Sys_id of the entitlement usage record. Data type: String Table: Entitlement Usage [sn_pss_core_entitlement_usage]
child_contract_lines.entitlement_characteristics.sys_id	Sys_id of a entitlement characteristics record associated with the child service contract line. Data type: String Table: Characteristic [sn_pss_core_entitlement_characteristic]
child_contract_lines.install_base_items_covered	List of sys_ids of the install base items covered under the child service contract line. Data type: Array of Objects `"install_base_items_covered": [ { "sys_id": "String" } ]`
child_contract_lines.install_base_items_covered.sys_id	Sys_id of the install base item covered. Data type: String Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
child_contract_lines.name	Name of the child service contract line. Data type: String
child_contract_lines.number	Unique number of the service contract line. Automatically generated by the endpoint. For example: CTRL9812347. Data type: String
child_contract_lines.sold_products_covered	List of sys_ids of the products covered under the child service contract line. Data type: Array of Objects `"sold_products_covered": [ { "sys_id": "String" } ]`
child_contract_lines.sold_products_covered.sys_id	Sys_id of a product covered by the child service contract line. Data type: String Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
child_contract_lines.sys_id	Sys_id of a product covered by the child contract item. Data type: String Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
entitlements	List of entitlements associated with the service contract line. Data type: Array of Objects `"entitlements": [ { "entitlement_characteristics": [Array], "entitlement_name": "String", "install_base_items_covered": [Array], "sold_products_covered": [Array], "sys_id": "String" } ]`
entitlements.entitlement_characteristics	List of the entitlement characteristic objects  created under the entitlement. Data type: Array of Objects `"entitlement_characteristics" [ { "entitlement_usage": {Object}, "sys_id": "String" } ]`
entitlements.entitlement_characteristics.entitlement_usage	Entitlement usage object inserted under the entitlement_characteristic. Data type: Object `"entitlement_usage": { "sys_id": "String" }`
entitlements.entitlement_characteristics.entitlement_usage.sys_id	Sys_id of the entitlement usage record. Data type: String Table: Entitlement Usage [sn_pss_core_entitlement_usage]
entitlements.entitlement_characteristics.sys_id	Sys_id of the entitlement characteristics record. Data type: String
entitlements.entitlement_name	Name of the entitlement. Data type: String
entitlements.install_base_items_covered	List of sys_ids of the install base items covered under the entitlement. Data type: Array of Objects `"install_base_items_covered": [ { "sys_id": "String" } ]`
entitlements.install_base_items_covered.sys_id	Sys_id of a install base items covered by the entitlement. Data type: String Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
entitlements.sold_products_covered	List of sys_ids of the products covered under the entitlement. Data type: Array of Objects `"sold_products_covered": [ { "sys_id": "String" } ]`
entitlements.sold_products_covered.sys_id	Sys_id of a product associated with the entitlement. Data type: String Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
entitlements.sys_id	Sys_id of the entitlement record associated with the service contract line. Data type: String Table: Entitlement [service_entitlement]
entitlement_characteristics	List of the entitlement characteristic objects  created under the service contract line. Data type: Array of Objects `"entitlement_characteristics" [ { "entitlement_usage": {Object}, "sys_id": "String" } ]`
entitlement_characteristics.entitlement_usage	Entitlement usage object inserted under the entitlement_characteristic. Data type: Object `"entitlement_usage": { "sys_id": "String" }`
entitlement_characteristics.entitlement_usage.sys_id	Sys_id of the entitlement usage record. Data type: String Table: Entitlement Usage [sn_pss_core_entitlement_usage]
entitlement_characteristics.sys_id	Sys_id of the entitlement characteristics record. Data type: String
install_base_items_covered	List of sys_ids of the install base items covered under the service contract line. Data type: Array of Objects `"install_base_items_covered": [ { "sys_id": "String" } ]`
install_base_items_covered.sys_id	Sys_id of the install base item covered. Data type: String Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
name	Name of the service contract line. Data type: String
number	Unique number of the service contract line. Automatically generated by the endpoint. For example: CTRL9812347. Data type: String
sold_products_covered	List of sys_ids of the products covered under the service contract line. Data type: Array of Objects `"sold_products_covered": [ { "sys_id": "String" } ]`
sold_products_covered.sys_id	Sys_id of a product covered by the service contract line. Data type: String Table: Sold Product Covered [sn_install_base_m2m_contract_sold_product]
sys_id	Sys_id of a service contract line record. Data type: String Table: Service Contract Line [sn_pss_core_service_contract_line]

cURL request

The following is a code example that shows how to call this endpoint and create a service contract line record.

curl "https://instance.servicenow.com/api/sn_pss_core/servicecontract/contractline" \
--request POST \
--header "Accept:application/json" \
--data
{
  "state": "active",
  "contract": "a4b415d1d1f53110f8776589fa411f20",
  "parent_contract_line": null,
  "name": "CLI",
  "starts": "2022-12-03",
  "child_contract_lines": [
    {
      "state": "active",
      "name": "Child CLI",
      "starts": "2022-12-03",
      "entitlements": [
        {
          "state": "active",
          "entitlement_name": "Child CLI - ENTL",
          "start_date": "2022-12-03"
        }
      ],
      "sold_products_covered": [
        {
          "sold_product": "8db4258949f14ef7b90d90822dfc5800",
          "added": "2023-12-03",
          "removed": "2023-12-03"
        }
      ],
      "install_base_items_covered": [
        {
          "install_base": "2f270832699b46e78aa899a5a5dc6682",
          "added": "2023-12-03",
          "removed": "2023-12-03"
        }
      ],
      "entitlement_characteristics": [
        {
          "characteristic": "63418db7539e61106bfcddeeff7b1238",
          "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
          "value": "20",
          "type": "coverage"
        }
      ]
    }
  ],
  "entitlements": [
    {
      "state": "active",
      "entitlement_name": "ENTL 1",
      "start_date": "2022-12-03",
      "sold_products_covered": [
        {
          "sold_product": "ec235d9dd1b53110f8776589fa411fe2"
        }
      ],
      "entitlement_characteristics": [
        {
          "characteristic": "63418db7539e61106bfcddeeff7b1238",
          "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
          "value": "20",
          "type": "coverage_and_usage",
          "entitlement_usage": {
            "used_units": "3"
          }
        }
      ]
    }
  ],
  "sold_products_covered": [
    {
      "sold_product": "0df21151d1f53110f8776589fa411f1b",
      "added": "2023-12-03",
      "removed": "2023-12-03"
    }
  ],
  "entitlement_characteristics": [
    {
      "characteristic": "63418db7539e61106bfcddeeff7b1238",
      "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
      "value": "tyfy6h",
      "type": "coverage"
    }
  ]
}

Response:

{
  "result": {
    "sys_id": "16e451d1d1f53110f8776589fa411f80",
    "name": "CLI",
    "number": "CTRL00000001",
    "child_contract_lines": [
      {
        "sys_id": "3a39ecdc01154f4ab782da0169c9c922",
        "name": "Child CLI",
        "number": "CTRL00000001",
        "child_contract_lines": [],
        "entitlements": [
          {
            "sys_id": "7439fd84c2494ba6951e58f333cfe8d4",
            "entitlement_name": "Child CLI - ENTL",
            "sold_products_covered": [],
            "install_base_items_covered": [],
            "entitlement_characteristics": []
          }
        ],
        "sold_products_covered": [
          {
            "sys_id": "dfb62e9c4c6843009be02a68f65b9118"
          }
        ],
        "install_base_items_covered": [
          {
            "sys_id": "2583912e81964501b52a2e44d4797a28"
          }
        ],
        "entitlement_characteristics": [
          {
            "sys_id": "3a00c975bb49412cae169200c7f6236e",
            "entitlement_usage": {}
          }
        ]
      }
    ],
    "entitlements": [
      {
        "sys_id": "9ee451d1d1f53110f8776589fa411f83",
        "entitlement_name": "ENTL 1",
        "sold_products_covered": [
          {
            "sys_id": "92e451d1d1f53110f8776589fa411f85"
          }
        ],
        "install_base_items_covered": [],
        "entitlement_characteristics": [
          {
            "sys_id": "92e451d1d1f53110f8776589fa411f86",
            "entitlement_usage": {
              "sys_id": "dee451d1d1f53110f8776589fa411f86"
            }
          }
        ]
      }
    ],
    "sold_products_covered": [
      {
        "sys_id": "5ae451d1d1f53110f8776589fa411f81"
      }
    ],
    "install_base_items_covered": [],
    "entitlement_characteristics": [
      {
        "sys_id": "dae451d1d1f53110f8776589fa411f82",
        "entitlement_usage": {}
      }
    ]
  }
}