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

    Get an Address Group by Address Group ID

    This method returns a specific address group from within in Service Now.

    URI

    https://[host]/api/juniper/servicenow/address-group-management/addressGroups/{id} (HTTP method = GET)

    URI Parameters

    Parameter

    Type

    Required

    Description

    id

    Integer

    Yes

    ID of the address group to be retrieved

    Consumes

    None

    Produces

    • application/vnd.juniper.servicenow.address-group-management.addressgroup+xml;version=1
    • application/vnd.juniper.servicenow.address-group-management.addressgroup+json;version=1

    Response

    Element

    Type

    Description

    uri

    String

    URI of the address group

    ID

    Integer

    ID of the address group

    name

    String

    Name of the location, such as the business name.

    address1 and address2

    String

    Address, such as street number and street name, to be associated with the device

    city, state and zipCode

    String

    City, State and Zip Code of the address

    createdBy

    String

    User who created this address group

    creationTime

    String

    Date and time the address group was created

    modifiedTime

    String

    Date and time the address group was last modified

    devices

    device

    Collection of devices to which the address group is associated

    href

    String

    Link to the collection of devices

    size

    Integer

    Number of devices in the collection

    device

    device

    A device in the collection

    href

    String

    Link to the device

    key

    Integer

    ID of the device

    hostName

    String

    Hostname of the device associated with this address group

    serialNumber

    String

    Serial number of the device associated with this address group

    platform

    String

    Device platform associated with this address group

    addressType

    String

    Specifies whether this address is a shipping address or business address.

    Possible values:location, shipto or both.

    • location—Address is business address
    • shipto—Address is shipping address
    • both—Address is both business and shipping address

    method

    String

    Method applicable to the address group

    domainId

    Integer

    ID of the domain in which the address group is present

    Sample Output

    Sample XML Output

    <addressGroup uri="/api/juniper/servicenow/address-group-management/addressGroups/10551296">
      <id>10551296</id>
      <name>Juniper Networks Bangalore</name>
      <address1>Plot No. 66</address1>    
      <address2>Bagmane Tech Park</address2>
      <city>Bangalore</city>
      <state>Bangalore</state>
      <country>India</country>
      <createdBy>super</createdBy>
      <creationTime>2012-08-23 01:33:06 IST</creationTime>
      <modifiedTime>2012-08-23 01:33:06 IST</modifiedTime>
      <zipCode>560093</zipCode>
      <domainId>10</domainId>
      <devices size="1" href="/api/juniper/servicenow/device-management/devices">
        <device key="1671168" href="/api/juniper/servicenow/device-management/devices/1671168">
          <hostName>MX80-Loopback</hostName>
          <serialNumber>D4358</serialNumber>
          <platform>junos</platform>
          <addressType>Location</addressType>
        </device>
      </devices>
      <method href="/api/juniper/servicenow/address-group-management/addressGroups /10551296/modify" rel="Modify Address Group"/>
      <method href="/api/juniper/servicenow/address-group-management/addressGroups /10551296/associateDevices" rel="Associate Devices to Address Group"/>
      <method href="/api/juniper/servicenow/address-group-management/addressGroups /10551296/deassociateDevices" rel="Deassociate Devices from Address Group"/>
    </addressGroup>
    

    Sample JSON Output

    {
      "addressGroup": {
        "@uri": "/api/juniper/servicenow/address-group-management/addressGroups/10551296",
        "id": 10551296,
        "name": "Juniper Networks Bangalore",
         "address1": " Plot No. 66",
         "address2": "Bagmane Tech Park",
        "city": "Bangalore",
        "state": "Bangalore",
        "country": "India",
        "createdBy": "super",
        "creationTime": "2012-08-23 01:33:06 IST",
        "modifiedTime": "2012-08-23 01:33:06 IST",
        "zipCode": 560093,
        "domainId":"10"
        "devices": {
          "@size": "1",
          "@href": "/api/juniper/servicenow/device-management/devices",
          "device": {
            "@key": "1867778",
            "@href": "/api/juniper/servicenow/device-management/devices/1867778",
            "hostName": "srx650_191",
            "serialNumber": "AJ4410AA0031",
            "platform": "junos-es",
            "addressType": "Location"
          }
        },
        "method": [
          {
            "@href": "/api/juniper/servicenow/address-group-management/addressGroups/10551296/modify",
            "@rel": "Modify Address Group"
          },
          {
            "@href": "/api/juniper/servicenow/address-group-management/addressGroups /10551296/associateDevices",
            "@rel": "Associate Devices to Address Group"
          },
          {
            "@href": "/api/juniper/servicenow/address-group-management/addressGroups /10551296/deassociateDevices",
            "@rel": "Deassociate Devices from Address Group"
          }
        ]
      }
    }
    

    Response Status Code

    Message

    Description

    404 Not Found

    • Invalid address group ID.
    • No address group with this ID was found within Service Now.

    Modified: 2016-08-11