IncidentIo.CustomFieldOptionsV1 (IncidentIo v0.3.1)

View Source

Manage options for single- and multi-select custom fields.

When a custom field is of type single_select or multi_select, its allowed values are defined as custom field options.

Summary

Functions

create(client \\ %Client{}, body)

Create a custom field option.

destroy(client \\ %Client{}, id)

Delete a custom field option.

list(client \\ %Client{}, custom_field_id, page_size \\ 25)

Show custom field options for a custom field.

show(client \\ %Client{}, id)

Get a single custom field option.

update(client \\ %Client{}, id, body)

Update a custom field option.

Functions

create(client \\ %Client{}, body)

@spec create(IncidentIo.Client.t(), create_request_body()) :: IncidentIo.response()

Create a custom field option.

Custom field option body example:

%{
  custom_field_id: "01FCNDV6P870EA6S7TK1DSYDG0",
  sort_key: 10,
  value: "Product"
}

Example

IncidentIo.CustomFieldOptionsV1.create(client, body)

More information at: https://api-docs.incident.io/tag/Custom-Field-Options-V1#operation/Custom%20Field%20Options%20V1_Create

destroy(client \\ %Client{}, id)

@spec destroy(IncidentIo.Client.t(), binary()) :: IncidentIo.response()

Delete a custom field option.

Example

IncidentIo.CustomFieldOptionsV1.destroy(client, "some-custom-field-option-id")

More information at: https://api-docs.incident.io/tag/Custom-Field-Options-V1#operation/Custom%20Field%20Options%20V1_Delete

list(client \\ %Client{}, custom_field_id, page_size \\ 25)

@spec list(IncidentIo.Client.t(), binary(), integer()) :: IncidentIo.response()

Show custom field options for a custom field.

Example

IncidentIo.CustomFieldOptionsV1.list(client, "some-custom-field-id")

IncidentIo.CustomFieldOptionsV1.list(client, "some-custom-field-id", 10)

More information at: https://api-docs.incident.io/tag/Custom-Field-Options-V1#operation/Custom%20Field%20Options%20V1_List

show(client \\ %Client{}, id)

@spec show(IncidentIo.Client.t(), binary()) :: IncidentIo.response()

Get a single custom field option.

Example

IncidentIo.CustomFieldOptionsV1.show(client, "some-custom-field-option-id")

More information at: https://api-docs.incident.io/tag/Custom-Field-Options-V1#operation/Custom%20Field%20Options%20V1_Show

update(client \\ %Client{}, id, body)

@spec update(IncidentIo.Client.t(), binary(), update_request_body()) ::
  IncidentIo.response()

Update a custom field option.

Custom field option body example:

%{
  sort_key: 10,
  value: "Product"
}

Example

IncidentIo.CustomFieldOptionsV1.update(client, "some-custom-field-option-id", body)

More information at: https://api-docs.incident.io/tag/Custom-Field-Options-V1#operation/Custom%20Field%20Options%20V1_Update