Creating a specification

In this scenario, you use Talend APIs to create a specification to improve your project quality.

About this task

Here are some details about the API call:

Method: POST
endpoint: api/v1/projects/quality/specifications
payload:[
  {
    "name": "string",
    "description": "string",
    "rules": [
      "string"
    ],
    "threshold": {
      "operator": "string",
      "value": 0,
      "type": "Percentage"
    }
  }
]

1. Call the GET /api/v1/projects/quality/rules endpoint to get all rules.
2. Note the ID of the rules you want to add to the new specification you want to create.
3. Call the POST /api/v1/projects/quality/specifications endpoint to create a specification.
4. In the Body area, enter the following information:

   Parameter name	Value
   name	Enter the name of the rule.
   description	Enter the description of the rule.
   rules	Enter one or several rule IDs.
   operator	Specify the comparison operator to compare with the threshold: <=, \>=, =, \>=
   value	Enter a value for the threshold. This value sets a limit or boundary, above or below which a condition should be observed. This field accepts numeric values starting from 0.
   type	Enter one of the following threshold types: Percentage or Numeric.

   Example:

   {
     "name": "cloud-migration", 
     "description": "This specification contains rules related best practices for Talend Cloud Migration", 
     "rules": [
         "30599ac4-09b0-4abd", "30599ac4-09b0-4abc" 
         ], 
         "threshold": {
             "operator": "=", 
             "value": 0, 
             "type": "PERCENTAGE" 
          }
   }

5. Click Execute to issue your call.