uip-tm-benutzerdefiniertes Feld

uip tm customfield verwaltet benutzerdefinierte Felddefinitionen auf einem Test Manager-Mandanten. Benutzerdefinierte Felder erweitern Testfall- und Anforderungsentitäten um projektspezifische Metadaten. Diese Befehlsgruppe hat drei Untergruppen:

• customfield – Verwalten Sie die Felddefinition selbst (auflisten, abrufen, erstellen, aktualisieren, löschen).
• customfield label – Verwalten Sie die Beschriftungszuweisungen, die auf Objekte angewendet werden
• customfield value – Verwalten Sie die zulässigen Werte für ein Feld

Wichtig:

Der primäre Bezeichner für Felddefinitionen ist --field-id. Beschriftungs- und Wertbefehls-Scope nach --object-type kombiniert mit --object-id, --label-id oder --value-id. Das Flag --customfield-id ist in v1.196 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 --object-type <type> (--field-id <uuid> | --name <name>)
uip tm customfield create --project-key <key> --name <name> --object-type <type> --data-type <type> [--scope-list <list>] [--description <text>] [--default-value <value>] [--value-hints <hints>]
uip tm customfield update --object-type <type> (--field-id <uuid> | --name <name>) [--rename-to <name>] [--description <text>] [--default-value <value>] [--value-hints <hints>] [--scope-list <list>]
uip tm customfield delete --object-type <type> (--field-ids <uuid...> | --name <name>) [-y]

# Labels
uip tm customfield label get --object-type <type> --label-id <uuid>
uip tm customfield label list --object-type <type> [--object-id <uuid>] [--limit <n>] [--offset <n>]
uip tm customfield label create --object-type <type> --object-id <uuid> --values <json>
uip tm customfield label add --object-type <type> --custom-field-name <name> --object-ids <uuid...> --values <values...>
uip tm customfield label remove --object-type <type> --custom-field-name <name> --object-ids <uuid...> (--values <values...> | --remove-all-values)

# Values
uip tm customfield value list --object-type <type> [--object-id <uuid>] [--limit <n>] [--offset <n>]
uip tm customfield value get --object-type <type> (--value-id <uuid> | --name <name> --object-id <uuid>)
uip tm customfield value create --object-type <type> --name <name> --object-id <uuid> --data-type <type> --value <value>
uip tm customfield value update --object-type <type> (--value-id <uuid> | --name <name> --object-id <uuid>) --value <value> [--clear]
uip tm customfield value delete --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 -t, --tenant <name> und --log-level <level> (Standard: Information).

---

Befehle zur Felddefinition

benutzerdefinierte UIP-TM-Feldliste

Listen Sie benutzerdefinierte Felddefinitionen in einem Projekt auf. --project-key ist erforderlich.

Optionen

• --project-key <key> (erforderlich) – besitzendes Projekt.
• --object-types <types...> – Durch Leerzeichen getrennte Objekttypen, nach denen gefiltert werden soll.
• --data-types <types...> – Durch Leerzeichen getrennte Datentypen, nach denen gefiltert werden soll.
• --name <name> – Filtern nach dem genauen Feldnamen.
• --filter <text> – Freitextsuche.
• --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 list \
  --project-key DEMO \
  --object-types TestCase

Datenform

{
  "Code": "CustomFieldList",
  "Data": [
    {
      "FieldId": "c1b2c3d4-0000-0000-0000-000000000001",
      "Name": "Priority",
      "ObjectType": "TestCase",
      "DataType": "String"
    }
  ]
}

---

Abrufen von benutzerdefiniertem UIP-TM

Rufen Sie eine einzelne benutzerdefinierte Felddefinition ab.

Optionen

• --object-type <type> (erforderlich) – Der Objekttyp, zu dem das Feld gehört.
• --field-id <uuid> – Feld-UUID. Sich gegenseitig mit --name ausschließen.
• --name <name> – Feldname. Sich gegenseitig mit --field-id ausschließen.

Beispiel

uip tm customfield get \
  --object-type TestCase \
  --field-id c1b2c3d4-0000-0000-0000-000000000001

Datenform

{
  "Code": "CustomFieldGet",
  "Data": {
    "FieldId": "c1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Priority",
    "ObjectType": "TestCase",
    "DataType": "String"
  }
}

---

uip tm benutzerdefiniertes Feld erstellen

Erstellen Sie eine neue benutzerdefinierte Felddefinition.

Optionen

• --project-key <key> (erforderlich) – besitzendes Projekt.
• --name <name> (erforderlich) – Feldname.
• --object-type <type> (erforderlich) – Objekttyp, an den das Feld angehängt werden soll (z. B. TestCase, TestSet).
• --data-type <type> (erforderlich) – Datentyp des Felds (z. B. String, Integer, Boolean).
• --scope-list <list> – Scope-Beschränkungen für das Feld.
• --description <text> – Feldbeschreibung.
• --default-value <value> – Standardwert für neue Objekte.
• --value-hints <hints> – zulässige Werthinweise oder Aufzählung für das Feld.

Beispiel

uip tm customfield create \
  --project-key DEMO \
  --name "Priority" \
  --object-type TestCase \
  --data-type String \
  --value-hints "Low,Medium,High"

Datenform

{
  "Code": "CustomFieldCreate",
  "Data": {
    "FieldId": "c1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Priority",
    "ObjectType": "TestCase",
    "DataType": "String"
  }
}

---

Aktualisierung des benutzerdefinierten UIP-TM-Felds

Aktualisieren Sie eine vorhandene benutzerdefinierte Felddefinition.

Optionen

• --object-type <type> (erforderlich) – Der Objekttyp, zu dem das Feld gehört.
• --field-id <uuid> – Feld-UUID. Sich gegenseitig mit --name ausschließen.
• --name <name> – Feldname (für die Suche). Sich gegenseitig mit --field-id ausschließen.
• --rename-to <name> – Neuer Name für das Feld.
• --description <text> – Neue Beschreibung.
• --default-value <value> – neuer Standardwert.
• --value-hints <hints> – Neue zulässige Werthinweise.
• --scope-list <list> – neue Scope-Einschränkungen.

Beispiel

uip tm customfield update \
  --object-type TestCase \
  --field-id c1b2c3d4-0000-0000-0000-000000000001 \
  --rename-to "Severity"

Datenform

{
  "Code": "CustomFieldUpdate",
  "Data": {
    "FieldId": "c1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Severity",
    "Result": "Updated"
  }
}

---

Benutzerdefiniertes UIP-TM-Feld löschen

Löschen Sie eine oder mehrere benutzerdefinierte Felddefinitionen.

Optionen

• --object-type <type> (erforderlich) – Der Objekttyp, zu dem die Felder gehören.
• --field-ids <uuid...> – durch Leerzeichen getrennte Feld-UUIDs, die gelöscht werden sollen. Sich gegenseitig mit --name ausschließen.
• --name <name> – Der zu löschende Feldname. Sich gegenseitig mit --field-ids ausschließen.
• -y, --yes – Überspringen Sie die Bestätigungsaufforderung.

Beispiel

uip tm customfield delete \
  --object-type TestCase \
  --field-ids c1b2c3d4-0000-0000-0000-000000000001 \
  --yes

Datenform

{
  "Code": "CustomFieldDelete",
  "Data": {
    "FieldId": "c1b2c3d4-0000-0000-0000-000000000001",
    "Result": "Deleted"
  }
}

---

Label-Befehle

Abrufen der benutzerdefinierten UIP-TM-Beschriftung

Rufen Sie eine einzelne Beschriftungszuweisung anhand ihrer UUID ab.

Optionen

• --object-type <type> (erforderlich) – Der Objekttyp, zu dem die Beschriftung gehört.
• --label-id <uuid> (erforderlich) – UUID der Beschriftungszuweisung (nicht der Beschriftungsname).

Beispiel

uip tm customfield label get \
  --object-type TestCase \
  --label-id l1b2c3d4-0000-0000-0000-000000000001

Datenform

{
  "Code": "CustomFieldLabelGet",
  "Data": {
    "LabelId": "l1b2c3d4-0000-0000-0000-000000000001",
    "ObjectType": "TestCase",
    "Label": "Priority"
  }
}

---

benutzerdefinierte UIP-TM-Beschriftungsliste

Listen Sie Beschriftungszuweisungen für einen Objekttyp auf, optional eingeschränkt auf ein bestimmtes Objekt.

Optionen

• --object-type <type> (erforderlich) – Objekttyp, für den Beschriftungen aufgelistet werden sollen.
• --object-id <uuid> – Filtern zu einer bestimmten Objekt-UUID.
• --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 \
  --object-type TestCase \
  --object-id a1b2c3d4-0000-0000-0000-000000000001

Datenform

{
  "Code": "CustomFieldLabelList",
  "Data": [
    {
      "LabelId": "l1b2c3d4-0000-0000-0000-000000000001",
      "ObjectId": "a1b2c3d4-0000-0000-0000-000000000001",
      "Label": "Priority"
    }
  ]
}

---

UIP TM CustomField Label erstellen

Erstellen Sie eine neue Beschriftung für ein Objekt.

Optionen

• --object-type <type> (erforderlich) – Objekttyp, an den die Beschriftung angehängt werden soll.
• --object-id <uuid> (erforderlich) – UUID des zu beschriftenden Objekts.
• --values <json> (erforderlich) – JSON-Array der anzuwendenden Beschriftungswerte.

Beispiel

uip tm customfield label create \
  --object-type TestCase \
  --object-id a1b2c3d4-0000-0000-0000-000000000001 \
  --values '[{"name":"Priority","value":"High"}]'

Datenform

{
  "Code": "CustomFieldLabelCreate",
  "Data": {
    "ObjectId": "a1b2c3d4-0000-0000-0000-000000000001",
    "Result": "Created"
  }
}

---

Hinzufügen einer benutzerdefinierten Feldbeschriftung für UIP TM

Fügen Sie Beschriftungswerte zu einem oder mehreren Objekten für ein benanntes benutzerdefiniertes Feld hinzu.

Optionen

• --object-type <type> (erforderlich) – Objekttyp.
• --custom-field-name <name> (erforderlich) – Name des benutzerdefinierten Felds.
• --object-ids <uuid...> (erforderlich) – durch Leerzeichen getrennte Objekt-UUIDs, auf die die Beschriftung angewendet werden soll.
• --values <values...> (erforderlich) – durch Leerzeichen getrennte Beschriftungswerte.

Beispiel

uip tm customfield label add \
  --object-type TestCase \
  --custom-field-name Priority \
  --object-ids a1b2c3d4-0000-0000-0000-000000000001 \
  --values High

Datenform

{
  "Code": "CustomFieldLabelAdd",
  "Data": {
    "Result": "Added"
  }
}

---

Entfernen der benutzerdefinierten UIP-TM-Beschriftung

Entfernen Sie Beschriftungswerte von einem oder mehreren Objekten für ein benanntes benutzerdefiniertes Feld.

Optionen

• --object-type <type> (erforderlich) – Objekttyp.
• --custom-field-name <name> (erforderlich) – Name des benutzerdefinierten Felds.
• --object-ids <uuid...> (erforderlich) – durch Leerzeichen getrennte Objekt-UUIDs.
• --values <values...> – Durch Leerzeichen getrennte Beschriftungswerte, die entfernt werden sollen.
• --remove-all-values – Entfernen Sie alle Beschriftungswerte für dieses Feld aus den angegebenen Objekten. Sich gegenseitig mit --values ausschließen.

Beispiel

uip tm customfield label remove \
  --object-type TestCase \
  --custom-field-name Priority \
  --object-ids a1b2c3d4-0000-0000-0000-000000000001 \
  --values High

Datenform

{
  "Code": "CustomFieldLabelRemove",
  "Data": {
    "Result": "Removed"
  }
}

---

Wertbefehle

benutzerdefiniertes Feldwertliste

Listen Sie benutzerdefinierte Feldwerte für einen Objekttyp auf, optional eingeschränkt auf ein bestimmtes Objekt.

Optionen

• --object-type <type> (erforderlich) – Objekttyp.
• --object-id <uuid> – Filtern zu einer bestimmten Objekt-UUID.
• --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 \
  --object-type TestCase \
  --object-id a1b2c3d4-0000-0000-0000-000000000001

Datenform

{
  "Code": "CustomFieldValueList",
  "Data": [
    {
      "ValueId": "v1b2c3d4-0000-0000-0000-000000000001",
      "Name": "Priority",
      "Value": "High"
    }
  ]
}

---

Abrufen des benutzerdefinierten Feldwerts von uip tm

Rufen Sie einen einzelnen benutzerdefinierten Feldwert ab.

Optionen

• --object-type <type> (erforderlich) – Objekttyp.
• --value-id <uuid> – Wert-UUID. Sich gegenseitig mit --name + --object-id ausschließen.
• --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 \
  --object-type TestCase \
  --value-id v1b2c3d4-0000-0000-0000-000000000001

Datenform

{
  "Code": "CustomFieldValueGet",
  "Data": {
    "ValueId": "v1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Priority",
    "Value": "High"
  }
}

---

uip tm benutzerdefinierter Feldwert erstellen

Legen Sie einen benutzerdefinierten Feldwert für ein Objekt fest.

Optionen

• --object-type <type> (erforderlich) – Objekttyp.
• --name <name> (erforderlich) – benutzerdefinierter Feldname.
• --object-id <uuid> (erforderlich) – Objekt-UUID.
• --data-type <type> (erforderlich) – Datentyp des Werts (z. B. String, Integer).
• --value <value> (erforderlich) – der festzulegende Wert.

Beispiel

uip tm customfield value create \
  --object-type TestCase \
  --name Priority \
  --object-id a1b2c3d4-0000-0000-0000-000000000001 \
  --data-type String \
  --value High

Datenform

{
  "Code": "CustomFieldValueCreate",
  "Data": {
    "ValueId": "v1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Priority",
    "Value": "High"
  }
}

---

Aktualisierung des benutzerdefinierten Feldwerts von UIP TM

Aktualisieren Sie einen vorhandenen benutzerdefinierten Feldwert.

Optionen

• --object-type <type> (erforderlich) – Objekttyp.
• --value-id <uuid> – Wert-UUID. Sich gegenseitig mit --name + --object-id ausschließen.
• --name <name> – Feldname. Wird zusammen mit --object-id verwendet.
• --object-id <uuid> – Objekt-UUID. Wird zusammen mit --name verwendet.
• --value <value> (erforderlich) – der neue Wert.
• --clear – Löschen Sie den Wert, anstatt ihn festzulegen.

Beispiel

uip tm customfield value update \
  --object-type TestCase \
  --value-id v1b2c3d4-0000-0000-0000-000000000001 \
  --value Critical

Datenform

{
  "Code": "CustomFieldValueUpdate",
  "Data": {
    "ValueId": "v1b2c3d4-0000-0000-0000-000000000001",
    "Value": "Critical",
    "Result": "Updated"
  }
}

---

Löschen des benutzerdefinierten UIP-TM-Feldwerts

Löschen Sie einen benutzerdefinierten Feldwert.

Optionen

• --object-type <type> (erforderlich) – Objekttyp.
• --value-id <uuid> – Wert-UUID. Sich gegenseitig mit --name + --object-id ausschließen.
• --name <name> – Feldname. Wird zusammen mit --object-id verwendet.
• --object-id <uuid> – Objekt-UUID. Wird zusammen mit --name verwendet.
• -y, --yes – Überspringen Sie die Bestätigungsaufforderung.

Beispiel

uip tm customfield value delete \
  --object-type TestCase \
  --value-id v1b2c3d4-0000-0000-0000-000000000001 \
  --yes

Datenform

{
  "Code": "CustomFieldValueDelete",
  "Data": {
    "ValueId": "v1b2c3d4-0000-0000-0000-000000000001",
    "Result": "Deleted"
  }
}

---

Zugehörig

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

Siehe auch

• Test Manager-Übersicht
• Authentication