Ticket

Create ticket

Creates a ticket from a JSON representation.

POST /orgs/{org}/ticket

Parameters

Name	In	Type	Required	Description
ticketing-provider	header	string	true	Acronym identifying the underlying ticketing tool where the tickets are. JAM (Jira Amarillo) , JCC (Jira CC), TGJ (TGJira), JNEXT (JiraNext)
org	path	string	true	Organization name as it is registered in Mas-Stack
body	body	Ticket	true	Json with ticket creation fields. See request ticket/metadata/create/properties.

Enumerated Values

Property	Values
ticketing-provider	one of [JAM, JCC, TGJ, JNEXT]

Request body - instance of 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

Request example

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



curl -X POST https://ticketing.sta.masstack.com/v2/orgs/yoigo/ticket \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "ticketing-provider: string" \
  -H "Authorization: Bearer {access-token}" \
 --data-raw "{
  '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'
  }
}" 

Responses

Code	Meaning	Description	Schema
201	Created	Entity has been created succesfully.	TicketCreateResponse
400	Bad Request	Bad Request	Error_400
401	Unauthorized	Unauthorized	Error_401
500	Internal Server Error	Internal Server Error	Error_500

Update ticket

Edits a ticket from a JSON representation.

PATCH /orgs/{org}/ticket/{ticketId}

Parameters

Name	In	Type	Required	Description
ticketId	path	string	true	The ticket id in MasMovil ticketing tool. You can use either ID or KEY.
ticketing-provider	header	string	true	Acronym identifying the underlying ticketing tool where the tickets are. JAM (Jira Amarillo) , JCC (Jira CC), TGJ (TGJira), JNEXT (JiraNext)
org	path	string	true	Organization name as it is registered in Mas-Stack
body	body	Ticket	true	Json with fields to update. See request /ticket/{ticketId}/metadata/update/properties.

Enumerated Values

Property	Values
ticketing-provider	one of [JAM, JCC, TGJ, JNEXT]

Request body - instance of 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

Request example

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



curl -X PATCH https://ticketing.sta.masstack.com/v2/orgs/yoigo/ticket/{ticketId} \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "ticketing-provider: string" \
  -H "Authorization: Bearer {access-token}" \
 --data-raw "{
  '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'
  }
}" 

Responses

Code	Meaning	Description	Schema
204	No Content	No content	None
400	Bad Request	Bad Request	Error_400
401	Unauthorized	Unauthorized	Error_401
500	Internal Server Error	Internal Server Error	Error_500

Get ticket

Returns a full representation of the ticket for the given key.

GET /orgs/{org}/ticket/{ticketId}

Parameters

Name	In	Type	Required	Description
ticketId	path	string	true	The ticket id in MasMovil ticketing tool. You can use either ID or KEY.
ticketing-provider	header	string	true	Acronym identifying the underlying ticketing tool where the tickets are. JAM (Jira Amarillo) , JCC (Jira CC), TGJ (TGJira), JNEXT (JiraNext)
expand	query	string	false	Filter for ticket response body. (You must add ‘attachment’ query param to get ticket attachments in response body)
org	path	string	true	Organization name as it is registered in Mas-Stack

Enumerated Values

Property	Values
ticketing-provider	one of [JAM, JCC, TGJ, JNEXT]
expand	one of [history, attachment]

Request example

1
2
3
4
5
6



curl -X GET https://ticketing.sta.masstack.com/v2/orgs/yoigo/ticket/{ticketId}?expand='string' \
  -H "Accept: application/json" \
  -H "ticketing-provider: string" \
  -H "Authorization: Bearer {access-token}"

Responses

Code	Meaning	Description	Schema
200	OK	Full representation of the ticket	Ticket
400	Bad Request	Bad Request	Error_400
401	Unauthorized	Unauthorized	Error_401
404	Not Found	Not Found	Error_404
500	Internal Server Error	Internal Server Error	Error_500

Search ticket

This method allows you to search tickets filtering and ordering as you need. Special opeators are allowed $like: value $in: [array] $notIn: [array] $isEmpty: '' $greaterThanEquals: value $greaterThan: value $lessThanEquals: value $lessThan: valueField names used in filters can be both Jira field name or MAS-Ticketing-API name, i.e. you can use \'customerDocument\' or \'Documento Cliente\'.

POST /orgs/{org}/search/ticket

Parameters

Name	In	Type	Required	Description
ticketing-provider	header	string	true	Acronym identifying the underlying ticketing tool where the tickets are. JAM (Jira Amarillo) , JCC (Jira CC), TGJ (TGJira), JNEXT (JiraNext)
org	path	string	true	Organization name as it is registered in Mas-Stack
body	body	SearchRequest	true	Filters to apply to search query

Enumerated Values

Property	Values
ticketing-provider	one of [JAM, JCC, TGJ, JNEXT]

Request body - instance of 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]

Request example

 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



curl -X POST https://ticketing.sta.masstack.com/v2/orgs/yoigo/search/ticket \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "ticketing-provider: string" \
  -H "Authorization: Bearer {access-token}" \
 --data-raw "{
  '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
}" 

Responses

Code	Meaning	Description	Schema
200	OK	Ticket response	[Ticket]
400	Bad Request	Bad Request	Error_400
401	Unauthorized	Unauthorized	Error_401
404	Not Found	Not Found	Error_404
500	Internal Server Error	Internal Server Error	Error_500

200 - instance of Ticket

Custom schema example

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


[
  {
    "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

Search ticket by JQL

This method allows you search ticket by JQL (Jira Query Language)

GET /orgs/{org}/search/ticket

Parameters

Name	In	Type	Required	Description
ticketing-provider	header	string	true	Acronym identifying the underlying ticketing tool where the tickets are. JAM (Jira Amarillo) , JCC (Jira CC), TGJ (TGJira), JNEXT (JiraNext)
org	path	string	true	Organization name as it is registered in Mas-Stack
jql	query	string	true	jql query

Enumerated Values

Property	Values
ticketing-provider	one of [JAM, JCC, TGJ, JNEXT]

Request example

1
2
3
4
5
6



curl -X GET https://ticketing.sta.masstack.com/v2/orgs/yoigo/search/ticket?jql='string'?jql=string \
  -H "Accept: application/json" \
  -H "ticketing-provider: string" \
  -H "Authorization: Bearer {access-token}"

Responses

Code	Meaning	Description	Schema
200	OK	Ticket Search response	TicketSearchGetResponse
400	Bad Request	Bad Request	Error_400
401	Unauthorized	Unauthorized	Error_401
404	Not Found	Not Found	Error_404
500	Internal Server Error	Internal Server Error	Error_500

Search tickets by territory owner

Performs a search returning tickets corresponding to the territory-owner in path

GET /orgs/{org}/searchByTerritoryOwner

Parameters

Name	In	Type	Required	Description
ticketing-provider	header	string	true	Acronym identifying the underlying ticketing tool where the tickets are. JAM (Jira Amarillo) , JCC (Jira CC), TGJ (TGJira), JNEXT (JiraNext)
org	path	string	true	Organization name as it is registered in Mas-Stack

Enumerated Values

Property	Values
ticketing-provider	one of [JAM, JCC, TGJ, JNEXT]

Request example

1
2
3
4
5
6



curl -X GET https://ticketing.sta.masstack.com/v2/orgs/yoigo/searchByTerritoryOwner \
  -H "Accept: application/json" \
  -H "ticketing-provider: string" \
  -H "Authorization: Bearer {access-token}"

Responses

Code	Meaning	Description	Schema
200	OK	Search by territory owner response	TicketSearchGetResponse
400	Bad Request	Bad Request	Error_400
401	Unauthorized	Unauthorized	Error_401
404	Not Found	Not Found	Error_404
500	Internal Server Error	Internal Server Error	Error_500

Transition ticket

This method allows you to execute a transition, i.e. change ticket status.

POST /orgs/{org}/ticket/{ticketId}/transitions

Parameters

Name	In	Type	Required	Description
ticketId	path	string	true	The ticket id in MasMovil ticketing tool. You can use either ID or KEY.
ticketing-provider	header	string	true	Acronym identifying the underlying ticketing tool where the tickets are. JAM (Jira Amarillo) , JCC (Jira CC), TGJ (TGJira), JNEXT (JiraNext)
org	path	string	true	Organization name as it is registered in Mas-Stack
body	body	Transition	false	‘none’

Enumerated Values

Property	Values
ticketing-provider	one of [JAM, JCC, TGJ, JNEXT]

Request body - instance of 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

Request example

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



curl -X POST https://ticketing.sta.masstack.com/v2/orgs/yoigo/ticket/{ticketId}/transitions \
  -H "Content-Type: application/json" \
  -H "ticketing-provider: string" \
  -H "Authorization: Bearer {access-token}" \
 --data-raw "{
  'transitionId': 111,
  'external_system_name': 'Orange',
  'external_system_info': 'Prueba de escalado externo via API de robot',
  'external_system_category': 'Instalación'
}" 

Responses

Code	Meaning	Description	Schema
204	No Content	No content	None

Get ticket available transitions

Get information about allowed transitions for a ticket, depending on current status.

GET /orgs/{org}/ticket/{ticketId}/transitions

Parameters

Name	In	Type	Required	Description
ticketId	path	string	true	The ticket id in MasMovil ticketing tool. You can use either ID or KEY.
ticketing-provider	header	string	true	Acronym identifying the underlying ticketing tool where the tickets are. JAM (Jira Amarillo) , JCC (Jira CC), TGJ (TGJira), JNEXT (JiraNext)
org	path	string	true	Organization name as it is registered in Mas-Stack

Enumerated Values

Property	Values
ticketing-provider	one of [JAM, JCC, TGJ, JNEXT]

Request example

1
2
3
4
5
6



curl -X GET https://ticketing.sta.masstack.com/v2/orgs/yoigo/ticket/{ticketId}/transitions \
  -H "Accept: application/json" \
  -H "ticketing-provider: string" \
  -H "Authorization: Bearer {access-token}"

Responses

Code	Meaning	Description	Schema
200	OK	Transitions response	[TransitionsResponse]
400	Bad Request	Bad Request	Error_400
401	Unauthorized	Unauthorized	Error_401
404	Not Found	Not Found	Error_404
500	Internal Server Error	Internal Server Error	Error_500

200 - instance of TransitionsResponse

Custom schema example

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


[
  [
    {
      "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

Assign a ticket

Assign a ticket to some user

PUT /ticket/{ticketId}/assignee

Parameters

Name	In	Type	Required	Description
ticketId	path	string	true	The ticket id in MasMovil ticketing tool. You can use either ID or KEY.
ticketing-provider	header	string	true	Acronym identifying the underlying ticketing tool where the tickets are. JAM (Jira Amarillo) , JCC (Jira CC), TGJ (TGJira), JNEXT (JiraNext)
body	body	Assignee	false	‘none’

Enumerated Values

Property	Values
ticketing-provider	one of [JAM, JCC, TGJ, JNEXT]

Request body - instance of Assignee

1
2
3


{
  "assignee": "javier.fernandezh"
}

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

Request example

1
2
3
4
5
6
7
8
9



curl -X PUT https://ticketing.sta.masstack.com/v2/ticket/{ticketId}/assignee \
  -H "Content-Type: application/json" \
  -H "ticketing-provider: string" \
  -H "Authorization: Bearer {access-token}" \
 --data-raw "{
  'assignee': 'javier.fernandezh'
}" 

Responses

Code	Meaning	Description	Schema
204	No Content	No content	None

Get ticket creation fields

Get information about fields needed to create a given type of ticket

GET /ticket/metadata/create/properties

Parameters

Name	In	Type	Required	Description
projectKey	query	string	true	The project key in MasMovil ticketing tool
ticketType	query	string	true	The ticket type in MasMovil ticketing tool
ticketing-provider	header	string	true	Acronym identifying the underlying ticketing tool where the tickets are. JAM (Jira Amarillo) , JCC (Jira CC), TGJ (TGJira), JNEXT (JiraNext)

Enumerated Values

Property	Values
ticketing-provider	one of [JAM, JCC, TGJ, JNEXT]

Request example

1
2
3
4
5
6



curl -X GET https://ticketing.sta.masstack.com/v2/ticket/metadata/create/properties?projectKey='string'&ticketType='string'?projectKey=string&ticketType=string \
  -H "Accept: application/json" \
  -H "ticketing-provider: string" \
  -H "Authorization: Bearer {access-token}"

Responses

Code	Meaning	Description	Schema
200	OK	Fields for ticket type	CreationDataInfo
400	Bad Request	Bad Request	Error_400
401	Unauthorized	Unauthorized	Error_401
404	Not Found	Not Found	Error_404
500	Internal Server Error	Internal Server Error	Error_500

Get ticket editable fields

Get information about editable fields.

GET /ticket/{ticketId}/metadata/update/properties

Parameters

Name	In	Type	Required	Description
ticketId	path	string	true	The ticket id in MasMovil ticketing tool. You can use either ID or KEY.
ticketing-provider	header	string	true	Acronym identifying the underlying ticketing tool where the tickets are. JAM (Jira Amarillo) , JCC (Jira CC), TGJ (TGJira), JNEXT (JiraNext)

Enumerated Values

Property	Values
ticketing-provider	one of [JAM, JCC, TGJ, JNEXT]

Request example

1
2
3
4
5
6



curl -X GET https://ticketing.sta.masstack.com/v2/ticket/{ticketId}/metadata/update/properties \
  -H "Accept: application/json" \
  -H "ticketing-provider: string" \
  -H "Authorization: Bearer {access-token}"

Responses

Code	Meaning	Description	Schema
200	OK	Editable Fields for ticket	EditableFields
400	Bad Request	Bad Request	Error_400
401	Unauthorized	Unauthorized	Error_401
404	Not Found	Not Found	Error_404
500	Internal Server Error	Internal Server Error	Error_500

Get ticket types

Get information about ticket types per project

GET /ticket/metadata/types

Parameters

Name	In	Type	Required	Description
ticketing-provider	header	string	true	Acronym identifying the underlying ticketing tool where the tickets are. JAM (Jira Amarillo) , JCC (Jira CC), TGJ (TGJira), JNEXT (JiraNext)

Enumerated Values

Property	Values
ticketing-provider	one of [JAM, JCC, TGJ, JNEXT]

Request example

1
2
3
4
5
6



curl -X GET https://ticketing.sta.masstack.com/v2/ticket/metadata/types \
  -H "Accept: application/json" \
  -H "ticketing-provider: string" \
  -H "Authorization: Bearer {access-token}"

Responses

Code	Meaning	Description	Schema
200	OK	Get ticket types	[TicketTypes]
400	Bad Request	Bad Request	Error_400
401	Unauthorized	Unauthorized	Error_401
404	Not Found	Not Found	Error_404
500	Internal Server Error	Internal Server Error	Error_500

200 - instance of TicketTypes

Custom schema example

 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
39
40


[
  [
    {
      "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

Get ticket field information

Get information about api names with api_name, customfield_id or jira_label params (Only one)

GET /ticket/field/info

Parameters

Name	In	Type	Required	Description
api_name	query	string	false	Search a field information with api name
customfield_id	query	string	false	Search a field information with customfield_id
jira_label	query	string	false	Search a field information with the TGJira field name
ticketing-provider	header	string	true	Acronym identifying the underlying ticketing tool where the tickets are. JAM (Jira Amarillo) , JCC (Jira CC), TGJ (TGJira), JNEXT (JiraNext)

Enumerated Values

Property	Values
ticketing-provider	one of [JAM, JCC, TGJ, JNEXT]

Request example

1
2
3
4
5
6



curl -X GET https://ticketing.sta.masstack.com/v2/ticket/field/info?api_name='track'&customfield_id='customfield_12800'&jira_label='Huella' \
  -H "Accept: application/json" \
  -H "ticketing-provider: string" \
  -H "Authorization: Bearer {access-token}"

Responses

Code	Meaning	Description	Schema
200	OK	Get field info successfully	Inline
400	Bad Request	Bad Request	Error_400
401	Unauthorized	Unauthorized	Error_401
404	Not Found	Not Found	Error_404
500	Internal Server Error	Internal Server Error	Error_500

200 - JsonObject

Custom schema example

1
2
3
4


{
  "jira_label": "Huella",
  "api_name": "track"
}

None