Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Incident Provider
  3. API Docs
  4. getCustomField
incident 5.4.1 published on Wednesday, Apr 9, 2025 by incident-io
incident-io/terraform-provider-incident

incident.getCustomField

Explore with Pulumi AI

incident 5.4.1 published on Wednesday, Apr 9, 2025 by incident-io
incident-io/terraform-provider-incident

This data source provides information about a custom field.

Using getCustomField

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getCustomField(args: GetCustomFieldArgs, opts?: InvokeOptions): Promise<GetCustomFieldResult>
function getCustomFieldOutput(args: GetCustomFieldOutputArgs, opts?: InvokeOptions): Output<GetCustomFieldResult>
Copy
def get_custom_field(name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetCustomFieldResult
def get_custom_field_output(name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetCustomFieldResult]
Copy
func LookupCustomField(ctx *Context, args *LookupCustomFieldArgs, opts ...InvokeOption) (*LookupCustomFieldResult, error)
func LookupCustomFieldOutput(ctx *Context, args *LookupCustomFieldOutputArgs, opts ...InvokeOption) LookupCustomFieldResultOutput
Copy

> Note: This function is named LookupCustomField in the Go SDK.

public static class GetCustomField 
{
    public static Task<GetCustomFieldResult> InvokeAsync(GetCustomFieldArgs args, InvokeOptions? opts = null)
    public static Output<GetCustomFieldResult> Invoke(GetCustomFieldInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetCustomFieldResult> getCustomField(GetCustomFieldArgs args, InvokeOptions options)
public static Output<GetCustomFieldResult> getCustomField(GetCustomFieldArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: incident:index/getCustomField:getCustomField
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
Human readable name for the custom field
Name This property is required. string
Human readable name for the custom field
name This property is required. String
Human readable name for the custom field
name This property is required. string
Human readable name for the custom field
name This property is required. str
Human readable name for the custom field
name This property is required. String
Human readable name for the custom field

getCustomField Result

The following output properties are available:

CatalogTypeId string
For catalog fields, the ID of the associated catalog type
Description string
Description of the custom field
FieldType string
Type of custom field
FilterBy GetCustomFieldFilterBy
GroupByCatalogAttributeId string
For catalog fields, the ID of the attribute used to group catalog entries (if applicable)
HelptextCatalogAttributeId string
Which catalog attribute provides helptext for the options
Id string
The custom field ID
Name string
Human readable name for the custom field
CatalogTypeId string
For catalog fields, the ID of the associated catalog type
Description string
Description of the custom field
FieldType string
Type of custom field
FilterBy GetCustomFieldFilterBy
GroupByCatalogAttributeId string
For catalog fields, the ID of the attribute used to group catalog entries (if applicable)
HelptextCatalogAttributeId string
Which catalog attribute provides helptext for the options
Id string
The custom field ID
Name string
Human readable name for the custom field
catalogTypeId String
For catalog fields, the ID of the associated catalog type
description String
Description of the custom field
fieldType String
Type of custom field
filterBy GetCustomFieldFilterBy
groupByCatalogAttributeId String
For catalog fields, the ID of the attribute used to group catalog entries (if applicable)
helptextCatalogAttributeId String
Which catalog attribute provides helptext for the options
id String
The custom field ID
name String
Human readable name for the custom field
catalogTypeId string
For catalog fields, the ID of the associated catalog type
description string
Description of the custom field
fieldType string
Type of custom field
filterBy GetCustomFieldFilterBy
groupByCatalogAttributeId string
For catalog fields, the ID of the attribute used to group catalog entries (if applicable)
helptextCatalogAttributeId string
Which catalog attribute provides helptext for the options
id string
The custom field ID
name string
Human readable name for the custom field
catalog_type_id str
For catalog fields, the ID of the associated catalog type
description str
Description of the custom field
field_type str
Type of custom field
filter_by GetCustomFieldFilterBy
group_by_catalog_attribute_id str
For catalog fields, the ID of the attribute used to group catalog entries (if applicable)
helptext_catalog_attribute_id str
Which catalog attribute provides helptext for the options
id str
The custom field ID
name str
Human readable name for the custom field
catalogTypeId String
For catalog fields, the ID of the associated catalog type
description String
Description of the custom field
fieldType String
Type of custom field
filterBy Property Map
groupByCatalogAttributeId String
For catalog fields, the ID of the attribute used to group catalog entries (if applicable)
helptextCatalogAttributeId String
Which catalog attribute provides helptext for the options
id String
The custom field ID
name String
Human readable name for the custom field

Supporting Types

GetCustomFieldFilterBy

CatalogAttributeId This property is required. string
This must be an attribute of the catalog type of this custom field. It must be an attribute that points to another catalog type (so not a plain string, number, or boolean attribute).
CustomFieldId This property is required. string
This must be the ID of a custom field, which must have values of the same type as the attribute you are filtering by.
CatalogAttributeId This property is required. string
This must be an attribute of the catalog type of this custom field. It must be an attribute that points to another catalog type (so not a plain string, number, or boolean attribute).
CustomFieldId This property is required. string
This must be the ID of a custom field, which must have values of the same type as the attribute you are filtering by.
catalogAttributeId This property is required. String
This must be an attribute of the catalog type of this custom field. It must be an attribute that points to another catalog type (so not a plain string, number, or boolean attribute).
customFieldId This property is required. String
This must be the ID of a custom field, which must have values of the same type as the attribute you are filtering by.
catalogAttributeId This property is required. string
This must be an attribute of the catalog type of this custom field. It must be an attribute that points to another catalog type (so not a plain string, number, or boolean attribute).
customFieldId This property is required. string
This must be the ID of a custom field, which must have values of the same type as the attribute you are filtering by.
catalog_attribute_id This property is required. str
This must be an attribute of the catalog type of this custom field. It must be an attribute that points to another catalog type (so not a plain string, number, or boolean attribute).
custom_field_id This property is required. str
This must be the ID of a custom field, which must have values of the same type as the attribute you are filtering by.
catalogAttributeId This property is required. String
This must be an attribute of the catalog type of this custom field. It must be an attribute that points to another catalog type (so not a plain string, number, or boolean attribute).
customFieldId This property is required. String
This must be the ID of a custom field, which must have values of the same type as the attribute you are filtering by.

Package Details

Repository
incident incident-io/terraform-provider-incident
License
Notes
This Pulumi package is based on the incident Terraform Provider.
incident 5.4.1 published on Wednesday, Apr 9, 2025 by incident-io
incident-io/terraform-provider-incident