Module asana::apis::custom_fields_api

Enums

CreateCustomFieldError	struct for typed errors of method create_custom_field
CreateEnumOptionForCustomFieldError	struct for typed errors of method create_enum_option_for_custom_field
DeleteCustomFieldError	struct for typed errors of method delete_custom_field
GetCustomFieldError	struct for typed errors of method get_custom_field
GetCustomFieldsForWorkspaceError	struct for typed errors of method get_custom_fields_for_workspace
InsertEnumOptionForCustomFieldError	struct for typed errors of method insert_enum_option_for_custom_field
UpdateCustomFieldError	struct for typed errors of method update_custom_field
UpdateEnumOptionError	struct for typed errors of method update_enum_option

Functions

create_custom_field	Creates a new custom field in a workspace. Every custom field is required to be created in a specific workspace, and this workspace cannot be changed once set. A custom field’s name must be unique within a workspace and not conflict with names of existing task properties such as ‘Due Date’ or ‘Assignee’. A custom field’s type must be one of ‘text’, ‘enum’, or ‘number’. Returns the full record of the newly created custom field.
create_enum_option_for_custom_field	Creates an enum option and adds it to this custom field’s list of enum options. A custom field can have at most 50 enum options (including disabled options). By default new enum options are inserted at the end of a custom field’s list. Locked custom fields can only have enum options added by the user who locked the field. Returns the full record of the newly created enum option.
delete_custom_field	A specific, existing custom field can be deleted by making a DELETE request on the URL for that custom field. Locked custom fields can only be deleted by the user who locked the field. Returns an empty data record.
get_custom_field	Get the complete definition of a custom field’s metadata. Since custom fields can be defined for one of a number of types, and these types have different data and behaviors, there are fields that are relevant to a particular type. For instance, as noted above, enum_options is only relevant for the enum type and defines the set of choices that the enum could represent. The examples below show some of these type-specific custom field definitions.
get_custom_fields_for_workspace	Returns a list of the compact representation of all of the custom fields in a workspace.
insert_enum_option_for_custom_field	Moves a particular enum option to be either before or after another specified enum option in the custom field. Locked custom fields can only be reordered by the user who locked the field.
update_custom_field	A specific, existing custom field can be updated by making a PUT request on the URL for that custom field. Only the fields provided in the data block will be updated; any unspecified fields will remain unchanged When using this method, it is best to specify only those fields you wish to change, or else you may overwrite changes made by another user since you last retrieved the custom field. A custom field’s type cannot be updated. An enum custom field’s enum_options cannot be updated with this endpoint. Instead see “Work With Enum Options” for information on how to update enum_options. Locked custom fields can only be updated by the user who locked the field. Returns the complete updated custom field record.
update_enum_option	Updates an existing enum option. Enum custom fields require at least one enabled enum option. Locked custom fields can only be updated by the user who locked the field. Returns the full record of the updated enum option.