Service Contract API

"install_base_items_covered": [ 
  {
    "added": "String",
    "install_base": "String",
    "removed": "String"
  }
]

"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"
  }
]

"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"
  }
]

"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"
  }
]

"entitlement_characteristics": [
  {
    "characteristic": "String",
    "characteristic_option": "String",
    "entitlement_usage": {Object},
    "type": "String",
    "value": "String"
  }
]

"entitlement_usage": {
    "used_units": "String"
}

</td></tr><tr><td>

service\_contract\_lines.​child\_contract\_lines.​entitlements.​install\_base\_items\_covered.​added

</td><td>

Date that the associated install base item was added to the entitlement.Data type: String

Format: yyyy-mm-dd

Default: Current date

</td></tr><tr><td>

service\_contract\_lines.​child\_contract\_lines.​entitlements.​install\_base\_items\_covered.​install\_base

</td><td>

Sys\_id of the install base item covered by the entitlement.Data type: String

Table: Install Base Item \[sn\_install\_base\_item\]

</td></tr><tr><td>

service\_contract\_lines.​child\_contract\_lines.​entitlements.​install\_base\_items\_covered.​removed

</td><td>

Date that the associated install base item was removed from the entitlement.Data type: String

Format: yyyy-mm-dd

Default: No end date

</td></tr><tr><td>

service\_contract\_lines.​child\_contract\_lines.​entitlements.​product

</td><td>

Sys\_id of the product model record associated with the entitlement.Data type: String

Table: Product Model \[cmdb\_model\]

</td></tr><tr><td>

service\_contract\_lines.​child\_contract\_lines.​entitlements.​product\_offering

</td><td>

Sys\_id of the product offering record associated with the entitlement.Data type: String

Table: Product Offering \[sn\_prd\_pm\_product\_offering\]

</td></tr><tr><td>

service\_contract\_lines.​child\_contract\_lines.​entitlements.​product\_specification

</td><td>

Sys\_id of the product specification record associated with the entitlement.Data type: String

Table: Product Specification \[sn\_prd\_pm\_product\_specification\]

</td></tr><tr><td>

service\_contract\_lines.​child\_contract\_lines.​entitlements.​sold\_entitlement

</td><td>

Sys\_id of the sold product record associated with the entitlement.Data type: String

Table: Sold Product \[sn\_install\_base\_sold\_product\]

</td></tr><tr><td>

service\_contract\_lines.​child\_contract\_lines.​entitlements.​sold\_products\_covered

</td><td>

List of sold products covered under the entitlement. Data type: Array of Objects

</td></tr><tr><td>

service\_contract\_lines.​child\_contract\_lines.​entitlements.​sold\_products\_covered.​added

</td><td>

Date that the associated sold product was added to the entitlement.Data type: String

Format: yyyy-mm-dd

Default: Current date

</td></tr><tr><td>

service\_contract\_lines.​child\_contract\_lines.​entitlements.​sold\_products\_covered.​removed

</td><td>

Date that the associated sold product was removed from the entitlement.Data type: String

Format: yyyy-mm-dd

Default: No end date

</td></tr><tr><td>

service\_contract\_lines.​child\_contract\_lines.​entitlements.​start\_date

</td><td>

Required. Start date of the entitlement.

Data type: String

Format: yyyy-mm-dd

</td></tr><tr><td>

service\_contract\_lines.​child\_contract\_lines.​entitlements.​state

</td><td>

Required.Current state of the entitlement.

Valid values: \(case-sensitive\)

-   active
-   cancelled
-   draft
-   expired
-   suspended

Data type: String

</td></tr><tr><td>

service\_contract\_lines.​child\_contract\_lines.​entitlement\_characteristics

</td><td>

List of characteristics associated with the service contract line.Data type: Array of Objects

Stored in: Characteristic \[sn\_pss\_core\_entitlement\_characteristic\]

</td></tr><tr><td>

service\_contract\_lines.​child\_contract\_lines.​entitlement\_characteristics.characteristic

</td><td>

Required. Sys\_id of the characteristic record associated with the service contract line.

Data type: String

Table: Characteristic \[sn\_prd\_pm\_characteristic\]

</td></tr><tr><td>

service\_contract\_lines.​child\_contract\_lines.​entitlement\_characteristics.characteristic\_option

</td><td>

Sys\_id of the characteristic option record associated with the service contract line.

Data type: String

Table: Characteristic Option \[sn\_prd\_pm\_characteristic\_option\]

</td></tr><tr><td>

service\_contract\_lines.​child\_contract\_lines.​entitlement\_characteristics.entitlement\_usage

</td><td>

Used unit value for the associated service contract line characteristic.Data type: Object

Stored in: Entitlement Usage \[sn\_pss\_core\_entitlement\_usage\]

</td></tr><tr><td>

service\_contract\_lines.​child\_contract\_lines.​entitlement\_characteristics.entitlement\_usage.​usage\_units

</td><td>

Usage of the associated entitlement characteristic.Data type: String

</td></tr><tr><td>

service\_contract\_lines.​child\_contract\_lines.​entitlement\_characteristics.type

</td><td>

Type of service contract line characteristic. Valid values:

-   coverage
-   coverage \_and\_usage

Data type: String

</td></tr><tr><td>

service\_contract\_lines.​child\_contract\_lines.​entitlement\_characteristics.value

</td><td><p>Required if the <strong>entitlement_characteristics.type</strong> parameter is not passed. Value of the characteristic.</p>
<p>Data type: String</p></td></tr><tr><td>

service\_contract\_lines.​child\_contract\_lines.​install\_base\_items\_covered

</td><td>

List of install base items covered under the  service contract line.

Data type: Array of Objects

Stored in: Sold Product Covered  \[sn\_install\_base\_m2m\_contract\_sold\_product\]

</td></tr><tr><td>

service\_contract\_lines.​child\_contract\_lines.​install\_base\_items\_covered.​added

</td><td>

Date that the associated install base item was added to the service contract line.

Data type: String

 Format: yyyy-mm-dd

 Default: Current date

</td></tr><tr><td>

service\_contract\_lines.​child\_contract\_lines.​install\_base\_items\_covered.​install\_base

</td><td>

Sys\_id of the install base item covered by the service contract line.Data type: String

Table: Install Base Item \[sn\_install\_base\_item\]

</td></tr><tr><td>

service\_contract\_lines.​child\_contract\_lines.​install\_base\_items\_covered.​removed

</td><td>

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

</td></tr><tr><td>

service\_contract\_lines.​child\_contract\_lines.​name

</td><td>

Name of the service contract line.

Data type: String

</td></tr><tr><td>

service\_contract\_lines.​child\_contract\_lines.​product\_model

</td><td>

Sys\_id of the product associated with the service contract line.Data type: String

Table: Product Model \[cmdb\_model\]

</td></tr><tr><td>

service\_contract\_lines.​child\_contract\_lines.​product\_offering

</td><td>

Sys\_id of the product offering record associated with the service contract line.Data type: String

Table: Product Offering \[sn\_prd\_pm\_product\_offering\]

</td></tr><tr><td>

service\_contract\_lines.​child\_contract\_lines.​product\_specification

</td><td>

Sys\_id of the product specification record associated with the service contract line.Data type: String

Table: Product Specification \[sn\_prd\_pm\_product\_specification\]

</td></tr><tr><td>

service\_contract\_lines.​child\_contract\_lines.​sold\_product

</td><td>

Sys\_id of the sold product record associated with the service contract line.Data type: String

Table: Sold Product \[sn\_install\_base\_sold\_product\]

</td></tr><tr><td>

service\_contract\_lines.​child\_contract\_lines.​sold\_products\_covered

</td><td>

List of products covered under the service contract line.

Data type: Array of Objects

 ```
"sold_products_covered": [ 
  {
    "added": "String",
    "removed": "String",
    "sold_product": "String"
  }
]

"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"
  }
]

"entitlement_characteristics": [
  {
    "characteristic": "String",
    "characteristic_option": "String",
    "entitlement_usage": {Object},
    "type": "String",
    "value": "String"
  }
]

"entitlement_usage": {
    "used_units": "String"
}

</td></tr><tr><td>

service\_contract\_lines.​entitlements.​install\_base\_items\_covered.​added

</td><td>

Date that the associated install base item was added to the entitlement.Data type: String

Format: yyyy-mm-dd

Default: Current date

</td></tr><tr><td>

service\_contract\_lines.​entitlements.​install\_base\_items\_covered.​install\_base

</td><td>

Sys\_id of the install base item covered by the entitlement.Data type: String

Table: Install Base Item \[sn\_install\_base\_item\]

</td></tr><tr><td>

service\_contract\_lines.​entitlements.​install\_base\_items\_covered.​removed

</td><td>

Date that the associated install base item was removed from the entitlement.Data type: String

Format: yyyy-mm-dd

Default: No end date

</td></tr><tr><td>

service\_contract\_lines.​entitlements.​product

</td><td>

Sys\_id of the product model record associated with the entitlement.Data type: String

Table: Product Model \[cmdb\_model\]

</td></tr><tr><td>

service\_contract\_lines.​entitlements.​product\_offering

</td><td>

Sys\_id of the product offering record associated with the entitlement.Data type: String

Table: Product Offering \[sn\_prd\_pm\_product\_offering\]

</td></tr><tr><td>

service\_contract\_lines.​entitlements.​product\_specification

</td><td>

Sys\_id of the product specification record associated with the entitlement.Data type: String

Table: Product Specification \[sn\_prd\_pm\_product\_specification\]

</td></tr><tr><td>

service\_contract\_lines.​entitlements.​sold\_entitlement

</td><td>

Sys\_id of the sold product record associated with the entitlement.Data type: String

Table: Sold Product \[sn\_install\_base\_sold\_product\]

</td></tr><tr><td>

service\_contract\_lines.​entitlements.​sold\_products\_covered

</td><td>

List of sold products covered under the entitlement. Data type: Array of Objects

</td></tr><tr><td>

service\_contract\_lines.​entitlements.​sold\_products\_covered.​added

</td><td>

Date that the associated sold product was added to the entitlement.Data type: String

Format: yyyy-mm-dd

Default: Current date

</td></tr><tr><td>

service\_contract\_lines.​entitlements.​sold\_products\_covered.​removed

</td><td>

Date that the associated sold product was removed from the entitlement.Data type: String

Format: yyyy-mm-dd

Default: No end date

</td></tr><tr><td>

service\_contract\_lines.​entitlements.​sold\_products\_covered.​sold\_product

</td><td>

Sys\_id of a product associated with the entitlement.Data type: String

Table: Sold Product Covered \[sn\_install\_base\_m2m\_contract\_sold\_product\]

</td></tr><tr><td>

service\_contract\_lines.​entitlements.​start\_date

</td><td>

Required. Start date of the entitlement.

Data type: String

Format: yyyy-mm-dd

</td></tr><tr><td>

service\_contract\_lines.​entitlements.​state

</td><td>

Required.Current state of the entitlement.

Valid values: \(case-sensitive\)

-   active
-   cancelled
-   draft
-   expired
-   suspended

Data type: String

</td></tr><tr><td>

service\_contract\_lines.​entitlement\_characteristics

</td><td>

List of characteristics associated with the service contract line.Data type: Array of Objects

Stored in: Characteristic \[sn\_pss\_core\_entitlement\_characteristic\]

</td></tr><tr><td>

service\_contract\_lines.​entitlement\_characteristics.​characteristic

</td><td>

Required. Sys\_id of the characteristic record associated with the service contract line.

Data type: String

Table: Characteristic \[sn\_prd\_pm\_characteristic\]

</td></tr><tr><td>

service\_contract\_lines.​entitlement\_characteristics.​characteristic\_option

</td><td>

Sys\_id of the characteristic option record associated with the service contract line.

Data type: String

Table: Characteristic Option \[sn\_prd\_pm\_characteristic\_option\]

</td></tr><tr><td>

service\_contract\_lines.​entitlement\_characteristics.​entitlement\_usage

</td><td>

Used unit value for the associated service contract line characteristic.Data type: Object

Stored in: Entitlement Usage \[sn\_pss\_core\_entitlement\_usage\]

</td></tr><tr><td>

service\_contract\_lines.​entitlement\_characteristics.​entitlement\_usage.​usage\_units

</td><td>

Usage of the associated entitlement characteristic.Data type: String

</td></tr><tr><td>

service\_contract\_lines.​entitlement\_characteristics.​type

</td><td>

Type of service contract line characteristic. Valid values:

-   coverage
-   coverage \_and\_usage

Data type: String

</td></tr><tr><td>

service\_contract\_lines.​entitlement\_characteristics.​value

</td><td><p>Required if the <strong>entitlement_characteristics.type</strong> parameter is not passed. Value of the characteristic.</p>
<p>Data type: String</p></td></tr><tr><td>

service\_contract\_lines.​install\_base\_items\_covered

</td><td>

List of install base items covered under the  service contract line.

Data type: Array of Objects

Stored in: Sold Product Covered  \[sn\_install\_base\_m2m\_contract\_sold\_product\]

</td></tr><tr><td>

service\_contract\_lines.​install\_base\_items\_covered.​added

</td><td>

Date that the associated install base item was added to the service contract line.

Data type: String

 Format: yyyy-mm-dd

 Default: Current date

</td></tr><tr><td>

service\_contract\_lines.​install\_base\_items\_covered.​install\_base

</td><td>

Sys\_id of the install base item covered by the service contract line.Data type: String

Table: Install Base Item \[sn\_install\_base\_item\]

</td></tr><tr><td>

service\_contract\_lines.​install\_base\_items\_covered.​removed

</td><td>

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

</td></tr><tr><td>

service\_contract\_lines.​name

</td><td>

Name of the service contract line.

Data type: String

</td></tr><tr><td>

service\_contract\_lines.​product\_model

</td><td>

Sys\_id of the product associated with the service contract line.Data type: String

Table: Product Model \[cmdb\_model\]

</td></tr><tr><td>

service\_contract\_lines.​product\_offering

</td><td>

Sys\_id of the product offering record associated with the service contract line.Data type: String

Table: Product Offering \[sn\_prd\_pm\_product\_offering\]

</td></tr><tr><td>

service\_contract\_lines.​product\_specification

</td><td>

Sys\_id of the product specification record associated with the service contract line.Data type: String

Table: Product Specification \[sn\_prd\_pm\_product\_specification\]

</td></tr><tr><td>

service\_contract\_lines.​sold\_product

</td><td>

Sys\_id of the sold product record associated with the service contract line.Data type: String

Table: Sold Product \[sn\_install\_base\_sold\_product\]

</td></tr><tr><td>

service\_contract\_lines.​sold\_products\_covered

</td><td>

List of products covered under the service contract line.

Data type: Array of Objects

 ```
"sold_products_covered": [ 
  {
    "added": "String",
    "removed": "String",
    "sold_product": "String"
  }
]

"sold_products_covered": [ 
  {
    "added": "String",
    "removed": "String",
    "sold_product": "String"
  }
]

"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"
  }
]

"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"
  }
]

"entitlement_characteristics": [
  {
    "characteristic": "String",
    "characteristic_option": "String",
    "entitlement_usage": {Object},
    "type": "String",
    "value": "String"
  }
]

"entitlement_usage": {
    "used_units": "String"
}

</td></tr><tr><td>

child\_contract\_lines.​entitlements.​install\_base\_items\_covered.​added

</td><td>

Date that the associated install base item was added to the entitlement.Data type: String

Format: yyyy-mm-dd

Default: Current date

</td></tr><tr><td>

child\_contract\_lines.​entitlements.​install\_base\_items\_covered.​install\_base

</td><td>

Sys\_id of the install base item covered by the entitlement.Data type: String

Table: Install Base Item \[sn\_install\_base\_item\]

</td></tr><tr><td>

child\_contract\_lines.​entitlements.​install\_base\_items\_covered.​removed

</td><td>

Date that the associated install base item was removed from the entitlement.Data type: String

Format: yyyy-mm-dd

Default: No end date

</td></tr><tr><td>

child\_contract\_lines.​entitlements.​product

</td><td>

Sys\_id of the product model record associated with the entitlement.Data type: String

Table: Product Model \[cmdb\_model\]

</td></tr><tr><td>

child\_contract\_lines.​entitlements.​product\_offering

</td><td>

Sys\_id of the product offering record associated with the entitlement.Data type: String

Table: Product Offering \[sn\_prd\_pm\_product\_offering\]

</td></tr><tr><td>

child\_contract\_lines.​entitlements.​product\_specification

</td><td>

Sys\_id of the product specification record associated with the entitlement.Data type: String

Table: Product Specification \[sn\_prd\_pm\_product\_specification\]

</td></tr><tr><td>

child\_contract\_lines.​entitlements.​sold\_entitlement

</td><td>

Sys\_id of the sold product record associated with the entitlement.Data type: String

Table: Sold Product \[sn\_install\_base\_sold\_product\]

</td></tr><tr><td>

child\_contract\_lines.​entitlements.​sold\_products\_covered

</td><td>

List of sold products covered under the entitlement. Data type: Array of Objects

</td></tr><tr><td>

child\_contract\_lines.​entitlements.​sold\_products\_covered.​added

</td><td>

Date that the associated sold product was added to the entitlement.Data type: String

Format: yyyy-mm-dd

Default: Current date

</td></tr><tr><td>

child\_contract\_lines.​entitlements.​sold\_products\_covered.​removed

</td><td>

Date that the associated sold product was removed from the entitlement.Data type: String

Format: yyyy-mm-dd

Default: No end date

</td></tr><tr><td>

child\_contract\_lines.​entitlements.​sold\_products\_covered.​sold\_product

</td><td>

Sys\_id of a product associated with the entitlement.Data type: String

Table: Sold Product Covered \[sn\_install\_base\_m2m\_contract\_sold\_product\]

</td></tr><tr><td>

child\_contract\_lines.​entitlements.​start\_date

</td><td>

Required. Start date of the entitlement.

Data type: String

Format: yyyy-mm-dd

</td></tr><tr><td>

child\_contract\_lines.​entitlements.​state

</td><td>

Required.Current state of the entitlement.

Valid values: \(case-sensitive\)

-   active
-   cancelled
-   draft
-   expired
-   suspended

Data type: String

</td></tr><tr><td>

child\_contract\_lines.​entitlement\_characteristics

</td><td>

List of characteristics associated with the entitlement.Data type: Array of Objects

Stored in: Characteristic \[sn\_pss\_core\_entitlement\_characteristic\]

</td></tr><tr><td>

child\_contract\_lines.​entitlement\_characteristics.​characteristic

</td><td>

Sys\_id of the characteristic record associated with the entitlement.

Data type: String

Table: Characteristic \[sn\_prd\_pm\_characteristic\]

</td></tr><tr><td>

child\_contract\_lines.​entitlement\_characteristics.​characteristic\_option

</td><td>

Sys\_id of the characteristic option record associated with the entitlement.Data type: String

Table: Characteristic Option \[sn\_prd\_pm\_characteristic\_option\]

</td></tr><tr><td>

child\_contract\_lines.​entitlement\_characteristics.​entitlement\_usage

</td><td>

Used unit value for the associated entitlement characteristic.Only pass this parameter if the entitlement\_characteristics are under the entitlement.

Data type: Object

Stored in: Entitlement Usage \[sn\_pss\_core\_entitlement\_usage\]

</td></tr><tr><td>

child\_contract\_lines.​entitlement\_characteristics.​entitlement\_usage.​used\_units

</td><td>

Usage of the associated entitlement characteristic.Data type: String

</td></tr><tr><td>

child\_contract\_lines.​entitlement\_characteristics.​type

</td><td>

Type of entitlement characteristic. Valid values:

-   coverage
-   coverage\_and\_usage

Data type: String

</td></tr><tr><td>

child\_contract\_lines.​entitlement\_characteristics.​value

</td><td>

Value of the characteristic.

Data type: String

</td></tr><tr><td>

child\_contract\_lines.​install\_base\_items\_covered

</td><td>

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"
  }
]

"sold_products_covered": [ 
  {
    "added": "String",
    "removed": "String",
    "sold_product": "String"
  }
]

"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"
  }
]

"entitlement_characteristics": [
  {
    "characteristic": "String",
    "characteristic_option": "String",
    "entitlement_usage": {Object},
    "type": "String",
    "value": "String"
  }
]

"entitlement_usage": {
    "used_units": "String"
}

</td></tr><tr><td>

entitlements.​install\_base\_items\_covered.​added

</td><td>

Date that the associated install base item was added to the entitlement.Data type: String

Format: yyyy-mm-dd

Default: Current date

</td></tr><tr><td>

entitlements.​install\_base\_items\_covered.​removed

</td><td>

Date that the associated install base item was removed from the entitlement.Data type: String

Format: yyyy-mm-dd

Default: No end date

</td></tr><tr><td>

entitlements.​product

</td><td>

Sys\_id of the product model record associated with the entitlement.Data type: String

Table: Product Model \[cmdb\_model\]

</td></tr><tr><td>

entitlements.​product\_offering

</td><td>

Sys\_id of the product offering record associated with the entitlement.Data type: String

Table: Product Offering \[sn\_prd\_pm\_product\_offering\]

</td></tr><tr><td>

entitlements.​product\_specification

</td><td>

Sys\_id of the product specification record associated with the entitlement.Data type: String

Table: Product Specification \[sn\_prd\_pm\_product\_specification\]

</td></tr><tr><td>

entitlements.​sold\_entitlement

</td><td>

Sys\_id of the sold product record associated with the entitlement.Data type: String

Table: Sold Product \[sn\_install\_base\_sold\_product\]

</td></tr><tr><td>

entitlements.​sold\_products\_covered

</td><td>

List of sold products covered under the entitlement. Data type: Array of Objects

</td></tr><tr><td>

entitlements.​sold\_products\_covered.​added

</td><td>

Date that the associated sold product was added to the entitlement.Data type: String

Format: yyyy-mm-dd

Default: Current date

</td></tr><tr><td>

entitlements.​sold\_products\_covered.​removed

</td><td>

Date that the associated sold product was removed from the entitlement.Data type: String

Format: yyyy-mm-dd

Default: No end date

</td></tr><tr><td>

entitlements.​sold\_products\_covered.​sold\_product

</td><td>

Sys\_id of a product associated with the entitlement.Data type: String

Table: Sold Product Covered \[sn\_install\_base\_m2m\_contract\_sold\_product\]

</td></tr><tr><td>

entitlements.​start\_date

</td><td>

Required. Start date of the entitlement.

Data type: String

Format: yyyy-mm-dd

</td></tr><tr><td>

entitlements.​state

</td><td>

Required.Current state of the entitlement.

Valid values: \(case-sensitive\)

-   active
-   cancelled
-   draft
-   expired
-   suspended

Data type: String

</td></tr><tr><td>

entitlement\_characteristics

</td><td>

List of characteristics associated with the service contract line.Data type: Array of Objects

Stored in: Characteristic \[sn\_pss\_core\_entitlement\_characteristic\]

</td></tr><tr><td>

entitlement\_characteristics.​characteristic

</td><td>

Required. Sys\_id of the characteristic record associated with the service contract line.

Data type: String

Table: Characteristic \[sn\_prd\_pm\_characteristic\]

</td></tr><tr><td>

entitlement\_characteristics.​characteristic\_option

</td><td><p>Required if the <strong>input_type</strong> parameter contained in the record specified in the <strong>entitlement_characteristics.characteristic</strong> parameter, is set to <code>choice</code>.Sys_id of the characteristic option record associated with the service contract line.</p>
<p>Data type: String</p>
<p>Table: Characteristic Option [sn_prd_pm_characteristic_option]</p></td></tr><tr><td>

entitlement\_characteristics.​entitlement\_usage

</td><td>

Used unit value for the associated service contract line characteristic.Data type: Object

Stored in: Entitlement Usage \[sn\_pss\_core\_entitlement\_usage\]

</td></tr><tr><td>

entitlement\_characteristics.​entitlement\_usage.​used\_units

</td><td>

Usage of the associated entitlement characteristic.Data type: String

</td></tr><tr><td>

entitlement\_characteristics.​type

</td><td>

Type of service contract line characteristic. Valid values:

-   coverage
-   coverage \_and\_usage

Data type: String

</td></tr><tr><td>

entitlement\_characteristics.​value

</td><td><p>Required if the <strong>entitlement_characteristics.type</strong> parameter is not passed. Value of the characteristic.</p>
<p>Data type: String</p></td></tr><tr><td>

install\_base\_items\_covered

</td><td><p>Required if the <strong>sold_products_covered</strong> parameter is not passed.List of install base items covered under the  service contract line.</p>
<p>Data type: Array of Objects</p>
<div class="highlight"><pre><span></span><code> &quot;install_base_items_covered&quot;: [ 
  {
    &quot;added&quot;: &quot;String&quot;,
    &quot;install_base&quot;: &quot;String&quot;,
    &quot;removed&quot;: &quot;String&quot;
  }
]
</code></pre></div>
<p>Stored in: Sold Product Covered  [sn_install_base_m2m_contract_sold_product]</p></td></tr><tr><td>

install\_base\_items\_covered.​added

</td><td>

Date that the associated install base item was added to the service contract line.

Data type: String

 Format: yyyy-mm-dd

 Default: Current date

</td></tr><tr><td>

install\_base\_items\_covered.​install\_base

</td><td>

Sys\_id of the install base item covered by the service contract line.Data type: String

Table: Install Base Item \[sn\_install\_base\_item\]

</td></tr><tr><td>

install\_base\_items\_covered.​removed

</td><td>

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

</td></tr><tr><td>

name

</td><td>

Required. Name of the service contract line.

Data type: String

</td></tr><tr><td>

parent\_contract\_line

</td><td>

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\]

</td></tr><tr><td>

product\_model

</td><td>

Sys\_id of the product associated with the service contract line.Data type: String

Table: Product Model \[cmdb\_model\]

</td></tr><tr><td>

product\_offering 

</td><td>

Sys\_id of the product offering record associated with the service contract line.Data type: String

Table: Product Offering \[sn\_prd\_pm\_product\_offering\]

</td></tr><tr><td>

product\_specification

</td><td>

Sys\_id of the product specification record associated with the service contract line.Data type: String

Table: Product Specification \[sn\_prd\_pm\_product\_specification\]

</td></tr><tr><td>

sold\_product

</td><td>

Sys\_id of the sold product record associated with the service contract line.Data type: String

Table: Sold Product \[sn\_install\_base\_sold\_product\]

</td></tr><tr><td>

sold\_products\_covered

</td><td><p>Required if the <strong>install_base_items_covered</strong> parameter is not passed.List of products covered under the service contract line.</p>
<p>Data type: Array of Objects</p>
<div class="highlight"><pre><span></span><code>&quot;sold_products_covered&quot;: [ 
  {
    &quot;added&quot;: &quot;String&quot;,
    &quot;removed&quot;: &quot;String&quot;,
    &quot;sold_product&quot;: &quot;String&quot;
  }
]
</code></pre></div>
<p>Data is stored in the Sold Products Covered  [sn_install_base_m2m_contract_sold_product] table.</p></td></tr><tr><td>

sold\_products\_covered.​added

</td><td>

Date that the associated service contract line starts to cover the associated product.Data type: String

Format: yyyy-mm-dd

Default: Current date

</td></tr><tr><td>

sold\_products\_covered.​removed

</td><td>

Date that the associated service contract line ends coverage of the associated product.Data type: String

Format: yyyy-mm-dd

Default: No end date

</td></tr><tr><td>

sold\_products\_covered.​sold\_product

</td><td>

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\]

</td></tr><tr><td>

starts

</td><td>

Required. Start date of the service contract line.

Data type: String

Format: yyyy-mm-dd

</td></tr><tr><td>

state

</td><td>

Required.Current state of the contract line.

Valid values: \(case-sensitive\)

-   active
-   cancelled
-   draft
-   expired
-   suspended

Data type: String

</td></tr></tbody>
</table>

### 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](../rest-api-explorer/c_RESTAPI.md).

<table class="rest_api_request_headers"><thead><tr><th>

Header

</th><th>

Description

</th></tr></thead><tbody><tr><td>

Accept

</td><td id="accept-entry-RESTAPI">Data format of the response body. Supported types: <strong>application/json</strong> or <strong>application/xml</strong>. Default: <strong>application/json</strong></td></tr><tr><td>

Content-Type

</td><td id="content_type-entry-RESTAPI">Data format of the request body. Supported types: <strong>application/json</strong> or <strong>application/xml</strong>. Default: <strong>application/json</strong></td></tr></tbody>
</table>

|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](../rest-api-explorer/c_RESTAPI.md).

|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\)

<table><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

child\_contract\_lines

</td><td>

List of child service contract line objects created under the service contract line.Data type: Array of Objects

</td></tr><tr><td>

child\_contract\_lines.​child\_contract\_lines

</td><td>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 <strong>child_contract_lines</strong> parameter.Data type: Array of Objects</td></tr><tr><td>

child\_contract\_lines.​entitlements

</td><td>

List of entitlements associated with the child service contract line.Data type: Array of Objects

</td></tr><tr><td>

child\_contract\_lines.​entitlements.​entitlement\_name

</td><td>

Name of the entitlement.

Data type: String

</td></tr><tr><td>

child\_contract\_lines.​entitlements.​entitlement\_characteristics

</td><td>

List of the entitlement characteristic objects  created under the entitlement. Data type: Array of Objects

</td></tr><tr><td>

child\_contract\_lines.​entitlements.​entitlement\_characteristics.​sys\_id

</td><td>

Sys\_id of an entitlement characteristics record associated with the child service contract line.Data type: String

Table: Characteristic \[sn\_pss\_core\_entitlement\_characteristic\]

</td></tr><tr><td>

child\_contract\_lines.​entitlements.​install\_base\_items\_covered

</td><td>

List of sys\_ids of the install base items covered under the entitlement. Data type: Array of Objects

</td></tr><tr><td>

child\_contract\_lines.​entitlements.​install\_base\_items\_covered.​sys\_id

</td><td>

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\]

</td></tr><tr><td>

child\_contract\_lines.​entitlements.​sold\_products\_covered

</td><td>

List of sys\_ids of the products covered under the entitlement. Data type: Array of Objects

</td></tr><tr><td>

child\_contract\_lines.​entitlements.​sold\_products\_covered.​sys\_id

</td><td>

Sys\_id of a product associated with the entitlement.Data type: String

Table: Sold Product Covered \[sn\_install\_base\_m2m\_contract\_sold\_product\]

</td></tr><tr><td>

child\_contract\_lines.​entitlements.​sys\_id

</td><td>

Sys\_id of the entitlement record associated with the child service contract line.Data type: String

Table: Entitlement \[service\_entitlement\]

</td></tr><tr><td>

child\_contract\_lines.​entitlement\_characteristics

</td><td>

List of characteristics associated with the chile contract line. Data type: Array of Objects

</td></tr><tr><td>

child\_contract\_lines.​entitlement\_characteristics.​entitlement\_usage

</td><td>

Entitlement usage object inserted under the entitlement\_characteristic.Data type: Object

</td></tr><tr><td>

child\_contract\_lines.​entitlement\_characteristics.​entitlement\_usage.​sys\_id

</td><td>

Sys\_id of the entitlement usage record.Data type: String

Table: Entitlement Usage \[sn\_pss\_core\_entitlement\_usage\]

</td></tr><tr><td>

child\_contract\_lines.​entitlement\_characteristics.​sys\_id

</td><td>

Sys\_id of a entitlement characteristics record associated with the child service contract line.Data type: String

Table: Characteristic \[sn\_pss\_core\_entitlement\_characteristic\]

</td></tr><tr><td>

child\_contract\_lines.​install\_base\_items\_covered

</td><td>

List of sys\_ids of the install base items covered under the child service contract line. Data type: Array of Objects

</td></tr><tr><td>

child\_contract\_lines.​install\_base\_items\_covered.​sys\_id

</td><td>

Sys\_id of the install base item covered.Data type: String

Table: Sold Product Covered \[sn\_install\_base\_m2m\_contract\_sold\_product\]

</td></tr><tr><td>

child\_contract\_lines.​name

</td><td>

Name of the child service contract line.Data type: String

</td></tr><tr><td>

child\_contract\_lines.​number

</td><td>

Unique number of the service contract line. Automatically generated by the endpoint. For example: CTRL9812347.Data type: String

</td></tr><tr><td>

child\_contract\_lines.​sold\_products\_covered

</td><td>

List of sys\_ids of the products covered under the child service contract line. Data type: Array of Objects

</td></tr><tr><td>

child\_contract\_lines.​sold\_products\_covered.​sys\_id

</td><td>

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\]

</td></tr><tr><td>

child\_contract\_lines.​sys\_id

</td><td>

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\]

</td></tr><tr><td>

entitlements

</td><td>

List of entitlements associated with the service contract line.Data type: Array of Objects

</td></tr><tr><td>

entitlements.​entitlement\_characteristics

</td><td>

List of the entitlement characteristic objects  created under the entitlement. Data type: Array of Objects

</td></tr><tr><td>

entitlements.​entitlement\_characteristics.​entitlement\_usage

</td><td>

Entitlement usage object inserted under the entitlement\_characteristic.Data type: Object

</td></tr><tr><td>

entitlements.​entitlement\_characteristics.​entitlement\_usage.​sys\_id

</td><td>

Sys\_id of the entitlement usage record.Data type: String

Table: Entitlement Usage \[sn\_pss\_core\_entitlement\_usage\]

</td></tr><tr><td>

entitlements.​entitlement\_characteristics.​sys\_id

</td><td>

Sys\_id of the entitlement characteristics record.Data type: String

</td></tr><tr><td>

entitlements.​entitlement\_name

</td><td>

Name of the entitlement.

Data type: String

</td></tr><tr><td>

entitlements.​install\_base\_items\_covered

</td><td>

List of sys\_ids of the install base items covered under the entitlement. Data type: Array of Objects

</td></tr><tr><td>

entitlements.​install\_base\_items\_covered.​sys\_id

</td><td>

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\]

</td></tr><tr><td>

entitlements.​sold\_products\_covered

</td><td>

List of sys\_ids of the products covered under the entitlement. Data type: Array of Objects

</td></tr><tr><td>

entitlements.​sold\_products\_covered.​sys\_id

</td><td>

Sys\_id of a product associated with the entitlement.Data type: String

Table: Sold Product Covered \[sn\_install\_base\_m2m\_contract\_sold\_product\]

</td></tr><tr><td>

entitlements.​sys\_id

</td><td>

Sys\_id of the entitlement record associated with the service contract line.Data type: String

Table: Entitlement \[service\_entitlement\]

</td></tr><tr><td>

entitlement\_characteristics

</td><td>

List of the entitlement characteristic objects  created under the service contract line. Data type: Array of Objects

</td></tr><tr><td>

entitlement\_characteristics.​entitlement\_usage

</td><td>

Entitlement usage object inserted under the entitlement\_characteristic.Data type: Object

</td></tr><tr><td>

entitlement\_characteristics.​entitlement\_usage.​sys\_id

</td><td>

Sys\_id of the entitlement usage record.Data type: String

Table: Entitlement Usage \[sn\_pss\_core\_entitlement\_usage\]

</td></tr><tr><td>

entitlement\_characteristics.​sys\_id

</td><td>

Sys\_id of the entitlement characteristics record.Data type: String

</td></tr><tr><td>

install\_base\_items\_covered

</td><td>

List of sys\_ids of the install base items covered under the service contract line. Data type: Array of Objects

</td></tr><tr><td>

install\_base\_items\_covered.​sys\_id

</td><td>

Sys\_id of the install base item covered.Data type: String

Table: Sold Product Covered \[sn\_install\_base\_m2m\_contract\_sold\_product\]

</td></tr><tr><td>

name

</td><td>

Name of the service contract line.

Data type: String

</td></tr><tr><td>

number

</td><td>

Unique number of the service contract line. Automatically generated by the endpoint. For example: CTRL9812347.Data type: String

</td></tr><tr><td>

sold\_products\_covered

</td><td>

List of sys\_ids of the products covered under the service contract line. Data type: Array of Objects

</td></tr><tr><td>

sold\_products\_covered.​sys\_id

</td><td>

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\]

</td></tr><tr><td>

sys\_id

</td><td>

Sys\_id of a service contract line record.Data type: String

Table: Service Contract Line \[sn\_pss\_core\_service\_contract\_line\]

</td></tr></tbody>
</table>

### cURL request

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

Response: