Default language.

Language availability Track-It! 2020 Release 03 online technical documentation is also available in the following languages:
  • French
  • German
  • Portuguese (Brazil)
  • Spanish
  • Spanish (XL)
The displayed language depends on your browser language. However, you can change languages from the Language menu.

Assignment Web APIs

Assignment Web APIs are available to perform the following tasks:

  • Create APIs that retrieve information about a variety of the tasks assigned to technicians in the ticket management process.
  • Create APIs that perform operations on specific assignments.

Using Get calls, Assignment Web APIs enable you to retrieve all:

  • Active assignment templates
  • Not null values 
  • Notes 
  • Note fields 
  • Successors
  • Predecessors

Using Post calls, Assignment Web APIs can:

  • Update a specific assignment with provided values
  • Create a specific assignment with provided values
  • Add user notes to an assignment 
  • Delete an assignment 
  • Change the status of a specific assignment
  • Close the status of a specific assignment

The following topics provide details about the Assignment Web APIs:

GET /assignments/Templates

Click here for a description.

Description

Returns all active assignment Templates in JSON format

Type of call

GET

Request Authorization Header

Bearer access_token received through the Token API call.

URL Syntax

http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/assignments/Templates

Request Parameters

None

Request Body

None

Execution response

The following values of active templates are retrieved:

  • Sequence
  • Name
  • Description
  • Template data
  • Is used in self Service

Important considerations

  • You do not need any permissions to use this Web API.
  • You can retrieve only Active Templates.
  • Templates are retrieved based on group availability.
Click here to view an example.
Example

http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/assignments/Templates

Request Authorization Header:

Bearer access_token:"ExPqpLF79Zi+vHZJIXZOGBSQVPKXlFVOfmQzMyfS7SGYJolrDAf3/LZR1qm9X+2OVY60OlEuUYOYaflcIjj7ytZ336b50mu4ieuPnx2AU2vCFgO3eqUe22Up"

Response:

{

  "AssignmentTemplates": [

    {

      "1": {

        "DisplayName": "Sequence",

        "Value": 3

      },

      "3": {

        "DisplayName": "Name",

        "Value": "Configure the New Hire Workstation"

      },

      "4": {

        "DisplayName": "Description",

        "Value": "Configure New Hire Workstation for <Username>"

      },

      "6": {

        "DisplayName": "Template Data",

        "Value": "<TemplateData>\r\n  <RowData>\r\n    <sequence>81</sequence>\r\n    <datatype>nvarchar</datatype>\r\n    <fkcolumn>80</fkcolumn>\r\n    <fkvalue>1</fkvalue>\r\n    <fieldname>Status</fieldname>\r\n    <value>Open</value>\r\n  </RowData>\r\n  <RowData>\r\n    <sequence>114</sequence>\r\n    <datatype>nvarchar</datatype>\r\n    <fkcolumn>113</fkcolumn>\r\n    <fkvalue>3</fkvalue>\r\n    <fieldname>Priority</fieldname>\r\n    <value>3 - Medium</value>\r\n  ……..</TemplateData>"

      },

      "10": {

        "DisplayName": "Is Used in Self Service",

        "Value": false

      }

    }….

}

GET /assignments/{id}

Click here for a description.

Description

Returns sequence, display names, and values of all fields for the specified assignment in JSON format

Type of call

GET

Request Authorization Header

Bearer access_token received through the Token API call.

URL Syntax

http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/assignments/{id}

Request Parameters

Specify the Assignment ID

Request Body

None

Execution response

Click here to see a table of the execution response values.

The following table lists the sequence number and Display Names of the fields that are returned by the GET assignments/{id} Web API:

Sequence

Display Name of the field

1

Assignment ID

2

Last Modified

3

Last User

4

Seq_Group

7

Additional Information

8

Open Date & Time

9

Status Type

10

Seq_Location

11

Seq_Department

12

Seq_Requestor

13

Seq_Open By

14

Seq_Assigned To

15

Seq_Category

18

Assignment Summary

20

Seq_Closed By

21

Close Date & Time

22

Ticket ID

26

Callback Number

35

Group

37

Requestor Last Name

38

Requestor First Name

39

Requestor ID

40

Requestor Phone

41

Requestor Email Address

43

Requestor Title

44

Requestor Ext.

45

Closed By Technician

47

Location

50

Location Main Contact

59

Department Name

61

Open By Technician

62

Assigned To Technician

65

Category

68

Custom Date 1

69

Custom Date 2

70

Custom Integer 1

71

Custom Numeric 1

72

Custom Text 1

73

Custom Text 2

74

Custom Text 3

75

Custom Text 4

76

Custom Text 5

77

Custom Text 6

80

Seq_Status

81

Status

82

Status Description

85

Due Date & Time

88

Inactive

89

Clock Stop Time

91

Expected Response Date & Time

92

Recommended Fix Date & Time

93

Opened Group

94

Closed Group

95

Assignment Source

96

Opened By First Name

97

Opened By Last Name

98

Closed By First Name

99

Closed By Last Name

100

Assigned To First Name

101

Assigned To Last Name

113

Seq_Priority

114

Priority

115

Priority Duration

123

Template

124

Custom Look Up 1

125

Custom Look Up 2

126

Custom Look Up 3

127

Custom Look Up 4

128

Custom Look Up 5

129

Custom Look Up 6

130

Custom Look Up 7

131

Custom Look Up 8

132

Custom Date 3

133

Custom Date 4

136

Charge

137

Hourly Rate

138

Requestor

139

Seq_Responded By

140

Responded By Technician

141

Responded By First Name

142

Responded By Last Name

143

Responded Date & Time

144

Solution ID

145

Solution Summary

146

Seq_EscalateToTechnician

147

Escalate To Technician

148

Escalate To Technician Email

149

Total Time Spent

150

Category Full Path

151

Assigned To Full Name

152

TI11 WO ID

153

Asset ID

154

BCM Asset ID

155

Asset Name

156

Audit Date

157

Serial Number

158

Escalate To Login ID

159

Open By FullName

160

Email Cc

161

Email Bcc

Important considerations

  • You need View Assignment Permission to use this Web API.
  • Data Segregation is applicable.
  • If the display names have been changed, the updated values are retrieved.
  • NULL values are not retrieved.
Click here to view an example.
Example

http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/assignments/101

Request Authorization Header:

Bearer access_token:"ExPqpLF79Zi+vHZJIXZOGBSQVPKXlFVOfmQzMyfS7SGYJolrDAf3/LZR1qm9X+2OVY60OlEuUYOYaflcIjj7ytZ336b50mu4ieuPnx2AU2vCFgO3eqUe22Up"

Response:

{

  "Assignments": {

    "1": {

      "DisplayName": "Assignment ID",

      "Value": 101

    },

    "2": {

      "DisplayName": "Last Modified",

      "Value": "2019-01-21T09:12:06.1730000Z"

    },

    "3": {

      "DisplayName": "Last User",

      "Value": "dbo"

    },…..

}

}

POST /assignments/{id}

Click here for a description.

Description

Modifies and returns the specified assignment in JSON format

Type of call

POST

Request Authorization Header

Bearer access_token received through the Token API call.

URL Syntax

http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/assignments/{id}

Request Parameters

  • (required) id
    Specify the Assignment ID.
  • (required) updateInput
    Specify the properties, which are pairs of values for Field Sequence ID and Display Name.
  • (optional) OptionalParams
    Specify any optional parameters when present

Request Body

{
 "Properties": {},
 "OptionalParams": {
 "Param1": {},
 "Param2": {}
 }
}


Click here to see a table of the fields you can update.

For the specified Assignment, you can update the following fields:

Sequence

Display Name of the field

4

Seq_Group

7

Additional Information

10

Seq_Location

11

Seq_Department

12

Seq_Requestor

14

Seq_Assigned To

15

Seq_Category

18

Assignment Summary

26

Callback Number

35

Group

37

Requestor Last Name

38

Requestor First Name

39

Requestor ID

40

Requestor Phone

41

Requestor Email Address

43

Requestor Title

44

Requestor Ext.

47

Location

59

Department Name

62

Assigned To Technician

65

Category

68

Custom Date 1

69

Custom Date 2

70

Custom Integer 1

71

Custom Numeric 1

72

Custom Text 1

73

Custom Text 2

74

Custom Text 3

75

Custom Text 4

76

Custom Text 5

77

Custom Text 6

80

Seq_Status

81

Status

82

Status Description

85

Due Date & Time

88

Inactive

91

Expected Response Date & Time

92

Recommended Fix Date & Time

95

Assignment Source

100

Assigned To First Name

101

Assigned To Last Name

113

Seq_Priority

114

Priority

124

Custom Look Up 1

125

Custom Look Up 2

126

Custom Look Up 3

127

Custom Look Up 4

128

Custom Look Up 5

129

Custom Look Up 6

130

Custom Look Up 7

131

Custom Look Up 8

132

Custom Date 3

133

Custom Date 4

138

Requestor

144

Solution ID

145

Solution Summary

151

Assigned To Full Name

152

TI11 WO ID

153

Asset ID

155

Asset Name

160

Email Cc

161

Email Bcc

Execution response

Click here to see a table of the execution response values.

The POST /assignments Web API can update the following fields for the specified assignment:

Sequence

Display Name of the field

4

Seq_Group

7

Additional Information

10

Seq_Location

11

Seq_Department

12

Seq_Requestor

14

Seq_Assigned To

15

Seq_Category

18

Assignment Summary

26

Callback Number

35

Group

37

Requestor Last Name

38

Requestor First Name

39

Requestor ID

40

Requestor Phone

41

Requestor Email Address

43

Requestor Title

44

Requestor Ext.

47

Location

59

Department Name

62

Assigned To Technician

65

Category

68

Custom Date 1

69

Custom Date 2

70

Custom Integer 1

71

Custom Numeric 1

72

Custom Text 1

73

Custom Text 2

74

Custom Text 3

75

Custom Text 4

76

Custom Text 5

77

Custom Text 6

80

Seq_Status

81

Status

82

Status Description

85

Due Date & Time

88

Inactive

91

Expected Response Date & Time

92

Recommended Fix Date & Time

95

Assignment Source

100

Assigned To First Name

101

Assigned To Last Name

113

Seq_Priority

114

Priority

124

Custom Look Up 1

125

Custom Look Up 2

126

Custom Look Up 3

127

Custom Look Up 4

128

Custom Look Up 5

129

Custom Look Up 6

130

Custom Look Up 7

131

Custom Look Up 8

132

Custom Date 3

133

Custom Date 4

138

Requestor

144

Solution ID

145

Solution Summary

151

Assigned To Full Name

152

TI11 WO ID

153

Asset ID

155

Asset Name

160

Email Cc

161

Email Bcc

Important considerations

  • You need Edit Assignment Permission to use this Web API.
  • Data Segregation is applicable.
  • If the display names have been changed, the updated values are retrieved.
  • NULL values are not retrieved.
  • If multiple virtual fields from the same module are requested for edit, then the last field from the list will be linked.
Click here to view an example.


Example

http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/assignments/101

Request Authorization Header:

Bearer access_token:"ExPqpLF79Zi+vHZJIXZOGBSQVPKXlFVOfmQzMyfS7SGYJolrDAf3/LZR1qm9X+2OVY60OlEuUYOYaflcIjj7ytZ336b50mu4ieuPnx2AU2vCFgO3eqUe22Up"

Request Body:

{

 "Properties": {


"Category" :"Applications",


"Additional Information" : "Additional Information field is updated. "


},
 "OptionalParams": {
 "Param1": {},
 "Param2": {}
 }
}

Response:

{

  "Assignments": {

    "1": {

      "DisplayName": "Assignment ID",

      "Value": 101

    },

    "2": {

      "DisplayName": "Last Modified",

      "Value": "2019-01-23T11:27:09.7970000Z"

    },

    "3": {

      "DisplayName": "Last User",

      "Value": "TECH1"

    },

    "4": {

      "DisplayName": "Seq_Group",

      "Value": 2

    },

    "7": {

      "DisplayName": "Additional Information",

      "Value": "Additional Information field is updated. "

    }….

"22": {

      "DisplayName": "Ticket ID",

      "Value": 101

    }….

"65": {

      "DisplayName": "Category",

      "Value": "Applications"

    }….

}}

GET /assignments/{id}/Attachments/{pageSize}/{pageNumber}

Click here for a description.


Description

Returns all attachments linked to the specified assignment in JSON format

Type of call

GET

Request Authorization Header

Bearer access_token received through the Token API call.

URL Syntax

http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/assignments/{id}/Attachments/{pageSize}/{pageNumber}

Request Parameters

  • (required) id
    Specify the Assignment ID.
  • (required ) pageSize
    Specify the page size.
  • (required ) pageNumber
    Specify the pageNumber.

Request Body

None

Execution response

For a specific assignment, the following values for the attachments are retrieved:

  • Count of Attachments
  • Sequence
  • File Size
  • File Name
  • URL Link

Important considerations

  • You need View Attachment Permission to use this Web API.
  • Data Segregation is not applicable.
  • NULL values are not retrieved.
  • If zero is specified for PageSize or PageNumber, all records are retrieved.
  • If there are no linked Attachments, an empty set is retrieved.
Click here to view an example.
Example

http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/assignments/101/Attachments/1/1/

Request Authorization Header:

Bearer access_token:"ExPqpLF79Zi+vHZJIXZOGBSQVPKXlFVOfmQzMyfS7SGYJolrDAf3/LZR1qm9X+2OVY60OlEuUYOYaflcIjj7ytZ336b50mu4ieuPnx2AU2vCFgO3eqUe22Up"

Response:

{

 "Count": 10,
 "AssignmentAttachments": [
 {
 "1": {
 "DisplayName": "Sequence",
 "Value": 1002
 },
 "6": {
 "DisplayName": "File Size",
 "Value": 120743
 },
 "7": {
 "DisplayName": "File Name",
 "Value": "Serengeti_National_Park_070.jpg"
 }
 },...
 ]}

GET /assignments/{id}/Notes/{pageSize}/{pageNumber}

Click here for a description.

Description

Returns all notes linked to specified assignment in JSON format

Type of call

GET

Request Authorization Header

Bearer access_token received through the Token API call.

URL Syntax

http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/assignments/{id}/Notes/{pageSize}/{pageNumber}

Request Parameters

  • (required) id
    Specify the Assignment ID.
  • (required) pageSize
    Specify the page size.
  • (required) pageNumber
    Specify the pageNumber.
  • maxContentLength
    Specify the maximum length of the content. Note: To return all characters, specify negative 1 (-1).
  • SystemNote
    Specify true or false to return the System Notes.

Request Body

None

Execution response

Returns all notes linked to a specific assignment

Important considerations

  • You need View Assignment Notes Permission to use this Web API.
  • Data Segregation is applicable.
  • NULL values are not retrieved.
  • If zero is specified for PageSize or PageNumber, all records are retrieved.
  • Rich text is displayed in plain text format.
  • SystemNote=true retrieves both System Notes and User Notes, while false only retrieves User Notes.
  • If there are no linked Notes, an empty set is retrieved.
Click here to view an example.
Example

http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/assignments/101/Notes/0/0/?maxContentLength=-1&SystemNote=true

Request Authorization Header:

Bearer access_token:"ExPqpLF79Zi+vHZJIXZOGBSQVPKXlFVOfmQzMyfS7SGYJolrDAf3/LZR1qm9X+2OVY60OlEuUYOYaflcIjj7ytZ336b50mu4ieuPnx2AU2vCFgO3eqUe22Up"

Response:

{

  "Count": 3,

  "AssignmentNotes": [

    {

      "1": {

        "DisplayName": "Sequence",

        "Value": 1003

      },

      "2": {

        "DisplayName": "Last Modified",

        "Value": "2019-01-23T08:20:43.3030000Z"

      },

      "3": {

        "DisplayName": "Last User",

        "Value": "TECH1"

      },

      "4": {

        "DisplayName": "Seq_Group",

        "Value": 2

      },….

}

}

GET /assignments/Note/{noteId}

Click here for a description.

Description

Returns sequence, display names, and values of all fields for the specified assignment note in JSON Format

Type of call

GET

Request Authorization Header

Bearer access_token received through the Token API call.

URL Syntax

http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/assignments/Note/{NoteId}

Request Parameters

Specify the Assignment Note ID.

Request Body

None

Execution response

Click here to see a table of the execution response values.

For the specified assignment note, the following fields can be returned:

Sequence

Display Name of the field

1

Sequence

2

Last Modified

3

Last User

4

Seq_Group

5

Note

6

Assignment ID

8

Seq_Technician

9

Date

10

Duration

11

Seq_Activity Code

13

Note Exists

14

System Activity

15

Activity Code

16

Technician

17

Inactive

20

Email (To/From)

21

Seq_EmailMgmt

22

Note Type

23

Private

24

Activity Code Description

25

Track Time

26

TI11 Note ID

27

Assigned To Technician

Important considerations

  • You need View Assignment Notes Permission to use this Web API.
  • Data Segregation is applicable.
  • NULL values are not retrieved.
  • Both System Notes and User Notes are retrieved.
Click here to view an example.
Example

http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/assignments/Note/1001

Request Authorization Header:

Bearer access_token:"ExPqpLF79Zi+vHZJIXZOGBSQVPKXlFVOfmQzMyfS7SGYJolrDAf3/LZR1qm9X+2OVY60OlEuUYOYaflcIjj7ytZ336b50mu4ieuPnx2AU2vCFgO3eqUe22Up" 

Response:

{

  "AssignmentNote": [

    {

      "1": {

        "DisplayName": "Sequence",

        "Value": 1001

      },

      "2": {

        "DisplayName": "Last Modified",

        "Value": "2019-01-23T08:20:43.1530000Z"

      },

      "3": {

        "DisplayName": "Last User",

        "Value": "TECH1"

      },

      "4": {

        "DisplayName": "Seq_Group",

        "Value": 2

      },....

}

}

GET /assignments/{id}/Successors/{pageSize}/{pageNumber}

Click here for a description.

Description

Returns all successors linked to a specified assignment in JSON format

Type of call

GET

Request Authorization Header

Bearer access_token received through the Token API call.

URL Syntax

http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/assignments/{id}//Successors/{pageSize}/{pageNumber}

Request Parameters

  • (required) id
    Specify the Assignment ID.
  • (required ) pageSize
    Specify the page size.
  • (required ) pageNumber
    Specify the pageNumber.

Request Body

None

Execution response

Returns all successors and their count linked to a specified assignment

Important considerations

  • You need View Assignment Permission to use this Web API.
  • Data Segregation is applicable.
  • NULL values are not retrieved.
  • If zero is specified for PageSize or PageNumber, all records are retrieved.
  • Both Open and Closed records are retrieved.
  • If there are no linked Successors, an empty set is retrieved.
Click here to view an example.
Example

http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/assignments/101/Successors/1/1

Request Authorization Header:

Bearer access_token:"ExPqpLF79Zi+vHZJIXZOGBSQVPKXlFVOfmQzMyfS7SGYJolrDAf3/LZR1qm9X+2OVY60OlEuUYOYaflcIjj7ytZ336b50mu4ieuPnx2AU2vCFgO3eqUe22Up"

Response:

{

  "Count": 3,

  "AssignmentDependencies": [

    {

      "1": {

        "DisplayName": "Sequence",

        "Value": 1003

      },

      "2": {

        "DisplayName": "Last Modified",

        "Value": "2019-01-23T08:20:43.3030000Z"

      },

      "3": {

        "DisplayName": "Last User",

        "Value": "TECH1"

      },

      "4": {

        "DisplayName": "Seq_Group",

        "Value": 2

      },….

}

}

GET /assignments/{id}/Predecessors/{pageSize}/{pageNumber}

Click here for a description.

Description

Returns all predecessors linked to a specified assignment in JSON format

Type of call

GET

Request Authorization Header

Bearer access_token received through the Token API call.

URL Syntax

http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/assignments/{id}/Predecessors/{pageSize}/{pageNumber}

Request Parameters

  • (required) id
    Specify the Assignment ID.
  • (require) pageSize
    Specify the page size.
  • (required) pageNumber
    Specify the pageNumber.

Request Body

None

Execution response

Returns all predecessors and their count linked to a specified assignment

Important considerations

  • You need View Assignment Permission to use this Web API.
  • Data Segregation is applicable.
  • NULL values are not retrieved.
  • If zero is specified for PageSize or PageNumber, all records are retrieved.
  • Both Open and Closed records are retrieved.
  • If there are no linked Predecessors, an empty set is retrieved.
Click here to view an example.
Example

http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/assignments/101/Predecessors/1/1

Request Authorization Header:

Bearer access_token:"ExPqpLF79Zi+vHZJIXZOGBSQVPKXlFVOfmQzMyfS7SGYJolrDAf3/LZR1qm9X+2OVY60OlEuUYOYaflcIjj7ytZ336b50mu4ieuPnx2AU2vCFgO3eqUe22Up"

Response:

{

  "Count": 3,

  "AssignmentDependencies": [

    {

      "1": {

        "DisplayName": "Sequence",

        "Value": 1003

      },

      "2": {

        "DisplayName": "Last Modified",

        "Value": "2019-01-23T08:20:43.3030000Z"

      },

      "3": {

        "DisplayName": "Last User",

        "Value": "TECH1"

      },

      "4": {

        "DisplayName": "Seq_Group",

        "Value": 2

      },….

}

}

POST /assignments

Click here for a description.

Description

Creates and returns the specified Assignment in JSON format

Type of call

POST

Request Authorization Header

Bearer access_token received through the Token API call.

URL Syntax

http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/assignments

Request Parameters

None

Request Body

Specify createInput as follows:

  • (required) Properties
    Specify the properties, which are pairs of values for Field Sequence ID and Display Name
  • (optional) OptionalParams
    Specify any optional parameters when present

{

 "Properties": {},
 "OptionalParams": {
 "Param1": {},
 "Param2": {}
 }
}

Click here to see a table of the fields you can update.

For the specified assignment, you can update the following fields:

Sequence

Display Name of the field

4

Seq_Group

7

Additional Information

10

Seq_Location

11

Seq_Department

12

Seq_Requestor

14

Seq_Assigned To

15

Seq_Category

18

Assignment Summary

22

Ticket ID

26

Callback Number

35

Group

37

Requestor Last Name

38

Requestor First Name

39

Requestor ID

40

Requestor Phone

41

Requestor Email Address

43

Requestor Title

44

Requestor Ext.

47

Location

59

Department Name

62

Assigned To Technician

65

Category

68

Custom Date 1

69

Custom Date 2

70

Custom Integer 1

71

Custom Numeric 1

72

Custom Text 1

73

Custom Text 2

74

Custom Text 3

75

Custom Text 4

76

Custom Text 5

77

Custom Text 6

80

Seq_Status

81

Status

82

Status Description

85

Due Date & Time

88

Inactive

91

Expected Response Date & Time

92

Recommended Fix Date & Time

95

Assignment Source

100

Assigned To First Name

101

Assigned To Last Name

113

Seq_Priority

114

Priority

124

Custom Look Up 1

125

Custom Look Up 2

126

Custom Look Up 3

127

Custom Look Up 4

128

Custom Look Up 5

129

Custom Look Up 6

130

Custom Look Up 7

131

Custom Look Up 8

132

Custom Date 3

133

Custom Date 4

138

Requestor

144

Solution ID

145

Solution Summary

151

Assigned To Full Name

152

TI11 WO ID

153

Asset ID

155

Asset Name

160

Email Cc

161

Email Bcc

Execution response

Creates and returns the assignment with Field Sequence and Display Names.

Click here to see a table of the execution response values.

For the created assignment, you can return the following fields:

Sequence

Display Name of the field

1

Assignment ID

2

Last Modified

3

Last User

4

Seq_Group

7

Additional Information

8

Open Date & Time

9

Status Type

10

Seq_Location

11

Seq_Department

12

Seq_Requestor

13

Seq_Open By

14

Seq_Assigned To

15

Seq_Category

18

Assignment Summary

20

Seq_Closed By

21

Close Date & Time

22

Ticket ID

26

Callback Number

35

Group

37

Requestor Last Name

38

Requestor First Name

39

Requestor ID

40

Requestor Phone

41

Requestor Email Address

43

Requestor Title

44

Requestor Ext.

45

Closed By Technician

47

Location

50

Location Main Contact

59

Department Name

61

Open By Technician

62

Assigned To Technician

65

Category

68

Custom Date 1

69

Custom Date 2

70

Custom Integer 1

71

Custom Numeric 1

72

Custom Text 1

73

Custom Text 2

74

Custom Text 3

75

Custom Text 4

76

Custom Text 5

77

Custom Text 6

80

Seq_Status

81

Status

82

Status Description

85

Due Date & Time

88

Inactive

89

Clock Stop Time

91

Expected Response Date & Time

92

Recommended Fix Date & Time

93

Opened Group

94

Closed Group

95

Assignment Source

96

Opened By First Name

97

Opened By Last Name

98

Closed By First Name

99

Closed By Last Name

100

Assigned To First Name

101

Assigned To Last Name

113

Seq_Priority

114

Priority

115

Priority Duration

123

Template

124

Custom Look Up 1

125

Custom Look Up 2

126

Custom Look Up 3

127

Custom Look Up 4

128

Custom Look Up 5

129

Custom Look Up 6

130

Custom Look Up 7

131

Custom Look Up 8

132

Custom Date 3

133

Custom Date 4

136

Charge

137

Hourly Rate

138

Requestor

139

Seq_Responded By

140

Responded By Technician

141

Responded By First Name

142

Responded By Last Name

143

Responded Date & Time

144

Solution ID

145

Solution Summary

146

Seq_EscalateToTechnician

147

Escalate To Technician

148

Escalate To Technician Email

149

Total Time Spent

150

Category Full Path

151

Assigned To Full Name

152

TI11 WO ID

153

Asset ID

154

BCM Asset ID

155

Asset Name

156

Audit Date

157

Serial Number

158

Escalate To Login ID

159

Open By FullName

160

Email Cc

161

Email Bcc

Important considerations

  • You need Create Assignment Permission to use this Web API.
  • Data Segregation is applicable.
  • If the display names have been changed, the updated values are retrieved.
  • NULL values are not retrieved.
  • User can create via both Display Name and Field Sequence
  • If multiple virtual fields from the same module are requested for creating the record, the last field from the list is linked.
Click here to view an example.
Example

http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/assignments

Request Authorization Header:

Bearer access_token:"ExPqpLF79Zi+vHZJIXZOGBSQVPKXlFVOfmQzMyfS7SGYJolrDAf3/LZR1qm9X+2OVY60OlEuUYOYaflcIjj7ytZ336b50mu4ieuPnx2AU2vCFgO3eqUe22Up"

Request body:

{

 "Properties": {

"Ticket ID":101,

"Category" :"Applications",

"Additional Information" : "Additional Information field is updated. "},

 "OptionalParams": {

 "Param1": {},

 "Param2": {}

 }

}

Response:

{

  "Assignments": {

    "1": {

      "DisplayName": "Assignment ID",

      "Value": 101

    },

    "2": {

      "DisplayName": "Last Modified",

      "Value": "2019-01-23T11:27:09.7970000Z"

    },

    "3": {

      "DisplayName": "Last User",

      "Value": "TECH1"

    },

    "4": {

      "DisplayName": "Seq_Group",

      "Value": 2

    },

    "7": {

      "DisplayName": "Additional Information",

      "Value": "Additional Information field is updated. "

    }….

    "65": {

      "DisplayName": "Category",

      "Value": "Applications"

    },

}}

POST /assignments/{id}/AddNote

Click here for a description.

Description

Creates and returns a user note linked to the specified assignment in JSON format

Type of call

POST 

Request Authorization Header

Bearer access_token received through the Token API call.

URL Syntax

http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/assignments/{id}/AddNote

Request Parameters

(required) id

Specify the Assignment ID.

Request Body

(required) note

Specify as follows:

  • Note Type
    Specify the Note Type as a string value.
  • Activity Code
    Specify the Activity Code as a string value.
  • Note
    Specify a string to create a User Note
  • Duration
    Specify the Duration as a string value
  • Private
    Specify true or false to determine the privacy for the note.
  • OptionalParams
    Specify any optional parameters when present.

{
 "Note Type": "string",
 "Activity Code": "string",
 "Note": "string",
 "Duration": "string",
 "OptionalParams": {
 "Param1": {},
 "Param2": {}
 }
}

Execution response

Creates and returns a user note linked to a specified assignment

Click here to see a table of the execution response values.

For the specified assignment note, the following fields can be returned:

Sequence

Display Name of the field

1

Sequence

2

Last Modified

3

Last User

4

Seq_Group

5

Note

6

Assignment ID

8

Seq_Technician

9

Date

10

Duration

11

Seq_Activity Code

13

Note Exists

14

System Activity

15

Activity Code

16

Technician

17

Inactive

20

Email (To/From)

21

Seq_EmailMgmt

22

Note Type

23

Private

24

Activity Code Description

25

Track Time

26

TI11 Note ID

27

Assigned To Technician

Important considerations

  • You need Create Assignment Notes Permission to use this Web API.
  • Data Segregation is applicable.
  • NULL values are not retrieved.
  • Rich text is displayed in plain text format.
  • Notes can be added to Open, Closed, Inactive Assignments.
  • If Note is specified, then the Note Type and Activity Code are required.
  • Only Activity Codes available for Assignment can be passed in Request Body.
Click here to view an example.
Example

http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/assignments/101/AddNote 

Request Authorization Header:

Bearer access_token:"ExPqpLF79Zi+vHZJIXZOGBSQVPKXlFVOfmQzMyfS7SGYJolrDAf3/LZR1qm9X+2OVY60OlEuUYOYaflcIjj7ytZ336b50mu4ieuPnx2AU2vCFgO3eqUe22Up"

Request Body:

{
"Note Type": "Assignment Description",
"Activity Code": "Install",
"Note": "This is an Assignment Note added by API",
"Duration": "00:10:00",
"OptionalParams": {
"Param1": {},
"Param2": {}
}
}

Response:

{

  "Assignment": {

    "1": {

      "DisplayName": "Assignment ID",

      "Value": 101

    },

    "2": {

      "DisplayName": "Last Modified",

      "Value": "2019-01-23T11:27:09.7970000Z"

    },

    "3": {

      "DisplayName": "Last User",

      "Value": "TECH1"

    },

    "4": {

      "DisplayName": "Seq_Group",

      "Value": 2

    },…

}     

"Note": {

    "1": {

      "DisplayName": "Sequence",

      "Value": 1008

    },

    "2": {

      "DisplayName": "Last Modified",

      "Value": "2019-01-23T12:40:46.6130000Z"

    },

    "3": {

      "DisplayName": "Last User",

      "Value": "SAK2"

    },

    "4": {

      "DisplayName": "Seq_Group",

      "Value": 2

    },

    "5": {

      "DisplayName": "Note",

      "Value": "This is an Assignment Note added by API"

    },

    "6": {

      "DisplayName": "Assignment ID",

      "Value": 101

    },

    "8": {

      "DisplayName": "Seq_Technician",

      "Value": 1035

    },

    "9": {

      "DisplayName": "Date",

      "Value": "2019-01-23T12:40:46.6130000Z"

    },

    "10": {

      "DisplayName": "Duration",

      "Value": 600

    },…..

}}

POST /assignments/{id}/Delete

Click here for a description.

Description

Deletes the specified assignment and returns the status in JSON format

Type of call

POST

Request Authorization Header

Bearer access_token received through the Token API call.

Request Body

None

URL Syntax

http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/assignments/{id}/Delete

Request Parameters

(required) id

Specify the Assignment ID.

Request Body

None

Execution response

Deletes the specified assignment and returns the status

The following response is generated, either true or false:

{

  "success": true

}

Important considerations

  • You need Delete Assignment Permission to use this Web API.
  • Data Segregation is applicable.
  • There is no change in the linked parent Ticket when the assignment is deleted.
Click here to view an example.
Example

http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/assignments/101/Delete 

Request Authorization Header:

Bearer access_token:"ExPqpLF79Zi+vHZJIXZOGBSQVPKXlFVOfmQzMyfS7SGYJolrDAf3/LZR1qm9X+2OVY60OlEuUYOYaflcIjj7ytZ336b50mu4ieuPnx2AU2vCFgO3eqUe22Up"

Response:

{

  "success": true

}

POST /assignments/{id}/ChangeStatus

Click here for a description.

Description

Changes and returns the status of the specified assignment in JSON format.

Type of call

POST 

Request Authorization Header

Bearer access_token received through the Token API call.

URL Syntax

http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/assignments/{id}/ChangeStatus

Request Parameters

(required) id

Specify the Assignment ID.

Request Body

Specify the changeStatusInput as follows:

  • StatusName
    Specify the Status Name as a string value.
  • Note Type
    Specify the Note Type as a string value.
  • Activity Code
    Specify the Activity Code as a string value.
  • Note
    Specify a string to create a User Note.
  • Private
    Specify true or false to determine the privacy for the note.
  • OptionalParams
    Specify any optional parameters when present.

{
 "StatusName": "string",
 "Note": {
 "Note Type": "string",
 "Activity Code": "string",
 "Note": "string",
 "OptionalParams": {
 "Param1": {},
 "Param2": {}
 }
 }
}

Execution response

Changes and returns the status of a specific assignment

Click here to see a table of the execution response values.

For the specified assignment, the following fields are returned:

Sequence

Display Name of the field

1

Assignment ID

2

Last Modified

3

Last User

4

Seq_Group

7

Additional Information

8

Open Date & Time

9

Status Type

10

Seq_Location

11

Seq_Department

12

Seq_Requestor

13

Seq_Open By

14

Seq_Assigned To

15

Seq_Category

18

Assignment Summary

20

Seq_Closed By

21

Close Date & Time

22

Ticket ID

26

Callback Number

35

Group

37

Requestor Last Name

38

Requestor First Name

39

Requestor ID

40

Requestor Phone

41

Requestor Email Address

43

Requestor Title

44

Requestor Ext.

45

Closed By Technician

47

Location

50

Location Main Contact

59

Department Name

61

Open By Technician

62

Assigned To Technician

65

Category

68

Custom Date 1

69

Custom Date 2

70

Custom Integer 1

71

Custom Numeric 1

72

Custom Text 1

73

Custom Text 2

74

Custom Text 3

75

Custom Text 4

76

Custom Text 5

77

Custom Text 6

80

Seq_Status

81

Status

82

Status Description

85

Due Date & Time

88

Inactive

89

Clock Stop Time

91

Expected Response Date & Time

92

Recommended Fix Date & Time

93

Opened Group

94

Closed Group

95

Assignment Source

96

Opened By First Name

97

Opened By Last Name

98

Closed By First Name

99

Closed By Last Name

100

Assigned To First Name

101

Assigned To Last Name

113

Seq_Priority

114

Priority

115

Priority Duration

123

Template

124

Custom Look Up 1

125

Custom Look Up 2

126

Custom Look Up 3

127

Custom Look Up 4

128

Custom Look Up 5

129

Custom Look Up 6

130

Custom Look Up 7

131

Custom Look Up 8

132

Custom Date 3

133

Custom Date 4

136

Charge

137

Hourly Rate

138

Requestor

139

Seq_Responded By

140

Responded By Technician

141

Responded By First Name

142

Responded By Last Name

143

Responded Date & Time

144

Solution ID

145

Solution Summary

146

Seq_EscalateToTechnician

147

Escalate To Technician

148

Escalate To Technician Email

149

Total Time Spent

150

Category Full Path

151

Assigned To Full Name

152

TI11 WO ID

153

Asset ID

154

BCM Asset ID

155

Asset Name

156

Audit Date

157

Serial Number

158

Escalate To Login ID

159

Open By FullName

160

Email Cc

161

Email Bcc

Important considerations

  • This API needs Edit Assignment Permission for Technician. Additionally, the following permissions may be required:
    • Permission to "Close Assignments", if you need to change the status type to Closed.
    • Permission to "Create Assignment Note", if you need to add a note.
  • Data Segregation is applicable.
  • If the display names have been changed, the updated values are retrieved.
  • NULL values are not retrieved.
  • Assignment Status Progression is applicable.
  • Stop the Clock from Status is applicable.
  • There is no change in the linked parent ticket when the status of the assignment is updated or closed.
  • Rich text is displayed in plain text format.
  • Notes can be added to Open, Closed, and Inactive Assignments.
  • If changeStatusInput is specified, then the Note Type and Activity Code are required, while Note is optional.
  • The default for the duration of the Note is zero (0).
  • You can only specify Activity Codes available for Assignment.
Click here to view an example.
Example

http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/assignments/101/ChangeStatus

Request Authorization Header:

Bearer access_token:"ExPqpLF79Zi+vHZJIXZOGBSQVPKXlFVOfmQzMyfS7SGYJolrDAf3/LZR1qm9X+2OVY60OlEuUYOYaflcIjj7ytZ336b50mu4ieuPnx2AU2vCFgO3eqUe22Up"

Request Body:


changeStatusInput:

{
 "StatusName": "Escalated",
 "Note": {
 "Note Type": "Assignment Description",
 "Activity Code": "Install",
 "Note": " This is an Assignment Note added by API to change Status ",
 "OptionalParams": {
 "Param1": {},
 "Param2": {}
 }
 }
}


Response:

{

  "Assignment": {

    "1": {

      "DisplayName": "Assignment ID",

      "Value": 101

    },

    "2": {

      "DisplayName": "Last Modified",

      "Value": "2019-01-23T13:06:08.7500000Z"

    },

    "3": {

      "DisplayName": "Last User",

      "Value": "TECH1"

    },

    "4": {

      "DisplayName": "Seq_Group",

      "Value": 2

    },….

    "81": {

      "DisplayName": "Status",

      "Value": "Escalated"

    },…..

}

}

"Note": {

    "1": {

      "DisplayName": "Sequence",

      "Value": 1010

    },

    "2": {

      "DisplayName": "Last Modified",

      "Value": "2019-01-23T13:06:09.3370000Z"

    },

    "3": {

      "DisplayName": "Last User",

      "Value": "TECH1"

    },

    "4": {

      "DisplayName": "Seq_Group",

      "Value": 2

    },

    "5": {

      "DisplayName": "This is an Assignment Note added by API to change Status.",

      "Value": "note"

    },

    "6": {

      "DisplayName": "Assignment ID",

      "Value": 101

    }….

}

}

POST /assignments/{id}/Close

Click here for a description.

Description

Changes and returns the status of the specified assignment to the default status type of Closed in JSON format.

Type of call

POST

Request Authorization Header

Bearer access_token received through the Token API call.

URL Syntax

http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/assignments/{id}/Close

Request Parameters

(required) id

Specify the Assignment ID.

Request Body

(required) closeInput

Specify as follows:

  • Note Type
    Specify the Note Type as a string value.
  • Activity Code
    Specify the Activity Code as a string value.
  • Note
    Specify a string to create a User Note.
  • Private
    Specify true or false to determine the privacy for the note.
  • OptionalParams
    Specify any optional parameters when present.

{

 "Note": {
 "Note Type": "string",
 "Activity Code": "string",
 "Note": "string",
 "OptionalParams": {
 "Param1": {},
 "Param2": {}
 }
 }
}

Execution response

Returns the assignment with Default Closed status and adds the respective Note.

Click here to see a table of the execution response values.

For the specified assignment, the following fields are returned:

Sequence

Display Name of the field

1

Assignment ID

2

Last Modified

3

Last User

4

Seq_Group

7

Additional Information

8

Open Date & Time

9

Status Type

10

Seq_Location

11

Seq_Department

12

Seq_Requestor

13

Seq_Open By

14

Seq_Assigned To

15

Seq_Category

18

Assignment Summary

20

Seq_Closed By

21

Close Date & Time

22

Ticket ID

26

Callback Number

35

Group

37

Requestor Last Name

38

Requestor First Name

39

Requestor ID

40

Requestor Phone

41

Requestor Email Address

43

Requestor Title

44

Requestor Ext.

45

Closed By Technician

47

Location

50

Location Main Contact

59

Department Name

61

Open By Technician

62

Assigned To Technician

65

Category

68

Custom Date 1

69

Custom Date 2

70

Custom Integer 1

71

Custom Numeric 1

72

Custom Text 1

73

Custom Text 2

74

Custom Text 3

75

Custom Text 4

76

Custom Text 5

77

Custom Text 6

80

Seq_Status

81

Status

82

Status Description

85

Due Date & Time

88

Inactive

89

Clock Stop Time

91

Expected Response Date & Time

92

Recommended Fix Date & Time

93

Opened Group

94

Closed Group

95

Assignment Source

96

Opened By First Name

97

Opened By Last Name

98

Closed By First Name

99

Closed By Last Name

100

Assigned To First Name

101

Assigned To Last Name

113

Seq_Priority

114

Priority

115

Priority Duration

123

Template

124

Custom Look Up 1

125

Custom Look Up 2

126

Custom Look Up 3

127

Custom Look Up 4

128

Custom Look Up 5

129

Custom Look Up 6

130

Custom Look Up 7

131

Custom Look Up 8

132

Custom Date 3

133

Custom Date 4

136

Charge

137

Hourly Rate

138

Requestor

139

Seq_Responded By

140

Responded By Technician

141

Responded By First Name

142

Responded By Last Name

143

Responded Date & Time

144

Solution ID

145

Solution Summary

146

Seq_EscalateToTechnician

147

Escalate To Technician

148

Escalate To Technician Email

149

Total Time Spent

150

Category Full Path

151

Assigned To Full Name

152

TI11 WO ID

153

Asset ID

154

BCM Asset ID

155

Asset Name

156

Audit Date

157

Serial Number

158

Escalate To Login ID

159

Open By FullName

160

Email Cc

161

Email Bcc

Important considerations

  • This Web API needs Edit Assignment Permission and Permission to Close Assignments for Technician.
  • If you want to add a note, you need Permission to Create Assignment Note.
  • Data segregation is applicable.
  • If the display names have been changed, the updated values are retrieved.
  • NULL values are not retrieved.
  • Assignment Status Progression is applicable.
  • Stop the Clock from Status is applicable.
  • There is no change in the linked parent ticket when the status of the assignment is closed.
  • Rich text is displayed in plain text format.
  • Notes can be added to Open, Closed, and Inactive Assignments.
  • If closeInput is specified, then the Note Type and Activity Code are required, while Note is optional.
  • The default for the duration of the Note is zero (0).
  • You can only specify available activity codes.
Click here to view an example.
Example

http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/assignments/101/Close

Request Authorization Header:

Bearer access_token:"ExPqpLF79Zi+vHZJIXZOGBSQVPKXlFVOfmQzMyfS7SGYJolrDAf3/LZR1qm9X+2OVY60OlEuUYOYaflcIjj7ytZ336b50mu4ieuPnx2AU2vCFgO3eqUe22Up"

Response:

{

  "Assignment": {

    "1": {

      "DisplayName": "Assignment ID",

      "Value": 101

    },

    "2": {

      "DisplayName": "Last Modified",

      "Value": "2019-01-23T13:06:08.7500000Z"

    },

    "3": {

      "DisplayName": "Last User",

      "Value": "TECH1"

    },

    "4": {

      "DisplayName": "Seq_Group",

      "Value": 2

    },….

    "81": {

      "DisplayName": "Status",

      "Value": "Closed"

    },…..

}

}

"Note": {

    "1": {

      "DisplayName": "Sequence",

      "Value": 1010

    },

    "2": {

      "DisplayName": "Last Modified",

      "Value": "2019-01-23T13:06:09.3370000Z"

    },

    "3": {

      "DisplayName": "Last User",

      "Value": "SAK2"

    },

    "4": {

      "DisplayName": "Seq_Group",

      "Value": 2

    },

    "5": {

      "DisplayName": "This is an Assignment Note added by API to close the Assignment.",

      "Value": "note"

    },

    "6": {

      "DisplayName": "Assignment ID",

      "Value": 101

    }….

}

} 






 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*