TechLibrary

Table of Contents

Guide That Contains This Content

[+] Expand All

[-] Collapse All

Add an Organization

An organization in Service Now represents a unique site ID in Juniper Support Systems (JSS) to identify customers when providing technical support. You can manage multiple sites (each with its own site ID) using multiple organizations defined in Service Now with just one Service Now installation. This is done by dividing the network into multiple logical customer sites. To communicate with JSS, a Service Now organization requires a site ID, login name, and password. The login name must be a contact associated with the site ID.

Use this API to add an organization to Service Now.

URI

https://[host]/api/juniper/servicenow/organization-management/addorganization (HTTP metod = POST)

Consumes

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

Request Elements

Element	Type	Description
siteName	String	Name of the organizaiton in JSS
siteIdentifier	String	ID of the organization in JSS Note: This element is not required if Service Now is operating in the End Customer mode.
userName	String	ID of the user in e-mail address format for autheticating the organization in JSS
password	String	Password to authenticate the organization in JSS Note: The password should be Base64 encrypted.
jmbFilterValue	Boolean	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 (*).
submit-case-as	String	indicates if incidents are submitted to JSS for resolution or test purposes Real Cases—Incidents are submitted to JSS for resolution Test Cases—Incidents are submitted for testing purposes and are ignored by JSS
domainId	Integer	ID of the domain in which the organization should be created. This is an optional element. If no domain ID is provided, the organization is created in the Global domain. Note: The create request fails if a user does not have access to the Global domain and if no domain ID is provided with the create request.

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 add organization job

Sample Input

Sample XML Input

<organization>
	<siteName>testOrg</siteName>
	<siteIdentifier>CJ18841</siteIdentifier>
	<userName>user@example.com</userName>
	<password> password</password>
	<jmbFilterValue>Do not send</jmbFilterValue>
	<submit-case-as>Real Cases</submit-case-as>
	<domainId>10</domainId>
</organization>

Sample JSON Input

{
  "organization": {
    "siteName": "sampleTestOrg",
    "siteIdentifier": "00001604",
    "userName": "user@example.com",
    "password": "password",
    "jmbFilterValue": "Do not send",
    "submit-case-as": "Real Cases",
    "domainId":"10"
  }
}

Sample XML Input for End-Customer Mode

<organization>
	<siteName>testOrg</siteName>
	<userName>user@example.com</userName>
	<password> password </password>
	<jmbFilterValue>Do not send</jmbFilterValue>
	<submit-case-as>Real Cases</submit-case-as>
	<domainId>10</domainId>
</organization>

Sample JSON Input for End-Customer Mode

{
  "organization": {
    "siteName": "sampleTestOrg",
    "userName": "user@example.com",
    "password": " password",
    "jmbFilterValue": "Do not send",
    "submit-case-as": "Real Cases",
    "domainId":"10"    }
}

If the Service Now is in Offline mode then only the siteName and jmbFilterValue attributes are required.

Sample XML Input for Offline Mode

<organization>
	<siteName>testOrg</siteName>
	<jmbFilterValue>Do not send</jmbFilterValue>
	<domainId>10</domainId>
</organization>

Sample JSON Input for Offline Mode

{
  "organization": {
    "siteName": "sampleTestOrg",
    "jmbFilterValue": "Do not send",
    "domainId":"10"
  }
}

Sample Output

Sample XML Output

<servicenowmsg>
	<msg>Organization created successfully. Successful Registration:  Service Now Successfully Connected to Juniper Technical Support.</msg>
</servicenowmsg>

Sample JSON Output

{"servicenowmsg":
   {
      "msg":"Organization created successfully. Successful Registration:  Service Now Successfully Connected to Juniper Technical Support."
   }
}

Response Status Code

Message	Description
404 Not Found	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 a letter having only alphanumeric (a-z, 0-9), underscores (_), spaces, and hyphens (-) User name is required but is not specified. User name is too long. The maximum number of characters is 128. 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 required but is not specified.

Message

Description

404 Not Found

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 a letter having only alphanumeric (a-z, 0-9), underscores (_), spaces, and hyphens (-)
User name is required but is not specified.
User name is too long. The maximum number of characters is 128.
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 required but is not specified.

TechLibrary

Related Documentation

Add an Organization

Related Documentation

Modified: 2016-08-10