모든 사용자 정의 필드 목록

사용자 정의 필드는 귀하의 비즈니스 요구에 맞는 추가 데이터 필드로 Blue의 표준 레코드 구조를 확장할 수 있게 해줍니다. 이 엔드포인트는 필드 유형별로 필터링하고 페이지 매김 지원을 통해 귀하의 프로젝트에서 사용할 수 있는 사용자 정의 필드를 검색합니다.

기본 예제

query ListCustomFields {
  customFields(
    filter: { projectId: "project_123" }
    sort: position_ASC
    take: 20
  ) {
    items {
      id
      uid
      name
      type
      position
    }
    pageInfo {
      totalItems
      hasNextPage
    }
  }
}

고급 예제

query ListCustomFieldsAdvanced {
  customFields(
    filter: {
      projectId: "project_123"
      types: [TEXT_SINGLE, NUMBER, SELECT_SINGLE]
    }
    sort: name_ASC
    skip: 20
    take: 50
  ) {
    items {
      id
      uid
      name
      type
      position
      description
      
      # Type-specific fields
      min              # For NUMBER, RATING, PERCENT
      max              # For NUMBER, RATING, PERCENT
      currency         # For CURRENCY type
      prefix           # For UNIQUE_ID type
      isDueDate        # For DATE type
      formula          # For FORMULA type
      
      # Validation settings
      editable
      metadata
      
      # For SELECT types
      customFieldOptions {
        id
        title
        color
        position
      }
    }
    pageInfo {
      totalItems
      hasNextPage
      hasPreviousPage
    }
  }
}

입력 매개변수

CustomFieldFilterInput

CustomFieldSort 값

CustomFieldType 값

페이지 매김 매개변수

응답 필드

CustomField

CustomFieldOption

PageInfo

필수 권한

사용자 정의 필드는 귀하의 프로젝트 역할에 따라 접근할 수 있습니다. 필드 접근이 제한된 사용자 정의 역할이 있는 경우, 귀하의 역할에 대해 편집 가능한 것으로 표시된 필드만 반환됩니다.

오류 응답

프로젝트를 찾을 수 없음

{
  "errors": [{
    "message": "Project not found.",
    "extensions": {
      "code": "PROJECT_NOT_FOUND"
    }
  }]
}

잘못된 필드 유형

{
  "errors": [{
    "message": "Variable \"$filter\" got invalid value \"INVALID_TYPE\" at \"filter.types[0]\"; Value \"INVALID_TYPE\" does not exist in \"CustomFieldType\" enum.",
    "extensions": {
      "code": "GRAPHQL_VALIDATION_FAILED"
    }
  }]
}

중요 사항

• 사용자 정의 필드는 프로젝트에 국한됩니다 - 필터에서 projectId를 지정해야 합니다.
• take 매개변수는 성능을 위해 요청당 500 항목으로 제한됩니다.
• 필드는 사용자 권한에 따라 반환됩니다 - 사용자 정의 역할은 접근이 제한될 수 있습니다.
• 기본 정렬 순서는 position 오름차순이며, 이는 UI에 표시된 순서를 반영합니다.
• 이 쿼리는 단일 프로젝트 필터링을 지원합니다 - 다중 프로젝트 쿼리의 경우 중첩된 CustomFieldQueries 인터페이스를 사용하십시오.
• 일부 필드 유형(예: FORMULA 및 REFERENCE)은 추가 중첩 데이터 구조를 포함할 수 있습니다.
• editable 필드는 현재 사용자가 이 사용자 정의 필드의 값을 수정할 수 있는지 여부를 나타냅니다.

관련 엔드포인트

• 사용자 정의 필드 생성 - 프로젝트에 새로운 사용자 정의 필드 추가
• 사용자 정의 필드 업데이트 - 기존 사용자 정의 필드 속성 수정
• 사용자 정의 필드 삭제 - 프로젝트에서 사용자 정의 필드 제거
• 사용자 정의 필드 값 설정 - 레코드에 값 설정