.wpb_animate_when_almost_visible { opacity: 1; }
Incident - Documentation
Report and track your incidents within Orange Business
1.3
Download

Incident API
 1.3 
OAS 2.0

[ Base URL: api.orange.com/incident/b2b/v1 ]
https://developer.orange.com/ope-contents/channels/87afd7365baec589/offers/YqQrpU2sda37cati/products/z0SJrk9yFvh4NDbt/contents/swagger/JabDdQB6na0usMP8/incident-swagger-1.3.json

An Orange Business API for managing incidents.

Incident API allow to performs the following operations:

  • Create or update an incident
  • Retrieve an incident or a collection of incidents.
  • Add a note, retrieve notes on an incident.
  • Upload an attachment/file, list or download attachments.

Resources

  • incidents: An incident defines an event impacting the service.
  • attachments: Attachments defines all files associated to an incident.
  • notes: notes are comments on the incident written by Orange or the Customer.
  • freezePeriods: timeframe during which the MTTR/GTR are not impacted for the incident ticket.
  • aggregation: calculate counters based on grouped attribute values.
  • status: used to know the status of API components.
  • version: provides the version of the API.
  • doc: allows to download the swagger file.

OAuth 2.0 Scopes

ScopeFeatures
b2b:incidentGrants access to list and have details of incidents and also to report new incidents
b2b:incident:readonlyGrants access to list and have details of incidents

Internationalization

By default, data are in English but you can request data in French by specifying a language code in the Accept-Language header.
Example: Accept-Language: fr

Copyright � Orange Business 2020. All Rights Reserved.

Contact Orange Business - API for Business

Incidents

Manage Incidents of the Orange Business solutions

Notes

A note is a comment on an incident added by the Customer staff or Orange staff.

Attachments

Attachments are files, documents associated to an incident or a note of an incident. These attachments can be provided by Orange staff, Orange Automatic tools or by Customers

Freeze Periods

Provide the list of freeze Periods

Miscellaneous

Information on the API and the user.

    • HTTP status codereasonresponse model
      400List of supported error codes:
      - 20: Invalid URL parameter value
      - 21: Missing body
      - 22: Invalid body
      - 23: Missing body field
      - 24: Invalid body field
      - 25: Missing header
      - 26: Invalid header value
      - 27: Missing query-string parameter
      - 28: Invalid query-string parameter value
      {
  "code": 28,
  "message": "Invalid query-string parameter value",
  "description": "One or more query-string parameters contain invalid values."
}
      401List of supported error codes:
      - 40: Missing credentials
      - 41: Invalid credentials
      - 42: Expired credentials
      {
  "code": 42,
  "message": "Expired credentials",
  "description": "The requested service needs credentials, and the ones provided were out-of-date."
}
      403List of supported error codes:
      - 50: Access denied
      - 51: Forbidden requester
      - 52: Forbidden user
      - 53: Too many requests
      {
  "code": 53,
  "message": "Too many requests",
  "description": "The application has made too many calls and has exceeded the rate limit for this service."
}
      404List of supported error codes:
      - 60: Resource not found
      {
  "code": 60,
  "message": "Resource not found",
  "description": "The requested URI or the requested resource does not exist."
}
      405List of supported error codes:
      - 61: Method not allowed
      {
  "code": 61,
  "message": "Method not allowed",
  "description": "The URI does not support the requested method. The available methods should be set in the response header 'Allow'"
}
      406List of supported error codes:
      - 62: Not acceptable
      {
  "code": 62,
  "message": "Not acceptable",
  "description": "The Accept incoming header does not match any available content-type."
}
      408List of supported error codes:
      - 63: Request time-out
      {
  "code": 63,
  "message": "Request time-out",
  "description": "The server timed out waiting for the incoming request."
}
      409List of supported error codes:
      - 69: Conflict
      {
  "code": 69,
  "message": "Conflict",
  "description": "The request could not be completed due to a conflict with the current state of the resource."
}
      411List of supported error codes:
      - 64: Length required
      {
  "code": 64,
  "message": "Length required",
  "description": "The request did not specify a Content-Length header, which is required by the requested resource."
}
      412List of supported error codes:
      - 65: Precondition failed
      {
  "code": 65,
  "message": "Precondition failed",
  "description": "One of the precondition request headers (aka. 'If-None-Match', 'If-Match', 'If-Modified-Since', and 'If-Unmodified-Since') failed to match."
}
      413List of supported error codes:
      - 66: Request entity too large
      {
  "code": 66,
  "message": "Request entity too large",
  "description": "The body of the request/response (PATCH, POST and PUT methods) is larger than the server is willing or able to process."
}
      414List of supported error codes:
      - 67: Request-URI too long
      {
  "code": 67,
  "message": "Request-URI too long",
  "description": "The URI provided was too long for the server to process."
}
      415List of supported error codes:
      - 68: Unsupported Media Type
      {
  "code": 68,
  "message": "Unsupported Media Type",
  "description": "The format of the posted body is not supported by the endpoint."
}
      429List of supported error codes:
      - 53: Too many requests
      {
  "code": 53,
  "message": "Too many requests",
  "description": "The application has made too many calls and has exceeded the rate limit for this service."
}
      500List of supported error codes:
      - 1: Internal error
      {
  "code": 1,
  "message": "Internal error",
  "description": "Generic failure message, used if no more precise code can be provided."
}
      502List of supported error codes:
      - 1: Internal error
      - 3: Bad gateway
      {
  "code": 1,
  "message": "Bad gateway",
  "description": "A runtime execution error occurs (RaiseFault)."
}
      503List of supported error codes:
      - 5: The service is temporarily unavailable
      - 6: Orange API is over capacity, retry later !
      {
  "code": 6,
  "message": "Orange API is over capacity, retry later !",
  "description": "The service faces too much requests and can not handle the call."
}
      504List of supported error codes:
      - 6: Gateway timeout
      {
  "code": 6,
  "message": "Gateway timeout",
  "description": "No response was received in time from a backend server acting as gateway or proxy."
}