Solution Web APIs

Solution Web APIs enable you to request solutions or solution attachments from a solution ID. The get calls return the solution objects in JSON Format. The following details describe the Web APIs:

GET /solutions/{solutionId}

Click here for a description.

Description	Returns all fields of specified solution 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/solutions/{solutionid}
Request Parameters	Specify the solutionId Valid values are integers.
Request Body	None
Execution response	The following fields are retrieved and sorted by column sequence: Solution ID Last modified Last user Seq_Group Summary Solution Text Seq_Topic Topic Inactive Private solution Rating Comment Count Relevance Count
Important considerations	You must have View Solution permission to view solution modules to use the Web API. You can request both active and inactive solutions. Rich Text is displayed in HTML format. Both column names and display names are returned. If the display names are changed, the updated values are returned. Data Segregation Rules are applied.

Click here to view an example.

Example

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

Request Authorization Header:

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

Response:

{
"1": { "DisplayName": "Solution ID", "Value": 101 },
"2": { "DisplayName": "Last Modified", "Value": "2019-01-08T07:34:55.0400000Z" },
"3": { "DisplayName": "Last User", "Value": "TECHNICIANA" },
"4": { "DisplayName": "Seq_Group", "Value": 2 },
"5": { "DisplayName": "Summary", "Value": "Test summary" },
"6": { "DisplayName": "Solution Text", "Value": "Test Solution Text" },
"7": { "DisplayName": "Seq_Topic", "Value": 1001 },
"8": { "DisplayName": "Topic", "Value": "General" },
"9": { "DisplayName": "Inactive", "Value": false },
"10": { "DisplayName": "Private Solution", "Value": false },
"11": { "DisplayName": "Rating", "Value": 0 },
"12": { "DisplayName": "Comment Count", "Value": 0 },
"13": { "DisplayName": "Relevance Count", "Value": 0 }
}

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

Click here for a description.

Description	Returns all attachments linked to the specified solution 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/solution/{id}/Attachments/{pageSize}/{pageNumber}
Request Parameters	Specify the following values: (required) solutionId, which is an integer. (required) PageSize, which is an integer. The default is 0. (required) PageNumber, which is an integer. The default being 0.
Request Body	None
Execution response	The following solution fields for all linked attachments are retrieved and sorted by column sequence: Sequence File Size (if Applicable) File Name (if Applicable) URL Link (if Applicable)
Important considerations	You must have permissions to view attachment modules to use the Web API. If zero is specified for PageSize or PageNumber, all records are retrieved.

Click here to view an example.

Example

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

Request Authorization Header:

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

Response:

{

"Count": 1,

"SolutionAttachments": [

{

"1":{"DisplayName": "Sequence","Value": 1001},
"6":{"DisplayName": "File Size","Value": 12074},
"7":{"DisplayName": "File Name","Value": "Test File.jpg"},
"14":{"DisplayName": "URL Link","Value": "www.google.com"}}
]
}

Solution Web APIs

GET /solutions/{solutionId}

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

On this page