API Overview Resources Schemas

Schemas

Ticket

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14


{
  "key": "INST-7902",
  "project": "INST",
  "ticketType": "Incidencia",
  "description": "Cita - Cliente solicita contacto en fecha concreta - Y28257924",
  "summary": "Cita - Y28257924",
  "customFields": {
    "segment": "Residencial",
    "brand": "Yoigo",
    "category": "Cita",
    "subcategory": "Cliente solicita contacto en fecha concreta",
    "work_order_id": "Y28257924"
  }
}

Name	Type	Required	Description
key	string	false	Ticket key reference.
project	string	false	Project key. RED, PROV, INST, etc. See Field Information request to query available values and field information.
ticketType	string	false	Ticket type. You can query available values using Get Ticket Types request.
summary	string	false	A simple summary for the ticket.
description	string	false	A detail description for the ticket.
components	[string]	false	Components list. See Field Information request to query available values and field information.
customFields	object	false	Object containing extra custom fields depending on ticket typology

TicketSearchGetResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21


{
  "startAt": 0,
  "maxResults": 50,
  "total": 3,
  "tickets": [
    {
      "key": "INST-7902",
      "project": "INST",
      "ticketType": "Incidencia",
      "description": "Cita - Cliente solicita contacto en fecha concreta - Y28257924",
      "summary": "Cita - Y28257924",
      "customFields": {
        "segment": "Residencial",
        "brand": "Yoigo",
        "category": "Cita",
        "subcategory": "Cliente solicita contacto en fecha concreta",
        "work_order_id": "Y28257924"
      }
    }
  ]
}

Name	Type	Required	Description
startAt	integer	false	none
maxResults	integer	false	none
total	integer	false	none
tickets	[Ticket]	false	none

TicketCreateResponse

1
2
3
4


{
  "id": 3645,
  "key": "INST-1341"
}

Name	Type	Required	Description
id	integer	false	Ticket ID
key	string	false	Ticket Key. You could reference the ticket by its key or by ID

TicketTypes

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38


[
  {
    "projectKey": "EKT",
    "name": "Euskaltel",
    "issuetypes": [
      {
        "name": "Aviso de llamada perdida",
        "description": "Incidencia-Servicios"
      },
      {
        "name": "Contestador",
        "description": "Incidencia-Servicios"
      },
      {
        "name": "No salta el aviso de saldo",
        "description": "Incidencia-Servicios"
      }
    ]
  },
  {
    "projectKey": "MM",
    "name": "MásMóvil Customer Care",
    "issuetypes": [
      {
        "name": "Problemas TV",
        "description": "Incidencia"
      },
      {
        "name": "Desacuerdo con la cuota de TV",
        "description": "Incidencia"
      },
      {
        "name": "Bloqueo por IMEI-Tarea",
        "description": "Tarea-Móvil"
      }
    ]
  }
]

Name	Type	Required	Description
projectKey	string	false	Project key reference
name	string	false	Project name
issuetypes	[object]	false	Issue types list with all types available
» name	string	false	issue type name
» description	string	false	issue type description

Comment

1
2
3
4
5


{
  "ticketId": "INST-3241",
  "author": "javier.fernandezh@masmovil.com",
  "body": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat."
}

Name	Type	Required	Description
ticketId	string	false	Ticket Id
author	string	false	Comment author, must match with ticketing provider user.
body	string	true	The text you want to add as a comment to the ticket

Attachment

1
2
3
4
5


{
  "name": "MYSIM_3847484.pdf",
  "data": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAkGBxITEhUSEhMVFhUXGBcVFxUVFRUVF...",
  "mimeType": "image/jpeg"
}

Name	Type	Required	Description
name	string	true	File name
data	string	true	File content in base64 format
mimeType	string	false	The file mime type. See https://docs.w3cub.com/http/basics_of_http/mime_types/complete_list_of_mime_types

AttachmentResponse

1
2
3
4
5
6
7
8


{
  "self": "https://mas-ticketing-sta.dev-01.k8s.masmovil.com/mas-ticketing-api/ticket/73232/attachment/24819",
  "content": "https://mas-ticketing-sta.dev-01.k8s.masmovil.com/mas-ticketing-api/ticket/73232/attachment/24819/MYSIM_398171_53e82c60-075c-42ab-af94-868ef8b80071.pdf",
  "filename": "MYSIM_398171_53e82c60-075c-42ab-af94-868ef8b80071.pdf",
  "created": "2022-01-13T09:20:22.556+0000",
  "mimeType": "multipart/form-data; charset=UTF-8",
  "size": 5576
}

Name	Type	Required	Description
self	string	false	The URL of the attachment metadata details.
content	string	false	The URL of the attachment.
filename	string	false	The name of the attachment file. there is not much more to say
created	string	false	The datetime the attachment was created.
size	integer	false	The size of the attachment.

AttachmentGETResponse

1
2
3
4
5
6


{
  "ticketId": "73232",
  "name": "MYSIM_398171_53e82c60-075c-42ab-af94-868ef8b80071.pdf",
  "attachmentId": "24819",
  "base64": "/9j/4AAQSkZJRgABAQAAAQABAAD/..."
}

Name	Type	Required	Description
ticketId	string	false	Ticket Id
name	string	false	Attachment file name
attachmentId	integer	false	Attachment Id
base64	string	false	Attachment content in base64 format

Transition

1
2
3
4
5
6


{
  "transitionId": 111,
  "external_system_name": "Orange",
  "external_system_info": "Prueba de escalado externo via API de robot",
  "external_system_category": "Instalación"
}

Name	Type	Required	Description
transitionId	integer	true	Transition Id reference to operate with.
status	string	false	Status name reference to operate with. It´s optional, you can reference by transitionId or status
customField1	object	false	Field to be update if the transitions allow it
customField2	object	false	Field to be update if the transitions allow it
customFieldN	object	false	You can send as many customfields as you need and the transitions allow

SendCommsTransitionExample

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
  "transitionId": 351,
  "communication_channel": "SMS",
  "communication_type": "Informar Cierre Avería",
  "ticket": "ATC-222117",
  "recipient": "677777777",
  "url": "",
  "text": "test",
  "preview": "No"
}

Name	Type	Required	Description
transitionId	integer	false	Transition Id to be executed
communication_channel	string	false	Communication channel to be used
communication_type	string	false	Type of the communication to be sent
ticket	string	false	Ticket key reference
recipient	string	false	Recipient’s contact information
url	string	false	URL to be sent
text	object	false	Text for the communication
preview	object	false	Specifies whether a preview is needed

TransitionsResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12


[
  {
    "id": 41,
    "name": "Reasignar",
    "status": "Asignado"
  },
  {
    "id": 21,
    "name": "Resolver",
    "status": "RESUELTO"
  }
]

Name	Type	Required	Description
id	integer	false	Transition Id
name	string	false	Transitions name
status	string	false	Status destination

IssueLinkType

1
2
3
4
5
6


{
  "id": "string",
  "name": "string",
  "inward": "string",
  "outward": "string"
}

Name	Type	Required	Description
id	string	false	IssueLinkType Id
name	string	false	IssueLinkType name
inward	string	false	Issue origin action
outward	string	false	Issue destination action

IssueLink

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12


{
  "id": "string",
  "type": {
    "name": "string"
  },
  "inwardIssue": {
    "key": "string"
  },
  "outwardIssue": {
    "key": "string"
  }
}

Name	Type	Required	Description
id	string	false	IssueLink Id
type	object	false	IssueLink type
» name	string	false	IssueLink type name
inwardIssue	object	false	Issue origin reference
» key	string	false	Issue origin reference key
outwardIssue	object	false	Issue destination reference
» key	string	false	Issue destination reference key

SearchRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28


{
  "filters": {
    "project": "MAS",
    "issuetype": {
      "$in": [
        "Avería (FTTH)",
        "Avería (xDSL)"
      ]
    },
    "status": {
      "$notIn": [
        "Resolved",
        "Descartado",
        "CLOSE"
      ]
    },
    "massiveFaults": {
      "$isNotEmpty": ""
    }
  },
  "orderby": {
    "fields": [
      "status desc"
    ]
  },
  "startAt": 0,
  "maxResults": 100
}

Name	Type	Required	Description
filters	[object]	false	Object array with fields you want filter by and its conditions
» ApiFieldName	string	false	Api field name
» value	object	false	Field Name value must be equals to direct value or macth the condition here requested
»» operator	string	false	condition operator. See operator enum
»» value	string	false	condition must match
orderby	object	false	fields to order by plus asc or desc orientation Exmpl. key desc
» fields	[object]	false	fields separated by coma and with desc o asc orientation
»» field	string	false	none
fields	[string]	false	This property allows you filter the fields you want in the response body
startAt	integer	false	Start position in the complete result, you want as firt item in the response body
maxResults	integer	false	Numbers of items you want back

Property	Values
operator	one of [$like, $in, $notIn, $isEmpty, $greaterThanEquals, $greaterThan, $lessThanEquals, $lessThan]

UpdateGridRow

1
2
3
4
5
6
7
8
9


[
  {
    "rowId": "row_94ba7042-c49b-4f53-971b-44549b9c08a0",
    "columns": {
      "property1": "test",
      "property2": "test"
    }
  }
]

Name	Type	Required	Description
rowId	string	false	Row identificator of the row to be modified
columns	object	false	Object containing the names (key value pairs) of the columns to be modified
» additionalProperties	string	false	none

Assignee

1
2
3


{
  "assignee": "javier.fernandezh"
}

Name	Type	Required	Description
assignee	string	false	user id, username o email.

EditableFields

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25


{
  "description": {
    "name": "Descripción"
  },
  "customerPostalCode": {
    "name": "Código Postal"
  },
  "customerSegment": {
    "name": "Segmento Cliente",
    "allowedValues": [
      {
        "value": "EMPRESA"
      },
      {
        "value": "RESIDENCIAL"
      },
      {
        "value": "HORECA"
      },
      {
        "value": "AUTONOMO"
      }
    ]
  }
}

Name	Type	Required	Description
description	object	false	Field example
» name	string	false	Field name
customerPostalCode	object	false	Field example
» name	string	false	Field name
customerSegment	object	false	Field example
» name	string	false	Field name
» allowedValues	[object]	false	list of allowed values
»» value	string	false	Field allowed values

CreationDataInfo

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14


{
  "subscriptionNumber": {
    "required": true,
    "name": "Suscripción"
  },
  "icc": {
    "required": false,
    "name": "ICC"
  },
  "contactEmail": {
    "required": false,
    "name": "Email del Cliente"
  }
}

Name	Type	Required	Description
subscriptionNumber	object	false	Field example
» required	boolean	false	Field is required
» name	string	false	Field name
icc	object	false	Field example
» required	boolean	false	Field is required
» name	string	false	Field name
contactEmail	object	false	Field example
» required	boolean	false	Field is required
» name	string	false	Field name

Error_400

1
2
3
4
5
6


{
  "code": "0015",
  "status": "BAD_REQUEST",
  "message": "Bad Request",
  "detailMsg": "detail message about the error"
}

Name	Type	Required	Description
code	string	false	Error code number
status	string	false	Status error
message	string	false	Error message
detailMsg	string	false	Message detail

Error_401

1
2
3
4
5
6


{
  "code": "0003",
  "status": "UNAUTHORIZED",
  "message": "Unauthorized",
  "detailMsg": null
}

Name	Type	Required	Description
code	string	false	Error code number
status	string	false	Status error
message	string	false	Error message
detailMsg	string	false	Message detail

Error_404

1
2
3
4
5
6


{
  "code": "0004",
  "status": "NOT_FOUND",
  "message": "Not found",
  "detailMsg": "Resource not found"
}

Name	Type	Required	Description
code	string	false	Error code number
status	string	false	Status error
message	string	false	Error message
detailMsg	string	false	Message detail

Error_500

1
2
3
4
5
6


{
  "code": "0002",
  "status": "UNEXPECTED",
  "message": "Unexpected Error",
  "detailMsg": null
}

Name	Type	Required	Description
code	string	false	Error code number
status	string	false	Status error
message	string	false	Error message
detailMsg	string	false	Message detail