Entitytag

An entity tag [Entitytag] is a custom classification tool that allows to organize entities into groups for reporting purposes.

Review the Usage Guidelines for the Entitytag object.

XML

SOAP

REST

Database table

Object

Entitytag

oaEntitytag

entity_tag

Supported Commands

Add, Read, Modify, Delete

add(), read(), modify(), upsert(), delete()

The Entitytag object has the following properties:

XML / SOAP

Database

Description

created

created

[Read-only] Time the record was created. See Date Fields.

customerid

customer_id

The ID of the associated customer.

default_for_entity

default_for_entity

A 1/0 field indicating whether this is the default row for this entity.

end_date

end_date

End date for this entity_tag. See Date Fields.

externalid

external_id

If the record was imported from an external system you store the unique external record id here.

id

id

[Read-only] Unique ID. Automatically assigned by OpenAir.

projectid

project_id

The ID of the associated project.

start_date

start_date

Start date for this entity_tag. See Date Fields.

tag_group_attribute_name

tag_group_attribute_name

The name of the associated tag group attribute.

tag_group_attributeid

tag_group_attribute_id

[Required] The ID of the associated tag_group_attribute.

tag_group_id

tag_group_id

The ID of the associated tag group attribute.

updated

updated

[Read-only] Time the record was last updated or modified. See Date Fields.

userid

user_id

[Required] The ID of the associated user. The user must exist, must not be marked as deleted and must be active.

Usage Guidelines

Review the following guidelines:

  • You can use the following read attributes when reading Entitytag objects: between_date and tag_with_name. See Read Attributes.

  • If default_for_entity is set to 1, you cannot set a start_date or end_date.

  • When you add or modify a User, you can modify the Entitytag associated with that User. See Updating User Entity Tags.