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

    Associate an Address Group with an Organization

    Use this API to associate an address group with an organization.

    URI

    https://[host]/api/juniper/servicenow/organization-management/organization/{id}/ associateAddressGroup (HTTP method = PUT)

    URI Parameters

    Parameter

    Type

    Required

    Description

    id

    Integer

    Yes

    ID of the organization with which to associate an address group

    Consumes

    • application/vnd.juniper.servicenow.organization-management.organization. associateAddressGroup+xml;version=1;charset=UTF-8
    • application/vnd.juniper.servicenow.organization-management.organization. associateAddressGroup+json;version=1;charset=UTF-8

    Request Elements

    Element

    Type

    Description

    locationAddress

    String

    Address of the physical location of the organization

    shipToAddress

    String

    Shipment delivery address of the organization

    devices

    device

    Collection of devices associated with the organization

    device

    String

    Link to a device

    Produces

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

    Response Elements

    Element

    Type

    Description

    msg

    String

    Status message of the associate address group job

    Sample Input

    Sample XML Input

    <associateAddressGroup>
    <locationAddress href="/api/juniper/servicenow/address-group-management/addressGroups/39843"/>
    <shipToAddress href="/api/juniper/servicenow/address-group-management/addressGroups/39843"/>
    <devices>
    <device href="/api/juniper/servicenow/device-management/devices/34639"/>
    </devices>
    </associateAddressGroup>
    

    Sample JSON Input

    {
      "associateAddressGroup": {
        "locationAddress": { "@href": "/api/juniper/servicenow/address-group-management/addressGroups/39843" },
        "shipToAddress": { "@href": "/api/juniper/servicenow/address-group-management/addressGroups/39843" },
        "devices": {
          "device": { "@href": "/api/juniper/servicenow/device-management/devices/34639" }
        }
      }
    }
    

    Sample Output

    Sample XML Output

    <ServiceNowMsg>
    	<msg>Association is successful for org id: 34635</msg>
    </ServiceNowMsg>
    

    Sample JSON Output

    {
      "servicenowmsg": {
        "msg": "Association is successful for org id: 34635"
      }
    }
    

    Modified: 2016-08-09