Een profiel uitvoeren

In dit scenario gebruikt u Talend API's om een profiel uit te voeren om de kwaliteit van uw project te verbeteren.

Over deze taak

Hier zijn enkele details over de API-aanroep:

Method: POST
endpoint: api/v1/projects/quality/profiles/{id}/executions
payload:
    {
  "repository": "string",
  "authentication": {
    "username": "string",
    "passcode": "string"
  },
  "branch": "string",
  "workspace": "string",
  "client": "UI"
    }

Het eindpunt gebruikt een profiel-ID als parameter die een lijst met specificaties bevat om uit te voeren op het Talend Project.

Procedure

Roep het GET api/v1/projects/quality/profiles eindpunt aan om de ID te krijgen van het profiel dat u wilt uitvoeren.
Noteer de ID van het profiel dat u wilt uitvoeren.
Roep het POST api/v1/projects/quality/profiles/{id}/executions eindpunt aan om een profiel uit te voeren. Voeg de ID toe van het profiel dat u wilt uitvoeren als parameter.

Geef in het Body-gebied de volgende informatie op:

Parameternaam	Waarde
opslagplaats	Voer de naam van de opslagplaats in.
gebruikersnaam	Voer uw gebruikersnaam in.
toegangscode	Voer uw toegangscode in.
vertakking	Voer de naam van de vertakking in.
werkruimte	Voer de werkruimtenaam in.
client	Voer de clientnaam in.

Voorbeeld:

 {
  "repository": "GIT",
  "authentication": {
    "username": "******",
    "passcode": "*************"
  },
  "branch": "master",
  "workspace": "PROJECT_73",
  "client": "UI"
}

Klik op Uitvoeren om uw aanroep te doen.

Resultaten

Hier is een voorbeeld van een antwoord:

{
  "id": "67",
  "status": "FAILED",
  "startTimestamp": "2023-10-13 17:36",
  "duration": "2s",
  "specifications": [
    {
      "id": "69",
      "specification": {
        "id": "2",
        "name": "best-practice",
        "description": "This specification contains rules related to best practices",
        "operator": "is_Equal_to",
        "threshold": 100,
        "thresholdType": "PERCENTAGE",
        "createdBy": "system"
      },
      "status": "FAILED",
      "rules": [
        {
          "id": "77",
          "rule": {
            "id": "4",
            "name": "Active-tLogRow",
            "description": "Identify jobs with tLogRow components",
            "category": "COMPONENT",
            "severity": "MINOR",
            "operator": "is_less_than_or_Equal",
            "threshold": "5",
            "thresholdType": "PERCENTAGE",
            "createdBy": "system"
          },
          "result": "30",
          "status": "FAILED"
        },
        {
          "id": "78",
          "rule": {
            "id": "5",
            "name": "JavaLogs",
            "description": "Identify jobs that contain java logs.",
            "category": "COMPONENT",
            "severity": "INFO",
            "operator": "is_less_than_or_Equal",
            "threshold": "50",
            "thresholdType": "PERCENTAGE",
            "createdBy": "system"
          },
          "result": "4.56",
          "status": "PASSED"
        }
      ],
      "duration": "1s"
    }
  ],
  "sourceProvider": {
    "providerType": "LOCAL",
    "workspace": "D:\\Talend_Studio\\studio\\workspaces\\qtcmt_test",
    "project": "PROJECT_73"
  },
  "info": {
    "version": "7.3.1",
    "label": "PROJECT_73",
    "description": "Project imported from TalendPS organization",
    "productVersion": "Talend Real-time Big Data Platform-7.3.1.20221115_1012-patch",
    "type": "DQ",
    "bigData": false,
    "local": false
  },
  "inventory": {
    "total_artifact_assets": 258,
    "context_group": 11,
    "standard_job": 210,
    "standard_job_versions": 211,
    "standard_joblet": 24,
    "standard_joblet_versions": 24,
    "resource": 2,
    "resource_versions": 24,
    "bd_batch": 1,
    "bd_batch_versions": 1,
    "bd_batch_joblet": 0,
    "bd_batch_joblet_versions": 0,
    "bd_streaming": 1,
    "bd_streaming_versions": 1,
    "bd_streaming_joblet": 0,
    "bd_streaming_joblet_versions": 0,
    "route": 46,
    "route_versions": 46,
    "routelet": 1,
    "routelet_versions": 1
  },
  "commits": [
    {
      "id": "24b228d45561e0a741a0409195ef492437bf3",
      "date": "Tue Feb 21 01:29:11 2023 +0000",
      "author": "talend <talend@3bed803c5b79>",
      "message": "\tCreate Project: PRJ_731\n"
    }
  ]
}

In dit voorbeeld zoekt de Active-tLogRow-regel naar Jobs met de tLogRow-componenten. Zoals gedefinieerd in de voorwaarde, moet het totale aantal geïdentificeerde bedrijfsmiddelen kleiner zijn dan de maximale drempelwaarde, die is 5 hier.

Het resultaat in dit voorbeeld is 30. De kwaliteitscontrole van de regel is mislukt. De status van de regel is Mislukt. De status van elke regel wordt geëvalueerd op basis van de vergelijking tussen het resultaat en de drempel.

De algehele kwaliteit van het project wordt bepaald door de status van de specificatie. De status van de specificatie wordt gevalideerd door het cumulatieve resultaat of de status van alle regels. In dit voorbeeld is de drempel ingesteld op 100%. Hier, zelfs als een enkele voorwaarde of regel mislukt, mislukt de specificatie en wordt de status ingesteld op Mislukt.

De drempel, het drempeltype en de operator kunnen worden bijgewerkt op basis van de impact van de regels en specificaties op de kwaliteit van uw Talend project.

Wanneer alle specificaties zijn uitgevoerd, wordt de status van de uitvoering ingesteld op basis van de volgende voorwaarde:

Geslaagd: Status als alle specificaties zijn geslaagd.
Mislukt: Status als een specificatie is mislukt.
Geannuleerd: Status als de uitvoering is geannuleerd.
Wordt uitgevoerd: Status als de uitvoering bezig is.

De uitvoeringen kunnen worden benaderd via een GET /api/v1/projects/quality/profiles/executions eindpunt. De uitvoeringen kunnen worden gefilterd op verschillende criteria: de status van de uitvoering vanaf een bepaalde starttijd of de projectnaam.

API geselecteerd om alle uitvoeringen op te halen.

Uitvoeringen kunnen ook worden verwijderd op basis van hun uitvoerings-ID's, status, starttijd of projectnaam.

API om alle uitvoeringen te verwijderen.

Was deze pagina nuttig?

Als u problemen ervaart op deze pagina of de inhoud onjuist is – een tikfout, een ontbrekende stap of een technische fout – laat het ons weten!

Geef hier uw feedback