Digital-Twin-Erstellungsaufträge

Basis-URL: https://app.neuroflash.com/api/digital-twin-service

Twin-Erstellungsauftrag erstellen

POST/v1/workspaces/{workspace_id}/target-audiences/{target_audience_id}/twin-creation-jobs

Pfadparameter

Parameter	Typ	Erforderlich	Beschreibung
workspace_id	string	Ja
target_audience_id	string	Ja

Anfrage-Body

FeldTypErforderlichBeschreibung

numberOfTwinsToCreateintegerJaAnzahl der zu erstellenden Twins

Antwort

FeldTypBeschreibung

idstringEindeutige Kennung

createdAtstringZeitstempel der Datensatzerstellung

updatedAtstringZeitstempel der letzten Aktualisierung des Datensatzes

createdByUserIdobjectID des Benutzers, der diesen Datensatz erstellt hat

targetAudienceIdstringZielgruppen-ID, für die dieser Auftrag Twins erstellt

createdTwinIdsarray<string>IDs von Twins, die von diesem Auftrag erstellt wurden

finishedAtobjectWann der Auftrag die Verarbeitung erfolgreich abgeschlossen hat

retriesintegerAnzahl der Verarbeitungsversuche. Der Auftrag wird bis zu 10 Mal erneut versucht

numberOfTwinsToCreateintegerWie viele Twins dieser Auftrag erstellen soll

successfulbooleanWahr, wenn der Auftrag ohne Fehler abgeschlossen wurde

Beispiel

cURL

curl -X POST "https://app.neuroflash.com/api/digital-twin-service/v1/workspaces/{workspace_id}/target-audiences/{target_audience_id}/twin-creation-jobs" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
      "numberOfTwinsToCreate": 0
  }'

Python

import requests

response = requests.post(
    f"https://app.neuroflash.com/api/digital-twin-service/v1/workspaces/{workspace_id}/target-audiences/{target_audience_id}/twin-creation-jobs",
    headers={"Authorization": f"Bearer {token}", "Content-Type": "application/json"},
    json={
        "numberOfTwinsToCreate": 0
    },
).json()

Node.js

const response = await fetch(
  `https://app.neuroflash.com/api/digital-twin-service/v1/workspaces/${workspaceId}/target-audiences/${targetAudienceId}/twin-creation-jobs`,
  {
    method: "POST",
    headers: {
      Authorization: `Bearer ${token}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
          "numberOfTwinsToCreate": 0
    }),
  }
).then((r) => r.json());

Go

body, _ := json.Marshal(map[string]any{
		"numberOfTwinsToCreate": 0,
	})

req, _ := http.NewRequest("POST", "https://app.neuroflash.com/api/digital-twin-service/v1/workspaces/"+workspaceID+"/target-audiences/"+targetAudienceID+"/twin-creation-jobs", bytes.NewReader(body))
req.Header.Set("Authorization", "Bearer "+token)
req.Header.Set("Content-Type", "application/json")

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

Antwort:

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z",
  "createdByUserId": "12345",
  "targetAudienceId": "string",
  "createdTwinIds": [
    "string"
  ],
  "finishedAt": {},
  "retries": 0,
  "numberOfTwinsToCreate": 0,
  "successful": false
}

Twin-Erstellungsaufträge auflisten

GET/v1/workspaces/{workspace_id}/target-audiences/{target_audience_id}/twin-creation-jobs

Pfadparameter

Parameter	Typ	Erforderlich	Beschreibung
workspace_id	string	Ja
target_audience_id	string	Ja

Abfrageparameter

Parameter	Typ	Standard	Beschreibung
page	integer	1	Seitennummer (1-basiert)
size	integer	20	Anzahl der Elemente pro Seite
order	string	—	Sortierreihenfolge

Antwort

FeldTypBeschreibung

dataarray<object>

idstringEindeutige Kennung

createdAtstringZeitstempel der Datensatzerstellung

updatedAtstringZeitstempel der letzten Aktualisierung des Datensatzes

createdByUserIdobjectID des Benutzers, der diesen Datensatz erstellt hat

targetAudienceIdstringZielgruppen-ID, für die dieser Auftrag Twins erstellt

createdTwinIdsarray<string>IDs von Twins, die von diesem Auftrag erstellt wurden

finishedAtobjectWann der Auftrag die Verarbeitung erfolgreich abgeschlossen hat

retriesintegerAnzahl der Verarbeitungsversuche. Der Auftrag wird bis zu 10 Mal erneut versucht

numberOfTwinsToCreateintegerWie viele Twins dieser Auftrag erstellen soll

successfulbooleanWahr, wenn der Auftrag ohne Fehler abgeschlossen wurde

pageobjectPaginierungsmetadaten.

sizeintegerAnzahl der Elemente pro Seite

totalElementsintegerGesamtzahl der übereinstimmenden Elemente

totalPagesintegerGesamtzahl der Seiten

currentPageintegerAktuelle Seitennummer (1-basiert)

Beispiel

cURL

curl "https://app.neuroflash.com/api/digital-twin-service/v1/workspaces/{workspace_id}/target-audiences/{target_audience_id}/twin-creation-jobs" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Python

import requests

response = requests.get(
    f"https://app.neuroflash.com/api/digital-twin-service/v1/workspaces/{workspace_id}/target-audiences/{target_audience_id}/twin-creation-jobs",
    headers={"Authorization": f"Bearer {token}"},
).json()

Node.js

const response = await fetch(
  `https://app.neuroflash.com/api/digital-twin-service/v1/workspaces/${workspaceId}/target-audiences/${targetAudienceId}/twin-creation-jobs`,
  { headers: { Authorization: `Bearer ${token}` } }
).then((r) => r.json());

Go

req, _ := http.NewRequest("GET", "https://app.neuroflash.com/api/digital-twin-service/v1/workspaces/"+workspaceID+"/target-audiences/"+targetAudienceID+"/twin-creation-jobs", nil)
req.Header.Set("Authorization", "Bearer "+token)

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

Antwort:

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z",
      "createdByUserId": "12345",
      "targetAudienceId": "string",
      "createdTwinIds": [
        "string"
      ],
      "finishedAt": {},
      "retries": 0,
      "numberOfTwinsToCreate": 0,
      "successful": false
    }
  ],
  "page": {
    "size": 0,
    "totalElements": 0,
    "totalPages": 0,
    "currentPage": 0
  }
}

Twin-Erstellungsauftrag abrufen

GET/v1/workspaces/{workspace_id}/target-audiences/{target_audience_id}/twin-creation-jobs/{job_id}

Pfadparameter

Parameter	Typ	Erforderlich	Beschreibung
workspace_id	string	Ja
target_audience_id	string	Ja
job_id	string	Ja

Antwort

FeldTypBeschreibung

idstringEindeutige Kennung

createdAtstringZeitstempel der Datensatzerstellung

updatedAtstringZeitstempel der letzten Aktualisierung des Datensatzes

createdByUserIdobjectID des Benutzers, der diesen Datensatz erstellt hat

targetAudienceIdstringZielgruppen-ID, für die dieser Auftrag Twins erstellt

createdTwinIdsarray<string>IDs von Twins, die von diesem Auftrag erstellt wurden

finishedAtobjectWann der Auftrag die Verarbeitung erfolgreich abgeschlossen hat

retriesintegerAnzahl der Verarbeitungsversuche. Der Auftrag wird bis zu 10 Mal erneut versucht

numberOfTwinsToCreateintegerWie viele Twins dieser Auftrag erstellen soll

successfulbooleanWahr, wenn der Auftrag ohne Fehler abgeschlossen wurde

Beispiel

cURL

curl "https://app.neuroflash.com/api/digital-twin-service/v1/workspaces/{workspace_id}/target-audiences/{target_audience_id}/twin-creation-jobs/{job_id}" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Python

import requests

response = requests.get(
    f"https://app.neuroflash.com/api/digital-twin-service/v1/workspaces/{workspace_id}/target-audiences/{target_audience_id}/twin-creation-jobs/{job_id}",
    headers={"Authorization": f"Bearer {token}"},
).json()

Node.js

const response = await fetch(
  `https://app.neuroflash.com/api/digital-twin-service/v1/workspaces/${workspaceId}/target-audiences/${targetAudienceId}/twin-creation-jobs/${jobId}`,
  { headers: { Authorization: `Bearer ${token}` } }
).then((r) => r.json());

Go

req, _ := http.NewRequest("GET", "https://app.neuroflash.com/api/digital-twin-service/v1/workspaces/"+workspaceID+"/target-audiences/"+targetAudienceID+"/twin-creation-jobs/"+jobID+"", nil)
req.Header.Set("Authorization", "Bearer "+token)

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

Antwort:

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z",
  "createdByUserId": "12345",
  "targetAudienceId": "string",
  "createdTwinIds": [
    "string"
  ],
  "finishedAt": {},
  "retries": 0,
  "numberOfTwinsToCreate": 0,
  "successful": false
}