UiPath CLI user guide

• customfield — manage the field definition itself (list, get, create, update, delete)
• customfield label — manage the label assignments applied to objects
• customfield value — manage the allowed values for a field

# 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]
# 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]

uip tm customfield list​

Options​

• --project-key <key> (required) — owning project.
• --object-types <types...> — space-separated object types to filter by.
• --data-types <types...> — space-separated data types to filter by.
• --name <name> — filter by exact field name.
• --filter <text> — free-text search.
• --sort-by <expr> — sort expression.
• --limit <n> — page size. Defaults to 50.
• --offset <n> — results to skip. Defaults to 0.

Example​

uip tm customfield list \
  --project-key DEMO \
  --object-types TestCase
uip tm customfield list \
  --project-key DEMO \
  --object-types TestCase

Data shape​

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

uip tm customfield get​

Options​

• --object-type <type> (required) — object type the field belongs to.
• --field-id <uuid> — field UUID. Mutually exclusive with --name.
• --name <name> — field name. Mutually exclusive with --field-id.

Example​

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

Data shape​

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

uip tm customfield create​

Options​

• --project-key <key> (required) — owning project.
• --name <name> (required) — field name.
• --object-type <type> (required) — object type to attach the field to (for example, TestCase, TestSet).
• --data-type <type> (required) — data type of the field (for example, String, Integer, Boolean).
• --scope-list <list> — scope restrictions for the field.
• --description <text> — field description.
• --default-value <value> — default value for new objects.
• --value-hints <hints> — allowed value hints or enumeration for the field.

Example​

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

Data shape​

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

uip tm customfield update​

Options​

• --object-type <type> (required) — object type the field belongs to.
• --field-id <uuid> — field UUID. Mutually exclusive with --name.
• --name <name> — field name (for lookup). Mutually exclusive with --field-id.
• --rename-to <name> — new name for the field.
• --description <text> — new description.
• --default-value <value> — new default value.
• --value-hints <hints> — new allowed value hints.
• --scope-list <list> — new scope restrictions.

Example​

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

Data shape​

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

uip tm customfield delete​

Options​

• --object-type <type> (required) — object type the fields belong to.
• --field-ids <uuid...> — space-separated field UUIDs to delete. Mutually exclusive with --name.
• --name <name> — field name to delete. Mutually exclusive with --field-ids.
• -y, --yes — skip the confirmation prompt.

Example​

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

Data shape​

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

uip tm customfield label get​

Options​

• --object-type <type> (required) — object type the label belongs to.
• --label-id <uuid> (required) — UUID of the label assignment (not the label name).

Example​

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

Data shape​

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

uip tm customfield label list​

Options​

• --object-type <type> (required) — object type to list labels for.
• --object-id <uuid> — filter to a specific object UUID.
• --limit <n> — page size. Defaults to 50.
• --offset <n> — results to skip. Defaults to 0.

Example​

uip tm customfield label list \
  --object-type TestCase \
  --object-id a1b2c3d4-0000-0000-0000-000000000001
uip tm customfield label list \
  --object-type TestCase \
  --object-id a1b2c3d4-0000-0000-0000-000000000001

Data shape​

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

uip tm customfield label create​

Options​

• --object-type <type> (required) — object type to attach the label to.
• --object-id <uuid> (required) — UUID of the object to label.
• --values <json> (required) — JSON array of label values to apply.

Example​

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

Data shape​

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

uip tm customfield label add​

Options​

• --object-type <type> (required) — object type.
• --custom-field-name <name> (required) — name of the custom field.
• --object-ids <uuid...> (required) — space-separated object UUIDs to apply the label to.
• --values <values...> (required) — space-separated label values to add.

Example​

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

Data shape​

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

uip tm customfield label remove​

Options​

• --object-type <type> (required) — object type.
• --custom-field-name <name> (required) — name of the custom field.
• --object-ids <uuid...> (required) — space-separated object UUIDs.
• --values <values...> — space-separated label values to remove.
• --remove-all-values — remove all label values for this field from the specified objects. Mutually exclusive with --values.

Example​

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

Data shape​

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

uip tm customfield value list​

Options​

• --object-type <type> (required) — object type.
• --object-id <uuid> — filter to a specific object UUID.
• --limit <n> — page size. Defaults to 50.
• --offset <n> — results to skip. Defaults to 0.

Example​

uip tm customfield value list \
  --object-type TestCase \
  --object-id a1b2c3d4-0000-0000-0000-000000000001
uip tm customfield value list \
  --object-type TestCase \
  --object-id a1b2c3d4-0000-0000-0000-000000000001

Data shape​

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

uip tm customfield value get​

Options​

• --object-type <type> (required) — object type.
• --value-id <uuid> — value UUID. Mutually exclusive with --name + --object-id.
• --name <name> — field name. Used together with --object-id.
• --object-id <uuid> — object UUID. Used together with --name.

Example​

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

Data shape​

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

uip tm customfield value create​

Options​

• --object-type <type> (required) — object type.
• --name <name> (required) — custom field name.
• --object-id <uuid> (required) — object UUID.
• --data-type <type> (required) — data type of the value (for example, String, Integer).
• --value <value> (required) — the value to set.

Example​

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

Data shape​

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

uip tm customfield value update​

Options​

• --object-type <type> (required) — object type.
• --value-id <uuid> — value UUID. Mutually exclusive with --name + --object-id.
• --name <name> — field name. Used together with --object-id.
• --object-id <uuid> — object UUID. Used together with --name.
• --value <value> (required) — the new value.
• --clear — clear the value instead of setting it.

Example​

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

Data shape​

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

uip tm customfield value delete​

Options​

• --object-type <type> (required) — object type.
• --value-id <uuid> — value UUID. Mutually exclusive with --name + --object-id.
• --name <name> — field name. Used together with --object-id.
• --object-id <uuid> — object UUID. Used together with --name.
• -y, --yes — skip the confirmation prompt.

Example​

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

Data shape​

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

• requirements — requirements can carry custom field values.
• testcases — test cases can carry custom field values.

• Test Manager overview
• Authentication