Custom 필드

요구 사항 및 시스템 포털의 Custom 필드 - API 문서

소개

요구 사항 및 시스템 포털에서 사용자 지정 필드는 사용자가 요구 사항 및 테스트 실행과 관련된 추가 필드를 만들 수 있도록 하여 플랫폼의 기능을 확장할 수 있는 강력한 방법을 제공합니다. 이러한 필드에는 날짜, 텍스트 및 선택 항목과 같은 다양한 유형의 데이터를 저장할 수 있습니다. 이 API 문서에서는 Custom 필드와 그 옵션을 프로그래밍 방식으로 만들고, 업데이트하고, 관리하는 프로세스를 간략하게 설명합니다.

Custom 필드의 정의

요구 사항 및 시스템 포털의 사용자 지정 필드는 다음 구문을 사용하여 /data/custom-field/ 엔드포인트를 사용하여 만들 수 있습니다:

CustomField{
  "프로젝트": [고유 항목: true 정수],
  "target_content_type": 정수,
  "name": 문자열,
  "type": 정수
  "multi": boolean
}

• projects: Custom 필드를 사용할 수 있는 프로젝트 고유 식별자 목록입니다.

• target_content_type: Custom 필드의 타겟 콘텐츠 유형입니다. 요구 사항에는 120을 사용하고 테스트 실행에는 291을 사용합니다.

• name: Custom 필드의 이름입니다.

• type: 텍스트에는 0, 선택 항목에는 1, 날짜에는 2를 사용합니다.

• multi: 선택 유형을 정의할 때 다중 선택의 경우 true로 설정합니다.

Custom 필드 만들기

Custom 필드를 만들려면 엔드포인트에 PUT 메서드를 사용합니다 /data/custom-field/. 예를 들어

{
  "프로젝트": [136],
  "target_content_type": 120,
  "name": "새 선택 열",
  "type": 1
}

Custom 필드 옵션 정의

선택 유형의 Custom 필드를 만들 때 다음과 같은 모델의 /data/custom-field-options/ 엔드포인트를 사용하여 사용 가능한 옵션도 정의해야 합니다:

CustomFieldOption{
  "custom_field": 정수,
  "title_name": 문자열
  "위치": 숫자
}

• custom_field: 옵션이 생성되는 Custom 필드의 고유 식별자입니다.

• titlename: 옵션의 이름입니다.

• position: 옵션 목록에서 옵션의 위치를 정의하는 옵션 필드입니다.

Custom 필드 옵션 만들기

Custom 필드 옵션을 만들려면 엔드포인트에 PUT 메서드( /data/custom-field-options/. 예를 들어

{
  "custom_field": 58,
  "name": "새 옵션"
}

Custom 필드에 데이터 추가하기

Custom 필드에 데이터를 추가하려면 다음 모델과 함께 /data/custom-field-row/ 엔드포인트를 사용하세요:

CustomFieldRow{
  "참조된_객체_ID": 정수,
  "custom_field": 정수,
  "value": 문자열
}

• referenced_object_id: 데이터가 속한 개체(요구 사항 또는 테스트 실행)의 고유 식별자입니다.

• custom_field: 데이터가 추가되는 Custom 필드의 고유 식별자입니다.

• value: 추가할 데이터입니다. 텍스트의 경우 자유 텍스트 문자열을 사용하고, 단일 선택의 경우 옵션 ID를 사용하고, 다중 선택의 경우 옵션 ID 목록을 사용하고, 날짜의 경우 문자열 형식의 날짜를 사용합니다.

Custom 필드에 데이터 추가하기 - 처음 입력하기

지정된 개체의 Custom 필드에 데이터를 처음 입력하려면 엔드포인트의 POST 메서드( /data/custom-field-row/bulk-create/. 예를 들어

{
  "참조된_객체_ID": 33803,
  "custom_field": 58,
  "value": 29
}

Custom 필드의 데이터 업데이트하기

지정된 객체의 Custom 필드에 대한 기존 데이터를 업데이트하려면 엔드포인트의 POST 메서드( /data/custom-field-row/bulk-update/. 예를 들어

{
  "614": {
    "value": 30
  }
}

Custom 필드에서 데이터 제거하기

지정된 Custom 필드 및 개체와 연결된 데이터를 제거하려면 동일한 대량 업데이트 방법을 사용하여 "value": null. 예를 들어

{
  "614": {
    "value": null
  }
}

결론

요구 사항 및 시스템 포털의 Custom 필드를 사용하면 플랫폼의 기능을 향상시키고 특정 프로젝트 요구 사항에 맞게 조정할 수 있습니다. 제공된 API 엔드포인트를 사용하여 Custom 필드를 만들고, 옵션을 정의하고, 프로그래밍 방식으로 데이터를 추가하여 요구 사항 및 시스템 포털을 프로젝트 관리 및 분석 요구 사항을 위한 다용도 도구로 만들 수 있습니다.