Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Navigation
Guide That Contains This Content
[+] Expand All
[-] Collapse All

    View Contract Information for a Service Now Device

    Use this API to view contract information of a Service Now device.

    URI

    https://[host]/api/juniper/servicenow/device-management/devices/{id}/ viewContractInformation (HTTP method = GET)

    URI Parameters

    Parameter

    Type

    Required

    Description

    id

    Integer

    Yes

    ID of the Service Now device for which contract information is to be viewed

    Consumes

    None

    Produces

    • application/vnd.juniper.servicenow.device-management.device-contracts+xml;version=1
    • application/vnd.juniper.servicenow.device-management.device-contracts+json;version=1

    Response Elements

    Element

    Type

    Description

    uri

    String

    URI of the collection of service contracts for a device

    size

    Integer

    Number of records in the contract collection

    deviceContract

    deviceContract

    A device contract

    href

    String

    Link to the device contract

    key

    Integer

    ID of the device contract

    contractAgreementNumber

    String

    Contract agreement number

    contractAgreementStatus

    String

    Status of the contract agreement

    contractSKU

    String

    SKU number of the contract

    contractSKUType

    String

    Type of contract SKU

    contractStartDate

    String

    Contract start date

    contractEndDate

    String

    Contract end date

    Sample Output

    Sample XML Output

    <deviceContracts uri=”/api/juniper/servicenow/device-management/devices/{id}/contracts”>
    <deviceContract>
    <contractNumber/>
    <contractAgreementStatus	/>
    <sku/>
    <skuType/>
    <startDate/>
    <endDate/>
    </deviceContract>
    </deviceContracts>
    

    Sample JSON Code

    {
      "deviceContracts": {
        "@uri": "/api/juniper/servicenow/device-management/devices/{id}/contracts",
        "deviceContract": {
          "contractNumber": "8778988898",
          "sku": "abc",
          "skuType": "abc",
          "startDate": "03-12-2015",
          "endDate": "12-24-2015"
        }
      }
    }
    

    Modified: 2016-08-10