class Asana::Resources::CustomFieldsBase

Public Class Methods

create_custom_field(client, options: {}, **data) click to toggle source

options - [Hash] the request I/O options > offset - [str] Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' > limit - [int] Results per page. The number of objects to return per page. The value must be between 1 and 100. > opt_fields - [list] Defines fields to return. Some requests return compact representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The id of included objects will always be returned, regardless of the field options. > opt_pretty - [bool] Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. data - [Hash] the attributes to POST

# File lib/asana/resources/gen/custom_fields_base.rb, line 24
def create_custom_field(client, options: {}, **data)
  path = "/custom_fields"
  CustomField.new(parse(client.post(path, body: data, options: options)).first, client: client)
end
create_enum_option_for_custom_field(client, custom_field_gid: required("custom_field_gid"), options: {}, **data) click to toggle source

Create an enum option

custom_field_gid - [str] (required) Globally unique identifier for the custom field. options - [Hash] the request I/O options > offset - [str] Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' > limit - [int] Results per page. The number of objects to return per page. The value must be between 1 and 100. > opt_fields - [list] Defines fields to return. Some requests return compact representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The id of included objects will always be returned, regardless of the field options. > opt_pretty - [bool] Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. data - [Hash] the attributes to POST

# File lib/asana/resources/gen/custom_fields_base.rb, line 38
def create_enum_option_for_custom_field(client, custom_field_gid: required("custom_field_gid"), options: {}, **data)
  path = "/custom_fields/{custom_field_gid}/enum_options"
  path["{custom_field_gid}"] = custom_field_gid
  parse(client.post(path, body: data, options: options)).first
end
delete_custom_field(client, custom_field_gid: required("custom_field_gid"), options: {}) click to toggle source

Delete a custom field

custom_field_gid - [str] (required) Globally unique identifier for the custom field. options - [Hash] the request I/O options > opt_fields - [list] Defines fields to return. Some requests return compact representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The id of included objects will always be returned, regardless of the field options. > opt_pretty - [bool] Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

# File lib/asana/resources/gen/custom_fields_base.rb, line 50
def delete_custom_field(client, custom_field_gid: required("custom_field_gid"), options: {})
  path = "/custom_fields/{custom_field_gid}"
  path["{custom_field_gid}"] = custom_field_gid
  parse(client.delete(path, options: options)).first
end
get_custom_field(client, custom_field_gid: required("custom_field_gid"), options: {}) click to toggle source

Get a custom field

custom_field_gid - [str] (required) Globally unique identifier for the custom field. options - [Hash] the request I/O options > opt_fields - [list] Defines fields to return. Some requests return compact representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The id of included objects will always be returned, regardless of the field options. > opt_pretty - [bool] Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

# File lib/asana/resources/gen/custom_fields_base.rb, line 62
def get_custom_field(client, custom_field_gid: required("custom_field_gid"), options: {})
  path = "/custom_fields/{custom_field_gid}"
  path["{custom_field_gid}"] = custom_field_gid
  CustomField.new(parse(client.get(path, options: options)).first, client: client)
end
get_custom_fields_for_workspace(client, workspace_gid: required("workspace_gid"), options: {}) click to toggle source

Get a workspace's custom fields

workspace_gid - [str] (required) Globally unique identifier for the workspace or organization. options - [Hash] the request I/O options > offset - [str] Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' > limit - [int] Results per page. The number of objects to return per page. The value must be between 1 and 100. > opt_fields - [list] Defines fields to return. Some requests return compact representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The id of included objects will always be returned, regardless of the field options. > opt_pretty - [bool] Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

# File lib/asana/resources/gen/custom_fields_base.rb, line 76
def get_custom_fields_for_workspace(client, workspace_gid: required("workspace_gid"), options: {})
  path = "/workspaces/{workspace_gid}/custom_fields"
  path["{workspace_gid}"] = workspace_gid
  Collection.new(parse(client.get(path, options: options)), type: CustomField, client: client)
end
inherited(base) click to toggle source
# File lib/asana/resources/gen/custom_fields_base.rb, line 10
def self.inherited(base)
  Registry.register(base)
end
insert_enum_option_for_custom_field(client, custom_field_gid: required("custom_field_gid"), options: {}, **data) click to toggle source

Reorder a custom field's enum

custom_field_gid - [str] (required) Globally unique identifier for the custom field. options - [Hash] the request I/O options > opt_fields - [list] Defines fields to return. Some requests return compact representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The id of included objects will always be returned, regardless of the field options. > opt_pretty - [bool] Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. data - [Hash] the attributes to POST

# File lib/asana/resources/gen/custom_fields_base.rb, line 89
def insert_enum_option_for_custom_field(client, custom_field_gid: required("custom_field_gid"), options: {}, **data)
  path = "/custom_fields/{custom_field_gid}/enum_options/insert"
  path["{custom_field_gid}"] = custom_field_gid
  parse(client.post(path, body: data, options: options)).first
end
update_custom_field(client, custom_field_gid: required("custom_field_gid"), options: {}, **data) click to toggle source

Update a custom field

custom_field_gid - [str] (required) Globally unique identifier for the custom field. options - [Hash] the request I/O options > opt_fields - [list] Defines fields to return. Some requests return compact representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The id of included objects will always be returned, regardless of the field options. > opt_pretty - [bool] Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. data - [Hash] the attributes to PUT

# File lib/asana/resources/gen/custom_fields_base.rb, line 102
def update_custom_field(client, custom_field_gid: required("custom_field_gid"), options: {}, **data)
  path = "/custom_fields/{custom_field_gid}"
  path["{custom_field_gid}"] = custom_field_gid
  CustomField.new(parse(client.put(path, body: data, options: options)).first, client: client)
end
update_enum_option(client, enum_option_gid: required("enum_option_gid"), options: {}, **data) click to toggle source

Update an enum option

enum_option_gid - [str] (required) Globally unique identifier for the enum option. options - [Hash] the request I/O options > opt_fields - [list] Defines fields to return. Some requests return compact representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The id of included objects will always be returned, regardless of the field options. > opt_pretty - [bool] Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. data - [Hash] the attributes to PUT

# File lib/asana/resources/gen/custom_fields_base.rb, line 115
def update_enum_option(client, enum_option_gid: required("enum_option_gid"), options: {}, **data)
  path = "/enum_options/{enum_option_gid}"
  path["{enum_option_gid}"] = enum_option_gid
  parse(client.put(path, body: data, options: options)).first
end