Create Incident Ticket
Version 1.0.0
Endpoint
POST
https://ebond.att.com/{ebondEnv}/api/clientapi/incident
Copy
Creating Incident Ticket to AT&T process
oauth2
Oauth2 implementation using Client Credentials - client_id & client_secret ProvidedByAT&T
clientCredentials:
scopes:
tokenUrl:https://ebond.att.com/sandbox/EdhREjkedhs234nU/oauth2/token/
Parameters to add while 'Creating Ticket' process
Path Parameters
- ebondEnvstringRequiredEnum: [sandbox/EdhREjkedhs234nU]AT&T ebond environmentExample: sandbox/EdhREjkedhs234nU
Query Parameters
- instanceIdstringRequiredClient Instance Id, provided by AT&TExample: instest
- apiKeystringRequiredUnique apikey per Client's instance, provided by AT&TExample: api234key24ljaalkjfiolaskdjfjalllfasd223
- clientIdstringRequiredUnique Client Id per Client, provided by AT&TExample: cli123ijklm4uv
Body Parameters
- object
- statestringThe client's ticket state. Att notes the client's state for reference purposes only. No restrictions on valuesExample: NewLength: 16
- numberstringRequiredTicket number of the client incident.Example: INC0020003Length: 31
- sys_idstringRequiredClient unique record ID. Used to link Att item to client item.Example: b5853027371133007bc9ded993990e89Length: 128
- locationstringCity for the location.Example: TestLength: 60
- caller_idstringName of individual using affected asset.Example: Alfonso GriglenLength: 20
- AttAssetIdstringThe unique identifier of the asset. Ideally customer should send a value that exactly matches to a corresponding value in the AT&T asset inventory. For select AT&T services, customer sending a value that does NOT exactly match to AT&T asset value will result in a failure of the create transaction.Example: Test Asset IDLength: 44
- work_notesstringFree-form text entered by the Customer or agent.Example: System Administrator (Work notes)\n update for swagger documentationLength: 32000
- AttSeveritystringRequiredLevel of dysfunction from outage, severity level should be start from 1.Example: 1Length: 1
- descriptionstringFree-form text entered by the Customer or agent on behalf of the Customer. A longer form of original text describing the problem being experienced in more detail than the short description. This will be mapped into the AT&T ticket log as part of the initial entry as there is no direct field equivalent in the AT&T ticketing systems.Example: Description field contents from ServiceNowLength: 32000
- location_zipstringPostal zip code for the location.Example: any stringLength: 10
- location_citystringCity for the location.Example: LondonLength: 60
- resolve_notesstringFree-form text describing problem resolution. Typically generated in the AT&T system at the time they resolve the ticket. Not relevant for customer to send this value to AT&T.Example: any stringLength: 160
- correlation_idstringUnique number identifying the AT&T main ticket. (This is the AT&T ticket number.). This is not required for client to send as part of create transaction. It will be provided as part of the response from AT&T.Example: any string
- opened_by_namestringName of individual who reported client trouble or request.Example: System AdministratorLength: 43
- caller_id_namestringName of contact at client site who gets updates on the status of the asset in trouble. This field is required by Process to support the incident lifecycle.Example: Alfonso GriglenLength: 43
- location_statestringState and province for the location.Example: any stringLength: 20
- location_streetstringFirst line of the address in locationExample: any stringLength: 60
- opened_by_emailstringRequiredEmail address of individual who reported the client trouble or request.Example: admin@example.comLength: 50
- caller_id_emailstringRequiredEmail of contact at client site who gets updates on the status of the asset in trouble.Example: alfonso.griglen@example.comLength: 50
- opened_by_phonestringPhone number of the individual who reported client trouble or request.Example: any stringLength: 25
- caller_id_phonestringPhone number of the caller. If caller_id_name is present on the transaction, then this is a required field.Example: any stringLength: 25
- AttReportedTimestringDate/time trouble was reported by external entity into the AT&T ticketing system.Example: any string
- short_descriptionstringFree form text of problem description. This might also be described as an "Abstract" or "Title" of the problem.Example: Short description for MLAN reactive ticketLength: 255
- AttIncidentStatusstringRepresents the state of the ticket in the AT&T system. For client create transaction default to sending "New" as the value from the client system.Example: NewLength: 16
- CustomerLocationIdstringID of where the asset resides this Comes from AT&T asset record (if used).Example: any stringLength: 11
- AttServiceCategorystringRequiredCode that identifies the initial service line. A list of enumerated values will be provided by the AT&T Business Analyst for your particular integration.Example: ATT-MLAN-Riverbed
- caller_id_user_namestringName of contact at client site who gets updates on the status.Example: alfonso.griglen1Length: 25
- AttIncidentOpenDatestringValue represents the date the ticket was opened in the AT&T ticketing system.Example: 2024-10-16 14:09:25
- AttResolutionActionstringAT&T Code OR description that identifies the action taken to resolve the trouble - Not sent by client on create transactions.Example: any stringLength: 15
- opened_by_user_namestringName of individual who reported client trouble or request. Though not required by schema, this field is required by Process to support the incident lifecycle.Example: adminLength: 43
- correlation_displaystringExample: any string
- AttTicketResolveDatestringThis is the date that AT&T resolved the ticket.Example: 2024-10-16 14:09:25
- location_countrycodestringISO country code of the location.Example: any stringLength: 20
- AttServiceRestoredDatestringDate/time of service was restored. The date represents when service is tracked as Restored in the AT&T ticketing system.Example: 2024-10-16 14:09:25
Responses
Request was successfully processed
Body
application/json
- objectRequired
- resultsobject