Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...


Filtering and attribute selection rules are described in the TMF REST Design Guidelines.
Notifications are also described in a subsequent section.

...

GET /API/troubleTicket/{ID}}/?{fields=attributes}&{filtering expression}

This Uniform Contract operation is used to retrieve the representation of a ticket.
Note that collections can be retrieved via GET /API/troubleTicket/ with no {ID}
Filtering is allowed on all attributes. See example below. Attribute selection is possible for all attributes. See example below.

...

  • GET /api/ticket/1/status,statusChangeReason

...

PUT API/troubleTicket/{ID}

Description :

  • This Uniform Contract operation is used to completely update the representation of a ticket.
  • Resource represents a managed entity.

...


Example see TMF REST Design Guidelines.

...

PATCH API/troubleTicket/{ID}

Description :

  • This Uniform Contract operation is used to partially update the representation of a ticket.
  • Resource represents a managed entity.

Behavior :

Description :

  • This Uniform Contract operation is used to partially update the representation of a ticket.
  • Resource represents a managed entity.

Behavior :
Patching of status is only allowed to transition :

...

REQUEST

PATCH API/ troubleTicket /{ID}
Content-type: application/json

{
"status": "Close",
"statusChangeReason": "Dispute has been resolved in favor of the customer."
}

RESPONSE

201
Content-Type: application/json

{
"id": "1",
"correlationId": "TT53482",
"description": "Customer complaint over last invoice.",
"severity": "Urgent",
"type": "Bills, charges or payment",
"creationDate": "2013-07-23T08:16:39.0Z",
"targetResolutionDate": "2013-07-30T10:20:01.0Z",
"status": "Closed",
"subStatus": "",
"statusChangeReason": "Dispute has been resolved in favor of the customer.",
"statusChangeDate": "2013-07-24T08:55:12.0Z",
"relatedParty": [
{
"href": "/customer/1234",
"role": "Originator"
},
{
"href": "/operator/1234",
"role": "Owner"
},
{
"href": "Roger Collins",
"role": "Reviser"
}
],
"relatedObject": [
{
"involvement": "Disputed",
"reference": "/invoice/1234"
},
{
"involvement": "Adjusted",
"reference": "/invoice/5678"
}
],
"note": [
{
"date": "2013-07-24T09:55:30.0Z",
"author": "Arthur Evans",
"text": "Already called the expert"
},
{
"date": "2013-07-25T08:55:12.0Z",
"author": "Arthur Evans",
"text": "Informed the originator"
}
]
}

 

...

POST API/ticket

Description :

  • This Uniform Contract operation is used to create a ticket.
  • Resource represents a managed entity.
  • Mandatory attributes that must be provided when you create the ticket :

...