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 information about an Organization

    Use this API to retrieve information about an organization.

    URI

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

    URI Parameters

    Element

    Type

    Required

    Description

    id

    Integer

    Yes

    ID of the organization for which information is to be retrieved

    Consumes

    None

    Produces

    • vnd.juniper.servicenow.organization-management.organization+xml;version=5
    • vnd.juniper.servicenow.organization-management.organization+json;version=5

    Response Elements

    Element

    Type

    Description

    id

    Integer

    ID of 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 the organization is assigned

    Sample Output

    Example XML Output

    <organization uri="/api/juniper/servicenow/organization-management/organization/99507">
         <id>99507</id>
         <siteName>TestConnectedMember</siteName>
         <siteIdentifier>- - -</siteIdentifier>
         <jnprUser>user@example.com</jnprUser>
         <connectionStatus>Success</connectionStatus>
         <jmbFilterValue>Do not send</jmbFilterValue>
         <isConnectedMember>false</isConnectedMember>
         <overrideECAddress>true</overrideECAddress>
    		  <platformVersion>15.1R2</platformVersion>
         <serviceNowVersion>15.1R2</serviceNowVersion>      
         <domainID>10</domainID>
    </organization>
    

    Example JSON Output

    {
         "organization":
         {
              "@uri":"/api/juniper/servicenow/organization-management/organization/99507",
              "id":99507,
              "siteName":"TestConnectedMember",
              "siteIdentifier":"- - -",
              "jnprUser":"user@example.com",
              "connectionStatus":"Success",
              "jmbFilterValue":"Do not send",
              "isConnectedMember":false,
              "isConnectedMember":true,
    		       ”platformVersion”:”15.1R2”,
    	       “serviceNowVersion”:”15.1R2”
              "domainID":"10"
         }
    }
    

    Response Status Code

    Message

    Description

    404 Not Found

    Invalid organization ID

    Modified: 2016-08-10