{ "info": { "title": "AT&T eBonding", "version": "1.0.0", "contact": { "name": "AT&T ebonding tech team", "email": "ebonding@att.com" }, "description": "The API documentation for ebonding with AT&T to Create and Update (Worknote addition & send attachments) Incident tickets & Service Requests." }, "tags": [ { "name": "Incident Ticket", "description": "Create/Update Incident Ticket" }, { "name": "Service Request", "description": "Create and Update Service Request" }, { "name": "File Attachment Update", "description": "Send File Attachment to Incident/Service Request " } ], "paths": { "/{ebondEnv}/api/clientapi/incident": { "put": { "tags": [ "Incident Ticket" ], "summary": "Update Incident Ticket", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessApiResponse" } } }, "description": "Ticket Updated Successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FailureApiResponse" } } }, "headers": { "Retry-After": { "schema": { "type": "string", "format": "date-time" }, "required": true, "description": "The Retry-After response HTTP header indicates how long the client should wait before retrying the request." } }, "description": "Unable to process request - please recheck request Body properties and values." }, "404": { "description": "requested data could not be found" } }, "parameters": [ { "$ref": "#/components/parameters/ebondEnv" }, { "$ref": "#/components/parameters/instanceId" }, { "$ref": "#/components/parameters/apiKey" }, { "$ref": "#/components/parameters/clientId" } ], "operationId": "clientapi_incident_put", "description": "Send Updates (Add Work Notes) to AT&T Incident Ticket", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTicket" } } }, "required": true, "description": "Enter valid values in body and it should contain in form of json format." } }, "post": { "tags": [ "Incident Ticket" ], "summary": "Create Incident Ticket", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessApiResponse" } } }, "description": "Request was successfully processed" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FailureApiResponse" } } }, "headers": { "Retry-After": { "schema": { "type": "string", "format": "date-time" }, "required": true, "description": "The Retry-After response HTTP header indicates how long the client should wait before retrying the request." } }, "description": "Unable to process request - please recheck request Body properties and values." }, "404": { "description": "requested data could not be found" } }, "parameters": [ { "$ref": "#/components/parameters/ebondEnv" }, { "$ref": "#/components/parameters/instanceId" }, { "$ref": "#/components/parameters/apiKey" }, { "$ref": "#/components/parameters/clientId" } ], "operationId": "clientapi_incident_post", "description": "Creating Incident Ticket to AT&T process", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketCreation" } } }, "required": true, "description": "Parameters to add while 'Creating Ticket' process" } } }, "/{ebondEnv}/api/clientapi/servicerequest": { "put": { "tags": [ "Service Request" ], "summary": "Update Service Request", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessApiResponse" } } }, "description": "Request was successfully processed" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FailureApiResponse" } } }, "headers": { "Retry-After": { "schema": { "type": "string", "format": "date-time" }, "required": true, "description": "The Retry-After response HTTP header indicates how long the client should wait before retrying the request." } }, "description": "The request cannot be fulfilled due to one of the mandatory property is missed or incomplete." }, "404": { "description": "requested data could not be found" } }, "parameters": [ { "$ref": "#/components/parameters/ebondEnv" }, { "$ref": "#/components/parameters/instanceId" }, { "$ref": "#/components/parameters/apiKey" }, { "$ref": "#/components/parameters/clientId" } ], "operationId": "clientapi_servicerequest_put", "description": "Update request is for Client to request update of a Client Request in the AT&T GPS system; update can be used to send a work note that will be appended to the request.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateServiceRequest" } } }, "required": true } }, "post": { "tags": [ "Service Request" ], "summary": "Create Service Request", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessApiResponse" } } }, "description": "Ok" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FailureApiResponse" } } }, "headers": { "Retry-After": { "schema": { "type": "string", "format": "date-time" }, "required": true, "description": "The Retry-After response HTTP header indicates how long the client should wait before retrying the request." } }, "description": "The request cannot be fulfilled due to one of the mandatory parameter is missed or incomplete." }, "404": { "description": "requested data could not be found." } }, "parameters": [ { "$ref": "#/components/parameters/ebondEnv" }, { "$ref": "#/components/parameters/instanceId" }, { "$ref": "#/components/parameters/apiKey" }, { "$ref": "#/components/parameters/clientId" } ], "operationId": "clientapi_servicerequest_post", "description": "Create request is for Client to request creation of a Client Request in the AT&T GPS system.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceRequestCreation" } } }, "required": true } } }, "/{ebondEnv}/api/clientapi/{FileAttachmentTicketType}": { "put": { "tags": [ "File Attachment Update" ], "summary": "Send File Attachment to Incident/Service Request", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessApiResponse" } } }, "description": "Ticket Updated Successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FailureApiResponse" } } }, "headers": { "Retry-After": { "schema": { "type": "string", "format": "date-time" }, "required": true, "description": "The Retry-After response HTTP header indicates how long the client should wait before retrying the request." } }, "description": "Unable to process request - please recheck request Body properties and values." }, "404": { "description": "requested data could not be found" } }, "parameters": [ { "$ref": "#/components/parameters/ebondEnv" }, { "$ref": "#/components/parameters/FileAttachmentTicketType" }, { "$ref": "#/components/parameters/instanceId" }, { "$ref": "#/components/parameters/apiKey" }, { "$ref": "#/components/parameters/clientId" }, { "$ref": "#/components/parameters/number" }, { "$ref": "#/components/parameters/sys_id" }, { "$ref": "#/components/parameters/correlation_id" }, { "$ref": "#/components/parameters/AttachmentFilename" }, { "$ref": "#/components/parameters/attachmentLength" }, { "$ref": "#/components/parameters/attachmentMimeType" } ], "operationId": "clientapi_attachment_put", "description": "Update Incident Ticket to AT&T process", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "data": { "type": "string", "format": "binary" } } } } }, "required": true, "description": "Actual File Attachment that needs to be sent" } } } }, "openapi": "3.0.1", "servers": [ { "url": "https://ebond.att.com", "description": "Server URI, this contains host name and eBondEnv path parameter." } ], "security": [ { "oAuth2ClientCredentials": [] } ], "components": { "schemas": { "UpdateTicket": { "type": "object", "required": [ "number", "correlation_id", "sys_id", "AttServiceCategory" ], "properties": { "state": { "$ref": "#/components/schemas/TicketCreation/properties/state" }, "number": { "type": "string", "example": "INC0020003", "maxLength": 31, "minLength": 1, "description": "Ticket number of the client incident." }, "sys_id": { "type": "string", "example": "b5853027371133007bc9ded993990e89", "maxLength": 128, "minLength": 5, "description": "Client unique record ID. Used to link AT&T item to client item." }, "location": { "$ref": "#/components/schemas/TicketCreation/properties/location" }, "caller_id": { "$ref": "#/components/schemas/TicketCreation/properties/caller_id" }, "AttAssetId": { "$ref": "#/components/schemas/TicketCreation/properties/AttAssetId" }, "work_notes": { "$ref": "#/components/schemas/TicketCreation/properties/work_notes" }, "AttSeverity": { "$ref": "#/components/schemas/TicketCreation/properties/AttSeverity" }, "description": { "$ref": "#/components/schemas/TicketCreation/properties/description" }, "location_zip": { "$ref": "#/components/schemas/TicketCreation/properties/location_zip" }, "location_city": { "$ref": "#/components/schemas/TicketCreation/properties/location_city" }, "resolve_notes": { "$ref": "#/components/schemas/TicketCreation/properties/resolve_notes" }, "correlation_id": { "type": "string", "example": "000000253522216", "description": "Unique number identifying the AT&T main ticket. (This is the AT&T ticket number.). This is required for client to send as part of update transaction." }, "opened_by_name": { "$ref": "#/components/schemas/TicketCreation/properties/opened_by_name" }, "caller_id_name": { "$ref": "#/components/schemas/TicketCreation/properties/caller_id_name" }, "location_state": { "$ref": "#/components/schemas/TicketCreation/properties/location_state" }, "location_street": { "$ref": "#/components/schemas/TicketCreation/properties/location_street" }, "opened_by_email": { "$ref": "#/components/schemas/TicketCreation/properties/opened_by_email" }, "caller_id_email": { "$ref": "#/components/schemas/TicketCreation/properties/caller_id_email" }, "opened_by_phone": { "$ref": "#/components/schemas/TicketCreation/properties/opened_by_phone" }, "caller_id_phone": { "$ref": "#/components/schemas/TicketCreation/properties/caller_id_phone" }, "AttReportedTime": { "$ref": "#/components/schemas/TicketCreation/properties/AttReportedTime" }, "short_description": { "$ref": "#/components/schemas/TicketCreation/properties/short_description" }, "AttIncidentStatus": { "$ref": "#/components/schemas/TicketCreation/properties/AttIncidentStatus" }, "CustomerLocationId": { "$ref": "#/components/schemas/TicketCreation/properties/CustomerLocationId" }, "AttServiceCategory": { "$ref": "#/components/schemas/TicketCreation/properties/AttServiceCategory" }, "caller_id_user_name": { "$ref": "#/components/schemas/TicketCreation/properties/caller_id_user_name" }, "AttIncidentOpenDate": { "$ref": "#/components/schemas/TicketCreation/properties/AttIncidentOpenDate" }, "AttResolutionAction": { "$ref": "#/components/schemas/TicketCreation/properties/AttResolutionAction" }, "opened_by_user_name": { "$ref": "#/components/schemas/TicketCreation/properties/opened_by_user_name" }, "correlation_display": { "$ref": "#/components/schemas/TicketCreation/properties/correlation_display" }, "AttTicketResolveDate": { "$ref": "#/components/schemas/TicketCreation/properties/AttTicketResolveDate" }, "location_countrycode": { "$ref": "#/components/schemas/TicketCreation/properties/location_countrycode" }, "AttServiceRestoredDate": { "$ref": "#/components/schemas/TicketCreation/properties/AttServiceRestoredDate" } } }, "TicketCreation": { "type": "object", "required": [ "AttSeverity", "caller_id_email", "number", "opened_by_email", "sys_id", "AttServiceCategory" ], "properties": { "state": { "type": "string", "example": "New", "maxLength": 16, "minLength": 1, "description": "The client's ticket state. Att notes the client's state for reference purposes only. No restrictions on values" }, "number": { "type": "string", "example": "INC0020003", "maxLength": 31, "minLength": 1, "description": "Ticket number of the client incident." }, "sys_id": { "type": "string", "example": "b5853027371133007bc9ded993990e89", "maxLength": 128, "minLength": 5, "description": "Client unique record ID. Used to link Att item to client item." }, "location": { "type": "string", "example": "Test", "maxLength": 60, "minLength": 1, "description": "City for the location." }, "caller_id": { "type": "string", "example": "Alfonso Griglen", "maxLength": 20, "minLength": 1, "description": "Name of individual using affected asset." }, "AttAssetId": { "type": "string", "example": "Test Asset ID", "maxLength": 44, "minLength": 1, "description": "The 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." }, "work_notes": { "type": "string", "example": "System Administrator (Work notes)\\n update for swagger documentation", "maxLength": 32000, "minLength": 1, "description": "Free-form text entered by the Customer or agent." }, "AttSeverity": { "type": "string", "example": "1", "maxLength": 1, "minLength": 1, "description": "Level of dysfunction from outage, severity level should be start from 1." }, "description": { "type": "string", "example": "Description field contents from ServiceNow", "maxLength": 32000, "minLength": 1, "description": "Free-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." }, "location_zip": { "type": "string", "example": "any string", "maxLength": 10, "minLength": 1, "description": "Postal zip code for the location." }, "location_city": { "type": "string", "example": "London", "maxLength": 60, "minLength": 1, "description": "City for the location." }, "resolve_notes": { "type": "string", "example": "any string", "maxLength": 160, "minLength": 1, "description": "Free-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." }, "correlation_id": { "type": "string", "example": "any string", "description": "Unique 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." }, "opened_by_name": { "type": "string", "example": "System Administrator", "maxLength": 43, "minLength": 1, "description": "Name of individual who reported client trouble or request." }, "caller_id_name": { "type": "string", "example": "Alfonso Griglen", "maxLength": 43, "minLength": 1, "description": "Name 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." }, "location_state": { "type": "string", "example": "any string", "maxLength": 20, "minLength": 1, "description": "State and province for the location." }, "location_street": { "type": "string", "example": "any string", "maxLength": 60, "minLength": 1, "description": "First line of the address in location" }, "opened_by_email": { "type": "string", "example": "admin@example.com", "maxLength": 50, "minLength": 1, "description": "Email address of individual who reported the client trouble or request." }, "caller_id_email": { "type": "string", "example": "alfonso.griglen@example.com", "maxLength": 50, "minLength": 1, "description": "Email of contact at client site who gets updates on the status of the asset in trouble." }, "opened_by_phone": { "type": "string", "example": "any string", "maxLength": 25, "minLength": 1, "description": "Phone number of the individual who reported client trouble or request." }, "caller_id_phone": { "type": "string", "example": "any string", "maxLength": 25, "minLength": 1, "description": "Phone number of the caller. If caller_id_name is present on the transaction, then this is a required field." }, "AttReportedTime": { "type": "string", "format": "data-time", "example": "any string", "description": "Date/time trouble was reported by external entity into the AT&T ticketing system." }, "short_description": { "type": "string", "example": "Short description for MLAN reactive ticket", "maxLength": 255, "minLength": 1, "description": "Free form text of problem description. This might also be described as an \"Abstract\" or \"Title\" of the problem." }, "AttIncidentStatus": { "type": "string", "example": "New", "maxLength": 16, "minLength": 1, "description": "Represents 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." }, "CustomerLocationId": { "type": "string", "example": "any string", "maxLength": 11, "minLength": 1, "description": "ID of where the asset resides this Comes from AT&T asset record (if used)." }, "AttServiceCategory": { "type": "string", "example": "ATT-MLAN-Riverbed", "description": "Code that identifies the initial service line. A list of enumerated values will be provided by the AT&T Business Analyst for your particular integration." }, "caller_id_user_name": { "type": "string", "example": "alfonso.griglen1", "maxLength": 25, "minLength": 1, "description": "Name of contact at client site who gets updates on the status." }, "AttIncidentOpenDate": { "type": "string", "format": "date-time", "example": "2024-10-16 14:09:25", "description": "Value represents the date the ticket was opened in the AT&T ticketing system." }, "AttResolutionAction": { "type": "string", "example": "any string", "maxLength": 15, "minLength": 1, "description": "AT&T Code OR description that identifies the action taken to resolve the trouble - Not sent by client on create transactions." }, "opened_by_user_name": { "type": "string", "example": "admin", "maxLength": 43, "minLength": 1, "description": "Name of individual who reported client trouble or request. Though not required by schema, this field is required by Process to support the incident lifecycle." }, "correlation_display": { "type": "string", "example": "any string", "description": "" }, "AttTicketResolveDate": { "type": "string", "format": "date-time", "example": "2024-10-16 14:09:25", "description": "This is the date that AT&T resolved the ticket." }, "location_countrycode": { "type": "string", "example": "any string", "maxLength": 20, "minLength": 1, "description": "ISO country code of the location." }, "AttServiceRestoredDate": { "type": "string", "format": "date-time", "example": "2024-10-16 14:09:25", "description": "Date/time of service was restored. The date represents when service is tracked as Restored in the AT&T ticketing system." } } }, "SuccessApiResponse": { "type": "object", "properties": { "results": { "type": "object", "properties": { "sys_id": { "type": "string", "example": "inpsysid42324398492abds32423232da", "description": "Client's recordId number that is linked to the AT&T ticket number." }, "number": { "type": "string", "example": "INC10023312", "description": "Client provided ticket number that is linked to the AT&T ticket number." }, "correlation_id": { "type": "string", "example": "00000042340234", "description": "AT&T ticket number that will be returned in a successful ticket creation." } } } } }, "FailureApiResponse": { "type": "object", "properties": { "results": { "type": "object", "properties": { "msg": { "type": "string" } } } } }, "SRCreationextended": { "type": "object", "required": [ "SrGps_requestOrderCompletionDate", "SrGps_clientSiteIdTo", "SrGps_AttCostcode", "SrGps_serviceLineCode" ], "properties": { "SrGps_priority": { "type": "string", "enum": [ "High", "Low" ], "example": "Low", "description": "Determines if request is submitted as Standard or Expedite. \"High\" is \"Expedite\"; \"Low\" is \"Standard\"" }, "SrGps_quantity": { "type": "string", "example": "1", "description": "Quantity for the requested Catalog ID. \"0\" is not applicable. \"1\" is a typical value." }, "SrGps_description": { "type": "string", "example": "Test description from Extended variables in ServiceNow", "maxLength": 4000, "minLength": 1, "description": "Text used to describe the basics of the request to be created in the AT&T system; If description of request is lengthy (nearing 4000 characters) client should consider sending a document with additional details as an attachment, either as part of Create or Update transaction, If description exceeds max length, the system will throw a back end error and request will not be processed." }, "SrGps_AttCostcode": { "type": "string", "example": "anystring", "maxLength": 50, "minLength": 1, "description": "A value is required by the bond in order to create a Client Request in GPS. May or may not represent an actual Cost Center." }, "SrGps_clientSiteIdTo": { "type": "string", "example": "EMEA-UK-LONDON-0225", "maxLength": 30, "minLength": 1, "description": "ID of client site as captured and represented in GPS as Customer Site ID in GPS. Value must match a valid GPS field value in order for the request to be created successfully; Client should work with assigned AT&T Business Analyst and AT&T account team to determine method for identification and capture of valid Site ID values that should be sent." }, "SrGps_caller_id_room": { "type": "string", "example": "2", "description": "Room number of the location of the caller requesting the service." }, "SrGps_serviceLineCode": { "type": "string", "example": "eLCM_LMAC_SECURITY", "maxLength": 30, "minLength": 1, "description": "Must be a valid SR Line type code in AT&T provisioning system. Check with your AT&T contact to confirm which service codes are applicable for your customer and service via the eBond." }, "SrGps_caller_id_buildingNumber": { "type": "string", "example": "1" }, "SrGps_requestOrderCompletionDate": { "type": "string", "format": "date-time", "example": "2024-10-16 14:09:25", "description": "CompletionDate should be greater than CurrentDate; if not, the request cannot be created in the AT&T system - system will return a back end error." } } }, "UpdateServiceRequest": { "type": "object", "required": [ "number", "correlation_id", "sys_id" ], "properties": { "state": { "$ref": "#/components/schemas/ServiceRequestCreation/properties/state" }, "number": { "type": "string", "example": "RITM0032003", "maxLength": 30, "minLength": 1, "description": "Request number in the customer's system." }, "sys_id": { "type": "string", "example": "1bfa9c3c379233007bc9ded993990efd", "description": "Client unique record ID. Used to link Att item to client item." }, "extended": { "$ref": "#/components/schemas/SRCreationextended" }, "location": { "$ref": "#/components/schemas/ServiceRequestCreation/properties/location" }, "caller_id": { "$ref": "#/components/schemas/ServiceRequestCreation/properties/caller_id" }, "AttAssetId": { "$ref": "#/components/schemas/ServiceRequestCreation/properties/AttAssetId" }, "work_notes": { "$ref": "#/components/schemas/ServiceRequestCreation/properties/work_notes" }, "AttSeverity": { "$ref": "#/components/schemas/ServiceRequestCreation/properties/AttSeverity" }, "description": { "$ref": "#/components/schemas/ServiceRequestCreation/properties/description" }, "location_zip": { "$ref": "#/components/schemas/ServiceRequestCreation/properties/location_zip" }, "location_city": { "$ref": "#/components/schemas/ServiceRequestCreation/properties/location_city" }, "resolve_notes": { "$ref": "#/components/schemas/ServiceRequestCreation/properties/resolve_notes" }, "correlation_id": { "type": "string", "example": "00002465718", "description": "Unique number identifying the AT&T client request. (This is the AT&T client request)" }, "opened_by_name": { "$ref": "#/components/schemas/ServiceRequestCreation/properties/opened_by_name" }, "caller_id_name": { "$ref": "#/components/schemas/ServiceRequestCreation/properties/caller_id_name" }, "location_state": { "$ref": "#/components/schemas/ServiceRequestCreation/properties/location_state" }, "location_street": { "$ref": "#/components/schemas/ServiceRequestCreation/properties/location_street" }, "opened_by_email": { "$ref": "#/components/schemas/ServiceRequestCreation/properties/opened_by_email" }, "caller_id_email": { "$ref": "#/components/schemas/ServiceRequestCreation/properties/caller_id_email" }, "opened_by_phone": { "$ref": "#/components/schemas/ServiceRequestCreation/properties/opened_by_phone" }, "caller_id_phone": { "$ref": "#/components/schemas/ServiceRequestCreation/properties/caller_id_phone" }, "short_description": { "$ref": "#/components/schemas/ServiceRequestCreation/properties/short_description" }, "AttIncidentStatus": { "$ref": "#/components/schemas/ServiceRequestCreation/properties/AttIncidentStatus" }, "AttServiceCategory": { "$ref": "#/components/schemas/ServiceRequestCreation/properties/AttServiceCategory" }, "caller_id_user_name": { "$ref": "#/components/schemas/ServiceRequestCreation/properties/caller_id_user_name" }, "AttIncidentOpenDate": { "$ref": "#/components/schemas/ServiceRequestCreation/properties/AttIncidentOpenDate" }, "AttResolutionAction": { "$ref": "#/components/schemas/ServiceRequestCreation/properties/AttResolutionAction" }, "opened_by_user_name": { "$ref": "#/components/schemas/ServiceRequestCreation/properties/opened_by_user_name" }, "correlation_display": { "$ref": "#/components/schemas/ServiceRequestCreation/properties/correlation_display" }, "AttTicketResolveDate": { "$ref": "#/components/schemas/ServiceRequestCreation/properties/AttTicketResolveDate" }, "location_countrycode": { "$ref": "#/components/schemas/ServiceRequestCreation/properties/location_countrycode" }, "AttServiceRestoredDate": { "$ref": "#/components/schemas/ServiceRequestCreation/properties/AttServiceRestoredDate" }, "AttActualCompletionDate": { "$ref": "#/components/schemas/ServiceRequestCreation/properties/AttActualCompletionDate" }, "AttSLANegotiatedDueDate": { "$ref": "#/components/schemas/ServiceRequestCreation/properties/AttSLANegotiatedDueDate" } } }, "ServiceRequestCreation": { "type": "object", "required": [ "number", "sys_id", "caller_id_name", "AttServiceCategory" ], "properties": { "state": { "type": "string", "example": "Open", "maxLength": 20, "minLength": 1, "description": "The client's ticket state." }, "number": { "type": "string", "example": "RITM0032001", "maxLength": 30, "minLength": 1, "description": "Request number in the customer's system." }, "sys_id": { "type": "string", "example": "d9836ba3370233007bc9ded993990ea0", "maxLength": 128, "minLength": 5, "description": "Client unique record ID. Used to link Att item to client item." }, "extended": { "$ref": "#/components/schemas/SRCreationextended" }, "location": { "type": "string", "example": "test", "maxLength": 60, "minLength": 1, "description": "City for the location." }, "caller_id": { "type": "string", "example": "Alfonso Griglen", "maxLength": 20, "minLength": 1, "description": "Name of individual using affected asset." }, "AttAssetId": { "type": "string", "example": "any string", "maxLength": 44, "minLength": 1, "description": "The unique identifier of the asset as represented in the AT&T system. (NA for client request process)" }, "work_notes": { "type": "string", "example": "System Administrator (Work notes)\\n update for swagger documentation.", "maxLength": 2000, "minLength": 1, "description": "Free-form text entered by the Customer or agent on behalf of the Customer that they deem as needed in helping to work, resolve the problem or status the Customer." }, "AttSeverity": { "type": "string", "enum": [ "1", "2", "3", "4", "5", "6" ], "example": "5", "maxLength": 15, "minLength": 1, "description": "Level of dysfunction from outage, severity level should be start from 1 (Not used for Client Request process)." }, "description": { "type": "string", "example": "any string", "maxLength": 4000, "minLength": 1, "description": "Free-form text entered by the Customer or agent on behalf of the Customer. This should be a high level description of the request being submitted." }, "location_zip": { "type": "string", "example": "any string", "maxLength": 20, "minLength": 1, "description": "Postal zip code for the location." }, "location_city": { "type": "string", "example": "London", "maxLength": 60, "minLength": 1, "description": "City for the location." }, "resolve_notes": { "type": "string", "example": "any string", "maxLength": 160, "minLength": 1, "description": "Free-form text describing problem resolution. Provided by AT&T on closure - not applicable for customer to send to AT&T." }, "correlation_id": { "type": "string", "example": "any string", "description": "Unique number identifying the AT&T client request. (This is the AT&T client request).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." }, "opened_by_name": { "type": "string", "example": "System Administrator", "maxLength": 43, "minLength": 1, "description": "Name of individual who reported client trouble or request." }, "caller_id_name": { "type": "string", "example": "System Administrator", "maxLength": 43, "minLength": 1, "description": "Name of client contact at client site who gets updates on the status of the requested item. This field is required by Process." }, "location_state": { "type": "string", "example": "any string", "maxLength": 20, "minLength": 1, "description": "State OR Province for the location." }, "location_street": { "type": "string", "example": "any string", "maxLength": 60, "minLength": 1, "description": "First line of the address in location." }, "opened_by_email": { "type": "string", "example": "admin@example.com", "maxLength": 50, "minLength": 1, "description": "Email address of individual who reported the client trouble or request." }, "caller_id_email": { "type": "string", "example": "admin@example.com", "maxLength": 50, "minLength": 5, "description": "Email of contact at client site who gets updates on the status of the asset in trouble." }, "opened_by_phone": { "type": "string", "example": "any string", "maxLength": 25, "minLength": 1, "description": "Phone number of the individual who reported client trouble or request." }, "caller_id_phone": { "type": "string", "example": "any string", "maxLength": 25, "minLength": 1, "description": "Phone number of the caller. If caller_id_name is present on the transaction, then this is a required field." }, "short_description": { "type": "string", "example": "eLCM_LMAC_SECURITY", "maxLength": 255, "minLength": 1, "description": "Value passed here will represent the Service Line Code or Catalog Item used for GPS purposes. A list of enumerated values will be provided by the AT&T Business Analyst for your particular integration." }, "AttIncidentStatus": { "type": "string", "example": "New", "maxLength": 16, "minLength": 0, "description": "The status of the ticket as represented in the AT&T incident or ServiceRequest." }, "AttServiceCategory": { "type": "string", "example": "REQUEST-ATT", "description": "Code that identifies the initial service line. A list of enumerated values will be provided by the AT&T Business Analyst for your particular integration." }, "caller_id_user_name": { "type": "string", "example": "admin", "maxLength": 25, "minLength": 1, "description": "Name of contact person, who get updates on the status." }, "AttIncidentOpenDate": { "type": "string", "format": "date-time", "description": "Date/time ticket was opened. This is not required or applicable for Service Request Create/Update transactions from the client." }, "AttResolutionAction": { "type": "string", "example": "any string", "maxLength": 15, "minLength": 1, "description": "AT&T Code OR description that identifies the action taken to resolve the trouble - Not sent by client on create transactions." }, "opened_by_user_name": { "type": "string", "example": "admin", "maxLength": 20, "minLength": 1, "description": "Name of individual who reported client trouble or request." }, "correlation_display": { "type": "string", "example": "att_ebonding", "description": "" }, "AttTicketResolveDate": { "type": "string", "format": "date-time", "description": "This is the date that AT&T resolved the ticket. This typically applies only in transactions from AT&T to client. Not required or applicable from client to AT&T." }, "location_countrycode": { "type": "string", "example": "any string", "maxLength": 20, "minLength": 1, "description": "ISO country code of the location." }, "AttServiceRestoredDate": { "type": "string", "format": "date-time", "description": "Date/time of service was restored. This is not required or applicable for Service Request Create/Update transactions from the client." }, "AttActualCompletionDate": { "type": "string", "format": "date-time", "description": "Represents the date the ATT request was actually completed in the GPS system. This date is not used or required for Client Create and Update transactions." }, "AttSLANegotiatedDueDate": { "type": "string", "format": "date-time", "description": "The SLA Negotiated Date of the Service Request. This is populated and sent by AT&T from the AT&T request - not applicable for customer to send to AT&T." } } } }, "parameters": { "number": { "in": "query", "name": "number", "schema": { "type": "string", "example": "INC0032003" }, "required": true, "description": "Ticket number of the client" }, "sys_id": { "in": "query", "name": "sys_id", "schema": { "type": "string", "example": "058d9b5f374e33007bc9ded993990e5c" }, "required": true, "description": "Client unique record ID. Used to link AT&T item to client item." }, "apiKey": { "in": "query", "name": "apiKey", "schema": { "type": "string", "example": "api234key24ljaalkjfiolaskdjfjalllfasd223" }, "required": true, "description": "Unique apikey per Client's instance, provided by AT&T" }, "ebondEnv": { "name": "ebondEnv", "in": "path", "description": "AT&T ebond environment", "required": true, "schema": { "type": "string", "enum": [ "sandbox/EdhREjkedhs234nU" ], "example": "sandbox/EdhREjkedhs234nU" } }, "clientId": { "in": "query", "name": "clientId", "schema": { "type": "string", "example": "cli123ijklm4uv" }, "required": true, "description": "Unique Client Id per Client, provided by AT&T" }, "instanceId": { "in": "query", "name": "instanceId", "schema": { "type": "string", "example": "instest" }, "required": true, "description": "Client Instance Id, provided by AT&T" }, "correlation_id": { "in": "query", "name": "correlation_id", "schema": { "type": "string", "example": "000000253522216" }, "required": true, "description": "Unique number identifying the AT&T main ticket. (This is the AT&T ticket number.). This is required for client to send as part of update transaction." }, "attachmentLength": { "in": "query", "name": "attachmentLength", "schema": { "type": "string", "example": "12300" }, "required": true, "description": "File Attachment Length in Bytes" }, "AttachmentFilename": { "in": "query", "name": "AttachmentFilename", "schema": { "type": "string", "example": "sampletext1KB.txt" }, "required": true, "description": "File Attachment Name" }, "attachmentMimeType": { "in": "query", "name": "attachmentMimeType", "schema": { "type": "string", "example": "text/plain" }, "required": true, "description": "File Attachment Mime Type" }, "FileAttachmentTicketType": { "in": "path", "name": "FileAttachmentTicketType", "schema": { "type": "string", "enum": [ "incident", "servicerequest" ], "example": "incident" }, "required": true, "description": "The associated ticket type for sending file attachment" } }, "securitySchemes": { "oAuth2ClientCredentials": { "type": "oauth2", "flows": { "clientCredentials": { "scopes": {}, "tokenUrl": "https://ebond.att.com/sandbox/EdhREjkedhs234nU/oauth2/token/" } }, "description": "Oauth2 implementation using Client Credentials - client_id & client_secret ProvidedByAT&T" } } } }