TechLibrary

Table of Contents

Guide That Contains This Content

[+] Expand All

[-] Collapse All

Modify an End-Customer Organization in Partner Proxy Mode

After you configure Service Now to run in Partner Proxy mode, you can add multiple end customers and manage end-customer Service Now applications over a secure https connection. The Service Now partner can communicate with the end customer only after the Service Now application of an end customer is activated.

Use this API to update an end-customer organization added to a Service Now partner.

URI

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

URI Parameters

Parameter	Type	Required	Description
id	Integer	Yes	ID of the end-customer organization to be modified

Consumes

application/vnd.juniper.servicenow.organization-management.connectedmember+xml; version=4;charset=UTF-8
application/vnd.juniper.servicenow.organization-management.connectedmember+json; version=4;charset=UTF-8

Request Elements

Element	Type	Description
siteName	String	Site Name associated with the end-customer organization
userName	String	Username to authenticate the end customer site
password	String	Password to authenticate the end customer site Note: The password needs to be Base64 encrypted.
jmbFilterValue	String	JMB filter level configured for the organization: Possible values: Do not send—JMBs are not sent to JSS. Send all information except configuration—All information in the JMB except the device configuration information is sent to JSS. Send all information—The JMB is sent as collected from the device to JSS. Only send list of features used—Only the list of features used in sent in the JMB to JSS. Send all information with IP addresses overwritten—IP addresses in the JMB are overwritten by asterisk (*).
overrideECAddress	Boolean	Flag to indicate if the address associated with a device by the end customer should be overridden in the Service Now partner Possible values: true—The address specified by the end-customer is overridden with an address specified by the Service Now partner false—he address specified by the end customer is not overridden with an address specified by the Service Now partner
domainId	Integer	ID of the domain to which the organization belongs This is an optional element. The value provided in this element is ignored if the value is invalid or a domainId other than the current domainId is provided.

Produces

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

Response Elements

Element	Type	Description
msg	String	Status message of the modify end-customer organization job

Sample Input

When modifying an end customer,, list only attributes to be updated. In the following examples, the site name and overrideECAddress attributes are updated.

Sample XML Input

<connectedmember>
                    <siteName>modifiedConnectedMember</siteName>
                    <overrideECAddress>false</overrideECAddress>
        </connectedmember>

Sample JSON Input

{
  "connectedmember": 
{ 
"siteName": "sampleConnectedMember",
"overrideECAddress ": false, 
}
}

Note:

While modifying organization, only the attributes which need to be modified is required. No need to specify all the attribute values.
Service Now only considers the values of sitename, username, password and jmbFilterValue.

Sample Output

Sample XML Output

<servicenowmsg>
	<msg>Connected Member updated successfully</msg>
</servicenowmsg>

Sample JSON Output

{
	"servicenowmsg":
	{
		"msg":" Connected Member updated successfully "
	}
}

Response Status Code

Message	Description
503 Service Unavailable	Service Now is not operating in Partner Proxy mode and an end-customer organization cannot be modified when Service Now is not operating in Partner Proxy mode.
404 Not Found	Invalid end-customer ID specified
400 Bad Request	One of the following: Site name is required but is not specified. Site name is too long. The maximum number of characters allowed is 64. Site name has an invalid character. Site names must begin with alphanumeric (a-z, 0-9) characters. User name is required but is not specified. User name is too long. The maximum number of characters allowed is 64. Password is required but is not specified. Password is too long. The maximum number of characters is 32. jmbFilterValue is required but is not specified. jmbFilterValue contains an invalid value. submit-case-as is not specified.

TechLibrary

Related Documentation

Modify an End-Customer Organization in Partner Proxy Mode

Related Documentation

Modified: 2016-08-09