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

    Request RMA Incident

    Use this API to generate Return Material Authorization (RMA) incidents for devices.

    URI

    https://[host]/api/juniper/servicenow/device-management/devices/{id}/requestRMAIncident ?queue=https://[host]/api/hornet-q/queues/jms.queue.[QueueName] (HTTP method = POST)

    URI Parameters

    Parameter

    Type

    Required

    Description

    QueueName

    String

    Yes

    Name of the request RMA job queue

    Consumes

    • application/vnd.juniper.servicenow.device-management.requestrmaincident+xml;version=4;charset=UTF-8
    • application/vnd.juniper.servicenow.device-management.requestrmaincident+json;version=4;charset=UTF-8

    Accept Header

    • application/vnd.juniper.servicenow.device-management.device+xml;version=4
    • application/vnd.juniper.servicenow.device-management.device+json;version=4

    Request Elements

    Element

    Type

    Description

    followUpMethod

    String

    Method used to follow up with the case created for the RMA incident

    Possible values:

    • EMAIL_FULL_TEXT_UPDATE
    • EMAIL_WEB_LINK
    • PHONE_CALL

    For an end-customer Service Now, a value need not be provided for followUpMethod. Any value, if provided, is discarded.

    caseCCList

    caseCCList

    Collection of e-mail ID of users to be notified about the RMA incident

    email

    String

    E-mail id of a user to be notified about the RMA incident

    Priority

    String

    Priority of the incident

    Possible values:

    • Critical
    • High
    • Medium
    • Low

    synopsisComments

    String

    Synopsis of the RMA incident

    customerComments

    String

    Comments from user for the RMA incident

    createCase

    Boolean

    Flag to indicate if the RMA incident should be submitted to JSS for creating a case:

    Possibel values

    • true—The RMA incident is submitted for creating a case.
    • fasle—The RMA incident is not submitted for creating a case.

    requestRMAParts

    String

    Device parts for which RMA is requested

    collectLogFiles

    Boolean

    Flag to indicate whether or not log files should be collected for this on-demand incident

    Possible values:

    • true—Log files are collected for the on-demand incident
    • false—Log files are not collected for the on-demand incident

    verifyCPUUsage

    Boolean

    Flag to indicate whether or not usage of device CPU must be verified while generating this on-demand incident

    Possible values:

    • true—CPU usage is verified
    • false—CPU usage is not verified

    Produces

    None

    Response Elements

    Element

    Type

    Description

    href

    String

    Link to the request RMA job

    id

    Integer

    ID of the request RMA job

    Sample Input

    Sample XML Input

    <requestrmaincident>
    		<followUpMethod>Email Full Text Update</followUpMethod>
    		<caseCCList>
    			<email>biruk@juniper.net</email>
    			<email>apathodia@juniper.net</email>
    		</caseCCList>
    		<priority>Critical</priority>
    		<synopsisComments>
    		These are my synopsis comments here
    		</synopsisComments>
    		<customerComments>
    		These are my customer comments here
    		</customerComments>
    		<createCase>true</createCase>
    		<requestRMAParts> Routing Engine 0 Model Number: EX2200-24T-4G
    		Routing Engine 0 Part Number: 750-026468 (REV 13)
    		Routing Engine 0 SerialNumber: CW0210402769 CW0210402769
    		Routing Engine 0 Description: EX2200-24T-4G
    		FPC 0 Model Number: EX2200-24T-4G
    		FPC 0 Part Number: 750-026468 (REV 13)
    		FPC 0 SerialNumber: CW0210402769
    		FPC 0 Description: EX2200-24T-4G
    		</requestRMAParts>
    		<collectLogFiles>true</collectLogFiles>
    		<verifyCPUUsage>true</verifyCPUUsage>
    </requestrmaincident>
    

    Sample JSON Input

    {
       "requestrmaincident":{
          
          "followUpMethod":"Email Full Text Update",
          "caseCCList":{
             "email":[
                "biruk@juniper.net",
                "apathodia@juniper.net"
             ]
          },
          "priority":"Critical",
          "synopsisComments":"These are my synopsis comments here",
          "customerComments":"These are my customer comments here",
          "createCase":"true",
          "requestRMAParts":"Routing Engine 0 Model Number: EX2200-24T-4G"	
    		"collectLogFiles": "true",
          "verifyCPUUsage": "true"
       }
    }

    Sample Output

    Sample XML Output

    <task href="/api/juniper/job-management/jobs/3801101">
    	<id>3801101</id>
    </task>

    Sample JSON Output

    {
       "task":{
          "@href":"/api/space/job-management/jobs/3801101",
          "id":3801101
       }
    }
    

    Error Codes

    Message

    Description

    400 Bad Request

    • The device is not associated with any device group.
    • The device Is an end-customer device.
    • The device Is a fabric node (TOR).
    • The device Is a DCF device.
    • The follow-up method specified in the request is invalid.
    • The priority specified in the request is invalid.
    • The e-mail ID specified in the request is invalid.

    404 Not Found

    The device specified in the request is not a valid Service Now device.

    Modified: 2016-08-11