Request API

The V3 API format for Requests have been revised.

The differences between the old and new V3 API formats based on the entities are listed below:

 

Request - Notes 

Change in Object Name

OLD 

NEW 

request_note

note

 

Changes in Attributes

OLD

NEW

created_by

added_by

created_time

added_time

 

New Attributes

ATTRIBUTE 

DESCRIPTION

last_updated_by

This is a read-only attribute that is part of the response messages. It provides the details of the user who modified a note.

last_updated_time

This is a read-only attribute that is part of the response messages. It provides the time the note was last modified.

 

Request - Attachments 

Changes in attributes

OLD

NEW

file_name

name

size

size(changed to a json with two keys "display_value" and "value" in place of string)

 

New Attributes

ATTRIBUTE

DESCRIPTION

module

This is a read only attribute that is part of the response messages. It provides the module associated with the attachment.

content_type

This is a read-only attribute that is part of the response messages. It provides the type of the attachment, say PDF, image, etc.

 

Removed Attributes

 

 

Sample format:

 

Old Format

New Format

attachments: [

{

size: "73.78KB",

file_name: "1_00images.png",

content_url: "/api/v3/attachments/606",

id: "606",

attachment_key: null

}

]

 

 

 

 

 

 

 

========================================

resolution_attachments: [

{

size: "73.78KB",

file_name: "1_00images.png",

content_url: "/api/v3/attachments/606",

id: "606",

attachment_key: null

}

]

"attachments": [

            {

                "content_type": "image/png",

                "size": {

                    "display_value": "18.27KB",

                    "value": 18709

                },

                "module": "request",

                "name": "xss_move.png",

                "content_url": "/api/v3/requests/13/attachments/7504/download",

                "id": "7504"

            }

]

 

================================

"resolution_attachments": [

            {

                "content_type": "image/png",

                "size": {

                    "display_value": "18.27KB",

                    "value": 18709

                },

                "module": "request",

                "name": "xss_move.png",

                "content_url": "/api/v3/requests/13/resolution_attachments/7504/download",

                "id": "7504"

            }

]

 

 

 

Request -  Admin Configurations 

Under Admin >> Helpdesk Customizer, the major differences are in the following areas:

 

Status

OLD

NEW

internalname

internal_name

stopclock

stop_timer

pending

in_progress

 

Category

Old format

Changed format

category_technician

technician

category_changemanager

change_manager

 

Request Type

Old format

Changed format

colorcode

color_code

 

 

The following operations are also supported for Priority Matrix:

Allow_Override (Convenience Operation : Get and Put)