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

    Modify an Organization

    An organization in Service Now represents a unique site ID in Juniper Support System (JSS). JSS uses the Site ID to identify a customer 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 modify the information of a specific organization.

    URI

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

    URI Parameters

    Element

    Type

    Required

    Description

    id

    Integer

    Yes

    ID of the organization to be modified

    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 organization 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 authenticating 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

    The ID of the domain to which 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=1
    • application/vnd.juniper.servicenow.organization-management.servicenowmsg+json;version=1

    Response Elements

    Element

    Type

    Description

    msg

    String

    Status message of the modify organization job

    Input

    Example XML Input

    <organization>
    <siteName>modifedOrg</siteName>
    </organization>
    

    Example JSON Input

    {
      "organization": {
        "siteName": "modifiedsampleOrg",
      }
    }
    

    As mentioned in the Add an Organization method, the input attributes will differ according to the Service Now modes.

    When modifying an organization, only the attribute to be modified is required. You do not need to send all the attribute values. For example, to modify the site name you should list only the new site name in the input as shown in the following examples.

    Example XML Input Modifying the Site Name

    <organization>
    <siteName>testOrg</siteName>
    </organization>
    

    Example JSON Input Modifying the Site Name

    {
      "organization": {
        "siteName": "sampleTestOrg",
      }
    }

    Sample Output

    Sample XML Output

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

    Sample JSON Output

    {
    "servicenowmsg":
    {"msg":" Organization updated 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 alphanumerics (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.

    Modified: 2016-08-11