Imported data
bearerAuth Bearer Token (JWT) | Recurso | Descripción |
|---|---|
| Trouble Ticket | Everything about your trouble tickets |
bearerAuth Bearer Token (JWT) | Recurso | Descripción |
|---|---|
| Trouble Ticket | Everything about your trouble tickets |
Create a new trouble ticket with status OPENACTIVE
trouble ticket attributes needed to create a new trouble ticket
{
"baseTroubleTicketState": "OPENACTIVE",
"mirrorKey": "string",
"dialog": "string",
"troubleType": "string",
"troubleDescription": "string",
"troubleDetectionTime": "2025-01-15T10:30:00Z",
"preferredPriority": 1,
"troubledObject": "string",
"customerTroubleNum": "string",
"homeId": "string",
"gescal37ID": "string",
"wh1Parameter": "cliente",
"wh2Parameter": "string",
"wh3Parameter": "string",
"wh4Parameter": "string",
"wh5Parameter": "string",
"customer": "string",
"clearencePerson": "string",
"attachments": [
{
"content": "string",
"mimeType": "string",
"name": "string"
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
baseTroubleTicketState* | string
()
OPENACTIVE | trouble ticket status | maxLength: 15 | |||||||||||||||||||||
mirrorKey* | string | trouble ticket id in TU ( territory user) | maxLength: 255 | |||||||||||||||||||||
dialog* | string | information about the issue | maxLength: 4000 | |||||||||||||||||||||
troubleType* | string | agreed opening typifications | maxLength: 35 | |||||||||||||||||||||
troubleDescription* | string | short description about issue | maxLength: 1000 | |||||||||||||||||||||
troubleDetectionTime* | string (date-time) | issue dectention datetime | ||||||||||||||||||||||
preferredPriority* | integer (integer)
()
123 | issue severity level. Level 1 more than 200 clients , level 2 between 65 & 200 and level 3 between 10 & 65) | min: 1, max: 3 | |||||||||||||||||||||
troubledObject* | string | affected object | maxLength: 100 | |||||||||||||||||||||
customerTroubleNum* | string | affected client identifier | maxLength: 100 | |||||||||||||||||||||
homeId | string | client home identifier. This field is required when issue type is client and IUA is not ready. | maxLength: 255 | |||||||||||||||||||||
gescal37ID | string | Gescal 37 indetifier | maxLength: 40 | |||||||||||||||||||||
wh1Parameter* | string
()
clientered | issue type (client | network ) | ||||||||||||||||||||||
wh2Parameter | string | generic field | maxLength: 255 | |||||||||||||||||||||
wh3Parameter | string | generic field | maxLength: 255 | |||||||||||||||||||||
wh4Parameter | string | generic field | maxLength: 255 | |||||||||||||||||||||
wh5Parameter | string | generic field | maxLength: 255 | |||||||||||||||||||||
customer | string | number of clients affected | ||||||||||||||||||||||
clearencePerson* | string | remote agent indentifier | ||||||||||||||||||||||
attachments | object[] | |||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||
{
"data": {},
"attachment": [
"string"
]
}| Property | Type | Description | Constraints | Default | |||||
|---|---|---|---|---|---|---|---|---|---|
data | object | json with the properties createTroubleTicketByValueRequest | |||||||
| |||||||||
attachment | string (binary)[] | array of attachtments in base64 (multipart/form-data) | |||||||
Created trouble ticket has been created successfully
{
"ticketId": "RED-84",
"mirrorKey": "ONV-1024"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
ticketId | string | |||
mirrorKey | string |
Bad Request OssjIllegalArgumentException, RemoteException
{
"illegalArgumentException": "required fields: baseTroubleTicketState,mirrorKey,dialog"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
illegalArgumentException | string |
| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
remoteException | string |
curl -X POST 'https://ticketing-ossj.masstack.com/troubleTicket' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"baseTroubleTicketState": "OPENACTIVE",
"mirrorKey": "string",
"dialog": "string",
"troubleType": "string",
"troubleDescription": "string",
"troubleDetectionTime": "2025-01-15T10:30:00Z",
"preferredPriority": 1,
"troubledObject": "string",
"customerTroubleNum": "string",
"homeId": "string",
"gescal37ID": "string",
"wh1Parameter": "cliente",
"wh2Parameter": "string",
"wh3Parameter": "string",
"wh4Parameter": "string",
"wh5Parameter": "string",
"customer": "string",
"clearencePerson": "string",
"attachments": [
{
"content": "string",
"mimeType": "string",
"name": "string"
}
]
}'PATH PARAMETERS
OK trouble ticket response
{
"ticketId": "RED-84",
"mirrorKey": "ONV-1024",
"baseTroubleTicketState": "OPENACTIVE",
"dialog": "ERI_MM_OLTZ3562010LAP012_para que se revise",
"troubleType": "FTTH_PROVISION_RANGED_NO_NAVEGA",
"troubleDescription": "ONT sincronizado, pero no navega.",
"troubleDectectionTime": "2020-09-15T00:00:00Z",
"preferredPriority": 1,
"troubledObject": "CTO",
"customerTroubleNum": "O99999999999/M9999999999",
"wh1Parameter": "Red",
"customer": 100
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
ticketId | string | |||
mirrorKey | string | |||
baseTroubleTicketState | string | |||
dialog | string | |||
troubleType | string | |||
troubleDescription | string | |||
troubleDectectionTime | string | |||
preferredPriority | integer | |||
troubledObject | string | |||
customerTroubleNum | string | |||
wh1Parameter | string | |||
customer | string |
curl -X GET 'https://ticketing-ossj.masstack.com/troubleTicket/:ticketId' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Update a Trouble ticket
PATH PARAMETERS
trouble ticket object to update an existing trouble ticket
{
"baseTroubleTicketState": "OPENACTIVE",
"ticketId": "<write here trouble ticket Id from TO>",
"mirrorKey": "<write here trouble ticket id from TU>",
"dialog": "<write here additional information>",
"attachments": [
{
"content": "ZmlsZSBudW1iZXIgMQ==",
"mimeType": "text/plain",
"name": "file1.txt"
},
{
"content": "ZmlsZSBudW1iZXIgMQ==",
"mimetype": "text/plain",
"name": "file2.txt"
}
]
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
baseTroubleTicketState | string
()
OPENACTIVEDEFERRED.AWAITING-CANCELATIONDEFERRED.AWAITING-INFORMATIONCLOSED.CANCELEDCLOSEDCLEARED | trouble ticket status | ||
ticketId* | string | id assigned to the trouble ticket in the TO systen | maxLength: 15 | |
mirrorKey* | string | id assigned to the trouble ticket in the TU systen | maxLength: 15 | |
dialog* | string | information about the issue | maxLength: 4000 | |
closeOutType* | string | Resolution typifications agreed | maxLength: 128 | |
closeOutNarr* | string | Real typification | maxLength: 128 | |
serviceRestoredTime* | string (date-time) | resolution date time | maxLength: 20 | |
customer | integer | clients number affected | maxLength: 100 | |
content | string | The actual contents of the attachment object, if embedded, encoded as base64 | ||
mimeType | string | Attachment mime type such as extension file for video, picture and document | ||
name | string | The name of the attachment |
{
"data": "string",
"attachments": [
"string"
]
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
data | string | json with the properties createTroubleTicketByValueRequest | ||
attachments | string (binary)[] | array of attachtments in base64 (multipart/form-data) |
OK trouble ticket has been updated succesfully
{
"ticketId": "RED-84",
"dialog": "This is a comment example",
"troubleType": "FTTH_INS_CTO INACCESIBLE",
"troubleDescription": "trouble description example",
"preferredPriority": "4",
"customerTroubleNum": "O99999990",
"wh1Parameter": "Incidencia Mutualizada"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
ticketId | string | |||
dialog | string | |||
troubleType | string | |||
troubleDescription | string | |||
preferredPriority | string | |||
customerTroubleNum | string | |||
wh1Parameter | string |
Bad Request OssjIllegalArgumentException, RemoteException, ObjectNotFoundException
{
"illegalArgumentException": "required fields: baseTroubleTicketState,mirrorKey,dialog"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
illegalArgumentException | string |
| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
remoteException | string |
| Property | Type | Description | Constraints | Default |
|---|
curl -X PATCH 'https://ticketing-ossj.masstack.com/troubleTicket/:ticketId' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"baseTroubleTicketState": "OPENACTIVE",
"ticketId": "<write here trouble ticket Id from TO>",
"mirrorKey": "<write here trouble ticket id from TU>",
"dialog": "<write here additional information>",
"attachments": [
{
"content": "ZmlsZSBudW1iZXIgMQ==",
"mimeType": "text/plain",
"name": "file1.txt"
},
{
"content": "ZmlsZSBudW1iZXIgMQ==",
"mimetype": "text/plain",
"name": "file2.txt"
}
]
}'