UiPath Documentation
uipath-cli
latest
false
UiPath-CLI-Benutzerhandbuch
Wichtig :
Dieser Inhalt wurde maschinell übersetzt. Es kann 1–2 Wochen dauern, bis die Lokalisierung neu veröffentlichter Inhalte verfügbar ist.

uip-tm-benutzerdefiniertes Feld

Syntax und Optionen für „uip tm customfield“, das benutzerdefinierte Felddefinitionen, Beschriftungszeilen und Wertzeilen in einem Test Manager-Projekt verwaltet.

uip tm customfield verwaltet benutzerdefinierte Felddefinitionen in einem Test Manager-Projekt. Benutzerdefinierte Felder erweitern Anforderungen, Testfälle und Testsätze mit projektspezifischen Metadaten. Diese Befehlsgruppe hat drei Untergruppen:

  • customfield – Verwalten Sie die Felddefinition selbst (auflisten, abrufen, erstellen, aktualisieren, löschen).
  • customfield label – Verwalten Sie Feldzeilen vom Typ Beschriftung (eine JSON-Zuordnung des Feldnamens zu einem oder mehreren Zeichenfolgenwerten pro Objekt)
  • customfield value – Verwalten Sie Feldzeilen vom Typ Text (ein einzelner String-Wert pro Objekt)
Wichtig:

Der primäre Bezeichner für Felddefinitionen ist --field-id. Beschriftungs- und Wertzeilen werden durch --label-id / --value-id oder durch den natürlichen Schlüssel --object-type + --name + --object-id identifiziert. Das Flag --customfield-id ist nicht vorhanden.

Zusammenfassung​

# Field definitions
uip tm customfield list --project-key <key> [--object-types <types...>] [--data-types <types...>] [--name <name>] [--filter <text>] [--sort-by <expr>] [--limit <n>] [--offset <n>]
uip tm customfield get --project-key <key> (--field-id <uuid> | --name <name> --object-type <type>)
uip tm customfield create --project-key <key> --name <name> --data-type <Text|Label> (--object-type <type> | --scope-list <types...>) [--description <text>] [--default-value <value>] [--value-hints <hints>]
uip tm customfield update --project-key <key> (--field-id <uuid> | --name <name> --object-type <type>) [--rename-to <name>] [--description <text>] [--default-value <value>] [--value-hints <hints>] [--scope-list <types...>]
uip tm customfield delete --project-key <key> (--field-ids <uuid...> | --name <name> --object-type <type>) [-y]

# Labels
uip tm customfield label get --project-key <key> --object-type <type> --label-id <uuid>
uip tm customfield label list --project-key <key> --object-type <type> [--object-id <uuid>] [--filter <text>] [--sort-by <expr>] [--limit <n>] [--offset <n>]
uip tm customfield label create --project-key <key> --object-type <type> --object-id <uuid> --values <json>
uip tm customfield label add --project-key <key> --object-type <type> --custom-field-name <name> --object-ids <uuid...> --values <value...> [--replace-existing-values]
uip tm customfield label remove --project-key <key> --object-type <type> --custom-field-name <name> --object-ids <uuid...> (--values <value...> | --remove-all-values) [-y]

# Values
uip tm customfield value list --project-key <key> --object-type <type> [--object-id <uuid>] [--filter <text>] [--sort-by <expr>] [--limit <n>] [--offset <n>]
uip tm customfield value get --project-key <key> --object-type <type> (--value-id <uuid> | --name <name> --object-id <uuid>)
uip tm customfield value create --project-key <key> --object-type <type> --name <name> --object-id <uuid> --data-type <Text|Label> [--value <text>]
uip tm customfield value update --project-key <key> --object-type <type> (--value-id <uuid> | --name <name> --object-id <uuid>) [--data-type <Text|Label>] (--value <text> | --clear)
uip tm customfield value delete --project-key <key> --object-type <type> (--value-id <uuid> | --name <name> --object-id <uuid>) [-y]
# Field definitions
uip tm customfield list --project-key <key> [--object-types <types...>] [--data-types <types...>] [--name <name>] [--filter <text>] [--sort-by <expr>] [--limit <n>] [--offset <n>]
uip tm customfield get --project-key <key> (--field-id <uuid> | --name <name> --object-type <type>)
uip tm customfield create --project-key <key> --name <name> --data-type <Text|Label> (--object-type <type> | --scope-list <types...>) [--description <text>] [--default-value <value>] [--value-hints <hints>]
uip tm customfield update --project-key <key> (--field-id <uuid> | --name <name> --object-type <type>) [--rename-to <name>] [--description <text>] [--default-value <value>] [--value-hints <hints>] [--scope-list <types...>]
uip tm customfield delete --project-key <key> (--field-ids <uuid...> | --name <name> --object-type <type>) [-y]

# Labels
uip tm customfield label get --project-key <key> --object-type <type> --label-id <uuid>
uip tm customfield label list --project-key <key> --object-type <type> [--object-id <uuid>] [--filter <text>] [--sort-by <expr>] [--limit <n>] [--offset <n>]
uip tm customfield label create --project-key <key> --object-type <type> --object-id <uuid> --values <json>
uip tm customfield label add --project-key <key> --object-type <type> --custom-field-name <name> --object-ids <uuid...> --values <value...> [--replace-existing-values]
uip tm customfield label remove --project-key <key> --object-type <type> --custom-field-name <name> --object-ids <uuid...> (--values <value...> | --remove-all-values) [-y]

# Values
uip tm customfield value list --project-key <key> --object-type <type> [--object-id <uuid>] [--filter <text>] [--sort-by <expr>] [--limit <n>] [--offset <n>]
uip tm customfield value get --project-key <key> --object-type <type> (--value-id <uuid> | --name <name> --object-id <uuid>)
uip tm customfield value create --project-key <key> --object-type <type> --name <name> --object-id <uuid> --data-type <Text|Label> [--value <text>]
uip tm customfield value update --project-key <key> --object-type <type> (--value-id <uuid> | --name <name> --object-id <uuid>) [--data-type <Text|Label>] (--value <text> | --clear)
uip tm customfield value delete --project-key <key> --object-type <type> (--value-id <uuid> | --name <name> --object-id <uuid>) [-y]

Alle Verben berücksichtigen die globalen Optionen und die Standardaustrittscodes. Jedes Verb akzeptiert --log-level <level> (Standardwert Information) und -t, --tenant <name> (Standardwert ist der authentifizierte Mandant).

Hinweis:

-t, --tenant ist hier eine normale, sichtbare Option.

--object-type (und --object-types/--scope-list, wenn variadisch) akzeptiert nur Requirement, TestCase oder TestSet. --data-type (und --data-types) akzeptieren nur Text oder Label – es gibt keinen String-, Integer- oder Boolean -Datentyp.


Befehle zur Felddefinition​

benutzerdefinierte UIP-TM-Feldliste​

Listen Sie benutzerdefinierte Felddefinitionen in einem Projekt auf. --project-key ist erforderlich; jeder andere Filter ist optional.

Optionen​
  • --project-key <key> (erforderlich) – besitzendes Projekt.
  • --object-types <types...> – Durch Leerzeichen getrennte Objekttypen, nach denen gefiltert werden soll: Requirement, TestCase, TestSet.
  • --data-types <types...> – Durch Leerzeichen getrennte Datentypen, nach denen gefiltert werden soll: Text, Label.
  • --name <name> – exakte Namensübereinstimmung (clientseitiger Filter; gibt eine Zeile pro Objekttyp zurück, auf dem das Feld definiert ist).
  • --filter <text> – Serverseitige Teilzeichenfolgesuche über Definitionsfelder hinweg.
  • --sort-by <expr> – Sortierausdruck, z. B. name asc.
  • --limit <n> – Seitengröße. Die Standardeinstellung ist 50.
  • --offset <n> – Ergebnisse, die übersprungen werden sollen. Die Standardeinstellung ist 0.
Beispiel​
uip tm customfield list \
  --project-key DEMO \
  --object-types TestCase
uip tm customfield list \
  --project-key DEMO \
  --object-types TestCase
Datenform​
{
  "Code": "CustomFieldDefinitionsList",
  "Data": [
    {
      "Id": "a1b2c3d4-0000-0000-0000-000000000001",
      "ProjectId": "p1",
      "Name": "Priority",
      "Description": "Test priority",
      "DefaultValue": "Medium",
      "ValueHints": "",
      "ObjectType": "TestCase",
      "DataType": "Text",
      "ScopeList": ["TestCase"]
    }
  ]
}
{
  "Code": "CustomFieldDefinitionsList",
  "Data": [
    {
      "Id": "a1b2c3d4-0000-0000-0000-000000000001",
      "ProjectId": "p1",
      "Name": "Priority",
      "Description": "Test priority",
      "DefaultValue": "Medium",
      "ValueHints": "",
      "ObjectType": "TestCase",
      "DataType": "Text",
      "ScopeList": ["TestCase"]
    }
  ]
}

Abrufen von benutzerdefiniertem UIP-TM​

Rufen Sie eine einzelne benutzerdefinierte Felddefinition ab. Identifizieren durch --field-id ODER durch --name + --object-type.

Optionen​
  • --project-key <key> (erforderlich) – besitzendes Projekt.
  • --field-id <uuid> – Feld-UUID.
  • --name <name> – Feldname. Wird zusammen mit --object-type verwendet.
  • --object-type <type> – Der Objekttyp, zu dem das Feld gehört: Requirement, TestCase, TestSet. Wird zusammen mit --name verwendet.
Beispiel​
uip tm customfield get \
  --project-key DEMO \
  --field-id a1b2c3d4-0000-0000-0000-000000000001
uip tm customfield get \
  --project-key DEMO \
  --field-id a1b2c3d4-0000-0000-0000-000000000001
Datenform​
{
  "Code": "CustomFieldDefinitionGet",
  "Data": {
    "Id": "a1b2c3d4-0000-0000-0000-000000000001",
    "ProjectId": "p1",
    "Name": "Priority",
    "Description": "Test priority",
    "DefaultValue": "Medium",
    "ValueHints": "",
    "ObjectType": "TestCase",
    "DataType": "Text",
    "ScopeList": ["TestCase"]
  }
}
{
  "Code": "CustomFieldDefinitionGet",
  "Data": {
    "Id": "a1b2c3d4-0000-0000-0000-000000000001",
    "ProjectId": "p1",
    "Name": "Priority",
    "Description": "Test priority",
    "DefaultValue": "Medium",
    "ValueHints": "",
    "ObjectType": "TestCase",
    "DataType": "Text",
    "ScopeList": ["TestCase"]
  }
}

uip tm benutzerdefiniertes Feld erstellen​

Erstellen Sie eine neue benutzerdefinierte Felddefinition. Geben Sie --object-type für einen einzelnen Scope ODER --scope-list für mehrere an – die beiden schließen sich gegenseitig aus und einer ist erforderlich.

Optionen​
  • --project-key <key> (erforderlich) – besitzendes Projekt.
  • --name <name> (erforderlich) – Feldname.
  • --data-type <type> (erforderlich) – Text oder Label.
  • --object-type <type> – Einzelner Scope: Requirement, TestCase, TestSet. Sich gegenseitig mit --scope-list ausschließen.
  • --scope-list <types...> – Scope mit mehreren Objekten (durch Leerzeichen getrennt): Requirement, TestCase, TestSet. Sich gegenseitig mit --object-type ausschließen.
  • --description <text> – Feldbeschreibung.
  • --default-value <text> – Standardwert, der auf jedes vorhandene Objekt des Feldtyps gesetzt wird.
  • --value-hints <text> – UI-Hinweistext, der neben dem Feld angezeigt wird.
Beispiel​
uip tm customfield create \
  --project-key DEMO \
  --name Priority \
  --data-type Text \
  --object-type TestCase \
  --description "Test priority" \
  --default-value Medium
uip tm customfield create \
  --project-key DEMO \
  --name Priority \
  --data-type Text \
  --object-type TestCase \
  --description "Test priority" \
  --default-value Medium
Datenform​
{
  "Code": "CustomFieldDefinitionCreate",
  "Data": {
    "Id": "a1b2c3d4-0000-0000-0000-000000000001",
    "ProjectId": "p1",
    "Name": "Priority",
    "Description": "Test priority",
    "DefaultValue": "Medium",
    "ValueHints": "",
    "ObjectType": "TestCase",
    "DataType": "Text",
    "ScopeList": ["TestCase"]
  }
}
{
  "Code": "CustomFieldDefinitionCreate",
  "Data": {
    "Id": "a1b2c3d4-0000-0000-0000-000000000001",
    "ProjectId": "p1",
    "Name": "Priority",
    "Description": "Test priority",
    "DefaultValue": "Medium",
    "ValueHints": "",
    "ObjectType": "TestCase",
    "DataType": "Text",
    "ScopeList": ["TestCase"]
  }
}

Aktualisierung des benutzerdefinierten UIP-TM-Felds​

Aktualisieren Sie eine vorhandene benutzerdefinierte Felddefinition. Identifizieren durch --field-id ODER durch --name + --object-type. Nicht angegebene Felder behalten ihre aktuellen Werte bei.

Optionen​
  • --project-key <key> (erforderlich) – besitzendes Projekt.
  • --field-id <uuid> – Feld-UUID.
  • --name <name> – Feldname (für die Suche). Wird zusammen mit --object-type verwendet.
  • --object-type <type> – Der Objekttyp, zu dem das Feld gehört. Wird zusammen mit --name verwendet.
  • --rename-to <name> – Neuer Name für das Feld.
  • --description <text> – Neue Beschreibung.
  • --default-value <text> – neuer Standardwert.
  • --value-hints <text> – Neuer UI-Hinweistext.
  • --scope-list <types...> – neuer Multi-Objekt-Scope (durch Leerzeichen getrennt).
Beispiel​
uip tm customfield update \
  --project-key DEMO \
  --field-id a1b2c3d4-0000-0000-0000-000000000001 \
  --rename-to Severity
uip tm customfield update \
  --project-key DEMO \
  --field-id a1b2c3d4-0000-0000-0000-000000000001 \
  --rename-to Severity
Datenform​
{
  "Code": "CustomFieldDefinitionUpdate",
  "Data": {
    "Id": "a1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Severity",
    "Result": "Updated"
  }
}
{
  "Code": "CustomFieldDefinitionUpdate",
  "Data": {
    "Id": "a1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Severity",
    "Result": "Updated"
  }
}

Benutzerdefiniertes UIP-TM-Feld löschen​

Löschen Sie eine oder mehrere benutzerdefinierte Felddefinitionen. Identifizieren durch --field-ids (eine oder mehrere UUIDs), ODER durch --name + --object-type (einzeln, nach natürlichem Schlüssel). Hartes Löschen ohne Kaskadieren – verwaiste Beschriftungs-/Wertzeilen werden nicht bereinigt.

Optionen​
  • --project-key <key> (erforderlich) – besitzendes Projekt.
  • --field-ids <uuid...> – durch Leerzeichen getrennte Feld-UUIDs, die gelöscht werden sollen.
  • --name <name> – Feldname (wird mit --object-type verwendet).
  • --object-type <type> – Der Objekttyp, zu dem das Feld gehört (wird mit --name verwendet).
  • -y, --yes – bestätigen Sie diesen nicht rückgängig zu machenden Vorgang. Erforderlich – die CLI fordert nie auf.
Beispiel​
uip tm customfield delete \
  --project-key DEMO \
  --field-ids a1b2c3d4-0000-0000-0000-000000000001 \
  --yes
uip tm customfield delete \
  --project-key DEMO \
  --field-ids a1b2c3d4-0000-0000-0000-000000000001 \
  --yes
Datenform​
{
  "Code": "CustomFieldDefinitionsDelete",
  "Data": { "Passed": 1, "Failed": 0 }
}
{
  "Code": "CustomFieldDefinitionsDelete",
  "Data": { "Passed": 1, "Failed": 0 }
}

Passed/Failed sind Zählwerte, keine Details pro ID – die Antwort wird nicht zurückgegeben, welche UUIDs fehlgeschlagen sind. Unbekannte UUIDs, die über --field-ids übergeben werden, werden an den Massenendpunkt weitergeleitet und als Failed gezählt, anstatt im Voraus abgelehnt zu werden.


Label-Befehle​

Beschriftungszeilen enthalten ein JSON-Objekt pro Objektinstanz und ordnen den benutzerdefinierten Feldnamen einem Array von Zeichenfolgenwerten zu ({"Priority":["High"],"Tags":["smoke","critical"]}).

Abrufen der benutzerdefinierten UIP-TM-Beschriftung​

Rufen Sie eine benutzerdefinierte Feldbeschriftungszeile von --label-id ab. Verwenden Sie für die Suche nach Objekt stattdessen customfield label list --object-id <uuid> (gibt dieselbe Zeile wie ein Ein-Element-Array zurück).

Optionen​
  • --project-key <key> (erforderlich) – besitzendes Projekt.
  • --object-type <type> (erforderlich) – Objekttyp, zu dem die Beschriftung gehört: Requirement, TestCase, TestSet.
  • --label-id <uuid> (erforderlich) – UUID der Beschriftungszeile (nicht der Beschriftungsname).
Beispiel​
uip tm customfield label get \
  --project-key DEMO \
  --object-type TestCase \
  --label-id f1b2c3d4-0000-0000-0000-000000000001
uip tm customfield label get \
  --project-key DEMO \
  --object-type TestCase \
  --label-id f1b2c3d4-0000-0000-0000-000000000001
Datenform​
{
  "Code": "CustomFieldLabelGet",
  "Data": {
    "Id": "f1b2c3d4-0000-0000-0000-000000000001",
    "ProjectId": "p1",
    "ObjectId": "a1b2c3d4-0000-0000-0000-000000000001",
    "ObjectType": "TestCase",
    "Values": { "Priority": ["High"], "Tags": ["smoke", "critical"] },
    "Created": "2025-01-01T00:00:00Z",
    "CreatedBy": "alice@example.com",
    "Updated": "2025-01-02T00:00:00Z",
    "UpdatedBy": "alice@example.com"
  }
}
{
  "Code": "CustomFieldLabelGet",
  "Data": {
    "Id": "f1b2c3d4-0000-0000-0000-000000000001",
    "ProjectId": "p1",
    "ObjectId": "a1b2c3d4-0000-0000-0000-000000000001",
    "ObjectType": "TestCase",
    "Values": { "Priority": ["High"], "Tags": ["smoke", "critical"] },
    "Created": "2025-01-01T00:00:00Z",
    "CreatedBy": "alice@example.com",
    "Updated": "2025-01-02T00:00:00Z",
    "UpdatedBy": "alice@example.com"
  }
}

benutzerdefinierte UIP-TM-Beschriftungsliste​

Listenbeschriftungszeilen für einen Objekttyp auf, optional eingeschränkt auf ein bestimmtes Objekt.

Optionen​
  • --project-key <key> (erforderlich) – besitzendes Projekt.
  • --object-type <type> (erforderlich) – Objekttyp, für den Beschriftungen aufgelistet werden sollen.
  • --object-id <uuid> – Filtern zu einer bestimmten Objekt-UUID.
  • --filter <text> – Beschriftungszeilen nach Wert suchen.
  • --sort-by <expr> – Sortierausdruck.
  • --limit <n> – Seitengröße. Die Standardeinstellung ist 50.
  • --offset <n> – Ergebnisse, die übersprungen werden sollen. Die Standardeinstellung ist 0.
Beispiel​
uip tm customfield label list \
  --project-key DEMO \
  --object-type TestCase \
  --object-id a1b2c3d4-0000-0000-0000-000000000001
uip tm customfield label list \
  --project-key DEMO \
  --object-type TestCase \
  --object-id a1b2c3d4-0000-0000-0000-000000000001
Datenform​
{
  "Code": "CustomFieldLabelsList",
  "Data": [
    {
      "Id": "f1b2c3d4-0000-0000-0000-000000000001",
      "ProjectId": "p1",
      "ObjectId": "a1b2c3d4-0000-0000-0000-000000000001",
      "ObjectType": "TestCase",
      "Values": { "Priority": ["High"], "Tags": ["smoke", "critical"] },
      "Created": "2025-01-01T00:00:00Z",
      "CreatedBy": "alice@example.com",
      "Updated": "2025-01-02T00:00:00Z",
      "UpdatedBy": "alice@example.com"
    }
  ]
}
{
  "Code": "CustomFieldLabelsList",
  "Data": [
    {
      "Id": "f1b2c3d4-0000-0000-0000-000000000001",
      "ProjectId": "p1",
      "ObjectId": "a1b2c3d4-0000-0000-0000-000000000001",
      "ObjectType": "TestCase",
      "Values": { "Priority": ["High"], "Tags": ["smoke", "critical"] },
      "Created": "2025-01-01T00:00:00Z",
      "CreatedBy": "alice@example.com",
      "Updated": "2025-01-02T00:00:00Z",
      "UpdatedBy": "alice@example.com"
    }
  ]
}

UIP TM CustomField Label erstellen​

Upsert-Vorgang für Beschriftungswerte für ein Objekt durchführen. Das Backend führt alle neuen Feldnamenschlüssel in eine vorhandene Zeile für dasselbe Objekt zusammen – es ersetzt nicht die gesamte Zeile.

Optionen​
  • --project-key <key> (erforderlich) – besitzendes Projekt.
  • --object-type <type> (erforderlich) – Objekttyp, an den die Beschriftungen angehängt werden sollen.
  • --object-id <uuid> (erforderlich) – UUID des zu beschriftenden Objekts.
  • --values <json> (erforderlich) – ein nicht leerer JSON- Objektzuordnungsfeldnamen zu String-Arrays, zum Beispiel {"Priority":["High"],"Tags":["smoke","critical"]}. Ein JSON-Array oder ein Wert, der kein Array von Strings pro Schlüssel ist, wird clientseitig abgelehnt.
Beispiel​
uip tm customfield label create \
  --project-key DEMO \
  --object-type TestCase \
  --object-id a1b2c3d4-0000-0000-0000-000000000001 \
  --values '{"Priority":["High"],"Tags":["smoke"]}'
uip tm customfield label create \
  --project-key DEMO \
  --object-type TestCase \
  --object-id a1b2c3d4-0000-0000-0000-000000000001 \
  --values '{"Priority":["High"],"Tags":["smoke"]}'
Datenform​
{
  "Code": "CustomFieldLabelCreate",
  "Data": {
    "Id": "f1b2c3d4-0000-0000-0000-000000000001",
    "ProjectId": "p1",
    "ObjectId": "a1b2c3d4-0000-0000-0000-000000000001",
    "ObjectType": "TestCase",
    "Values": { "Priority": ["High"], "Tags": ["smoke"] },
    "Created": "2025-01-01T00:00:00Z",
    "CreatedBy": "alice@example.com",
    "Updated": "2025-01-01T00:00:00Z",
    "UpdatedBy": "alice@example.com"
  }
}
{
  "Code": "CustomFieldLabelCreate",
  "Data": {
    "Id": "f1b2c3d4-0000-0000-0000-000000000001",
    "ProjectId": "p1",
    "ObjectId": "a1b2c3d4-0000-0000-0000-000000000001",
    "ObjectType": "TestCase",
    "Values": { "Priority": ["High"], "Tags": ["smoke"] },
    "Created": "2025-01-01T00:00:00Z",
    "CreatedBy": "alice@example.com",
    "Updated": "2025-01-01T00:00:00Z",
    "UpdatedBy": "alice@example.com"
  }
}

Hinzufügen einer benutzerdefinierten Feldbeschriftung für UIP TM​

Fügen Sie Beschriftungswerte zu einem benannten benutzerdefinierten Feld über mehrere Objekte hinweg mit einem einzigen Aufruf hinzu.

Optionen​
  • --project-key <key> (erforderlich) – besitzendes Projekt.
  • --object-type <type> (erforderlich) – Objekttyp.
  • --custom-field-name <name> (erforderlich) – Name einer vorhandenen benutzerdefinierten Felddefinition für diesen Objekttyp.
  • --object-ids <uuid...> (erforderlich) – durch Leerzeichen getrennte Objekt-UUIDs, auf die die Beschriftung angewendet werden soll.
  • --values <value...> (erforderlich) – durch Leerzeichen getrennte Beschriftungswerte.
  • --replace-existing-values – Ersetzen Sie vorhandene Werte, anstatt sie zusammenzuführen (Standard: Zusammenführung).
Beispiel​
uip tm customfield label add \
  --project-key DEMO \
  --object-type TestCase \
  --custom-field-name Priority \
  --object-ids id1 id2 \
  --values High Critical
uip tm customfield label add \
  --project-key DEMO \
  --object-type TestCase \
  --custom-field-name Priority \
  --object-ids id1 id2 \
  --values High Critical
Datenform​
{
  "Code": "CustomFieldLabelAdd",
  "Data": {
    "CustomFieldName": "Priority",
    "ObjectCount": 2,
    "Result": "Added"
  }
}
{
  "Code": "CustomFieldLabelAdd",
  "Data": {
    "CustomFieldName": "Priority",
    "ObjectCount": 2,
    "Result": "Added"
  }
}

Entfernen der benutzerdefinierten UIP-TM-Beschriftung​

Entfernen Sie Beschriftungswerte aus einem benannten benutzerdefinierten Feld über mehrere Objekte hinweg. Dies ist ein unwiderruflicher Vorgang – er erfordert -y, --yes; die CLI fordert nie auf.

Optionen​
  • --project-key <key> (erforderlich) – besitzendes Projekt.
  • --object-type <type> (erforderlich) – Objekttyp.
  • --custom-field-name <name> (erforderlich) – Name des benutzerdefinierten Felds.
  • --object-ids <uuid...> (erforderlich) – durch Leerzeichen getrennte Objekt-UUIDs.
  • --values <value...> – Durch Leerzeichen getrennte Beschriftungswerte, die entfernt werden sollen. Erforderlich, es sei denn, --remove-all-values ist festgelegt.
  • --remove-all-values – Löschen Sie alle Werte für dieses Feld in den aufgelisteten Objekten. Sich gegenseitig mit --values ausschließen.
  • -y, --yes – bestätigen Sie diesen nicht rückgängig zu machenden Vorgang. Erforderlich – die CLI fordert nie auf.
Beispiel​
uip tm customfield label remove \
  --project-key DEMO \
  --object-type TestCase \
  --custom-field-name Priority \
  --object-ids id1 id2 \
  --values Critical \
  --yes
uip tm customfield label remove \
  --project-key DEMO \
  --object-type TestCase \
  --custom-field-name Priority \
  --object-ids id1 id2 \
  --values Critical \
  --yes
Datenform​
{
  "Code": "CustomFieldLabelRemove",
  "Data": {
    "CustomFieldName": "Priority",
    "ObjectCount": 2,
    "Result": "Removed"
  }
}
{
  "Code": "CustomFieldLabelRemove",
  "Data": {
    "CustomFieldName": "Priority",
    "ObjectCount": 2,
    "Result": "Removed"
  }
}

Wertbefehle​

Wertzeilen enthalten einen einzelnen Texttypwert pro Objekt.

benutzerdefiniertes Feldwertliste​

Listen Sie benutzerdefinierte Feldwerte für einen Objekttyp auf. Die Ergebnisse sind leer, es sei denn, --object-id ist angegeben.

Optionen​
  • --project-key <key> (erforderlich) – besitzendes Projekt.
  • --object-type <type> (erforderlich) – Objekttyp.
  • --object-id <uuid> – Objekt-UUID, deren Werte aufgelistet werden sollen. In der Praxis erforderlich – die Ergebnisse sind leer, wenn sie weggelassen werden.
  • --filter <text> – Suchwerte nach Inhalt.
  • --sort-by <expr> – Sortierausdruck.
  • --limit <n> – Seitengröße. Die Standardeinstellung ist 50.
  • --offset <n> – Ergebnisse, die übersprungen werden sollen. Die Standardeinstellung ist 0.
Beispiel​
uip tm customfield value list \
  --project-key DEMO \
  --object-type TestCase \
  --object-id a1b2c3d4-0000-0000-0000-000000000001
uip tm customfield value list \
  --project-key DEMO \
  --object-type TestCase \
  --object-id a1b2c3d4-0000-0000-0000-000000000001
Datenform​
{
  "Code": "CustomFieldValuesList",
  "Data": [
    {
      "Id": "v1b2c3d4-0000-0000-0000-000000000001",
      "Name": "Priority",
      "Value": "High",
      "ObjectId": "a1b2c3d4-0000-0000-0000-000000000001",
      "ObjectType": "TestCase",
      "DataType": "Text",
      "Updated": "2025-01-02T00:00:00Z"
    }
  ]
}
{
  "Code": "CustomFieldValuesList",
  "Data": [
    {
      "Id": "v1b2c3d4-0000-0000-0000-000000000001",
      "Name": "Priority",
      "Value": "High",
      "ObjectId": "a1b2c3d4-0000-0000-0000-000000000001",
      "ObjectType": "TestCase",
      "DataType": "Text",
      "Updated": "2025-01-02T00:00:00Z"
    }
  ]
}

Abrufen des benutzerdefinierten Feldwerts von uip tm​

Rufen Sie eine einzelne benutzerdefinierte Feldwertzeile ab. Identifizieren durch --value-id ODER durch --name + --object-id.

Optionen​
  • --project-key <key> (erforderlich) – besitzendes Projekt.
  • --object-type <type> (erforderlich) – Objekttyp.
  • --value-id <uuid> – UUID der Wertzeile.
  • --name <name> – Feldname. Wird zusammen mit --object-id verwendet.
  • --object-id <uuid> – Objekt-UUID. Wird zusammen mit --name verwendet.
Beispiel​
uip tm customfield value get \
  --project-key DEMO \
  --object-type TestCase \
  --value-id v1b2c3d4-0000-0000-0000-000000000001
uip tm customfield value get \
  --project-key DEMO \
  --object-type TestCase \
  --value-id v1b2c3d4-0000-0000-0000-000000000001
Datenform​
{
  "Code": "CustomFieldValueGet",
  "Data": {
    "Id": "v1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Priority",
    "Value": "High",
    "ObjectId": "a1b2c3d4-0000-0000-0000-000000000001",
    "ObjectType": "TestCase",
    "DataType": "Text",
    "Updated": "2025-01-02T00:00:00Z"
  }
}
{
  "Code": "CustomFieldValueGet",
  "Data": {
    "Id": "v1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Priority",
    "Value": "High",
    "ObjectId": "a1b2c3d4-0000-0000-0000-000000000001",
    "ObjectType": "TestCase",
    "DataType": "Text",
    "Updated": "2025-01-02T00:00:00Z"
  }
}

uip tm benutzerdefinierter Feldwert erstellen​

Erstellen Sie eine benutzerdefinierte Feldwertzeile für ein Objekt.

Optionen​
  • --project-key <key> (erforderlich) – besitzendes Projekt.
  • --object-type <type> (erforderlich) – Objekttyp.
  • --name <name> (erforderlich) – benutzerdefinierter Feldname (muss mit einer vorhandenen Definition übereinstimmen).
  • --object-id <uuid> (erforderlich) – Objekt-UUID, an die dieser Wert angehängt wird.
  • --data-type <type> (erforderlich) – Text oder Label (muss mit der Definition übereinstimmen).
  • --value <text> – Wertinhalt. Optional – lassen Sie es weg, eine leere Zeile zu erstellen.
Beispiel​
uip tm customfield value create \
  --project-key DEMO \
  --object-type TestCase \
  --name Priority \
  --object-id a1b2c3d4-0000-0000-0000-000000000001 \
  --data-type Text \
  --value High
uip tm customfield value create \
  --project-key DEMO \
  --object-type TestCase \
  --name Priority \
  --object-id a1b2c3d4-0000-0000-0000-000000000001 \
  --data-type Text \
  --value High
Datenform​
{
  "Code": "CustomFieldValueCreate",
  "Data": {
    "Id": "v1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Priority",
    "Value": "High",
    "ObjectId": "a1b2c3d4-0000-0000-0000-000000000001",
    "ObjectType": "TestCase",
    "DataType": "Text",
    "Updated": "2025-01-02T00:00:00Z"
  }
}
{
  "Code": "CustomFieldValueCreate",
  "Data": {
    "Id": "v1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Priority",
    "Value": "High",
    "ObjectId": "a1b2c3d4-0000-0000-0000-000000000001",
    "ObjectType": "TestCase",
    "DataType": "Text",
    "Updated": "2025-01-02T00:00:00Z"
  }
}

Aktualisierung des benutzerdefinierten Feldwerts von UIP TM​

Aktualisieren Sie eine vorhandene benutzerdefinierte Feldwertzeile. Identifizieren durch --value-id ODER durch --name + --object-id. --value ist erforderlich, es sei denn, --clear wird übergeben.

Hinweis:

Ein leerer --value kann dazu führen, dass die Zeile gelöscht anstatt aktualisiert wird, wenn ihr Feldname keiner Definition mehr zugeordnet ist. Übergeben Sie --clear, um diese Absicht zu bestätigen.

Optionen​
  • --project-key <key> (erforderlich) – besitzendes Projekt.
  • --object-type <type> (erforderlich) – Objekttyp.
  • --value-id <uuid> – UUID der Wertzeile.
  • --name <name> – Feldname. Wird zusammen mit --object-id verwendet.
  • --object-id <uuid> – Objekt-UUID. Wird zusammen mit --name verwendet.
  • --data-type <type> – Text oder Label. Standardmäßig der aktuelle Datentyp der Zeile.
  • --value <text> – der neue Wert. Erforderlich, es sei denn, --clear wird übergeben.
  • --clear – Bestätigen Sie, dass ein leeres --value die Zeile löschen kann.
Beispiel​
uip tm customfield value update \
  --project-key DEMO \
  --object-type TestCase \
  --value-id v1b2c3d4-0000-0000-0000-000000000001 \
  --value Critical
uip tm customfield value update \
  --project-key DEMO \
  --object-type TestCase \
  --value-id v1b2c3d4-0000-0000-0000-000000000001 \
  --value Critical
Datenform​
{
  "Code": "CustomFieldValueUpdate",
  "Data": {
    "Id": "v1b2c3d4-0000-0000-0000-000000000001",
    "Result": "Updated"
  }
}
{
  "Code": "CustomFieldValueUpdate",
  "Data": {
    "Id": "v1b2c3d4-0000-0000-0000-000000000001",
    "Result": "Updated"
  }
}

Löschen des benutzerdefinierten UIP-TM-Feldwerts​

Löschen Sie eine benutzerdefinierte Feldwertzeile. Identifizieren durch --value-id ODER durch --name + --object-id.

Optionen​
  • --project-key <key> (erforderlich) – besitzendes Projekt.
  • --object-type <type> (erforderlich) – Objekttyp.
  • --value-id <uuid> – UUID der Wertzeile.
  • --name <name> – Feldname. Wird zusammen mit --object-id verwendet.
  • --object-id <uuid> – Objekt-UUID. Wird zusammen mit --name verwendet.
  • -y, --yes – bestätigen Sie diesen nicht rückgängig zu machenden Vorgang. Erforderlich – die CLI fordert nie auf.
Beispiel​
uip tm customfield value delete \
  --project-key DEMO \
  --object-type TestCase \
  --value-id v1b2c3d4-0000-0000-0000-000000000001 \
  --yes
uip tm customfield value delete \
  --project-key DEMO \
  --object-type TestCase \
  --value-id v1b2c3d4-0000-0000-0000-000000000001 \
  --yes
Datenform​
{
  "Code": "CustomFieldValueDelete",
  "Data": {
    "Id": "v1b2c3d4-0000-0000-0000-000000000001",
    "Result": "Deleted"
  }
}
{
  "Code": "CustomFieldValueDelete",
  "Data": {
    "Id": "v1b2c3d4-0000-0000-0000-000000000001",
    "Result": "Deleted"
  }
}

  • requirements – Anforderungen können benutzerdefinierte Feldwerte enthalten.
  • Testfälle – Testfälle können benutzerdefinierte Feldwerte enthalten.

Siehe auch​

War diese Seite hilfreich?

Verbinden

Benötigen Sie Hilfe? Support

Möchten Sie lernen? UiPath Academy

Haben Sie Fragen? UiPath-Forum

Auf dem neuesten Stand bleiben