Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

Get All Organizations in Service Now

 

Use this API to retrieve all organizations configured in Junos Space Service Now.

URI

https://[host]/api/juniper/servicenow/organization-management/organization/ (HTTP method = GET)

Consumes

None

Produces

  • application/vnd.juniper.servicenow.organization-management.organizations+xml;version=5

  • application/vnd.juniper.servicenow.organization-management.organizations+json;version=5

Response Elements

Element

Type

Description

uri

String

URI to the collection of organizations in Service Now

size

Integer

Number of records in the collection

organization

organization

An organization

key

Integer

ID of the organization

uri

String

URI of the organization

href

String

Link to the organization

siteName

String

Name of the organization in JSS

siteIdentifier

String

ID of the organization in JSS

jnprUser

String

ID of the user in e-mail address format for connecting to the JSS using the organization

connectionStatus

String

Status of connection between the organization and JSS

Possible values—Success, or reason for failure

isConnectedMember

Boolean

Flag to indicate if the organization is configured in End Customer mode

Possible values:

  • true—Organization is configured in End Customer mode

  • false—Organization is not configured in End Customer mode

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

platformVersion

String

Version of Junos Space Network Management Platform on which Service Now is installed

serviceNowVersion

String

Version of Service Now used

domainId

Integer

ID of the domain to which an organization is assigned

Sample Output

Sample XML Output

Sample JSON Output

Response Status Code

Message

Description

204 No Content

No organizations found in Service Now.

Get an Organization by Specifying its Site Name

To get an organization by specifying its site name, use a filter as shown in the following example:

https://[host]/api/juniper/servicenow/organization-management/organization?filter=(siteName eq 'test') (HTTP method = GET)

An example XML output when specifying the site name is shown below:

Get an Organization by Specifying a Partial Site Name

To get an organization by specifying characters contained in the site name, use a filter as shown in the example below:

https://[host]/api/juniper/servicenow/organization-management/organization?filter=(siteName contains 'test') (HTTP method = GET)

An example XML output when specifying the organization name is shown below: