Interface ICustomFieldNames


  • public interface ICustomFieldNames

    Allows to query names of tasks and cases custom fields.

    Example: Query the names of all custom fields set on any task

    
     List<Result> names = ICustomFieldNames.tasks().executor().results();
     

    Example: Query the names of all custom fields of type String on cases matching the given case query

    
     List<Result> names = ICustomFieldNames.cases().filter(caseQuery).type(CustomFieldType.STRING).executor().results();
     
    Since:
    9.2
    API:
    This is a public API.
    • Method Detail

      • tasks

        static ICustomFieldNames.NameQuery<TaskQuery> tasks()

        Queries names of tasks custom fields.

        Example:

        
         List<Result> names = ICustomFieldNames.tasks().executor().results();
         
        Returns:
        task custom field name query to further filter the result
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.
      • cases

        static ICustomFieldNames.NameQuery<CaseQuery> cases()

        Queries names of cases custom fields.

        Example:

        
         List<Result> names = ICustomFieldNames.cases().executor().results();
         
        Returns:
        case custom field name query to further filter the result
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.