TrackServiceRest Resource

Track

Available Since
1.6.0

POST /2.0/lms/track/create

This method has been deprecated. Use POST /lms/api/v0/tracks/ instead.

Create a Track

Available Since
1.6.0
Request Body
media type data type description
application/json TrackApiVO (JSON)
REQUIRED

Request JSON (example):


 {
 	"code" : "TR01", // Code of Track (optional)
 	"name" : "Track name", // Name (required)
 	"status" : "AVAILABLE", // Status (required)
 	"author" : "Author", // Author (required)
 	"workload" : 1, // Workload (required)
 	"objective" : "Objective", // Objective (optional)
 	"catalogSkills": [  // CatalogSkills (optional)
 		    {
 			  "id":  192, // Skill ID (required)
 			  "minPoint": 0, // maxPoint (required)
 			  "maxPoint": 100 // minPoint (required)
 		    }
 		  ],
 	"preExamId" : 191, // Pre-test, assessment version id (optional)
 	"approvePreExam" : false, // Flag to approve on PreExam (optional)
 	"scoreApprovePreExam" : 75.00, // Score to Approve on PreExame (optional)
 	"reprovePreExam" : false, // Flag to reprove on PreExam (optional)
 	"scoreReprovePreExam" : 40.00,  // Score to Reprove on PreExame (optional)
 	"requiredPreExam" : false, // Flag to required PreExam (optional)
 	"trackItemIds" : [ 192, 193, 184], // Defines the Tracks and Trainings ids (optional)
 	"trackItems" : [
 		{
 			"enrollableItemId":  192, // ID track or training (required)
 			"mandatory": true, // mandatory (optional)
 			"order": 5, // Order that you be presented on the track execution (optional, default is 0)
 			"requirementIds": [100] // id of requirement item (optional)
 		}
 	"cost" : 0, // Defines the Cost of Tracks (required)
 	"posExamId" : 122, // Post-test, assessment version id (optional)
 	"scoreApprove" : 75.00, // Required Score to Approve (optional)
 	"reactionId" : 120, //  Reaction evaluation, assessment version id (optional)
 	"certificateId" : 1, // Certificate (optional)
 	"programmaticContent" : "Defines Programmatic Content", // Programmatic Content (optional)
 	"targetPublic" : "Defines Target Public", // Target Public (optional)
 	"requirementsIds" : [111, 222, 333], // Defines the Tracks and Trainings ids that will be requirement to this Track (optional)
 	"requirementsDisciplineIds" : [444, 555, 666], // Defines the Disciplines ids that will be requirement to this Track (optional)
 	"parentId": 10, // Parent item that the folder will be created (required)
 	"inheritPermissions" : "INHERIT", // Type Inherit Permission "INHERIT" Or "NOT_INHERIT"
 	"securityPermission": [  // Defines the security configurations for the track
 		    {
 			  "partyId": 193, // Party ID
 			  "roles": [ "READ" ] // Permission level key. Acceptable values: NONE, READ, EXECUTE, WRITE, MODIFY, REMOVE, COMPLETE
 		  }
 	  ],
 	"securityRestriction": [  // Defines the security configurations for the track
 		    {
 			  "partyId": 193, // Party ID
 			  "roles": [ "MODIFY" ] // Restriction level key. Acceptable values: NONE, READ, EXECUTE, WRITE, MODIFY, REMOVE, COMPLETE
 		  }
 	  ],
 	"imageProperties": {  // Defines images properties for the crop operation
 		 "imageName": "track_image.png", // File must already be on the learn user upload directory. Acceptable image types: JPG,JPGE,PNG,GIF
 		 "coordinateX": "0", // Set the pixel x coordinate
 		 "coordinateY": "0", // Set the pixel y coordinate
 		 "width": "500", // Set the width of the image in pixels
 		 "height": "500" // Set the height of the image in pixels
 	 },
 	"theme" : "Miscellaneous" // Track theme (optional)
 }
 
Response Body
media type data type description
application/json object (JSON)

 This method return HTTP 200 status and Object TrackVO
{ content: { "id" : 1, "code" : "TR01", "name" : "Track name", "status" : "AVAILABLE", "author" : "Author", "workload" : 1, "objective" : "Objective", "catalogSkills": [ { "id": 192, "minPoint": 0, "maxPoint": 100 } ], "preExamId" : 191, "approvePreExam" : false "scoreApprovePreExam" : 75.00 "reprovePreExam" : false "scoreReprovePreExam" : 40.00 "requiredPreExam" : false "trackItemIds" : [ 192, 193, 184], "trackItems" : [ { "enrollableItemId": 192, "mandatory": true, "order": 5, "requirementIds": [100] } ], "cost" : 0, "posExamId" : 122, "scoreApprove" : 75.00, "reactionId" : 120, "certificateId" : 1, "programmaticContent" : "Defines Programmatic Content", "targetPublic" : "Defines Target Public", "requirementsIds" : [111, 222, 333], "requirementsDisciplineIds" : [ 444, 555, 666], "parentId": 10, "securityPermission": [ { "partyId": 193, "roles": [ "READ" ] } ], "securityRestriction": [ { "partyId": 193, "roles": [ "MODIFY" ] } ], "inheritPermissions" : "INHERIT", "imageProperties": { "imageName": "track_image.png", "coordinateX": "0", "coordinateY": "0", "width": "500", "height": "500" }, "theme": "Miscellaneous" }, message: { message: "OK", detail: "OK", type: "INFO" } }
Available Since
1.6.0

POST /2.0/lms/track/edit

This method has been deprecated. Use PUT /lms/api/v0/tracks/ instead.

Edit a Track

Available Since
1.6.0
Request Body
media type data type description
application/json TrackApiVO (JSON)
REQUIRED

Request JSON (example):


 {
 	"id" : 1, // ID of Track (required)
 	"code" : "TR01", // Code of Track (optional)
 	"name" : "Track name", // Name (required)
 	"status" : "AVAILABLE", // Status (required)
 	"author" : "Author", // Author (required)
 	"workload" : 1, // Workload (required)
 	"objective" : "Objective", // Objective (optional)
 	"catalogSkills": [  // CatalogSkills (optional)
 		    {
 			  "id":  192, // Skill ID (required)
 			  "minPoint": 0, // maxPoint (required)
 			  "maxPoint": 100 // minPoint (required)
 		    }
 		  ],
 	"preExamId" : 191, // Pre-test, assessment version id (optional)
 	"approvePreExam" : false, // Flag to approve on PreExam (optional)
 	"scoreApprovePreExam" : 75.00, // Score to Approve on PreExame (optional)
 	"reprovePreExam" : false, // Flag to reprove on PreExam (optional)
 	"scoreReprovePreExam" : 40.00,  // Score to Reprove on PreExame (optional)
 	"requiredPreExam" : false, // Flag to required PreExam (optional)
 	"trackItemIds" : [ 192, 193, 184], // Defines the Tracks and Trainings ids (optional)
 	"trackItems" : [
 		    {
 			  "id":  192, // ID track or training (required)
 			  "mandatory": true, // mandatory (optional)
 			   "order": 5, // Order that you be presented on the track execution (optional, default is 0)
 			  "requirementIds": [100] // id of requirement item (optional)
 		    }
 		  ], // Defines the Tracks and Trainings (optional)
 	"cost" : 0, // Defines the Cost of Tracks (required)
 	"posExamId" : 122, // Post-test, assessment version id (optional)
 	"scoreApprove" : 75.00, // Required Score to Approve (optional)
 	"reactionId" : 120, //  Reaction evaluation, assessment version id (optional)
 	"certificateId" : 1, // Certificate (optional)
 	"programmaticContent" : "Defines Programmatic Content", // Programmatic Content (optional)
 	"targetPublic" : "Defines Target Public", // Target Public (optional)
 	"requirementsIds" : [111, 222, 333], // Defines the Tracks and Trainings ids that will be requirement to this Track (optional)
 	"requirementsDisciplineIds" : [444, 555, 666], // Defines the Disciplines ids that will be requirement to this Track (optional)
 	"parentId": 10, // Parent item that the folder will be created (required)
 	"inheritPermissions" : "INHERIT", // Type Inherit Permission "INHERIT" Or "NOT_INHERIT" (required)
 	"securityPermission": [  // Defines the security configurations for the track (required)
 		    {
 			  "partyId": 193, // Party ID
 			  "roles": [ "READ" ] // Permission level key. Acceptable values: NONE, READ, EXECUTE, WRITE, MODIFY, REMOVE, COMPLETE (required)
 		  }
 	  ],
 	"securityRestriction": [  // Defines the security configurations for the track (required)
 		    {
 			  "partyId": 193, // Party ID (required)
 			  "roles": [ "MODIFY" ] // Restriction level key. Acceptable values: NONE, READ, EXECUTE, WRITE, MODIFY, REMOVE, COMPLETE (required)
 		  }
 	  ],
 	"imageProperties": {  // Defines images properties for the crop operation
 		 "imageName": "track_image.png", // File must already be on the learn user upload directory. Acceptable image types: JPG,JPGE,PNG,GIF
 		 "coordinateX": "0", // Set the pixel x coordinate
 		 "coordinateY": "0", // Set the pixel y coordinate
 		 "width": "500", // Set the width of the image in pixels
 		 "height": "500" // Set the height of the image in pixels
 	 },
 	"theme": "Miscellaneous" // Track theme (optional)
 }
 
Response Body
media type data type description
application/json object (JSON)

 This method return HTTP 200 status and Object TrackVO
{ content: { "id" : 1, "code" : "TR01", "name" : "Track name", "status" : "AVAILABLE", "author" : "Author", "workload" : 1, "objective" : "Objective", "catalogSkills": [ { "id": 192, "minPoint": 0, "maxPoint": 100 } ], "preExamId" : 191, "approvePreExam" : false "scoreApprovePreExam" : 75.00 "reprovePreExam" : false "scoreReprovePreExam" : 40.00 "requiredPreExam" : false "trackItemIds" : [ 192, 193, 184], "trackItems" : [ { "enrollableItemId": 192, "mandatory": true, "order": 5, "requirementIds": [100] } ], // Defines the Tracks and Trainings (optional) "cost" : 0, "posExamId" : 122, "scoreApprove" : 75.00, "reactionId" : 120, "certificateId" : 1, "programmaticContent" : "Defines Programmatic Content", "targetPublic" : "Defines Target Public", "requirementsIds" : [111, 222, 333], "requirementsDisciplineIds" : [444, 555, 666], "parentId": 10, "securityPermission": [ { "partyId": 193, "roles": [ "READ" ] } ], "securityRestriction": [ { "partyId": 193, "roles": [ "MODIFY" ] } ], "inheritPermissions" : "INHERIT", "imageProperties": { "imageName": "track_image.png", "coordinateX": "0", "coordinateY": "0", "width": "500", "height": "500" }, "theme": "Miscellaneous" }, message: { message: "OK", detail: "OK", type: "INFO" } }
Available Since
1.6.0

POST /2.0/lms/track/delete/{trackId}

This method has been deprecated. Use DELETE /lms/api/v0/tracks/{trackId} instead.

Delete a Track

Available Since
1.6.0
Request Parameters
name type description constraints
trackId path ID Track to be removed (required) long
Response Body
media type data type
application/json object (JSON)
Available Since
1.6.0

POST /2.0/lms/track/move/{trackId}/{destinationId}

This method has been deprecated. Use POST /lms/api/v0/tracks/move/{trackId}/{destinationId} instead.

Move a Track to another folder

Available Since
1.6.0
Request Parameters
name type description constraints
destinationId path destination folder ID (required) long
trackId path ID folder to be moved (required) long
Response Body
media type data type
application/json object (JSON)