Incident - Documentation 1.10

Added

1) New Endpoint: POST /autodiag

Creates/launches an automatic diagnosis for a configuration item targeting eligible devices only.

Key behaviors:

• Eligibility check is performed before launching the autodiag.
  
  
• Optional parameters cannot be combined (you must use one option at a time).
  
  
• Supported usage patterns:
  
  
• • POST /autodiag (no parameters):
  • • Launches a standard autodiag.
    • In the response, resetPort must be set to true.
      
      
  • POST /autodiag with resetPort:
    
    
• • • Launches a reset port action on the equipment.
    • This may cause a reboot/disruption.
      
      
  • POST /autodiag with getResult:
    
    
  • • Retrieves the result of the resetPort action.

 2) New Endpoint: GET /autofdiag/{autodiagId}

Fetches the autodiag execution result/details by autodiag identifier.

Path parameter:

• {autodiagId}: ID of the autodiag job/execution to query.

Important Note (UAT / Sandbox Safety)

Using /autodiag in UAT/sandbox will poll or trigger actions on real production assets.

When testing:

• Be very cautious, especially if using options that perform actions (e.g., resetPort).
• A simple autodiag is generally harmless.
• A reset port action will reboot the device and may temporarily break connectivity.

Changed

• Offer Name Filter in /incident: Updated the offer.name filter to accept an array of strings instead of a single string. This change allows for more flexible filtering options without impacting existing usage

Added

• Field "name" in Service Point: Included a new name field in the request body for POST /Incident to enhance incident reporting details.
• Retention Policy Definition: Introduced a new retention policy definition to support data lifecycle management.

Changed

• Offer Name Filter in /aggregate: Updated the offer.name filter to accept an array of strings instead of a single string. This change allows for more flexible filtering options without impacting existing usage

• POST /attachment now supports both synchronous and asynchronous modes via the async query parameter. In both modes, attachments are scanned by antivirus before processing.

• New fields added to the response of the synchronous mode for POST /attachment:
  • attachmentId: The unique identifier of the newly posted attachment.
  • href: The URI location of the created attachment.

• New endpoint: GET /jobs/{id} to retrieve the status and details of asynchronous jobs initiated by the POST /attachment endpoint in async mode.

• Recommendation: It is recommended to use async=true for POST /attachment to avoid timeout issues during antivirus scanning, especially for large files.

• Enhanced Note Creation: Added the capability to include an attachment reference when creating a new note via POST request.
• • Only one attachment can be linked per note.
• Improved Note Retrieval: The GET Note response now includes the attachment href if an attachment is linked to the note.
• Data Consistency Fix: Corrected the enum values for the origin field in GET notes to match the case-sensitive stored values. 

• ​Added new endpoint /incidents/aggregate/{groupby}
• • This endpoint allows to fetch pre-cached aggregates of incidents based on criterion

• ​Enhancements
  
  
• • Added the option to update incident "shortDescription".
  • Defined maximum limit for incidents retrieval to be 250 incidents maximum per request. 

• Bug fixes
  
  
• • Posting contact while creating an incident.
    
    
• ​Enhancements
  
  
• • Added optional field "firstName" to contacts object.

Delay of availability in the API of elements created by Orange Business have been reduced to +/- 3 minutes

Release including new filter note.createdAT for searching incidents