Module: metadata

Enumeration: MetadataType

Type of metadata element

TEXT	1	Freeform text field
NUMBER	2	Numeric
LIST	3	Restricted list of options
MULTI_SELECT_LIST	4	Multi-select list of options

Enumeration: MetadataSystemKey

System metadata

TAGS

1

Enumeration: Owner

Owning scope for metadata

ALL	0	Used to request all metadata on a team; not valid on input
JOB_TEMPLATE	1	Metadata item for templates and template sets
STEP	3	Metadata item for steps
JOB	4	Metadata item for jobs (i.e. Job Parameters)
USER	5	Metadata item for users

Union: MetadataValue

Key	Field	Type	Description	Requiredness	Default value
1	text	string	string value; when passed in *WhereOpts, uses full text searching	default
2	number	double	double value; when passed in *WhereOpts, uses exact number searching	default
3	listValue	string	string value from metadata list of options; when passed in *WhereOpts, uses exact string searching	default
5	listValueId	string	value id referring to listValue	default
4	selectedListValues	common.SelectedListValues	set of string values from metadata list of options; when passed in *WhereOpts, uses string "contains" searching, e.g. searching for "A" returns all values containing "A", such as set("A"), set("A", "B"), set("A", "B", "C") ...	default
6	selectedListValueIds	common.SelectedListValueIds	value id set referring to selectedListValues	default
7	date	i64	timestamp for metadata date	default

Struct: MetadataValueDiff

Key	Field	Type	Description	Requiredness	Default value
1	latestChange	diff.Change		default
10	otherValue	MetadataValue		optional

Used to indicate diff in MetadataEntries

Struct: Range

Key	Field	Type	Description	Requiredness	Default value
1	range_start	double		optional
2	range_end	double		optional

Struct: ListOptions

Key	Field	Type	Description	Requiredness	Default value
1	options	list<string>	list of options to choose from	default
2	valueIds	list<string>	list of value ids to uniquely identify the options	optional
3	systemValueIds	list<string>	values seeded by a system key	optional

Struct: Constraints

Key	Field	Type	Description	Requiredness	Default value
1	range	Range	only for numeric type; not required	optional
2	listOptions	ListOptions	required for list types (both list and multi-select list)	optional

Struct: Metadata

Key	Field	Type	Description	Requiredness	Default value
1	id	string		default
2	key	string	Display name of metadata element	default
3	type	MetadataType	Type of metadata element	default
4	constraints	Constraints	Optional constraints for list or numeric	default
5	owner	Owner	Owning scope for metadata	default
6	createdAt	i64	Timestamp of when the Metadata was created	default
7	isRequired	bool	Is data required (for template metadata, before starting)	default
8	archivedAt	i64	Timestamp of when the Metadata was archived, or 0 if not archived	default
9	updatedAt	i64	Timestamp of when the Metadata was last updated	default
10	position	double	Display position, used as the sort index; if not passed in, add 1.0 to highest for team+owner	optional
11	defaultValue	MetadataValue	Default value to display when a field is newly added or cleared. See Setting Default Values for Metadata for usage explanation.	optional
12	clearDefault	bool	Flag to clear the default value, if previously set	optional
13	externallyManaged	bool	Flag to indicate this field is externally managed	optional
14	systemKey	MetadataSystemKey	Type of system metadata	optional

Struct: MetadataEntry

Key	Field	Type	Description	Requiredness	Default value
1	metadataId	string		default
3	key	string		default
2	value	MetadataValue		default
4	idValue	MetadataValue		optional
5	externallyManaged	bool	This value is a metadata field that is externally managed	optional
10	referenced	bool		optional

Struct: ListOptionParams

Key	Field	Type	Description	Requiredness	Default value
1	name	string	rename value	optional
2	position	i32	move value to new position, append if -1	optional
3	alphabetical	bool	insertion order	optional

Optional parameters when updating list metadata values

Function: MetadataService.add

Metadata add(string teamId,
             Metadata metadata)
    throws common.SystemException

Add a metadata definition to the specified team; will assign an ID and a default position Raises BAD_REQUEST if key is not unique among unarchived metadata for the same team+owner; note that it is OK to create a new item to replace an archived one with the same key

Function: MetadataService.index

list<Metadata> index(string teamId,
                     Owner owner = Owner.ALL,
                     bool includeArchived = false,
                     bool includeExternallyManaged = false)
    throws common.SystemException

Return all metadata definitions for requested teamId and owner, optionally with archived fields

Function: MetadataService.get

Metadata get(string teamId,
             string id)
    throws common.SystemException

Return a specific metadata definition

Function: MetadataService.update

void update(string teamId,
            Metadata metadata)
    throws common.SystemException

Update a metadata definition.
Allowable update operations include: a) change key name, b) position change (re-order), c) change required-ness, d) modify range, e) change or clear default value, f) change externally-managed flag
Disallowed update operations include: f) change list values (DEPRECATED, use updateList* below for granular ops), g) change to metadata owner, h) change to metadata type (except list -> multi-select list)

Function: MetadataService.updateListAdd

list<string> updateListAdd(string teamId,
                           string metadataId,
                           list<string> values,
                           ListOptionParams params)
    throws common.SystemException

Add values to a list (or multi-select list) metadata
Append values to end of list by default. Insert into list position if params contains position, append to end of list when position=-1
Sort all values alphabetically if params contains alphabetical=true, ignoring position when set
Return added list value ids in original input order, error if metadata is not one of the list types or values already added or bad insert position

Function: MetadataService.updateListRemove

void updateListRemove(string teamId,
                      string metadataId,
                      list<string> valueIds)
    throws common.SystemException

Remove values from a list (or multi-select list) metadata
Remove values from list if they exist; active metadata list objects will remove these values automatically
Error if metadata is not one of the list types or values not found

Function: MetadataService.updateListUpdate

void updateListUpdate(string teamId,
                      string metadataId,
                      list<string> valueIds,
                      list<ListOptionParams> params)
    throws common.SystemException

Update values in a list (or multi-select list) metadata
Update value names if params contains name; active metadata list objects will update value names automatically
Move values to list position if params contains position, move to end of list when position=-1
Sort all values alphabetically if any params contains alphabetical=true, ignoring all position when set
Error if metadata is not one of the list types or values not found or bad move position
Note that multi-move position is not supported unless all params have the same position (bulk move).

Function: MetadataService.updateListMerge

void updateListMerge(string teamId,
                     string metadataId,
                     list<string> valueIds,
                     string mergedValueId)
    throws common.SystemException

Merge values in a list (or multi-select list) metadata
Merge values into a single existing value; active metadata list objects will update all merged values to final value automatically
Error if metadata is not one of the list types or values/merged value not found

Function: MetadataService.archive

void archive(string teamId,
             string id)
    throws common.SystemException

Archive a metadata definition; this allows access to the metadata on existing owners, but prevents new users of the metadata

Function: MetadataService.updateMetadataAttributes

list<abac.AbacAttribute> updateMetadataAttributes(common.UUID teamId,
                                                  common.UUID metadataId,
                                                  list<abac.AbacAttribute> attributes,
                                                  abac.AbacUploadBehaviour behave)
    throws common.SystemException

update Metadata Attributes provide teamId to prevent extra lookups

Function: MetadataService.updateMetadataAttribute

list<abac.AbacAttribute> updateMetadataAttribute(common.UUID teamId,
                                                 common.UUID metadataId,
                                                 common.UUID attributeId,
                                                 list<abac.AbacAttributeValue> values,
                                                 abac.AbacUploadBehaviour behave)
    throws common.SystemException

update a Metadata abac actor with a single Attribute provide teamId to prevent extra lookups

Function: MetadataService.updateMetadataValueAttributes

list<abac.AbacAttribute> updateMetadataValueAttributes(common.UUID teamId,
                                                       common.UUID metadataId,
                                                       list<abac.AbacAttribute> attributes,
                                                       abac.AbacUploadBehaviour behave)
    throws common.SystemException

update a Metadata Value abac actor with Attributes provide teamId to prevent extra lookups

Function: MetadataService.updateMetadataValueAttribute

list<abac.AbacAttribute> updateMetadataValueAttribute(common.UUID teamId,
                                                      common.UUID metadataId,
                                                      common.UUID attributeId,
                                                      list<abac.AbacAttributeValue> values,
                                                      abac.AbacUploadBehaviour behave)
    throws common.SystemException

update Metadata Value with a single Attribute provide teamId to prevent extra lookups