TMF621 v4 Trouble Ticket Management

GET List All Trouble Ticket

GET /troubleTicket

This operation list or find TroubleTicket entities.

Parameters

fields (query, string) Specifies the comma-separated properties to provide in the response. Accepted fields are [name, description, priority, status, lastUpdate, ticketType, creationDate, resolutionDate, severity]
severity (query, string) Specifies the filter for provided severity. The supported values are org specific and are dependent on the configuration within the org.
ticketType (query, string) Specifies the filter for provided Ticket Type.
priority (query, string) Specifies the filter for provided Priority. The supported values are org specific and are dependent on the configuration within the org.
status (query, string) Specifies the filter for provided Status. The supported values are org specific and are dependent on the configuration within the org.
name (query, string) Filter based on Name.
description (query, string) Filter based on description.
offset (query, integer) Specifies the requested index for the start of the resources to be included in the response.
limit (query, integer) Specifies the requested number of the resources to be included in the response.
Authorization (header, string, required) Specifies the bearer token to use for the authentication of request.
Namespace (header, string) Specifies the namespace to use with the URL path.
Domain-Name (header, string, required) Specifies the domain name to use with the URL path received from the userinfo API.

Responses

200 Success

Media type: application/json. Schema: array of object.

Array of object.

id (string, required) Specifies the unique identifier of the TroubleTicket.
href (string, required) Specifies the unique reference of the TroubleTicket.

Example

[
    {
        "channel": {
            "@type": "Channel",
            "name": "Phone"
        },
        "relatedParty": [
            {
                "@referredType": "Account",
                "name": "Burlington Textiles Corp of America",
                "id": "001RO000003zz9SYAQ"
            },
            {
                "@referredType": "Contact",
                "name": "Jack Rogers",
                "id": "003RO00000366d5YAA"
            }
        ],
        "statusChangeDate": "2022-09-21T05:24:40.000Z",
        "name": "sample name from subject",
        "id": "00001020",
        "lastUpdate": "2022-09-21T05:24:40.000+0000",
        "resolutionDate": "2021-08-03T18:59:51.000+0000",
        "ticketType": "Electrical",
        "status": "Closed",
        "priority": "Medium",
        "creationDate": "2022-09-21T05:24:40.000+0000",
        "href": "/services/apexrest/vlocity_cmt/tmforum/troubleticket/v1/troubleticket/00001020"
    },
    {
        "channel": {
            "@type": "Channel",
            "name": "Phone"
        },
        "relatedParty": [
            {
                "@referredType": "Account",
                "name": "United Oil & Gas Corp.",
                "id": "001RO000003zz9WYAQ"
            },
            {
                "@referredType": "Contact",
                "name": "Stella Pavlova",
                "id": "003RO00000366dAYAQ"
            }
        ],
        "statusChangeDate": "2022-09-21T05:24:40.000Z",
        "name": "sample name from subject",
        "id": "00001021",
        "lastUpdate": "2022-09-21T05:24:40.000+0000",
        "resolutionDate": "2021-08-03T18:59:51.000+0000",
        "ticketType": "Structural",
        "status": "Closed",
        "priority": "High",
        "creationDate": "2022-09-21T05:24:40.000+0000",
        "href": "/services/apexrest/vlocity_cmt/tmforum/troubleticket/v1/troubleticket/00001021"
    },
    {
        "attachment": [
            {
                "name": "SampleFtest",
                "id": "069RO0000004R1EYAU"
            },
            {
                "name": "anotherAttachemt",
                "id": "069RO0000004WqwYAE"
            }
        ],
        "channel": {
            "@type": "Channel",
            "name": "Web"
        },
        "note": [
            {
                "id": "00aRO000000dbgtYAA",
                "date": "2023-03-01T14:53:16.000+0000",
                "text": "This is a sample comment/Note for testing",
                "author": "Zainul Abidin Mulla",
                "@type": "CaseComment"
            },
            {
                "id": "00aRO000000dbh8YAA",
                "date": "2023-03-02T02:05:19.000+0000",
                "text": "Case comment 2",
                "author": "Zainul Abidin Mulla",
                "@type": "CaseComment"
            },
            {
                "id": "00aRO000000dbhDYAQ",
                "date": "2023-03-02T03:17:56.000+0000",
                "text": "putting on hold",
                "author": "Zainul Abidin Mulla",
                "@type": "CaseComment"
            }
        ],
        "relatedEntity": [
            {
                "@referredType": "Asset",
                "name": "Galaxy M01",
                "id": "02iRO00000077Z0YAI"
            },
            {
                "@referredType": "Product",
                "name": "4G Router CFS",
                "id": "01tRO000000XnTNYA0"
            }
        ],
        "relatedParty": [
            {
                "@referredType": "Account",
                "name": "United Oil & Gas Corp.",
                "id": "001RO000003zz9WYAQ"
            },
            {
                "@referredType": "Contact",
                "name": "Stella Pavlova",
                "id": "003RO00000366dAYAQ"
            }
        ],
        "statusChange": [
            {
                "changeDate": "2023-03-08T18:19:07.000+0000",
                "status": "Escalated"
            },
            {
                "changeDate": "2023-03-02T03:17:56.000+0000",
                "status": "On Hold"
            },
            {
                "changeDate": "2023-03-02T03:13:15.000+0000",
                "status": "Pending"
            }
        ],
        "troubleTicketRelationship": [
            {
                "relationshipType": "Parent",
                "id": "500RO000002K2YXYA0"
            }
        ],
        "statusChangeDate": "2023-03-08T18:19:07.000Z",
        "name": "sample name from subject",
        "id": "00001022",
        "severity": "Critical",
        "lastUpdate": "2023-03-11T04:05:50.000+0000",
        "resolutionDate": "2021-08-03T18:59:51.000+0000",
        "ticketType": "Electronic",
        "status": "Escalated",
        "priority": "Medium",
        "creationDate": "2022-09-21T05:24:40.000+0000",
        "description": "This is sample description for testing",
        "href": "/services/apexrest/vlocity_cmt/tmforum/troubleticket/v1/troubleticket/00001022"
    }
]

400 There was an issue with your request.
Media type: application/json. Schema: Error.

Example
```
code: "400"
reason: Invalid picklist value for :Priority
```

404 Resource not found.

Media type: application/json. Schema: Error.

Example

code: NOT_FOUND
reason: There are no matching resource.
message: There are no data in system or not data for specified filters.

500 Internal server Error
Media type: application/json. Schema: Error.

Example
```
code: "500"
reason: Internal server Error
```