다음을 통해 공유


HighQ(미리 보기)

이 커넥터를 사용하면 HighQ API에 대한 안전하고 인증된 액세스를 가능하게 하여 공동 작업 및 콘텐츠 관리 기능을 사용자 지정 워크플로 및 애플리케이션에 원활하게 통합할 수 있습니다. 문서 자동화, 데이터 동기화 및 워크플로 오케스트레이션을 지원하므로 법률 및 전문 서비스 팀이 작업을 간소화하고 수동 작업을 줄이며 생산성을 향상시킬 수 있습니다.

이 커넥터는 다음 제품 및 지역에서 사용할 수 있습니다.

서비스 클래스 Regions
Copilot Studio Premium 다음을 제외한 모든 Power Automate 지역 :
     - 미국 정부(GCC)
     - 미국 정부(GCC High)
     - 21Vianet에서 운영하는 중국 클라우드
     - 미국 국방부(DoD)
논리 앱 스탠다드 다음을 제외한 모든 Logic Apps 지역 :
     - Azure Government 지역
     - Azure 중국 지역
     - 미국 국방부(DoD)
Power Apps Premium 다음을 제외한 모든 Power Apps 지역 :
     - 미국 정부(GCC)
     - 미국 정부(GCC High)
     - 21Vianet에서 운영하는 중국 클라우드
     - 미국 국방부(DoD)
Power Automate Premium 다음을 제외한 모든 Power Automate 지역 :
     - 미국 정부(GCC)
     - 미국 정부(GCC High)
     - 21Vianet에서 운영하는 중국 클라우드
     - 미국 국방부(DoD)
연락처
이름 Highq
URL https://www.thomsonreuters.com/en-gb/help/highq/feature-updates/support/technical-support
전자 메일 highq-support@thomsonreuters.com
커넥터 메타데이터
게시자 톰슨 로이터 법인
웹 사이트 https://legal.thomsonreuters.com/en/products/highq
개인 정보 보호 정책 https://www.thomsonreuters.com/en/privacy-statement
카테고리 합작; 콘텐츠 및 파일

HighQ

개요

HighQ는 HighQ API에 대한 원활하고 안전한 인증된 액세스를 제공합니다. 이 커넥터를 사용하면 ISheet 모듈, 문서 리소스 API, ISheet 관리자 API 및 사용자 작업을 비롯한 다양한 HighQ 서비스와 원활하게 상호 작용할 수 있습니다. HighQ 공동 작업 플랫폼과의 통합을 용이하게 하기 위해 설계되었으며, iSheet 항목 검색 및 만들기, 문서 파일 관리 및 사용자 계정 관리와 같은 기능을 제공합니다.

  • 커넥터 버전: 1.0.0
  • 타이틀: HighQ
  • 묘사: 이 커넥터는 HighQ API에 대한 원활하고 안전한 인증된 액세스를 제공합니다.
  • 접촉:
    • 이름: Highq
    • 웹 사이트:HighQ 지원
    • 메일 주소:highq-support@thomsonreuters.com

Authentication

커넥터는 보안 연결을 위해 동적 환경 변수를 활용합니다.

  • 호스트: @environmentVariables("highqt_host")
  • 기본 경로: /@environmentVariables("highqt_instancename")/api
  • 클라이언트 ID:@environmentVariables("highqt_clientid")
  • 클라이언트 암호:@environmentVariables("highqt_clientsecret")

자세한 인증 절차는 HighQ 기술 지원 포털을 참조하거나 HighQ 지원에 문의하세요.

커넥터 작업

ISheet 모듈

  • iSheet 항목 검색
    GET /{version}/isheet/{isheetid}/items
    지정된 iSheet 내의 항목 목록을 검색합니다.

  • iSheet 항목 만들기
    POST /{version}/isheet/{isheetid}/items
    여러 iSheet를 지원하고 점진적 키를 통해 상태 추적을 지원하는 새 항목을 iSheet에 삽입합니다.

문서 리소스 API

  • 파일 정보 검색
    GET /{version}/files/{fileid}
    HighQ 공동 작업 플랫폼에서 특정 파일에 대한 자세한 정보를 검색합니다.

  • 파일 업로드
    POST /{version}/files/content
    지정된 폴더에 파일을 업로드하여 헤더가 제공될 때 청크 분할 업로드를 Content-Range 지원합니다.

  • 폴더 목록 검색
    GET /{version}/folders/{folderid}/items
    정렬 및 페이지 매김을 지원하는 지정된 폴더 내의 폴더 목록을 검색합니다.

ISheet Admin API

  • iSheet 열 검색
    GET /{version}/isheets/admin/{isheetid}/columns
    지정된 iSheet에 대한 열 구성을 검색합니다.

사용자 작업

  • 사용자 검색
    GET /{version}/users
    필터링, 페이지 매김 및 자세한 사용자 역할을 지원하는 사용자 목록을 검색합니다.

  • 새 사용자 추가
    POST /{version}/users
    확장 특성 및 유효성 검사를 사용하여 새 사용자 계정을 만듭니다.

  • 사용자 보관
    DELETE /{version}/users/{userid}
    시스템에서 기존 사용자를 보관합니다.

문서 및 사이트 관리

  • 폴더 만들기
    POST /{version}/folders
    지정된 부모 폴더 아래에 새 폴더를 만듭니다.

  • 문서 이동
    PUT /{version}/files/move
    한 폴더에서 동일한 사이트 내의 다른 폴더로 하나 이상의 파일을 이동합니다.

  • 사이트 관리 작업:

    • 사이트에 기존 그룹 추가: POST /{version}/sites/{siteid}/groups/{groupid}
    • 사이트 그룹 업데이트: PUT /{version}/sites/{siteid}/groups/{groupid}
    • 새 사이트 추가: POST /{version}/sites

시작하기

  1. 구성:

    • 환경 변수 및 highqt_hosthighqt_instancename Power Platform 환경을 정의합니다.
  2. 인증:

    • HighQ에서 제공하는 지침에 따라 API 요청에 대한 보안 인증을 구성합니다.
  3. 사용 현황:

    • HighQ를 Power Platform 인스턴스로 가져옵니다.
    • 필요에 따라 사용 가능한 작업을 활용합니다. 지침은 위에 제공된 작업 요약을 참조하세요.

매개 변수 및 설정

  • 경로 매개 변수:
    , , versionisheetidfileidfolderid및 해당하는 경우와 같은 userid필수 매개 변수를 포함합니다.

  • 쿼리 매개 변수:
    , , sheetviewidsortcolumnid등의 limit선택적 매개 변수를 offset 사용하여 API 응답을 구체화할 수 있습니다.

  • 본문 매개 변수:
    요청 본문(예: iSheet 항목 또는 사용자 만들기)이 필요한 작업의 경우 요청이 정의된 스키마(예: isheetDBO, FolderDBO또는 IntegrationUserDBO)를 준수하는지 확인합니다.

문제 해결 및 제한 사항

  • 오류 코드:
    표준 HTTP 상태 코드는 작업 간에 사용됩니다.

    • 200 성공적인 작업을 위한 것입니다.
    • 401 무단 액세스
    • 403 사용할 수 없음 또는 유효성 검사 실패
    • 405 HTTP 메서드가 잘못되었습니다.
    • 500 내부 서버 오류
      자세한 오류 설명은 개별 API 설명서를 참조하세요.
  • 제한 사항:
    일부 엔드포인트에는 기본 제한(예: 기본값 limit 100개 레코드)이 있을 수 있습니다. 큰 데이터 세트를 정렬하고 필터링하려면 추가 매개 변수가 필요할 수 있습니다.

추가 리소스

자세한 내용 및 확장 설명서는 다음을 참조하세요.

  • HighQ 기술 지원
  • HighQ 커넥터 패키지와 함께 제공되는 내부 설명서입니다.

라이선스 및 지원

라이선스 세부 정보 및 기술 지원:

  • 연락처: Highq
  • 지원 URL: HighQ 기술 지원
  • 지원 전자 메일: highq-support@thomsonreuters.com

제한 한도

Name 호출 갱신 기간
연결당 API 호출 100 60초

동작

iSheet 열 검색

이 API 호출은 지정된 iSheet와 연결된 열을 검색합니다. 이 기능은 API 버전 3 이상에서 지원됩니다.

iSheet 항목 목록 검색

이 API 호출은 지정된 iSheet에 포함된 항목 목록을 검색합니다.

iSheet 항목을 만들려면

이 API 호출은 iSheet 항목을 삽입하는 데 사용됩니다. 여러 iSheet를 지원합니다.

프로그레시브 키를 기반으로 하는 iSheet 항목의 상태를 얻으려면 API POST /api/3/progressivekeystatus/{progressive_key}를 호출합니다.

예: POST /api/{version}/progressivekeystatus/{progressive_key}

이름유형Description
progressive_keyString 작업의 상태를 확인하는 키입니다.

응답

<progressivekeyresponse>
 \t<항목>
  \t\t<항목>
   \t\t\t<itemid>1232</itemid>
   \t\t\t<상태>SUCCESS</status>
   \t\t\t<statuscode>200</statuscode>
   \t\t\t<메시지>레코드가 성공적으로< 추가됨/메시지>
  \t\t</item>
  \t\t<항목>
   \t\t\t<itemid>1233</itemid>
   \t\t\t<상태>SUCCESS</status>
   \t\t\t<statuscode>200</statuscode>
   \t\t\t<메시지>레코드가 성공적으로< 추가됨/메시지>
  \t\t</item>
 \t</items>
</progressivekeyresponse>
문서 이동

이 API는 여러 파일을 한 폴더에서 동일한 사이트 내의 다른 폴더로 이동합니다.

사용자 목록 검색

사용자 목록을 검색합니다. 이 API는 시스템에서 사용자 목록을 검색합니다. ## 주요 기능 - 여러 필터링 옵션을 사용하여 사용자 세부 정보 가져오기 - 최근 버전에 도입된 새 쿼리 매개 변수 및 limit 필드를 사용하여 페이지 매 offset 김을 지원합니다. - 사용자 역할 및 특성을 사용한 구조적 응답 ## 새 쿼리 매개 변수(Version-Specific) - V12에 도입됨: - systemAdminSearch: 로 설정1하면 시스템 관리자 역할이 있는 사용자만 반환합니다. - V18에서 도입: - userid쉼표로 구분된 값(CSV)을 허용합니다. ## 응답 본문 업데이트 - 새 필드가 추가되었습니다. - ,emaildomain, org,invitationsentcreatedby, createddate,modifiedbymodifieddate - ifpartnerlastlogindateinvalidloginsexternalidpublicwebsiteprofileid - systemuserresetpassworddateusertypeidavatarpracticegroup - langcodepublicprofiledateOfBirth, ## 주소 형식 변경(V11에서) - 태그의 location 이름이 일관성을 위해 address 변경되었습니다. - 응답 예제: xml <address> <addressid>1</addressid> <addressline1>2nd floor</addressline1> <addressline2>additional</addressline2> <city>London</city> <state>state</state> <country>UK</country> <postCode>EC4R</postCode> </address> ## 사용자 역할(API V11 이상에 도입됨) - 응답 예제: xml <roles> <role> <alias>SYSTEM_ADMIN</alias> <name>System Admin</name> </role> <role> <alias>EXTERNAL_ADMIN</alias> <name>External Admin</name> </role> <role> <alias>INTERNAL_USER</alias> <name>Internal User</name> </role> </roles> ## 제한 및 오프셋 - 제한 동작: - 기본값: 100 값이 제공되지 않은 경우. - 모든 레코드를 반환하는 데 사용합니다 -1 . - 값이 보다 -1작으면 기본값은 .입니다 100. - 오프셋 동작: - 기본값: 0 값이 제공되지 않은 경우 - 오프셋이 총 레코드를 초과하는 경우 기본값은 다시 0. ## 새 역할 소개 - V12: Basic User, Allow user to bypass XSS protection - V14: Allow user to manage Contract Express system groups ## 오류 코드 | 요약 | Ref 코드(V4 이전) | Ref Code(V4) | |---------|----------------------|--------------| | 사용자 상태에 대한 잘못된 입력(ACTIVE, ARCHIVED, INACTIVE) | 147 | 147 | | 조직 ID가 잘못되었습니다. | 해당하지 않습니다. | 260 | | 잘못된 neverinvited 값(true/false) | 해당하지 않습니다. | 387 | | 잘못된 neverlogin 값(true/false) | 해당하지 않습니다. | 388 | | 잘못된 groupids 값 | 해당하지 않습니다. | 214 | | 잘못된 notingroup 값(true/false) | 해당하지 않습니다. | 389 | | 유효하지 않음 ordertype (지원됨: 이름, 조직, 상태 등) | 해당하지 않습니다. | 289 | | 잘못됨 orderby (지원됨: asc, desc) | 해당하지 않습니다. | 290 | | 잘못된 offset 값 | 138 | 138 | | 잘못된 limit 값 | 137 | 137 | ## 참고 - V13 이상부터 이 API는 모든 사용자(이전에 시스템 관리자로 제한됨)에 대해 열려 있습니다. - V18부터 userregistered2FA 필드는 사용자가 2FA에 등록했는지 여부를 나타냅니다. --- 이 설명은 Swagger 2.0 스키마 서식을 따르며 사용자 지정 커넥터 스키마의 설명 필드에 배치되어야 합니다.

사용자 보관

이 API 호출은 시스템 내에서 사용자를 보관하는 데 사용됩니다.

오류 코드

요약 Ref 코드(V4 이전) Ref 코드(V4)

다음 사용자가 시스템 내에 없습니다.

110 110

사용자 ID 가 필요합니다.

109 109

사용자 ID 가 적절한 형식이 아닙니다.

113 113

사용자의 ID 길이가 50자를 초과할 수 없음

N/A 304


JIRA 티켓: https://dev.highq.com/jira/browse/COL-67441

사용자 추가

이 API 호출은 시스템에 새 사용자를 추가하는 데 사용됩니다.
고:
1. 다음 새 필드에 대한 지원이 추가됨
emaildomain, org, invitationsent, createdby, createddate, modifiedby, modifieddate, ifpartner, lastlogindate, invalidlogins, externalid, publicwebsiteprofileid, systemuser, resetpassworddate, usertypeid, avatar, practicegroup, langcode, publicprofile, dateOfBirth
2. 주소 태그가 API 버전 4에 추가되었습니다.
< 주소>
1

요약 Ref 코드(V4 이전) Ref 코드(V4)

전자 메일 주소가 필요합니다.

101 101

전자 메일 주소가 잘못되었습니다.

104 104

이름은 필수입니다.

102 102

이름에 허용되는 최대 문자는 1에서 100 사이여야 합니다.

102 352

비서/비서의 이메일 주소가 잘못되었습니다.

104 353

상태는 활성 상태이거나 비활성 상태여야 합니다.

116 116

입력한 부서는 256자를 초과할 수 없습니다.

N/A 354

입력한 ifpartner 특성이 잘못되었습니다.

N/A 355

입력한 systemuser 특성이 잘못되었습니다.

N/A 356

입력한 usertypeid 특성이 잘못되었습니다.

N/A 357

입력한 langcode 특성이 잘못되었습니다.

N/A 358

입력한 sourcetype 특성이 잘못되었습니다. 유효한 값은 System, Active Directory 또는 System 기본값입니다.

N/A 359

유효한 전화 번호를 입력하세요.   

N/A 360

유효한 전화 번호를 {countrycode} ${areacode}  ${number}형식으로 입력하세요.

N/A 361

유효한 휴대폰 번호를 {countrycode}${number}형식으로 입력하세요.

N/A 362

유효한 사무실 전화 국가 코드 입력

N/A 363

사무실 전화 국가 코드는 최대 4자리를 가질 수 있습니다.

N/A 364

유효한 사무실 전화 영역 코드 입력

N/A 365

사무실 전화 영역 코드는 최대 5자리를 가질 수 있습니다.

N/A 366

사무실 전화 번호는 최대 15자리여야 합니다.

N/A 368

유효한 휴대폰 국가 코드 입력

N/A 369

휴대폰 국가 코드는 최대 4자리를 가질 수 있습니다.

N/A 372

유효한 휴대폰 번호를 입력하세요.

N/A 373

휴대폰 번호는 최대 20자리여야 합니다.

N/A 374

도메인이 없습니다.

105 105

전자 메일이 시스템에 이미 있습니다.

111 111

자체 등록 도메인의 경우 멘션 조직   

187 187

예외 도메인의 경우 멘션 조직   

115 115

조직 ID가 적절한 형식이 아닙니다.   

112 112

조직이 존재하지 않음

106 106

도메인이 다른 조직에 있음

114 114

입력한 주소 ID가 잘못되었습니다.

N/A 308

시스템에서 소셜 링크 이름을 찾을 수 없습니다.

N/A 375

소셜 링크 이름이 필요합니다.

N/A 376

소셜 링크 값이 필요합니다.

N/A 377

소셜 링크 값의 최대 문자는 1에서 500 사이여야 합니다.

N/A 378

사용자 지정 링크의 이름을 입력합니다.

N/A 379

필요한 사용자 지정 링크 값

N/A 380

사용자 지정 링크 이름의 최대 문자는 1에서 500 사이여야 합니다.

N/A 381

사용자 지정 링크 값의 최대 문자는 1에서 500 사이여야 합니다.

N/A 382

필요한 메시지 링크 이름

N/A 383

시스템에서 메시지 링크 이름을 찾을 수 없음

N/A 384

필요한 메시지 링크 값   

N/A 385

메시지 링크 값의 최대 문자는 1에서 500 사이여야 합니다.

N/A 386

소셜 링크가 비활성화됨

N/A 408

메시지 링크가 비활성화되었습니다.

N/A 409

사용자 지정 링크가 비활성화됨

N/A 410

JIRA 티켓: https://dev.highq.com/jira/browse/COL-65685

사이트 그룹 업데이트

이 API 메서드는 사이트의 기존 그룹 이름을 업데이트합니다.
이 API는 사이트의 기존 기본 사용자 그룹의 이름을 업데이트하도록 확장되었습니다.

사이트 업데이트

이 API 엔드포인트를 사용하여 기존 사이트의 세부 정보를 업데이트합니다. API는 사이트 만들기 API에 사용되는 것과 동일한 필드를 지원합니다.

이 메서드는 API 버전 10 이후를 사용하여 사이트에 추가할 여러 문제 번호를 지원합니다. "matternos" 태그는 읽기 전용인지 아닌 여러 문제 번호를 나타냅니다.

버전 18 이상: 범주(사이트 용도)가 필요합니다. 사이트 용도가 숨겨지면 메시지가 표시됩니다. 그렇지 않으면 숨겨진 사이트 용도가 사이트에 추가되지 않습니다.

이제 사이트 소유자에게도 다른 사용자를 할당할 수 있지만 사이트 참가자여야 하며 사이트 관리자보다 높은 역할이 있어야 합니다.

버전 18 이상: 사이트 소유자는 사이트에 다른 사용자를 추가할 수 있습니다.

API 버전 19부터 customPages라는 새 모듈이 도입되어 홈 모듈과 긴밀하게 결합됩니다. 홈 모듈 값이 True이면 customPages는 true이고 그 반대의 경우도 마찬가지입니다.

사이트 응답 가져오기의 모든 속성/요소는 업다이트/삽입할 수 없습니다. 읽기 전용, 업다이트 가능 또는 삽입 가능한 항목은 아래 표를 참조하세요.

사이트 추가

이 API를 사용하여 새 사이트를 만듭니다. 사이트 개체는 만들기 사이트 인터페이스에 표시되는 특성만 지원합니다.

이 API를 사용하려면 새 사이트를 만들려면 사이트 이름(및 ASP 수준에서 구성된 필수 필드)이 필요합니다.

"module" 태그는 요청 특성에 표시된 것처럼 사이트에서 구성할 다른 모듈을 나타냅니다.
"sitetemplateid" 태그를 전달하여 템플릿에서 사이트를 만들려면
     - 버전 7 미만의 경우 요청에 모듈이 지정되지 않은 경우("모듈" 태그가 전달되지 않음) 템플릿 모듈 구성이 수행됩니다. 모듈 태그가 구성과 함께 제공되는 경우 템플릿 모듈 구성을 활용하는 대신 요청에 지정된 대로 해당 태그를 준수하고 구성합니다.
     - 버전 7보다 큰 경우 요청에 모듈이 지정되었거나("모듈" 태그가 전달됨) 템플릿 모듈 구성이 수행되지 않는 경우

이 메서드는 이 호출에서 사이트 이미지 업로드를 지원하지 않으며 사이트 아이콘 지원은 별도의 호출로 제공됩니다.
메서드 호출에는 기존 범주 ID가 있어야 합니다. 범주 ID는 사이트 범주 인터페이스에 대한 이전 호출을 통해 호출 애플리케이션에서 가져와야 합니다. 요청에 범주가 지정되지 않은 경우 기본적으로 범주(실제 범주가 아님)가 추가되지 않습니다.

사이트 시작 및 종료 날짜는 'dd MMM yyyy' 형식이어야 하며 UTC가 아닙니다. API 클라이언트는 항상 실제 날짜를 요청합니다.

"landingpage"에는 기본값이 "files(루트 폴더)"입니다.
"방문 페이지"에는 파일 모듈에 대한 세 가지 다른 단어 또는 식별이 필요합니다. 가능한 값은 다음과 같습니다.
- 파일(루트 폴더)
- 파일(최근 활동)
- 파일(고급 검색)
이제 메서드 구현은 (5.1부터) 다국어 사이트 이름을 지원합니다. API 버전 6 이상 <사이트 이름은> 사용자 기본 설정 순서에 따라 요청 본문에 표시됩니다. API 버전 5 또는 이전 <사이트 이름은> 기본 영국 영어를 나타냅니다.
<sitenametranslations> 는 모든 언어의 사이트 이름(5.1 이상에서 "개체 자체 API"의 추가 태그가 될 것임) API 버전 6 이상을 요청 본문에서 두 태그(예 <: sitename> 및 <sitenametranslations> )를 모두 전송합니다. 그런 다음, 값의 유효성을 검사해야 합니다. 예를 들어 <sitename> 은 사용자의 언어 기본 설정 측면에서 각 <번역> 태그와 일치해야 합니다. API 7 이상, 템플릿에서 만든 사이트는 원본 템플릿의 모듈을 따르며 요청 본문에 전송된 모듈 목록을 무시합니다.

이제 메서드 구현은 "sitetemplateid" 태그(이전 방법)를 제공하여 템플릿에서 사이트 만들기를 지원합니다.

이 API를 사용하여 템플릿에서 사이트를 만드는 지원은 나중에 더 이상 사용되지 않습니다. 템플릿에서 사이트를 만들려면 긴 폴링 API(장기 실행 요청에 대한 지원 포함)인 템플릿(/sites/templates/{templateid}/site)에서 새 API 만들기 사이트를 사용하세요.

이 메서드는 API 버전 10 이후를 사용하여 사이트에 추가할 여러 문제 번호를 지원합니다. "matternos" 태그는 읽기 전용인지 아닌 여러 문제 번호를 나타냅니다. 이전 버전(버전 10 미만) 단일 물질 번호 "matterno"는 사이트에 존재했던 여러 물질 번호의 첫 번째 문제 수를 반영합니다.

버전 18 이상: 범주(사이트 용도)가 필요합니다. 사이트 용도가 숨겨지면 메시지가 표시됩니다. 그렇지 않으면 숨겨진 사이트 용도가 사이트에 추가되지 않습니다.

버전 17까지: 사이트 소유자는 로그인한 사용자입니다. 다른 사용자를 추가할 수 없습니다.

버전 18 이상: 사이트 소유자는 사이트에 다른 사용자를 추가할 수 있습니다.

API 버전 19부터 홈 모듈과 긴밀하게 결합된 'customPages'라는 새 모듈이 도입되었습니다. 따라서 홈 모듈 값이 True이면 customPages는 true이고 그 반대의 경우도 마찬가지입니다.

사이트에 기존 그룹 추가

이 API 메서드는 기존 시스템 그룹을 사이트에 추가합니다.
이 API는 사이트에 기존 시스템 기본 사용자 그룹(시스템/조직 유형)을 추가하도록 확장되었습니다.

파일 업로드

이 API 호출은 HighQ Collaborate 플랫폼의 지정된 폴더에 파일을 업로드합니다. Content-Range 헤더가 제공될 때 청크 분할 업로드를 지원합니다.

파일 정보 검색

이 API 호출은 HighQ 공동 작업 플랫폼에서 지정된 파일에 대한 자세한 정보를 검색합니다.

폴더 만들기

이 API는 지정된 사이트 내에 새 폴더를 만듭니다. 이를 통해 폴더 세부 정보를 제공하고 지정된 부모 폴더 아래에 폴더가 만들어지도록 할 수 있습니다.

폴더 목록 검색

이 API 호출은 지정된 폴더 내에 포함된 폴더 목록을 검색합니다. 'limit' 매개 변수는 반환할 최대 항목 수를 설정하고 'offset' 매개 변수는 데이터 검색의 시작 위치를 지정합니다. 이러한 매개 변수를 생략하고 폴더가 생성 날짜별로 오름차순으로 반환되는 경우 기본값이 적용됩니다.

폴더 정보 가져오기

이 메서드는 지정된 폴더 ID의 폴더 세부 정보를 제공합니다.

iSheet 열 검색

이 API 호출은 지정된 iSheet와 연결된 열을 검색합니다. 이 기능은 API 버전 3 이상에서 지원됩니다.

매개 변수

Name 필수 형식 Description
iSheet ID
isheetid True integer

열이 필요한 iSheet의 고유 ID를 지정합니다.

API 버전
version True string

사용 중인 API의 버전을 지정합니다.

iSheet 보기 ID
sheetviewid string

iSheet 보기의 ID를 지정합니다. 생략하면 모든 열이 반환됩니다.

삭제된 iSheet 열 포함
onlyForDeletedIsheet boolean

삭제된 iSheet의 열을 포함할지 여부를 나타냅니다. 기본값은 false입니다.

반환

columns

iSheet 항목 목록 검색

이 API 호출은 지정된 iSheet에 포함된 항목 목록을 검색합니다.

매개 변수

Name 필수 형식 Description
API 버전
version True string

사용 중인 API의 버전을 지정합니다.

iSheet ID
isheetid True integer

iSheet의 고유 ID를 지정합니다.

iSheet 보기 ID
sheetviewid integer

iSheet 보기의 ID를 지정합니다. 생략하면 기본 보기가 반환됩니다.

열 ID 정렬
sortcolumnid integer

결과를 정렬하는 데 사용되는 열의 ID를 지정합니다.

정렬 순서
sortorder integer

정렬 순서를 지정합니다. 예를 들어 오름차순으로 0을 사용하거나 내림차순으로 다른 값을 사용합니다.

레코드 제한
limit integer

반환할 최대 레코드 수를 지정합니다. 지정하지 않으면 기본값은 100입니다.

레코드 오프셋
offset integer

레코드 검색의 시작 위치를 지정합니다. 지정하지 않으면 기본값은 0입니다.

모든 열 포함
allColumnRequired boolean

현재 뷰에 관계없이 모든 열 데이터를 포함할지 여부를 나타내는 플래그입니다.

보기 제한 무시
isIgnoreView boolean

항목 데이터를 검색할 때 보기 제한을 무시할지 여부를 나타내는 플래그입니다.

반환

Name 경로 형식 Description
isheet
isheet array of object

iSheet 항목 목록입니다.

아이템 ID
isheet.itemId string

항목의 고유 ID입니다.

데이터
isheet.data array of object

항목의 자세한 데이터입니다.

식별
isheet.data.sequence string

데이터와 연결된 시퀀스 번호입니다.

columnDisplayName
isheet.data.columnDisplayName string

열의 표시 이름입니다.

value
isheet.data.value string

열에 포함된 값입니다.

iSheet 항목을 만들려면

이 API 호출은 iSheet 항목을 삽입하는 데 사용됩니다. 여러 iSheet를 지원합니다.

프로그레시브 키를 기반으로 하는 iSheet 항목의 상태를 얻으려면 API POST /api/3/progressivekeystatus/{progressive_key}를 호출합니다.

예: POST /api/{version}/progressivekeystatus/{progressive_key}

이름유형Description
progressive_keyString 작업의 상태를 확인하는 키입니다.

응답

<progressivekeyresponse>
 \t<항목>
  \t\t<항목>
   \t\t\t<itemid>1232</itemid>
   \t\t\t<상태>SUCCESS</status>
   \t\t\t<statuscode>200</statuscode>
   \t\t\t<메시지>레코드가 성공적으로< 추가됨/메시지>
  \t\t</item>
  \t\t<항목>
   \t\t\t<itemid>1233</itemid>
   \t\t\t<상태>SUCCESS</status>
   \t\t\t<statuscode>200</statuscode>
   \t\t\t<메시지>레코드가 성공적으로< 추가됨/메시지>
  \t\t</item>
 \t</items>
</progressivekeyresponse>

매개 변수

Name 필수 형식 Description
API 버전
version True string

API 버전

iSheet 식별자
isheetid True integer

iSheet의 ID

시트 뷰 식별자
sheetviewid integer

iSheet 보기의 ID(선택 사항)

아이디
id integer

Isheet 식별자입니다.

title
title string

시트의 제목입니다.

description
description string

시트에 대한 설명입니다.

status
status string

시트의 상태입니다.

accesstype
accesstype string

시트의 액세스 유형입니다.

type
type string

시트의 형식입니다.

보기 링크
viewlink string

시트를 볼 수 있는 URL 링크입니다.

allowsections
allowsections string

섹션이 허용되는지 나타냅니다.

allowlookup
allowlookup string

조회가 허용되는지 나타냅니다.

displayisheet
displayisheet string

isheet를 표시합니다.

searchasdefaultview
searchasdefaultview string

검색을 기본 보기로 설정합니다.

enableversion
enableversion string

버전을 사용하도록 설정합니다.

enablesheetalerter
enablesheetalerter string

시트 경고자를 활성화합니다.

alertercondition
alertercondition string

경고를 트리거하기 위한 조건입니다.

overrideitemmodifieddate
overrideitemmodifieddate string

승차 기간 동안 항목 수정 날짜입니다.

enablebulkinsertupdate
enablebulkinsertupdate string

대량 삽입 업데이트를 허용합니다.

fielddescriptions
fielddescriptions string

필드에 대한 설명입니다.

enablerowlocking
enablerowlocking string

행 잠금을 사용하도록 설정합니다.

setcharlimittruncatemultilinetextenabled
setcharlimittruncatemultilinetextenabled string

여러 줄 텍스트에 문자 제한 잘림을 사용하도록 설정합니다.

setcharlimittruncatemultilinetextval
setcharlimittruncatemultilinetextval string

는 잘림에 대한 문자 제한을 설정합니다.

allowchoicelistvaluesforreuse
allowchoicelistvaluesforreuse string

선택 목록 값을 다시 사용할 수 있습니다.

allowscorelistvaluesforreuse
allowscorelistvaluesforreuse string

점수 목록 값을 다시 사용할 수 있습니다.

allowIsheetComments
allowIsheetComments string

시트에 주석을 허용합니다.

shareRecordsLimit
shareRecordsLimit integer

공유 레코드에 대한 제한입니다.

shareRecordsLimitEnabled
shareRecordsLimitEnabled integer

공유 레코드 제한을 사용하도록 설정합니다.

enableIsheetAddRecordFormSharing
enableIsheetAddRecordFormSharing string

레코드 추가 양식을 공유할 수 있습니다.

allowViewBaseRendering
allowViewBaseRendering string

뷰의 기본 렌더링을 허용합니다.

칼럼
column object
recordcount
recordcount string

총 레코드 수입니다.

viewId
viewId integer

뷰의 고유 식별자입니다.

siteId
siteId integer

연결된 사이트의 식별자입니다.

사이트 이름
siteName string

사이트의 이름입니다.

sheetName
sheetName string

시트의 이름입니다.

viewName
viewName string

보기의 이름입니다.

sheetId
sheetId integer

시트의 식별자입니다.

식별
sequence string

머리글 열의 시퀀스 번호입니다.

columnValue
columnValue string

머리글 열의 값입니다.

columnTypeId
columnTypeId string

열 형식의 식별자입니다.

columnId
columnId string

열의 고유 식별자입니다.

columnTypeAlias
columnTypeAlias string

열 형식의 별칭 이름입니다.

itemsequence
itemsequence string

항목의 시퀀스 번호입니다.

itemid
itemid string

항목의 고유 식별자입니다.

externalid
externalid string

항목과 연결된 외부 식별자입니다.

columnid
columnid integer

열의 고유 식별자

이름
name string

열의 이름

type
type integer

열의 데이터 형식입니다.

systemgeneratedtype
systemgeneratedtype string

시스템 생성 형식 정보입니다.

section
section integer

열이 있는 구역 번호입니다.

description
description string

열에 대한 자세한 설명입니다.

addtodefaultview
addtodefaultview string

열이 기본 보기에 추가되었는지를 나타냅니다.

columnconditionstate
columnconditionstate string

열 조건의 상태입니다.

rowid
rowid integer

행의 식별자입니다.

columnid
columnid integer

열의 식별자입니다.

operatorid
operatorid integer

연산자의 식별자입니다.

oprand
oprand string

필터의 피연산자 값입니다.

logicaltype
logicaltype string

필터의 논리적 형식입니다.

sheetfiltervaluetypeid
sheetfiltervaluetypeid string

시트 필터 값 형식의 ID입니다.

displaytype
displaytype string

필터의 표시 유형입니다.

sourceColumnId
sourceColumnId integer

필터의 원본 열 ID입니다.

scoreConditionTypeid
scoreConditionTypeid integer

점수 조건 형식의 ID입니다.

defaultvalue
defaultvalue string

열의 기본값입니다.

columnwidth
columnwidth string

열의 너비입니다.

sheetname
sheetname string

연결된 시트의 이름입니다.

sitename
sitename string

사이트의 이름입니다.

필수
mandatory string

열이 필수인지를 나타냅니다.

allowsearch
allowsearch string

검색이 허용되는지 지정합니다.

maxchars
maxchars integer

최대 문자 수입니다.

allowfieldfromanotherisheet
allowfieldfromanotherisheet string

다른 시트의 필드를 허용합니다.

allowrichhtmltext
allowrichhtmltext string

서식 있는 HTML 텍스트가 허용되는지 지정합니다.

numberoflines
numberoflines integer

열의 줄 수입니다.

displaymethod
displaymethod string

열을 표시하는 데 사용되는 메서드입니다.

includeotheroption
includeotheroption string

'기타' 옵션을 포함합니다.

singleormultileselectioninsearch
singleormultileselectioninsearch string

검색에서 선택 유형을 지정합니다.

아이디
id string

선택에 대한 고유 식별자입니다."

label
label string

선택한 레이블입니다.

점수
score string

선택 항목과 관련된 점수입니다.

color
color string

선택한 색 코드입니다.

imageid
imageid integer

연결된 이미지의 ID입니다.

includeinalertpreferences
includeinalertpreferences string

경고 기본 설정에 포함됩니다.

min
min string

열의 최소값입니다.

max
max string

열의 최대값입니다.

decimalplaces
decimalplaces integer

소수 자릿수입니다.

showthousandseparators
showthousandseparators string

천 단위 구분 기호를 표시합니다.

showaspercentage
showaspercentage string

값을 백분율로 표시합니다.

formattype
formattype string

열의 형식 형식을 지정합니다.

dateformat
dateformat string

열의 날짜 형식을 정의합니다.

defaultdateandtime
defaultdateandtime string

열의 기본 날짜 및 시간 값을 설정합니다.

sheetlookup
sheetlookup string

열이 다른 시트에 대한 조회인지를 나타냅니다.

fielddisplay
fielddisplay string

필드가 표시되는 방식을 결정합니다.

allowmultipleusers
allowmultipleusers string

여러 사용자가 필드에 액세스할 수 있는지를 지정합니다.

methodtype
methodtype string

열의 메서드 형식을 정의합니다.

sheetids
sheetids string

열과 연결된 시트의 ID를 나열합니다.

allowuserstorenamelinks
allowuserstorenamelinks string

사용자가 열의 링크 이름을 바꿀 수 있는지를 나타냅니다.

sheetid
sheetid integer

시트의 ID를 지정합니다.

columnids
columnids string

열의 ID를 나열합니다.

viewid
viewid integer

뷰의 ID를 지정합니다.

allowmultiplevalues
allowmultiplevalues string

열에 여러 값이 허용되는지 나타냅니다.

restrictdelete
restrictdelete string

열에 대한 삭제가 제한되는지를 지정합니다.

displaycolumnnameprefix
displaycolumnnameprefix string

열 이름 표시의 접두사를 설정합니다.

linkname
linkname string

열과 연결된 링크의 이름을 정의합니다.

donotcountweekendsonlycountmontofri
donotcountweekendsonlycountmontofri string

주말이 계산에서 제외되는지를 지정합니다.

currentsheetcolumnid
currentsheetcolumnid integer

현재 시트 열의 ID입니다.

targetsheetcolumnid
targetsheetcolumnid integer

대상 시트 열의 ID입니다.

formula string

열에 적용되는 수식을 지정합니다.

startvalue
startvalue integer

열의 시작 값을 설정합니다.

prefix
prefix string

열 값의 접두사를 정의합니다.

접미사
postfix string

열 값에 대한 접두사를 정의합니다.

minlength
minlength integer

열 값의 최소 길이를 지정합니다.

lookupglossarysheetid
lookupglossarysheetid integer

조회 용어집 시트의 ID를 지정합니다.

lookupglossarysheetviewid
lookupglossarysheetviewid integer

조회 용어집 시트의 뷰 ID를 지정합니다.

width
width integer

열의 너비를 설정합니다.

otherscorevalue
otherscorevalue string

열의 다른 점수 값을 정의합니다.

importdatafromexternalsource
importdatafromexternalsource string

외부 원본에서 데이터를 가져오는지 나타냅니다.

analysisengine
analysisengine string

열에 사용되는 분석 엔진을 지정합니다.

attachmentcustomfolderid
attachmentcustomfolderid integer

첨부 파일의 사용자 지정 폴더 ID를 지정합니다.

isattachmentfoldercurrentsite
isattachmentfoldercurrentsite integer

첨부 파일 폴더가 현재 사이트에 있는지를 나타냅니다.

singleLineEmailValidation
singleLineEmailValidation string

한 줄 전자 메일 유효성 검사가 적용되는지 지정합니다.

readonly
readonly string

열이 읽기 전용인지를 나타냅니다.

virtualColumn
virtualColumn integer

열이 가상인지를 지정합니다.

allowInlineEditing
allowInlineEditing string

열에 대해 인라인 편집이 허용되는지 나타냅니다.

식별
sequence string

열의 시퀀스 번호입니다.

attributecolumnid
attributecolumnid string

특성 열 식별자입니다.

value
value string

원시 데이터의 값입니다.

date
date string

원시 데이터의 날짜입니다.

time
time string

원시 데이터의 시간입니다.

linkdisplayname
linkdisplayname string

링크 이름을 표시합니다.

linkdisplayurl
linkdisplayurl string

URL 링크를 표시합니다.

아이디
id string

조회 ID

메일 주소
email string

이메일 주소.

userlookuptype
userlookuptype string

사용자 조회 유형입니다.

folderid
folderid string

폴더 ID입니다.

docid
docid string

문서 ID입니다.

fromdate
fromdate string

날짜부터.

todate
todate string

현재까지.

file
file string

파일 콘텐츠입니다.

이름
name string

첨부 파일의 이름입니다.

order
order string

첨부 파일의 순서입니다.

아이디
id integer

첨부 파일의 고유 식별자입니다.

확장
extension string

파일 확장명입니다.

parentfolderid
parentfolderid integer

부모 폴더의 ID입니다.

filehttplink
filehttplink string

파일에 액세스하기 위한 HTTP 링크입니다.

folderpath
folderpath string

파일이 포함된 폴더의 경로입니다.

folderhttplink
folderhttplink string

폴더에 대한 HTTP 링크입니다.

filesize
filesize integer

파일의 크기(바이트)입니다.

redactionStatus
redactionStatus boolean

파일이 수정되었는지를 나타냅니다.

displayname
displayname string

첨부 파일의 표시 이름입니다.

siteid
siteid integer

첨부 파일과 연결된 사이트의 ID입니다.

레코드 ID
recordid string

레코드 ID입니다.

linkname
linkname string

링크 이름입니다.

apilink
apilink string

API 링크.

httplink
httplink string

HTTP 링크입니다.

colViewPosition
colViewPosition integer

보기에서 열의 위치입니다.

columntype
columntype string

열의 형식입니다.

생성일
createdDate date-time

열을 만든 날짜 및 시간입니다.

modifiedDate
modifiedDate date-time

열이 마지막으로 수정된 날짜 및 시간입니다.

injectReferenceColumn
injectReferenceColumn integer

삽입된 열에 대한 참조

parentColumnID
parentColumnID integer

부모 열의 식별자입니다.

reusecolumnidfromisheet
reusecolumnidfromisheet integer

입력 시트에서 다시 사용한 열 ID입니다.

choicelistid
choicelistid integer

열과 연결된 선택 목록의 식별자입니다.

alerteroption
alerteroption string

항목에 대한 경고 옵션 설정입니다.

sheettypeid
sheettypeid integer

시트 형식의 식별자입니다.

enableSmartForm
enableSmartForm string

스마트 양식 기능을 활성화합니다.

allowDeletedItemsView
allowDeletedItemsView string

삭제된 항목을 볼 수 있습니다.

allowAllColumnsInCustomView
allowAllColumnsInCustomView string

사용자 지정 보기의 모든 열을 허용합니다.

반환

문서 이동

이 API는 여러 파일을 한 폴더에서 동일한 사이트 내의 다른 폴더로 이동합니다.

매개 변수

Name 필수 형식 Description
API 버전
version True string

API 버전을 지정합니다.

대상 폴더 ID
targetfolder True string

파일을 이동할 대상 폴더의 고유 식별자입니다.

fileidCSV
fileidCSV string

이동할 파일 ID의 쉼표로 구분된 목록입니다.

사용자 목록 검색

사용자 목록을 검색합니다. 이 API는 시스템에서 사용자 목록을 검색합니다. ## 주요 기능 - 여러 필터링 옵션을 사용하여 사용자 세부 정보 가져오기 - 최근 버전에 도입된 새 쿼리 매개 변수 및 limit 필드를 사용하여 페이지 매 offset 김을 지원합니다. - 사용자 역할 및 특성을 사용한 구조적 응답 ## 새 쿼리 매개 변수(Version-Specific) - V12에 도입됨: - systemAdminSearch: 로 설정1하면 시스템 관리자 역할이 있는 사용자만 반환합니다. - V18에서 도입: - userid쉼표로 구분된 값(CSV)을 허용합니다. ## 응답 본문 업데이트 - 새 필드가 추가되었습니다. - ,emaildomain, org,invitationsentcreatedby, createddate,modifiedbymodifieddate - ifpartnerlastlogindateinvalidloginsexternalidpublicwebsiteprofileid - systemuserresetpassworddateusertypeidavatarpracticegroup - langcodepublicprofiledateOfBirth, ## 주소 형식 변경(V11에서) - 태그의 location 이름이 일관성을 위해 address 변경되었습니다. - 응답 예제: xml <address> <addressid>1</addressid> <addressline1>2nd floor</addressline1> <addressline2>additional</addressline2> <city>London</city> <state>state</state> <country>UK</country> <postCode>EC4R</postCode> </address> ## 사용자 역할(API V11 이상에 도입됨) - 응답 예제: xml <roles> <role> <alias>SYSTEM_ADMIN</alias> <name>System Admin</name> </role> <role> <alias>EXTERNAL_ADMIN</alias> <name>External Admin</name> </role> <role> <alias>INTERNAL_USER</alias> <name>Internal User</name> </role> </roles> ## 제한 및 오프셋 - 제한 동작: - 기본값: 100 값이 제공되지 않은 경우. - 모든 레코드를 반환하는 데 사용합니다 -1 . - 값이 보다 -1작으면 기본값은 .입니다 100. - 오프셋 동작: - 기본값: 0 값이 제공되지 않은 경우 - 오프셋이 총 레코드를 초과하는 경우 기본값은 다시 0. ## 새 역할 소개 - V12: Basic User, Allow user to bypass XSS protection - V14: Allow user to manage Contract Express system groups ## 오류 코드 | 요약 | Ref 코드(V4 이전) | Ref Code(V4) | |---------|----------------------|--------------| | 사용자 상태에 대한 잘못된 입력(ACTIVE, ARCHIVED, INACTIVE) | 147 | 147 | | 조직 ID가 잘못되었습니다. | 해당하지 않습니다. | 260 | | 잘못된 neverinvited 값(true/false) | 해당하지 않습니다. | 387 | | 잘못된 neverlogin 값(true/false) | 해당하지 않습니다. | 388 | | 잘못된 groupids 값 | 해당하지 않습니다. | 214 | | 잘못된 notingroup 값(true/false) | 해당하지 않습니다. | 389 | | 유효하지 않음 ordertype (지원됨: 이름, 조직, 상태 등) | 해당하지 않습니다. | 289 | | 잘못됨 orderby (지원됨: asc, desc) | 해당하지 않습니다. | 290 | | 잘못된 offset 값 | 138 | 138 | | 잘못된 limit 값 | 137 | 137 | ## 참고 - V13 이상부터 이 API는 모든 사용자(이전에 시스템 관리자로 제한됨)에 대해 열려 있습니다. - V18부터 userregistered2FA 필드는 사용자가 2FA에 등록했는지 여부를 나타냅니다. --- 이 설명은 Swagger 2.0 스키마 서식을 따르며 사용자 지정 커넥터 스키마의 설명 필드에 배치되어야 합니다.

매개 변수

Name 필수 형식 Description
API 버전
version True string

API의 버전입니다.

사용자 상태
status string

활성, 보관됨, 비활성 또는 잠금 상태별로 사용자를 필터링합니다.

페이지 매김 오프셋
offset string

페이지 매김의 시작 위치입니다.

결과 제한
limit string

요청당 반환할 항목 수입니다.

조직 ID
orgid string

조직 ID별로 사용자를 필터링합니다.

초대되지 않은 사용자
neverinvited string

초대된 적이 없는 사용자를 검색합니다.

로그인하지 않은 사용자
neverlogin string

로그인한 적이 없는 사용자를 검색합니다.

사용자 ID
userid string

고유한 사용자 ID로 사용자를 필터링합니다.

그룹 아이디
groupid string

그룹 ID별로 사용자를 필터링합니다.

그룹에 없는 사용자
notingroup string

그룹에 없는 사용자를 검색합니다.

정렬 순서 유형
ordertype string

이름, 조직 또는 상태와 같은 지정된 필드를 기준으로 사용자를 정렬합니다.

정렬 순서
orderby string

정렬 결과를 오름차순 또는 내림차순으로 정렬합니다.

외부 식별자
externalid string

외부 ID로 사용자를 필터링합니다.

이름 (First Name)
firstname string

이름을 사용하여 사용자를 필터링합니다.

성 이름
lastname string

성을 사용하여 사용자를 필터링합니다.

이메일 주소
email string

전자 메일 주소로 사용자를 필터링합니다.

사용자 검색
search string

이름, 전자 메일 및 직함 등 다양한 특성으로 사용자를 검색합니다.

알파벳 필터
alphabets string

성이 특정 문자로 시작하는 사용자를 필터링합니다.

직위
jobtitle string

직할별로 사용자를 필터링합니다.

위치
locations string

도시별로 사용자를 필터링합니다.

부서
departments string

부서별로 사용자를 필터링합니다.

조직 이름
organisations string

조직 이름으로 사용자를 필터링합니다.

특선 요리
specialities string

전문 분야별로 사용자를 필터링합니다.

시스템 관리자 검색
systemAdminSearch string

시스템 관리자 역할을 가진 사용자를 검색합니다.

반환

users

사용자 보관

이 API 호출은 시스템 내에서 사용자를 보관하는 데 사용됩니다.

오류 코드

요약 Ref 코드(V4 이전) Ref 코드(V4)

다음 사용자가 시스템 내에 없습니다.

110 110

사용자 ID 가 필요합니다.

109 109

사용자 ID 가 적절한 형식이 아닙니다.

113 113

사용자의 ID 길이가 50자를 초과할 수 없음

N/A 304


JIRA 티켓: https://dev.highq.com/jira/browse/COL-67441

매개 변수

Name 필수 형식 Description
API 버전
version True string

api 버전

사용자 ID
userid True string

사용자 ID

사용자 추가

이 API 호출은 시스템에 새 사용자를 추가하는 데 사용됩니다.
고:
1. 다음 새 필드에 대한 지원이 추가됨
emaildomain, org, invitationsent, createdby, createddate, modifiedby, modifieddate, ifpartner, lastlogindate, invalidlogins, externalid, publicwebsiteprofileid, systemuser, resetpassworddate, usertypeid, avatar, practicegroup, langcode, publicprofile, dateOfBirth
2. 주소 태그가 API 버전 4에 추가되었습니다.
< 주소>
1

요약 Ref 코드(V4 이전) Ref 코드(V4)

전자 메일 주소가 필요합니다.

101 101

전자 메일 주소가 잘못되었습니다.

104 104

이름은 필수입니다.

102 102

이름에 허용되는 최대 문자는 1에서 100 사이여야 합니다.

102 352

비서/비서의 이메일 주소가 잘못되었습니다.

104 353

상태는 활성 상태이거나 비활성 상태여야 합니다.

116 116

입력한 부서는 256자를 초과할 수 없습니다.

N/A 354

입력한 ifpartner 특성이 잘못되었습니다.

N/A 355

입력한 systemuser 특성이 잘못되었습니다.

N/A 356

입력한 usertypeid 특성이 잘못되었습니다.

N/A 357

입력한 langcode 특성이 잘못되었습니다.

N/A 358

입력한 sourcetype 특성이 잘못되었습니다. 유효한 값은 System, Active Directory 또는 System 기본값입니다.

N/A 359

유효한 전화 번호를 입력하세요.   

N/A 360

유효한 전화 번호를 {countrycode} ${areacode}  ${number}형식으로 입력하세요.

N/A 361

유효한 휴대폰 번호를 {countrycode}${number}형식으로 입력하세요.

N/A 362

유효한 사무실 전화 국가 코드 입력

N/A 363

사무실 전화 국가 코드는 최대 4자리를 가질 수 있습니다.

N/A 364

유효한 사무실 전화 영역 코드 입력

N/A 365

사무실 전화 영역 코드는 최대 5자리를 가질 수 있습니다.

N/A 366

사무실 전화 번호는 최대 15자리여야 합니다.

N/A 368

유효한 휴대폰 국가 코드 입력

N/A 369

휴대폰 국가 코드는 최대 4자리를 가질 수 있습니다.

N/A 372

유효한 휴대폰 번호를 입력하세요.

N/A 373

휴대폰 번호는 최대 20자리여야 합니다.

N/A 374

도메인이 없습니다.

105 105

전자 메일이 시스템에 이미 있습니다.

111 111

자체 등록 도메인의 경우 멘션 조직   

187 187

예외 도메인의 경우 멘션 조직   

115 115

조직 ID가 적절한 형식이 아닙니다.   

112 112

조직이 존재하지 않음

106 106

도메인이 다른 조직에 있음

114 114

입력한 주소 ID가 잘못되었습니다.

N/A 308

시스템에서 소셜 링크 이름을 찾을 수 없습니다.

N/A 375

소셜 링크 이름이 필요합니다.

N/A 376

소셜 링크 값이 필요합니다.

N/A 377

소셜 링크 값의 최대 문자는 1에서 500 사이여야 합니다.

N/A 378

사용자 지정 링크의 이름을 입력합니다.

N/A 379

필요한 사용자 지정 링크 값

N/A 380

사용자 지정 링크 이름의 최대 문자는 1에서 500 사이여야 합니다.

N/A 381

사용자 지정 링크 값의 최대 문자는 1에서 500 사이여야 합니다.

N/A 382

필요한 메시지 링크 이름

N/A 383

시스템에서 메시지 링크 이름을 찾을 수 없음

N/A 384

필요한 메시지 링크 값   

N/A 385

메시지 링크 값의 최대 문자는 1에서 500 사이여야 합니다.

N/A 386

소셜 링크가 비활성화됨

N/A 408

메시지 링크가 비활성화되었습니다.

N/A 409

사용자 지정 링크가 비활성화됨

N/A 410

JIRA 티켓: https://dev.highq.com/jira/browse/COL-65685

매개 변수

Name 필수 형식 Description
API 버전
version True string

api 버전

index
index integer

사용자의 고유 인덱스입니다.

userid
userid integer

사용자의 고유 식별자입니다.

이름
firstname string

사용자의 이름입니다.

lastname
lastname string

사용자의 성입니다.

practicegroup
practicegroup string

사용자가 속한 연습 그룹입니다.

langcode
langcode string

사용자의 언어 코드입니다.

localeID
localeID string

사용자의 로캘 ID입니다.

publicprofile
publicprofile string

사용자의 공개 프로필입니다.

pwpid
pwpid string

사용자의 PWP ID입니다.

usertypeid
usertypeid string

사용자 유형 ID입니다.

systemuser
systemuser string

시스템 사용자 플래그입니다.

메일 주소
email string

사용자의 Email 주소입니다.

phone
phone string

사용자의 전화 번호입니다.

mobile
mobile string

사용자의 휴대폰 번호입니다.

부서
department string

사용자의 부서입니다.

org
org string

사용자가 속한 조직입니다.

addressline1
addressline1 string

주소의 첫 줄입니다.

addressline2
addressline2 string

주소의 두 번째 줄입니다.

addressline3
addressline3 string

주소의 세 번째 줄입니다.

city
city string

주소의 구/군/시입니다.

state string

주소의 상태입니다.

country
country string

주소의 국가입니다.

우편 번호
postcode string

주소의 우편 번호입니다.

addressid
addressid string

주소의 고유 식별자입니다.

addressline1
addressline1 string

주소의 첫 줄입니다.

addressline2
addressline2 string

주소의 두 번째 줄입니다.

addressline3
addressline3 string

주소의 세 번째 줄입니다.

city
city string

주소의 구/군/시입니다.

state string

주소의 상태입니다.

country
country string

주소의 국가입니다.

우편 번호
postCode string

주소의 우편 번호입니다.

knownas
knownas string

주소의 대체 이름 또는 애칭입니다.

경험
experience array of string
아이디
id string

링크 ID

이름
name string

링크 이름입니다.

value
value string

링크 값입니다.

아이디
id string

링크 ID

이름
name string

링크 이름입니다.

value
value string

링크 값입니다.

아이디
id string

링크 ID

이름
name string

링크 이름입니다.

value
value string

링크 값입니다.

img
img string
reportsto
reportsto string
메타데이터 이름
metadataname array of string
metadatavalue
metadatavalue array of string
group
group array of string
externalid
externalid string

사용자의 외부 ID입니다.

jobtitle
jobtitle string

사용자의 직호입니다.

비서 이름
secretaryname string

사용자의 비서 이름입니다.

secretarymail
secretarymail string

사용자 비서의 전자 메일입니다.

특선 요리
specialities string

사용자의 특수성입니다.

title
title string

사용자의 제목입니다.

goesby
goesby string

사용자의 기본 설정 이름입니다.

접미사
suffix string

사용자 이름의 접미사입니다.

atomlink
atomlink string

사용자와 연결된 Atom 링크입니다.

바이오
bio string

사용자의 전기입니다.

dateOfBirth
dateOfBirth string

사용자의 생년월일입니다.

link
link string

사용자와 연결된 링크입니다.

status
status string

사용자의 상태입니다.

상태 코드
statuscode string

사용자의 상태 코드입니다.

message
message string

사용자와 연결된 메시지입니다.

sourcetype
sourcetype string

사용자의 원본 유형입니다.

orgid
orgid string

조직 ID입니다.

ifpartner
ifpartner string

파트너 플래그입니다.

emaildomain
emaildomain string

사용자의 전자 메일 도메인입니다.

초대
invitationsent string

초대 보낸 플래그입니다.

만든 사람
createdby string

레코드를 만든 사용자입니다.

createddate
createddate string

레코드를 만든 날짜입니다.

수정자
modifiedby string

레코드를 수정한 사용자입니다.

modifieddate
modifieddate string

레코드가 수정된 날짜입니다.

lastlogindate
lastlogindate string

마지막 로그인 날짜입니다.

invalidlogins
invalidlogins string

잘못된 로그인 시도 횟수입니다.

publicwebsiteprofileid
publicwebsiteprofileid string

공개 웹 사이트 프로필 ID입니다.

resetpassworddate
resetpassworddate string

암호를 재설정한 날짜입니다.

아바타
avatar string

아바타 이미지 URL입니다.

followingcount
followingcount integer

팔로우 중인 사용자 수입니다.

followercount
followercount integer

팔로워 수입니다.

다음
following boolean

다음 플래그입니다.

역할
role string

사용자의 역할입니다.

isbasicuser
isbasicuser string

기본 사용자 플래그입니다.

encryptedUserId
encryptedUserId string

암호화된 사용자 ID입니다.

자체 등록됨
selfregistered integer

자체 등록 플래그입니다.

registeredWith2FA
registeredWith2FA string

2단계 인증 등록 플래그입니다.

내부입니다
isInternal integer

내부 사용자 플래그입니다.

orgName
orgName string

조직 이름

반환

사이트 그룹 업데이트

이 API 메서드는 사이트의 기존 그룹 이름을 업데이트합니다.
이 API는 사이트의 기존 기본 사용자 그룹의 이름을 업데이트하도록 확장되었습니다.

매개 변수

Name 필수 형식 Description
API 버전
version True string

version

사이트의 ID
siteid True string

사이트의 ID입니다.

API 버전
groupid True string
The ID of the site group.
이름
name string
아이디
id integer
copypermissionsfrom
copypermissionsfrom string
message
message string
typeID
typeID integer
type
type string
numberofusers
numberofusers string
만든
created string
modified
modified string
systemGroupID
systemGroupID integer
description
description string
basicusergroup
basicusergroup integer

반환

sitegroup

사이트 업데이트

이 API 엔드포인트를 사용하여 기존 사이트의 세부 정보를 업데이트합니다. API는 사이트 만들기 API에 사용되는 것과 동일한 필드를 지원합니다.

이 메서드는 API 버전 10 이후를 사용하여 사이트에 추가할 여러 문제 번호를 지원합니다. "matternos" 태그는 읽기 전용인지 아닌 여러 문제 번호를 나타냅니다.

버전 18 이상: 범주(사이트 용도)가 필요합니다. 사이트 용도가 숨겨지면 메시지가 표시됩니다. 그렇지 않으면 숨겨진 사이트 용도가 사이트에 추가되지 않습니다.

이제 사이트 소유자에게도 다른 사용자를 할당할 수 있지만 사이트 참가자여야 하며 사이트 관리자보다 높은 역할이 있어야 합니다.

버전 18 이상: 사이트 소유자는 사이트에 다른 사용자를 추가할 수 있습니다.

API 버전 19부터 customPages라는 새 모듈이 도입되어 홈 모듈과 긴밀하게 결합됩니다. 홈 모듈 값이 True이면 customPages는 true이고 그 반대의 경우도 마찬가지입니다.

사이트 응답 가져오기의 모든 속성/요소는 업다이트/삽입할 수 없습니다. 읽기 전용, 업다이트 가능 또는 삽입 가능한 항목은 아래 표를 참조하세요.

매개 변수

Name 필수 형식 Description
요청되는 API의 버전
version True string

api 버전

사이트의 고유 식별자입니다.
siteid True string

사이트의 ID입니다.

아이디
id integer

사이트 식별자입니다.

sitename
sitename string

사이트의 이름입니다.

역할
role string

사이트의 역할입니다.

sitedescription
sitedescription string

사이트에 대한 설명입니다.

enabledmodules
enabledmodules string

사이트에 대해 사용하도록 설정된 모듈 목록입니다.

sitefolderID
sitefolderID string

사이트 폴더의 식별자입니다.

sitefolderpermission
sitefolderpermission string

사이트 폴더에 대한 사용 권한 수준입니다.

enable
enable string

HomeDBO에 대한 상태를 사용하도록 설정합니다.

enable
enable string

ActivityDBO에 대한 상태를 사용하도록 설정합니다.

microblog
microblog string

ActivityDBO와 연결된 마이크로 블로그 콘텐츠입니다.

docid
docid string

문서 ID입니다.

blogTitle
blogTitle string

블로그 게시물의 제목입니다.

blogContent
blogContent string

블로그 게시물의 콘텐츠입니다.

showComment
showComment integer

주석을 표시합니다.

태그 목록
tagList array of string

블로그와 연결된 태그 목록입니다.

status
status integer

블로그 게시물의 상태입니다.

siteID
siteID integer

연결된 사이트의 식별자입니다.

저자
author string

블로그 작성자입니다.

categoryList
categoryList array of string

블로그 게시물에 할당된 범주입니다.

notificationTypeID
notificationTypeID integer

알림 유형에 대한 식별자입니다.

message
message string

블로그와 관련된 메시지 콘텐츠입니다.

messageCode
messageCode integer

메시지와 연결된 코드입니다.

외부 ID
externalID string

블로그에 연결된 외부 식별자입니다.

게시날짜
publishDate string

블로그의 게시 날짜입니다.

processtype
processtype string

블로그와 연결된 프로세스 유형입니다.

enable
enable string

BlogDBO에 대한 상태를 사용하도록 설정합니다.

wikiid
wikiid integer

Wiki의 고유 식별자입니다.

currentversionid
currentversionid integer

위키의 현재 버전 식별자

parentwikiid
parentwikiid integer

부모 위키의 식별자입니다.

wikititle
wikititle string

위키의 제목입니다.

wikicontent
wikicontent string

위키의 내용입니다.

showcomment
showcomment integer

주석을 사용할 수 있는지 여부를 나타냅니다.

createddate
createddate string

위키의 생성 날짜입니다.

modifieddate
modifieddate string

위키의 마지막 수정 날짜입니다.

taglist
taglist string

wiki와 연결된 태그의 쉼표로 구분된 목록입니다.

wikipath
wikipath string

위키에 액세스하는 경로입니다.

wikidraftid
wikidraftid integer

Wiki 초안 버전의 식별자입니다.

drafttype
drafttype string

위키와 연결된 초안의 유형입니다.

status
status integer

위키의 현재 상태입니다.

wikiversionid
wikiversionid integer

위키의 버전 식별자입니다.

index
index string

작업의 인덱스 또는 식별자입니다.

parenttaskid
parenttaskid integer

부모 작업의 식별자입니다.

taskid
taskid integer

작업에 대한 고유 식별자입니다.

title
title string

작업의 제목입니다.

description
description string

작업에 대한 자세한 설명입니다.

duedate
duedate string

작업 완료 기한입니다.

startdate
startdate string

작업이 시작된 시작 날짜입니다.

mattermaptaskid
mattermaptaskid string

문제 맵 작업에 연결하는 식별자입니다.

type
type string

작업의 유형 또는 범주입니다.

dependenton
dependenton string

이 태스크가 사용하는 작업입니다.

daysfromdependent
daysfromdependent string

종속 작업의 일 수입니다.

ignoreweekend
ignoreweekend integer

예약에서 주말이 무시되는지를 나타냅니다.

duration
duration integer

작업을 완료하는 기간입니다.

resource
resource string

작업에 할당된 리소스입니다.

eventTitle
eventTitle string

이벤트의 제목입니다.

eventContent
eventContent string

이벤트의 콘텐츠입니다.

showComment
showComment integer

이벤트에 대한 주석을 사용할 수 있는지 여부를 나타냅니다.

태그 목록
tagList array of string

이벤트와 연결된 태그 목록입니다.

status
status integer

이벤트의 현재 상태입니다.

siteID
siteID integer

사이트의 식별자입니다.

접촉
contact string

이벤트에 대한 연락처 정보입니다.

categoryList
categoryList array of string

이벤트가 나열되는 범주입니다.

notificationTypeID
notificationTypeID integer

이벤트와 관련된 알림 유형입니다.

message
message string

이벤트의 메시지입니다.

messageCode
messageCode integer

이벤트의 메시지 코드입니다.

외부 ID
externalID string

외부 식별자입니다.

startDate
startDate string

이벤트의 시작 날짜입니다.

종료일
endDate string

이벤트의 종료 날짜입니다.

startTime
startTime string

이벤트의 시작 시간입니다.

endTime 사이에서
endTime string

이벤트의 종료 시간입니다.

location
location string

이벤트의 위치입니다.

저자
author string

이벤트의 작성자입니다.

processtype
processtype string

이벤트의 프로세스 시간입니다.

enable
enable string

Enable의 이벤트입니다.

아이디
id integer

iSheet의 고유 식별자입니다.

title
title string

iSheet의 제목입니다.

description
description string

isheet에 대한 설명입니다.

status
status string

isheet의 상태입니다.

accesstype
accesstype string

isheet의 액세스 유형입니다.

type
type string

isheet의 형식입니다.

보기 링크
viewlink string

iSheet를 보려면 링크입니다.

allowsections
allowsections string

섹션 허용 여부입니다.

allowlookup
allowlookup string

조회 필드가 사용되는지 여부입니다.

displayisheet
displayisheet string

iSheet에 대한 옵션을 표시합니다.

searchasdefaultview
searchasdefaultview string

검색이 기본 보기인지를 나타냅니다.

enableversion
enableversion string

버전 관리 사용 플래그입니다.

enablesheetalerter
enablesheetalerter string

시트 경고를 사용하도록 설정하는 플래그입니다.

alertercondition
alertercondition string

경고를 트리거하기 위한 조건입니다.

overrideitemmodifieddate
overrideitemmodifieddate string

수정된 날짜 플래그를 재정의합니다.

enablebulkinsertupdate
enablebulkinsertupdate string

대량 삽입/업데이트를 사용하도록 설정합니다.

fielddescriptions
fielddescriptions string

iSheet에 대한 필드 설명입니다.

enablerowlocking
enablerowlocking string

행 수준 잠금을 사용하도록 설정합니다.

setcharlimittruncatemultilinetextenabled
setcharlimittruncatemultilinetextenabled string

여러 줄 텍스트 플래그를 자립니다.

setcharlimittruncatemultilinetextval
setcharlimittruncatemultilinetextval string

여러 줄 잘림에 대한 문자 제한입니다.

allowchoicelistvaluesforreuse
allowchoicelistvaluesforreuse string

선택 목록 값을 다시 사용할 수 있습니다.

allowscorelistvaluesforreuse
allowscorelistvaluesforreuse string

점수 목록 값을 다시 사용할 수 있습니다.

allowIsheetComments
allowIsheetComments string

iSheet에서 메모를 허용합니다.

shareRecordsLimit
shareRecordsLimit integer

공유할 수 있는 레코드 제한입니다.

shareRecordsLimitEnabled
shareRecordsLimitEnabled integer

사용 가능한 레코드 공유 제한

enableIsheetAddRecordFormSharing
enableIsheetAddRecordFormSharing string

레코드를 추가하기 위해 양식 공유를 사용하도록 설정합니다.

recordcount
recordcount string

현재 레코드 수입니다.

sheettypeid
sheettypeid integer

iSheet의 형식 ID

enable
enable string

QA 기능을 사용하도록 설정합니다.

userid
userid integer

사용자 ID.

메일 주소
email string

전자 메일 주소입니다.

httpavatar
httpavatar string

아바타의 HTTP URL입니다.

아바타
avatar string

아바타 이미지입니다.

userlink
userlink string

사용자 프로필에 연결합니다.

httplink
httplink string

사용자 프로필에 대한 HTTP 링크입니다.

phone
phone string

전화번호.

mobile
mobile string

휴대폰 번호입니다.

부서
department string

사용자의 부서입니다.

enable
enable string

Contract Express 통합을 사용하도록 설정합니다.

adminnote
adminnote string

사이트와 관련된 관리 참고 사항입니다.

startdate
startdate string

사이트 작업의 시작 날짜입니다.

enddate
enddate string

사이트 작업의 종료 날짜입니다.

createddate
createddate string

사이트를 만든 날짜입니다.

archiveddate
archiveddate string

사이트가 보관된 날짜입니다.

clientno
clientno string

사이트와 연결된 클라이언트 번호입니다.

matterno
matterno string

사이트와 연결된 문제 번호입니다.

방문 페이지
landingpage string

사이트의 방문 페이지 URL입니다.

link
link string

사이트와 관련된 링크입니다.

status
status string

사이트의 현재 상태입니다.

statusid
statusid integer

사이트 상태에 대한 식별자입니다.

size
size string

사이트의 크기입니다.

billingnotes
billingnotes string

사이트에 대한 청구와 관련된 참고 사항입니다.

billingnextinvoicedate
billingnextinvoicedate string

사이트에 대한 다음 청구서의 날짜입니다.

billinglastinvoicedate
billinglastinvoicedate string

사이트에 대한 마지막 청구서의 날짜입니다.

filepagecount
filepagecount string

사이트에 있는 파일의 총 페이지 수입니다.

maxpagecount
maxpagecount string

사이트의 파일에 허용되는 최대 페이지 수입니다.

sitehttplink
sitehttplink string

사이트에 대한 HTTP 링크입니다.

isSyncable
isSyncable integer

사이트를 동기화할 수 있는지를 나타냅니다.

enforceusergroups
enforceusergroups string

사이트에 적용된 사용자 그룹입니다.

csvSiteCategory
csvSiteCategory string

CSV 형식의 사이트 범주입니다.

siteNameInDefaultLanguage
siteNameInDefaultLanguage string

기본 언어로 된 사이트의 이름입니다.

보이는
visible integer

사이트가 표시되는지 나타냅니다.

siteLogoName
siteLogoName string

사이트 로고 파일의 이름입니다.

siteLogoFileSize
siteLogoFileSize integer

사이트 로고의 파일 크기입니다.

siteLogoHeight
siteLogoHeight integer

사이트 로고의 높이입니다.

siteLogoWidth
siteLogoWidth integer

사이트 로고의 너비입니다.

siteStatus
siteStatus integer

사이트의 상태 코드입니다.

applySiteTerms
applySiteTerms integer

사이트 용어가 적용되는지 나타냅니다.

siteTerm
siteTerm string

사이트에 적용된 용어입니다.

termType
termType integer

사이트에 적용되는 용어의 유형입니다.

nextLoginSiteTerms
nextLoginSiteTerms integer

다음 로그인에 사이트 용어가 필요한지 나타냅니다.

defaultSiteTermsEnable
defaultSiteTermsEnable integer

기본 사이트 용어를 사용할 수 있는지를 나타냅니다.

advancedQAPermission
advancedQAPermission integer

사이트에 대한 고급 QA 권한 수준입니다.

내부입니다
isInternal integer

사이트가 내부인지를 나타냅니다.

psm
psm integer

Product Service Manager 식별자입니다.

siteLabelDisplay
siteLabelDisplay string

사이트의 표시 레이블입니다.

allowSiteAdministration
allowSiteAdministration integer

사이트 관리가 허용되는지 여부를 나타냅니다.

siteLevelPasswordEnable
siteLevelPasswordEnable integer

사이트 수준 암호 보호를 사용하도록 설정하려면

siteLevelPasscodeEnable
siteLevelPasscodeEnable integer

사이트 수준 암호 보호를 사용하도록 설정하려면

passcodeUsingAuthApp
passcodeUsingAuthApp integer

암호 인증이 인증 앱을 사용하는지 나타냅니다.

sitePassword
sitePassword string

사이트와 연결된 암호입니다.

ipRestrictionEnable
ipRestrictionEnable integer

사이트 액세스에 대한 IP 제한을 사용하도록 설정합니다.

availableIP
availableIP string

사이트에 액세스할 수 있는 IP 주소의 쉼표로 구분된 목록입니다.

highqDrive
highqDrive integer

HighQ Drive 통합을 사용할 수 있는지를 나타냅니다.

applySiteHomePage
applySiteHomePage integer

사이트에 대한 사용자 지정 홈페이지를 적용하려면

siteHomePage
siteHomePage string

사이트에 대한 사용자 지정 홈페이지의 URL입니다.

siteHomePageType
siteHomePageType integer

홈페이지의 유형입니다.

nextLoginSiteHomePage
nextLoginSiteHomePage integer

다음 로그인을 사이트 홈페이지로 설정하려면

applyDisplayContent
applyDisplayContent integer

표시 콘텐츠 설정을 적용하려면

displayContent
displayContent string

사이트에 표시할 콘텐츠입니다.

rssSecurity
rssSecurity integer

RSS 피드 보안 수준입니다.

암호화된 비밀번호
encryptedPassword integer

사이트 암호가 암호화되었는지를 나타냅니다.

availableIPRangeCSV
availableIPRangeCSV string

사이트에 액세스할 수 있는 IP 주소 범위의 쉼표로 구분된 목록입니다.

siteModuleID
siteModuleID integer

사이트 모듈의 식별자입니다.

icalSecurity
icalSecurity integer

iCal 피드 보안 수준입니다.

defaultDisplayContent
defaultDisplayContent string

사이트에 표시할 기본 콘텐츠입니다.

defaultEmailAlert
defaultEmailAlert integer

기본 전자 메일 경고를 사용하도록 설정하려면

excelReportFooter
excelReportFooter integer

Excel 보고서에 바닥글을 포함합니다.

excelReportFooterText
excelReportFooterText string

Excel 보고서의 바닥글에 표시할 텍스트입니다.

announcementMLJSON
announcementMLJSON string

사이트에 대한 JSON 형식 공지 사항입니다.

템플릿 유형
templateType integer

사이트에 사용되는 서식 파일의 유형입니다.

templateLicence
templateLicence integer

사이트 서식 파일의 라이선스 유형입니다.

openChannelAppID
openChannelAppID string

열린 채널 통합에 대한 애플리케이션 ID입니다.

itemid
itemid integer

사이트와 연결된 항목의 식별자입니다.

sitemetadatasheetid
sitemetadatasheetid integer

사이트와 연결된 메타데이터 시트의 ID입니다.

mysite
mysite boolean

사용자의 개인 사이트인지를 나타냅니다.

lastaccesseddate
lastaccesseddate string

사이트에 마지막으로 액세스한 날짜 및 시간입니다.

defaultViewerMetaDataTab
defaultViewerMetaDataTab integer

사이트 뷰어의 기본 메타데이터 탭입니다.

documentMetadataViewId
documentMetadataViewId integer

뷰 식별자에 대한 문서 메타데이터입니다.

folderMetadataViewId
folderMetadataViewId integer

뷰 식별자에 대한 폴더 메타데이터입니다.

docSort
docSort integer

문서의 정렬 순서입니다.

folderSort
folderSort integer

폴더의 정렬 순서입니다.

defaultFolderRenderView
defaultFolderRenderView integer

폴더의 기본 보기 모드를 결정합니다.

isTaskAttachmentDefault
isTaskAttachmentDefault integer

작업 첨부 파일의 기본 위치입니다.

taskAttachmentDefaultFolderId
taskAttachmentDefaultFolderId integer

작업 첨부 파일의 기본 위치로 지정된 폴더의 고유 식별자입니다.

좋아하는
favourite string

즐겨찾기 상태.

enabledocumentredaction
enabledocumentredaction boolean

사이트에 대해 문서 편집을 사용할 수 있는지 여부를 지정합니다.

멘션 그룹
mentiongroups integer

언급된 그룹입니다.

enablefilerelationships
enablefilerelationships boolean

파일 관계를 사용할 수 있는지 여부를 나타냅니다.

filerelationshipsitepermissionlevel
filerelationshipsitepermissionlevel integer

파일 관계를 관리하는 데 필요한 권한 수준입니다.

사이트 추가

이 API를 사용하여 새 사이트를 만듭니다. 사이트 개체는 만들기 사이트 인터페이스에 표시되는 특성만 지원합니다.

이 API를 사용하려면 새 사이트를 만들려면 사이트 이름(및 ASP 수준에서 구성된 필수 필드)이 필요합니다.

"module" 태그는 요청 특성에 표시된 것처럼 사이트에서 구성할 다른 모듈을 나타냅니다.
"sitetemplateid" 태그를 전달하여 템플릿에서 사이트를 만들려면
     - 버전 7 미만의 경우 요청에 모듈이 지정되지 않은 경우("모듈" 태그가 전달되지 않음) 템플릿 모듈 구성이 수행됩니다. 모듈 태그가 구성과 함께 제공되는 경우 템플릿 모듈 구성을 활용하는 대신 요청에 지정된 대로 해당 태그를 준수하고 구성합니다.
     - 버전 7보다 큰 경우 요청에 모듈이 지정되었거나("모듈" 태그가 전달됨) 템플릿 모듈 구성이 수행되지 않는 경우

이 메서드는 이 호출에서 사이트 이미지 업로드를 지원하지 않으며 사이트 아이콘 지원은 별도의 호출로 제공됩니다.
메서드 호출에는 기존 범주 ID가 있어야 합니다. 범주 ID는 사이트 범주 인터페이스에 대한 이전 호출을 통해 호출 애플리케이션에서 가져와야 합니다. 요청에 범주가 지정되지 않은 경우 기본적으로 범주(실제 범주가 아님)가 추가되지 않습니다.

사이트 시작 및 종료 날짜는 'dd MMM yyyy' 형식이어야 하며 UTC가 아닙니다. API 클라이언트는 항상 실제 날짜를 요청합니다.

"landingpage"에는 기본값이 "files(루트 폴더)"입니다.
"방문 페이지"에는 파일 모듈에 대한 세 가지 다른 단어 또는 식별이 필요합니다. 가능한 값은 다음과 같습니다.
- 파일(루트 폴더)
- 파일(최근 활동)
- 파일(고급 검색)
이제 메서드 구현은 (5.1부터) 다국어 사이트 이름을 지원합니다. API 버전 6 이상 <사이트 이름은> 사용자 기본 설정 순서에 따라 요청 본문에 표시됩니다. API 버전 5 또는 이전 <사이트 이름은> 기본 영국 영어를 나타냅니다.
<sitenametranslations> 는 모든 언어의 사이트 이름(5.1 이상에서 "개체 자체 API"의 추가 태그가 될 것임) API 버전 6 이상을 요청 본문에서 두 태그(예 <: sitename> 및 <sitenametranslations> )를 모두 전송합니다. 그런 다음, 값의 유효성을 검사해야 합니다. 예를 들어 <sitename> 은 사용자의 언어 기본 설정 측면에서 각 <번역> 태그와 일치해야 합니다. API 7 이상, 템플릿에서 만든 사이트는 원본 템플릿의 모듈을 따르며 요청 본문에 전송된 모듈 목록을 무시합니다.

이제 메서드 구현은 "sitetemplateid" 태그(이전 방법)를 제공하여 템플릿에서 사이트 만들기를 지원합니다.

이 API를 사용하여 템플릿에서 사이트를 만드는 지원은 나중에 더 이상 사용되지 않습니다. 템플릿에서 사이트를 만들려면 긴 폴링 API(장기 실행 요청에 대한 지원 포함)인 템플릿(/sites/templates/{templateid}/site)에서 새 API 만들기 사이트를 사용하세요.

이 메서드는 API 버전 10 이후를 사용하여 사이트에 추가할 여러 문제 번호를 지원합니다. "matternos" 태그는 읽기 전용인지 아닌 여러 문제 번호를 나타냅니다. 이전 버전(버전 10 미만) 단일 물질 번호 "matterno"는 사이트에 존재했던 여러 물질 번호의 첫 번째 문제 수를 반영합니다.

버전 18 이상: 범주(사이트 용도)가 필요합니다. 사이트 용도가 숨겨지면 메시지가 표시됩니다. 그렇지 않으면 숨겨진 사이트 용도가 사이트에 추가되지 않습니다.

버전 17까지: 사이트 소유자는 로그인한 사용자입니다. 다른 사용자를 추가할 수 없습니다.

버전 18 이상: 사이트 소유자는 사이트에 다른 사용자를 추가할 수 있습니다.

API 버전 19부터 홈 모듈과 긴밀하게 결합된 'customPages'라는 새 모듈이 도입되었습니다. 따라서 홈 모듈 값이 True이면 customPages는 true이고 그 반대의 경우도 마찬가지입니다.

매개 변수

Name 필수 형식 Description
요청되는 API의 버전
version True string

api 버전

아이디
id integer

사이트 식별자입니다.

sitename
sitename string

사이트의 이름입니다.

역할
role string

사이트의 역할입니다.

sitedescription
sitedescription string

사이트에 대한 설명입니다.

enabledmodules
enabledmodules string

사이트에 대해 사용하도록 설정된 모듈 목록입니다.

sitefolderID
sitefolderID string

사이트 폴더의 식별자입니다.

sitefolderpermission
sitefolderpermission string

사이트 폴더에 대한 사용 권한 수준입니다.

enable
enable string

HomeDBO에 대한 상태를 사용하도록 설정합니다.

enable
enable string

ActivityDBO에 대한 상태를 사용하도록 설정합니다.

microblog
microblog string

ActivityDBO와 연결된 마이크로 블로그 콘텐츠입니다.

docid
docid string

문서 ID입니다.

blogTitle
blogTitle string

블로그 게시물의 제목입니다.

blogContent
blogContent string

블로그 게시물의 콘텐츠입니다.

showComment
showComment integer

주석을 표시합니다.

태그 목록
tagList array of string

블로그와 연결된 태그 목록입니다.

status
status integer

블로그 게시물의 상태입니다.

siteID
siteID integer

연결된 사이트의 식별자입니다.

저자
author string

블로그 작성자입니다.

categoryList
categoryList array of string

블로그 게시물에 할당된 범주입니다.

notificationTypeID
notificationTypeID integer

알림 유형에 대한 식별자입니다.

message
message string

블로그와 관련된 메시지 콘텐츠입니다.

messageCode
messageCode integer

메시지와 연결된 코드입니다.

외부 ID
externalID string

블로그에 연결된 외부 식별자입니다.

게시날짜
publishDate string

블로그의 게시 날짜입니다.

processtype
processtype string

블로그와 연결된 프로세스 유형입니다.

enable
enable string

BlogDBO에 대한 상태를 사용하도록 설정합니다.

wikiid
wikiid integer

Wiki의 고유 식별자입니다.

currentversionid
currentversionid integer

위키의 현재 버전 식별자

parentwikiid
parentwikiid integer

부모 위키의 식별자입니다.

wikititle
wikititle string

위키의 제목입니다.

wikicontent
wikicontent string

위키의 내용입니다.

showcomment
showcomment integer

주석을 사용할 수 있는지 여부를 나타냅니다.

createddate
createddate string

위키의 생성 날짜입니다.

modifieddate
modifieddate string

위키의 마지막 수정 날짜입니다.

taglist
taglist string

wiki와 연결된 태그의 쉼표로 구분된 목록입니다.

wikipath
wikipath string

위키에 액세스하는 경로입니다.

wikidraftid
wikidraftid integer

Wiki 초안 버전의 식별자입니다.

drafttype
drafttype string

위키와 연결된 초안의 유형입니다.

status
status integer

위키의 현재 상태입니다.

wikiversionid
wikiversionid integer

위키의 버전 식별자입니다.

index
index string

작업의 인덱스 또는 식별자입니다.

parenttaskid
parenttaskid integer

부모 작업의 식별자입니다.

taskid
taskid integer

작업에 대한 고유 식별자입니다.

title
title string

작업의 제목입니다.

description
description string

작업에 대한 자세한 설명입니다.

duedate
duedate string

작업 완료 기한입니다.

startdate
startdate string

작업이 시작된 시작 날짜입니다.

mattermaptaskid
mattermaptaskid string

문제 맵 작업에 연결하는 식별자입니다.

type
type string

작업의 유형 또는 범주입니다.

dependenton
dependenton string

이 태스크가 사용하는 작업입니다.

daysfromdependent
daysfromdependent string

종속 작업의 일 수입니다.

ignoreweekend
ignoreweekend integer

예약에서 주말이 무시되는지를 나타냅니다.

duration
duration integer

작업을 완료하는 기간입니다.

resource
resource string

작업에 할당된 리소스입니다.

eventTitle
eventTitle string

이벤트의 제목입니다.

eventContent
eventContent string

이벤트의 콘텐츠입니다.

showComment
showComment integer

이벤트에 대한 주석을 사용할 수 있는지 여부를 나타냅니다.

태그 목록
tagList array of string

이벤트와 연결된 태그 목록입니다.

status
status integer

이벤트의 현재 상태입니다.

siteID
siteID integer

사이트의 식별자입니다.

접촉
contact string

이벤트에 대한 연락처 정보입니다.

categoryList
categoryList array of string

이벤트가 나열되는 범주입니다.

notificationTypeID
notificationTypeID integer

이벤트와 관련된 알림 유형입니다.

message
message string

이벤트의 메시지입니다.

messageCode
messageCode integer

이벤트의 메시지 코드입니다.

외부 ID
externalID string

외부 식별자입니다.

startDate
startDate string

이벤트의 시작 날짜입니다.

종료일
endDate string

이벤트의 종료 날짜입니다.

startTime
startTime string

이벤트의 시작 시간입니다.

endTime 사이에서
endTime string

이벤트의 종료 시간입니다.

location
location string

이벤트의 위치입니다.

저자
author string

이벤트의 작성자입니다.

processtype
processtype string

이벤트의 프로세스 시간입니다.

enable
enable string

Enable의 이벤트입니다.

아이디
id integer

iSheet의 고유 식별자입니다.

title
title string

iSheet의 제목입니다.

description
description string

isheet에 대한 설명입니다.

status
status string

isheet의 상태입니다.

accesstype
accesstype string

isheet의 액세스 유형입니다.

type
type string

isheet의 형식입니다.

보기 링크
viewlink string

iSheet를 보려면 링크입니다.

allowsections
allowsections string

섹션 허용 여부입니다.

allowlookup
allowlookup string

조회 필드가 사용되는지 여부입니다.

displayisheet
displayisheet string

iSheet에 대한 옵션을 표시합니다.

searchasdefaultview
searchasdefaultview string

검색이 기본 보기인지를 나타냅니다.

enableversion
enableversion string

버전 관리 사용 플래그입니다.

enablesheetalerter
enablesheetalerter string

시트 경고를 사용하도록 설정하는 플래그입니다.

alertercondition
alertercondition string

경고를 트리거하기 위한 조건입니다.

overrideitemmodifieddate
overrideitemmodifieddate string

수정된 날짜 플래그를 재정의합니다.

enablebulkinsertupdate
enablebulkinsertupdate string

대량 삽입/업데이트를 사용하도록 설정합니다.

fielddescriptions
fielddescriptions string

iSheet에 대한 필드 설명입니다.

enablerowlocking
enablerowlocking string

행 수준 잠금을 사용하도록 설정합니다.

setcharlimittruncatemultilinetextenabled
setcharlimittruncatemultilinetextenabled string

여러 줄 텍스트 플래그를 자립니다.

setcharlimittruncatemultilinetextval
setcharlimittruncatemultilinetextval string

여러 줄 잘림에 대한 문자 제한입니다.

allowchoicelistvaluesforreuse
allowchoicelistvaluesforreuse string

선택 목록 값을 다시 사용할 수 있습니다.

allowscorelistvaluesforreuse
allowscorelistvaluesforreuse string

점수 목록 값을 다시 사용할 수 있습니다.

allowIsheetComments
allowIsheetComments string

iSheet에서 메모를 허용합니다.

shareRecordsLimit
shareRecordsLimit integer

공유할 수 있는 레코드 제한입니다.

shareRecordsLimitEnabled
shareRecordsLimitEnabled integer

사용 가능한 레코드 공유 제한

enableIsheetAddRecordFormSharing
enableIsheetAddRecordFormSharing string

레코드를 추가하기 위해 양식 공유를 사용하도록 설정합니다.

recordcount
recordcount string

현재 레코드 수입니다.

sheettypeid
sheettypeid integer

iSheet의 형식 ID

enable
enable string

QA 기능을 사용하도록 설정합니다.

userid
userid integer

사용자 ID.

메일 주소
email string

전자 메일 주소입니다.

httpavatar
httpavatar string

아바타의 HTTP URL입니다.

아바타
avatar string

아바타 이미지입니다.

userlink
userlink string

사용자 프로필에 연결합니다.

httplink
httplink string

사용자 프로필에 대한 HTTP 링크입니다.

phone
phone string

전화번호.

mobile
mobile string

휴대폰 번호입니다.

부서
department string

사용자의 부서입니다.

enable
enable string

Contract Express 통합을 사용하도록 설정합니다.

adminnote
adminnote string

사이트와 관련된 관리 참고 사항입니다.

startdate
startdate string

사이트 작업의 시작 날짜입니다.

enddate
enddate string

사이트 작업의 종료 날짜입니다.

createddate
createddate string

사이트를 만든 날짜입니다.

archiveddate
archiveddate string

사이트가 보관된 날짜입니다.

clientno
clientno string

사이트와 연결된 클라이언트 번호입니다.

matterno
matterno string

사이트와 연결된 문제 번호입니다.

방문 페이지
landingpage string

사이트의 방문 페이지 URL입니다.

link
link string

사이트와 관련된 링크입니다.

status
status string

사이트의 현재 상태입니다.

statusid
statusid integer

사이트 상태에 대한 식별자입니다.

size
size string

사이트의 크기입니다.

billingnotes
billingnotes string

사이트에 대한 청구와 관련된 참고 사항입니다.

billingnextinvoicedate
billingnextinvoicedate string

사이트에 대한 다음 청구서의 날짜입니다.

billinglastinvoicedate
billinglastinvoicedate string

사이트에 대한 마지막 청구서의 날짜입니다.

filepagecount
filepagecount string

사이트에 있는 파일의 총 페이지 수입니다.

maxpagecount
maxpagecount string

사이트의 파일에 허용되는 최대 페이지 수입니다.

sitehttplink
sitehttplink string

사이트에 대한 HTTP 링크입니다.

isSyncable
isSyncable integer

사이트를 동기화할 수 있는지를 나타냅니다.

enforceusergroups
enforceusergroups string

사이트에 적용된 사용자 그룹입니다.

csvSiteCategory
csvSiteCategory string

CSV 형식의 사이트 범주입니다.

siteNameInDefaultLanguage
siteNameInDefaultLanguage string

기본 언어로 된 사이트의 이름입니다.

보이는
visible integer

사이트가 표시되는지 나타냅니다.

siteLogoName
siteLogoName string

사이트 로고 파일의 이름입니다.

siteLogoFileSize
siteLogoFileSize integer

사이트 로고의 파일 크기입니다.

siteLogoHeight
siteLogoHeight integer

사이트 로고의 높이입니다.

siteLogoWidth
siteLogoWidth integer

사이트 로고의 너비입니다.

siteStatus
siteStatus integer

사이트의 상태 코드입니다.

applySiteTerms
applySiteTerms integer

사이트 용어가 적용되는지 나타냅니다.

siteTerm
siteTerm string

사이트에 적용된 용어입니다.

termType
termType integer

사이트에 적용되는 용어의 유형입니다.

nextLoginSiteTerms
nextLoginSiteTerms integer

다음 로그인에 사이트 용어가 필요한지 나타냅니다.

defaultSiteTermsEnable
defaultSiteTermsEnable integer

기본 사이트 용어를 사용할 수 있는지를 나타냅니다.

advancedQAPermission
advancedQAPermission integer

사이트에 대한 고급 QA 권한 수준입니다.

내부입니다
isInternal integer

사이트가 내부인지를 나타냅니다.

psm
psm integer

Product Service Manager 식별자입니다.

siteLabelDisplay
siteLabelDisplay string

사이트의 표시 레이블입니다.

allowSiteAdministration
allowSiteAdministration integer

사이트 관리가 허용되는지 여부를 나타냅니다.

siteLevelPasswordEnable
siteLevelPasswordEnable integer

사이트 수준 암호 보호를 사용하도록 설정하려면

siteLevelPasscodeEnable
siteLevelPasscodeEnable integer

사이트 수준 암호 보호를 사용하도록 설정하려면

passcodeUsingAuthApp
passcodeUsingAuthApp integer

암호 인증이 인증 앱을 사용하는지 나타냅니다.

sitePassword
sitePassword string

사이트와 연결된 암호입니다.

ipRestrictionEnable
ipRestrictionEnable integer

사이트 액세스에 대한 IP 제한을 사용하도록 설정합니다.

availableIP
availableIP string

사이트에 액세스할 수 있는 IP 주소의 쉼표로 구분된 목록입니다.

highqDrive
highqDrive integer

HighQ Drive 통합을 사용할 수 있는지를 나타냅니다.

applySiteHomePage
applySiteHomePage integer

사이트에 대한 사용자 지정 홈페이지를 적용하려면

siteHomePage
siteHomePage string

사이트에 대한 사용자 지정 홈페이지의 URL입니다.

siteHomePageType
siteHomePageType integer

홈페이지의 유형입니다.

nextLoginSiteHomePage
nextLoginSiteHomePage integer

다음 로그인을 사이트 홈페이지로 설정하려면

applyDisplayContent
applyDisplayContent integer

표시 콘텐츠 설정을 적용하려면

displayContent
displayContent string

사이트에 표시할 콘텐츠입니다.

rssSecurity
rssSecurity integer

RSS 피드 보안 수준입니다.

암호화된 비밀번호
encryptedPassword integer

사이트 암호가 암호화되었는지를 나타냅니다.

availableIPRangeCSV
availableIPRangeCSV string

사이트에 액세스할 수 있는 IP 주소 범위의 쉼표로 구분된 목록입니다.

siteModuleID
siteModuleID integer

사이트 모듈의 식별자입니다.

icalSecurity
icalSecurity integer

iCal 피드 보안 수준입니다.

defaultDisplayContent
defaultDisplayContent string

사이트에 표시할 기본 콘텐츠입니다.

defaultEmailAlert
defaultEmailAlert integer

기본 전자 메일 경고를 사용하도록 설정하려면

excelReportFooter
excelReportFooter integer

Excel 보고서에 바닥글을 포함합니다.

excelReportFooterText
excelReportFooterText string

Excel 보고서의 바닥글에 표시할 텍스트입니다.

announcementMLJSON
announcementMLJSON string

사이트에 대한 JSON 형식 공지 사항입니다.

템플릿 유형
templateType integer

사이트에 사용되는 서식 파일의 유형입니다.

templateLicence
templateLicence integer

사이트 서식 파일의 라이선스 유형입니다.

openChannelAppID
openChannelAppID string

열린 채널 통합에 대한 애플리케이션 ID입니다.

itemid
itemid integer

사이트와 연결된 항목의 식별자입니다.

sitemetadatasheetid
sitemetadatasheetid integer

사이트와 연결된 메타데이터 시트의 ID입니다.

mysite
mysite boolean

사용자의 개인 사이트인지를 나타냅니다.

lastaccesseddate
lastaccesseddate string

사이트에 마지막으로 액세스한 날짜 및 시간입니다.

defaultViewerMetaDataTab
defaultViewerMetaDataTab integer

사이트 뷰어의 기본 메타데이터 탭입니다.

documentMetadataViewId
documentMetadataViewId integer

뷰 식별자에 대한 문서 메타데이터입니다.

folderMetadataViewId
folderMetadataViewId integer

뷰 식별자에 대한 폴더 메타데이터입니다.

docSort
docSort integer

문서의 정렬 순서입니다.

folderSort
folderSort integer

폴더의 정렬 순서입니다.

defaultFolderRenderView
defaultFolderRenderView integer

폴더의 기본 보기 모드를 결정합니다.

isTaskAttachmentDefault
isTaskAttachmentDefault integer

작업 첨부 파일의 기본 위치입니다.

taskAttachmentDefaultFolderId
taskAttachmentDefaultFolderId integer

작업 첨부 파일의 기본 위치로 지정된 폴더의 고유 식별자입니다.

좋아하는
favourite string

즐겨찾기 상태.

enabledocumentredaction
enabledocumentredaction boolean

사이트에 대해 문서 편집을 사용할 수 있는지 여부를 지정합니다.

멘션 그룹
mentiongroups integer

언급된 그룹입니다.

enablefilerelationships
enablefilerelationships boolean

파일 관계를 사용할 수 있는지 여부를 나타냅니다.

filerelationshipsitepermissionlevel
filerelationshipsitepermissionlevel integer

파일 관계를 관리하는 데 필요한 권한 수준입니다.

반환

site

사이트에 기존 그룹 추가

이 API 메서드는 기존 시스템 그룹을 사이트에 추가합니다.
이 API는 사이트에 기존 시스템 기본 사용자 그룹(시스템/조직 유형)을 추가하도록 확장되었습니다.

매개 변수

Name 필수 형식 Description
API 버전
version True string

version

사이트의 ID
siteid True string

사이트의 ID입니다.

시스템 그룹의 ID
groupid True string

사이트에 추가할 시스템 그룹의 ID입니다.

반환

sitegroup

파일 업로드

이 API 호출은 HighQ Collaborate 플랫폼의 지정된 폴더에 파일을 업로드합니다. Content-Range 헤더가 제공될 때 청크 분할 업로드를 지원합니다.

매개 변수

Name 필수 형식 Description
API 버전
version True string

사용 중인 API의 버전을 지정합니다.

업로드할 파일
file True file

업로드할 파일을 지정합니다.

부모 폴더 ID
parentfolderid True string

파일이 업로드될 부모 폴더의 고유 ID를 지정합니다.

중복 플래그 재정의
overrideduplicate boolean

중복 파일 업로드를 재정의해야 하는지 여부를 나타냅니다.

문서 이름
filename True string

문서의 이름을 지정합니다.

버전 참고
versionnote string

파일의 버전을 설명하는 메모를 제공합니다.

프로그레시브 작업 키
progressiveoperkey string

파일 업로드 중에 점진적 작업에 사용되는 키를 지정합니다.

DMS 데이터베이스 이름
dmsdatabasename string

문서 관리 시스템 데이터베이스의 이름을 지정합니다.

DMS 편집 날짜
dmseditdate string

문서 관리 시스템에 기록된 편집 날짜를 지정합니다.

DMS 부모 폴더 ID
dmsparentfolderid string

문서 관리 시스템에서 부모 폴더의 고유 ID를 지정합니다.

DMS 문서 ID
dmsdocid string

문서 관리 시스템에서 문서의 고유 ID를 지정합니다.

DMS 문서 버전
dmsversion string

문서 관리 시스템에 기록된 문서의 버전을 지정합니다.

알림 세부 정보
notification string

파일 업로드 시 보낼 알림에 대한 세부 정보를 제공합니다.

일괄 처리 ID
batchid string

일괄 처리 작업의 고유 ID를 지정합니다.

루트 폴더 ID
rootfolderid string

루트 폴더의 고유 ID를 지정합니다.

파일 정보 검색

이 API 호출은 HighQ 공동 작업 플랫폼에서 지정된 파일에 대한 자세한 정보를 검색합니다.

매개 변수

Name 필수 형식 Description
API 버전
version True string

사용 중인 API의 버전을 지정합니다.

파일 ID
fileid True string

파일의 고유 ID를 지정합니다.

최신 DMS 정보 플래그
lastdmsinfo boolean

문서 관리 시스템에서 최신 정보를 검색할지 여부를 나타냅니다.

폴더 유형
foldertype string

해당하는 경우 폴더 유형을 지정합니다.

파일 상태 정보 포함
statusinfo boolean

공유 상태, 즐겨찾기 상태, 작업 수 및 좋아요 상태와 같은 추가 파일 상태 정보를 포함할지 여부를 나타냅니다. 기본값은 false입니다.

전자 메일 메타데이터 포함
emailmetadata boolean

보낸 사람, 받는 사람 및 타임스탬프와 같은 전자 메일 메타데이터를 포함할지 여부를 나타냅니다. 기본값은 false입니다.

반환

폴더 만들기

이 API는 지정된 사이트 내에 새 폴더를 만듭니다. 이를 통해 폴더 세부 정보를 제공하고 지정된 부모 폴더 아래에 폴더가 만들어지도록 할 수 있습니다.

매개 변수

Name 필수 형식 Description
API 버전
version True string

API 버전을 지정합니다.

일괄 처리 식별자
batchid string

일괄 처리 작업에 대한 고유 식별자입니다.

루트 폴더 ID
rootfolderid string

루트 폴더의 고유 식별자입니다.

부모 폴더 ID
parentfolderid True string

새 폴더를 만들 상위 폴더의 고유 식별자입니다.

중복 폴더 허용
allowduplicatefolder boolean

지정된 부모 폴더에서 중복 폴더가 허용되는지 여부를 나타냅니다.

이름
name True string

폴더의 이름입니다.

description
description string

폴더에 대한 설명입니다.

accessInherited
accessInherited integer

폴더 액세스가 상속되는지를 나타냅니다.

batchID
batchID string

작업에 대한 일괄 처리 식별자입니다.

dmsfolderid
dmsfolderid string

DMS 폴더 식별자입니다.

dmsParentFolderID
dmsParentFolderID string

DMS 부모 폴더 식별자입니다.

dmscreateddate
dmscreateddate date-time

DMS 폴더를 만든 날짜입니다.

dmsmodifiedBy
dmsmodifiedBy string

DMS 폴더를 마지막으로 수정한 사용자입니다.

dmsdatabasename
dmsdatabasename string

DMS 데이터베이스의 이름입니다.

dmslink
dmslink boolean

DMS 링크를 사용할 수 있는지 여부를 나타냅니다.

dmslinkby
dmslinkby string

DMS 폴더를 연결한 사용자입니다.

emailmetadata
emailmetadata string

폴더와 연결된 전자 메일 메타데이터입니다.

반환

폴더 목록 검색

이 API 호출은 지정된 폴더 내에 포함된 폴더 목록을 검색합니다. 'limit' 매개 변수는 반환할 최대 항목 수를 설정하고 'offset' 매개 변수는 데이터 검색의 시작 위치를 지정합니다. 이러한 매개 변수를 생략하고 폴더가 생성 날짜별로 오름차순으로 반환되는 경우 기본값이 적용됩니다.

매개 변수

Name 필수 형식 Description
API 버전
version True string

사용 중인 API의 버전을 지정합니다.

폴더 ID
folderid True string

폴더의 고유 ID를 지정합니다.

항목 제한
limit string

반환할 최대 항목 수를 지정합니다.

항목 오프셋
offset string

반환된 항목의 시작 위치를 지정합니다.

정렬 순서 방향
orderby string

항목 정렬의 순서 방향을 지정합니다. 오름차순에는 'asc'를, 내림차순으로는 'desc'를 사용합니다.

정렬 기준
ordertype string

이름, 작성자 또는 마지막으로 수정한 날짜와 같은 항목을 정렬하기 위한 조건을 지정합니다.

폴더 상태 정보 포함
statusinfo boolean

추가 폴더 상태 정보를 포함할지 여부를 나타냅니다. 기본값은 false입니다.

스마트 폴더 포함
includesmartfolder boolean

반환된 목록에 스마트 폴더를 포함할지 여부를 나타냅니다. 기본값은 false입니다.

반환

Name 경로 형식 Description
folder
folder array of object
items
folder object

폴더 정보 가져오기

이 메서드는 지정된 폴더 ID의 폴더 세부 정보를 제공합니다.

매개 변수

Name 필수 형식 Description
API 버전
version True string

api 버전

폴더 ID
folderid True string

folderID

상태 정보
statusinfo boolean

statusinfo 매개 변수를 사용하면 폴더에 대한 추가 정보에 액세스할 수 있습니다. 사용 가능한 정보에는 로그인한 사용자의 공유 상태, 즐겨찾기 상태가 포함됩니다.

반환

정의

ErrorDBO

Name 경로 형식 Description
summary
summary string
참조
ref string
link
link string

DocumentDBO

Name 경로 형식 Description
docid
docid string

문서 ID입니다.

columns

Name 경로 형식 Description
칼럼
column array of object
items
column object

LocationDBO

Name 경로 형식 Description
addressline1
addressline1 string

주소의 첫 줄입니다.

addressline2
addressline2 string

주소의 두 번째 줄입니다.

addressline3
addressline3 string

주소의 세 번째 줄입니다.

city
city string

주소의 구/군/시입니다.

state string

주소의 상태입니다.

country
country string

주소의 국가입니다.

우편 번호
postcode string

주소의 우편 번호입니다.

사용자 이름

Name 경로 형식 Description
title
title string

사용자의 제목입니다.

이름
firstname string

사용자의 이름입니다.

lastname
lastname string

사용자의 성입니다.

goesby
goesby string

사용자의 기본 설정 이름입니다.

MetadataListDBO

Name 경로 형식 Description
메타데이터 이름
metadataname array of string
metadatavalue
metadatavalue array of string
Name 경로 형식 Description
아이디
id string

링크 ID

이름
name string

링크 이름입니다.

value
value string

링크 값입니다.

Name 경로 형식 Description
link
link array of NameValueLink

ExperiencesDBO

Name 경로 형식 Description
경험
experience array of string

GroupsDBO

Name 경로 형식 Description
group
group array of string

사용자

Name 경로 형식 Description
userid
userid integer

사용자 ID.

다음
following boolean

다음.

메일 주소
email string

전자 메일 주소입니다.

이름
name UserName
userlink
userlink string

사용자 링크.

httplink
httplink string

HTTP 링크입니다.

httpavatar
httpavatar string

HTTP 아바타.

아바타
avatar integer

사용자의 아바타입니다.

externalid
externalid string

외부 ID입니다.

dateofbirth
dateofbirth string

생년월일.

phone
phone string

전화번호.

jobtitle
jobtitle string

직할 제목입니다.

mobile
mobile string

휴대폰 번호입니다.

부서
department string

비방.

status
status string

상태

org
org string

조직.

orgName
orgName string

조직 이름입니다.

location
location LocationDBO
img
img string

이미지.

경험
experiences ExperiencesDBO
sociallinks
sociallinks Link
customlink
customlink Link
messaginglink
messaginglink Link
비서 이름
secretaryname string

비서 이름입니다.

secretarymail
secretarymail string

장관 메일.

바이오
bio string

사용자의 전기입니다.

sourcetype
sourcetype string

원본 형식입니다.

특선 요리
specialities string

특선 요리.

reportsto
reportsto string

현재 사용자가 보고하는 사용자입니다.

metadata
metadata MetadataListDBO
groups
groups GroupsDBO
접미사
suffix string

사용자 이름의 접미사입니다.

atomlink
atomlink string

사용자와 연결된 Atom 링크입니다.

link
link string

사용자와 연결된 링크입니다.

loggeduserlike
loggeduserlike integer

로그인한 사용자의 좋아요 수입니다.

사용자 이름
userName string

사용자 이름입니다.

users

Name 경로 형식 Description
사용자
user array of user

FolderDBOV1

Name 경로 형식 Description
folderid
folderid string

만든 폴더의 고유 식별자입니다.

DmsDBO

Name 경로 형식 Description
dmsfolderid
dmsfolderid string

DMS 폴더 식별자입니다.

dmsParentFolderID
dmsParentFolderID string

DMS 부모 폴더 식별자입니다.

dmscreateddate
dmscreateddate date-time

DMS 폴더를 만든 날짜입니다.

dmsmodifiedBy
dmsmodifiedBy string

DMS 폴더를 마지막으로 수정한 사용자입니다.

dmsdatabasename
dmsdatabasename string

DMS 데이터베이스의 이름입니다.

dmslink
dmslink boolean

DMS 링크를 사용할 수 있는지 여부를 나타냅니다.

dmslinkby
dmslinkby string

DMS 폴더를 연결한 사용자입니다.

sitegroup

Name 경로 형식 Description
이름
name string
아이디
id integer
copypermissionsfrom
copypermissionsfrom string
message
message string
typeID
typeID integer
type
type string
numberofusers
numberofusers string
만든
created string
modified
modified string
systemGroupID
systemGroupID integer
description
description string
basicusergroup
basicusergroup integer

Address

Name 경로 형식 Description
addressid
addressid string

주소의 고유 식별자입니다.

addressline1
addressline1 string

주소의 첫 줄입니다.

addressline2
addressline2 string

주소의 두 번째 줄입니다.

addressline3
addressline3 string

주소의 세 번째 줄입니다.

city
city string

주소의 구/군/시입니다.

state string

주소의 상태입니다.

country
country string

주소의 국가입니다.

우편 번호
postCode string

주소의 우편 번호입니다.

knownas
knownas string

주소의 대체 이름 또는 애칭입니다.

IntegrationUserDBO

Name 경로 형식 Description
index
index integer

사용자의 고유 인덱스입니다.

userid
userid integer

사용자의 고유 식별자입니다.

이름
firstname string

사용자의 이름입니다.

lastname
lastname string

사용자의 성입니다.

practicegroup
practicegroup string

사용자가 속한 연습 그룹입니다.

langcode
langcode string

사용자의 언어 코드입니다.

localeID
localeID string

사용자의 로캘 ID입니다.

publicprofile
publicprofile string

사용자의 공개 프로필입니다.

pwpid
pwpid string

사용자의 PWP ID입니다.

usertypeid
usertypeid string

사용자 유형 ID입니다.

systemuser
systemuser string

시스템 사용자 플래그입니다.

메일 주소
email string

사용자의 Email 주소입니다.

phone
phone string

사용자의 전화 번호입니다.

mobile
mobile string

사용자의 휴대폰 번호입니다.

부서
department string

사용자의 부서입니다.

org
org string

사용자가 속한 조직입니다.

location
location LocationDBO
address
address Address
경험
experiences ExperiencesDBO
sociallinks
sociallinks Link
messaginglink
messaginglink Link
customlink
customlink Link
img
img string
reportsto
reportsto string
metadata
metadata MetadataListDBO
groups
groups GroupsDBO
externalid
externalid string

사용자의 외부 ID입니다.

jobtitle
jobtitle string

사용자의 직호입니다.

비서 이름
secretaryname string

사용자의 비서 이름입니다.

secretarymail
secretarymail string

사용자 비서의 전자 메일입니다.

특선 요리
specialities string

사용자의 특수성입니다.

title
title string

사용자의 제목입니다.

goesby
goesby string

사용자의 기본 설정 이름입니다.

접미사
suffix string

사용자 이름의 접미사입니다.

atomlink
atomlink string

사용자와 연결된 Atom 링크입니다.

바이오
bio string

사용자의 전기입니다.

dateOfBirth
dateOfBirth string

사용자의 생년월일입니다.

link
link string

사용자와 연결된 링크입니다.

status
status string

사용자의 상태입니다.

상태 코드
statuscode string

사용자의 상태 코드입니다.

message
message string

사용자와 연결된 메시지입니다.

sourcetype
sourcetype string

사용자의 원본 유형입니다.

orgid
orgid string

조직 ID입니다.

ifpartner
ifpartner string

파트너 플래그입니다.

emaildomain
emaildomain string

사용자의 전자 메일 도메인입니다.

초대
invitationsent string

초대 보낸 플래그입니다.

만든 사람
createdby string

레코드를 만든 사용자입니다.

createddate
createddate string

레코드를 만든 날짜입니다.

수정자
modifiedby string

레코드를 수정한 사용자입니다.

modifieddate
modifieddate string

레코드가 수정된 날짜입니다.

lastlogindate
lastlogindate string

마지막 로그인 날짜입니다.

invalidlogins
invalidlogins string

잘못된 로그인 시도 횟수입니다.

publicwebsiteprofileid
publicwebsiteprofileid string

공개 웹 사이트 프로필 ID입니다.

resetpassworddate
resetpassworddate string

암호를 재설정한 날짜입니다.

아바타
avatar string

아바타 이미지 URL입니다.

followingcount
followingcount integer

팔로우 중인 사용자 수입니다.

followercount
followercount integer

팔로워 수입니다.

다음
following boolean

다음 플래그입니다.

역할
role string

사용자의 역할입니다.

isbasicuser
isbasicuser string

기본 사용자 플래그입니다.

encryptedUserId
encryptedUserId string

암호화된 사용자 ID입니다.

자체 등록됨
selfregistered integer

자체 등록 플래그입니다.

registeredWith2FA
registeredWith2FA string

2단계 인증 등록 플래그입니다.

내부입니다
isInternal integer

내부 사용자 플래그입니다.

orgName
orgName string

조직 이름

웹사이트

Name 경로 형식 Description
아이디
id integer

사이트 식별자입니다.

sitename
sitename string

사이트의 이름입니다.

역할
role string

사이트의 역할입니다.

sitedescription
sitedescription string

사이트에 대한 설명입니다.

enabledmodules
enabledmodules string

사이트에 대해 사용하도록 설정된 모듈 목록입니다.

sitefolderID
sitefolderID string

사이트 폴더의 식별자입니다.

sitefolderpermission
sitefolderpermission string

사이트 폴더에 대한 사용 권한 수준입니다.

module
module ModuleDBO
adminnote
adminnote string

사이트와 관련된 관리 참고 사항입니다.

startdate
startdate string

사이트 작업의 시작 날짜입니다.

enddate
enddate string

사이트 작업의 종료 날짜입니다.

createddate
createddate string

사이트를 만든 날짜입니다.

archiveddate
archiveddate string

사이트가 보관된 날짜입니다.

clientno
clientno string

사이트와 연결된 클라이언트 번호입니다.

matterno
matterno string

사이트와 연결된 문제 번호입니다.

방문 페이지
landingpage string

사이트의 방문 페이지 URL입니다.

link
link string

사이트와 관련된 링크입니다.

status
status string

사이트의 현재 상태입니다.

statusid
statusid integer

사이트 상태에 대한 식별자입니다.

size
size string

사이트의 크기입니다.

billingnotes
billingnotes string

사이트에 대한 청구와 관련된 참고 사항입니다.

billingnextinvoicedate
billingnextinvoicedate string

사이트에 대한 다음 청구서의 날짜입니다.

billinglastinvoicedate
billinglastinvoicedate string

사이트에 대한 마지막 청구서의 날짜입니다.

filepagecount
filepagecount string

사이트에 있는 파일의 총 페이지 수입니다.

maxpagecount
maxpagecount string

사이트의 파일에 허용되는 최대 페이지 수입니다.

sitehttplink
sitehttplink string

사이트에 대한 HTTP 링크입니다.

isSyncable
isSyncable integer

사이트를 동기화할 수 있는지를 나타냅니다.

enforceusergroups
enforceusergroups string

사이트에 적용된 사용자 그룹입니다.

csvSiteCategory
csvSiteCategory string

CSV 형식의 사이트 범주입니다.

siteNameInDefaultLanguage
siteNameInDefaultLanguage string

기본 언어로 된 사이트의 이름입니다.

보이는
visible integer

사이트가 표시되는지 나타냅니다.

siteLogoName
siteLogoName string

사이트 로고 파일의 이름입니다.

siteLogoFileSize
siteLogoFileSize integer

사이트 로고의 파일 크기입니다.

siteLogoHeight
siteLogoHeight integer

사이트 로고의 높이입니다.

siteLogoWidth
siteLogoWidth integer

사이트 로고의 너비입니다.

siteStatus
siteStatus integer

사이트의 상태 코드입니다.

applySiteTerms
applySiteTerms integer

사이트 용어가 적용되는지 나타냅니다.

siteTerm
siteTerm string

사이트에 적용된 용어입니다.

termType
termType integer

사이트에 적용되는 용어의 유형입니다.

nextLoginSiteTerms
nextLoginSiteTerms integer

다음 로그인에 사이트 용어가 필요한지 나타냅니다.

defaultSiteTermsEnable
defaultSiteTermsEnable integer

기본 사이트 용어를 사용할 수 있는지를 나타냅니다.

advancedQAPermission
advancedQAPermission integer

사이트에 대한 고급 QA 권한 수준입니다.

내부입니다
isInternal integer

사이트가 내부인지를 나타냅니다.

psm
psm integer

Product Service Manager 식별자입니다.

siteLabelDisplay
siteLabelDisplay string

사이트의 표시 레이블입니다.

allowSiteAdministration
allowSiteAdministration integer

사이트 관리가 허용되는지 여부를 나타냅니다.

siteLevelPasswordEnable
siteLevelPasswordEnable integer

사이트 수준 암호 보호를 사용하도록 설정하려면

siteLevelPasscodeEnable
siteLevelPasscodeEnable integer

사이트 수준 암호 보호를 사용하도록 설정하려면

passcodeUsingAuthApp
passcodeUsingAuthApp integer

암호 인증이 인증 앱을 사용하는지 나타냅니다.

sitePassword
sitePassword string

사이트와 연결된 암호입니다.

ipRestrictionEnable
ipRestrictionEnable integer

사이트 액세스에 대한 IP 제한을 사용하도록 설정합니다.

availableIP
availableIP string

사이트에 액세스할 수 있는 IP 주소의 쉼표로 구분된 목록입니다.

highqDrive
highqDrive integer

HighQ Drive 통합을 사용할 수 있는지를 나타냅니다.

applySiteHomePage
applySiteHomePage integer

사이트에 대한 사용자 지정 홈페이지를 적용하려면

siteHomePage
siteHomePage string

사이트에 대한 사용자 지정 홈페이지의 URL입니다.

siteHomePageType
siteHomePageType integer

홈페이지의 유형입니다.

nextLoginSiteHomePage
nextLoginSiteHomePage integer

다음 로그인을 사이트 홈페이지로 설정하려면

applyDisplayContent
applyDisplayContent integer

표시 콘텐츠 설정을 적용하려면

displayContent
displayContent string

사이트에 표시할 콘텐츠입니다.

rssSecurity
rssSecurity integer

RSS 피드 보안 수준입니다.

암호화된 비밀번호
encryptedPassword integer

사이트 암호가 암호화되었는지를 나타냅니다.

availableIPRangeCSV
availableIPRangeCSV string

사이트에 액세스할 수 있는 IP 주소 범위의 쉼표로 구분된 목록입니다.

siteModuleID
siteModuleID integer

사이트 모듈의 식별자입니다.

icalSecurity
icalSecurity integer

iCal 피드 보안 수준입니다.

defaultDisplayContent
defaultDisplayContent string

사이트에 표시할 기본 콘텐츠입니다.

defaultEmailAlert
defaultEmailAlert integer

기본 전자 메일 경고를 사용하도록 설정하려면

excelReportFooter
excelReportFooter integer

Excel 보고서에 바닥글을 포함합니다.

excelReportFooterText
excelReportFooterText string

Excel 보고서의 바닥글에 표시할 텍스트입니다.

announcementMLJSON
announcementMLJSON string

사이트에 대한 JSON 형식 공지 사항입니다.

템플릿 유형
templateType integer

사이트에 사용되는 서식 파일의 유형입니다.

templateLicence
templateLicence integer

사이트 서식 파일의 라이선스 유형입니다.

openChannelAppID
openChannelAppID string

열린 채널 통합에 대한 애플리케이션 ID입니다.

itemid
itemid integer

사이트와 연결된 항목의 식별자입니다.

sitemetadatasheetid
sitemetadatasheetid integer

사이트와 연결된 메타데이터 시트의 ID입니다.

mysite
mysite boolean

사용자의 개인 사이트인지를 나타냅니다.

lastaccesseddate
lastaccesseddate string

사이트에 마지막으로 액세스한 날짜 및 시간입니다.

defaultViewerMetaDataTab
defaultViewerMetaDataTab integer

사이트 뷰어의 기본 메타데이터 탭입니다.

documentMetadataViewId
documentMetadataViewId integer

뷰 식별자에 대한 문서 메타데이터입니다.

folderMetadataViewId
folderMetadataViewId integer

뷰 식별자에 대한 폴더 메타데이터입니다.

docSort
docSort integer

문서의 정렬 순서입니다.

folderSort
folderSort integer

폴더의 정렬 순서입니다.

defaultFolderRenderView
defaultFolderRenderView integer

폴더의 기본 보기 모드를 결정합니다.

isTaskAttachmentDefault
isTaskAttachmentDefault integer

작업 첨부 파일의 기본 위치입니다.

taskAttachmentDefaultFolderId
taskAttachmentDefaultFolderId integer

작업 첨부 파일의 기본 위치로 지정된 폴더의 고유 식별자입니다.

좋아하는
favourite string

즐겨찾기 상태.

enabledocumentredaction
enabledocumentredaction boolean

사이트에 대해 문서 편집을 사용할 수 있는지 여부를 지정합니다.

멘션 그룹
mentiongroups integer

언급된 그룹입니다.

enablefilerelationships
enablefilerelationships boolean

파일 관계를 사용할 수 있는지 여부를 나타냅니다.

filerelationshipsitepermissionlevel
filerelationshipsitepermissionlevel integer

파일 관계를 관리하는 데 필요한 권한 수준입니다.

ModuleDBO

Name 경로 형식 Description
home
home HomeDBO
활동
activity ActivityDBO
문서
document DocumentDBO
블로그
blog BlogDBO
wiki(위키)
wiki WikiDBO
작업
task TaskDBO
이벤트
event EventDBO
isheet
isheet ISheetDBO
qa
qa QaDBO
people
people PeopleDBO
contractexpress
contractexpress ContractExpressDBO

HomeDBO

Name 경로 형식 Description
enable
enable string

HomeDBO에 대한 상태를 사용하도록 설정합니다.

ActivityDBO

Name 경로 형식 Description
enable
enable string

ActivityDBO에 대한 상태를 사용하도록 설정합니다.

microblog
microblog string

ActivityDBO와 연결된 마이크로 블로그 콘텐츠입니다.

BlogDBO

Name 경로 형식 Description
blogTitle
blogTitle string

블로그 게시물의 제목입니다.

blogContent
blogContent string

블로그 게시물의 콘텐츠입니다.

showComment
showComment integer

주석을 표시합니다.

태그 목록
tagList array of string

블로그와 연결된 태그 목록입니다.

status
status integer

블로그 게시물의 상태입니다.

siteID
siteID integer

연결된 사이트의 식별자입니다.

저자
author string

블로그 작성자입니다.

categoryList
categoryList array of string

블로그 게시물에 할당된 범주입니다.

notificationTypeID
notificationTypeID integer

알림 유형에 대한 식별자입니다.

message
message string

블로그와 관련된 메시지 콘텐츠입니다.

messageCode
messageCode integer

메시지와 연결된 코드입니다.

외부 ID
externalID string

블로그에 연결된 외부 식별자입니다.

게시날짜
publishDate string

블로그의 게시 날짜입니다.

processtype
processtype string

블로그와 연결된 프로세스 유형입니다.

enable
enable string

BlogDBO에 대한 상태를 사용하도록 설정합니다.

WikiDBO

Name 경로 형식 Description
wikiid
wikiid integer

Wiki의 고유 식별자입니다.

currentversionid
currentversionid integer

위키의 현재 버전 식별자

parentwikiid
parentwikiid integer

부모 위키의 식별자입니다.

wikititle
wikititle string

위키의 제목입니다.

wikicontent
wikicontent string

위키의 내용입니다.

showcomment
showcomment integer

주석을 사용할 수 있는지 여부를 나타냅니다.

createddate
createddate string

위키의 생성 날짜입니다.

modifieddate
modifieddate string

위키의 마지막 수정 날짜입니다.

taglist
taglist string

wiki와 연결된 태그의 쉼표로 구분된 목록입니다.

wikipath
wikipath string

위키에 액세스하는 경로입니다.

wikidraftid
wikidraftid integer

Wiki 초안 버전의 식별자입니다.

drafttype
drafttype string

위키와 연결된 초안의 유형입니다.

status
status integer

위키의 현재 상태입니다.

wikiversionid
wikiversionid integer

위키의 버전 식별자입니다.

TaskDBO

Name 경로 형식 Description
index
index string

작업의 인덱스 또는 식별자입니다.

parenttaskid
parenttaskid integer

부모 작업의 식별자입니다.

taskid
taskid integer

작업에 대한 고유 식별자입니다.

title
title string

작업의 제목입니다.

description
description string

작업에 대한 자세한 설명입니다.

duedate
duedate string

작업 완료 기한입니다.

startdate
startdate string

작업이 시작된 시작 날짜입니다.

mattermaptaskid
mattermaptaskid string

문제 맵 작업에 연결하는 식별자입니다.

type
type string

작업의 유형 또는 범주입니다.

dependenton
dependenton string

이 태스크가 사용하는 작업입니다.

daysfromdependent
daysfromdependent string

종속 작업의 일 수입니다.

ignoreweekend
ignoreweekend integer

예약에서 주말이 무시되는지를 나타냅니다.

duration
duration integer

작업을 완료하는 기간입니다.

resource
resource string

작업에 할당된 리소스입니다.

EventDBO

Name 경로 형식 Description
eventTitle
eventTitle string

이벤트의 제목입니다.

eventContent
eventContent string

이벤트의 콘텐츠입니다.

showComment
showComment integer

이벤트에 대한 주석을 사용할 수 있는지 여부를 나타냅니다.

태그 목록
tagList array of string

이벤트와 연결된 태그 목록입니다.

status
status integer

이벤트의 현재 상태입니다.

siteID
siteID integer

사이트의 식별자입니다.

접촉
contact string

이벤트에 대한 연락처 정보입니다.

categoryList
categoryList array of string

이벤트가 나열되는 범주입니다.

notificationTypeID
notificationTypeID integer

이벤트와 관련된 알림 유형입니다.

message
message string

이벤트의 메시지입니다.

messageCode
messageCode integer

이벤트의 메시지 코드입니다.

외부 ID
externalID string

외부 식별자입니다.

startDate
startDate string

이벤트의 시작 날짜입니다.

종료일
endDate string

이벤트의 종료 날짜입니다.

startTime
startTime string

이벤트의 시작 시간입니다.

endTime 사이에서
endTime string

이벤트의 종료 시간입니다.

location
location string

이벤트의 위치입니다.

저자
author string

이벤트의 작성자입니다.

processtype
processtype string

이벤트의 프로세스 시간입니다.

enable
enable string

Enable의 이벤트입니다.

ISheetDBO

Name 경로 형식 Description
아이디
id integer

iSheet의 고유 식별자입니다.

title
title string

iSheet의 제목입니다.

description
description string

isheet에 대한 설명입니다.

status
status string

isheet의 상태입니다.

accesstype
accesstype string

isheet의 액세스 유형입니다.

type
type string

isheet의 형식입니다.

보기 링크
viewlink string

iSheet를 보려면 링크입니다.

allowsections
allowsections string

섹션 허용 여부입니다.

allowlookup
allowlookup string

조회 필드가 사용되는지 여부입니다.

displayisheet
displayisheet string

iSheet에 대한 옵션을 표시합니다.

searchasdefaultview
searchasdefaultview string

검색이 기본 보기인지를 나타냅니다.

enableversion
enableversion string

버전 관리 사용 플래그입니다.

enablesheetalerter
enablesheetalerter string

시트 경고를 사용하도록 설정하는 플래그입니다.

alertercondition
alertercondition string

경고를 트리거하기 위한 조건입니다.

overrideitemmodifieddate
overrideitemmodifieddate string

수정된 날짜 플래그를 재정의합니다.

enablebulkinsertupdate
enablebulkinsertupdate string

대량 삽입/업데이트를 사용하도록 설정합니다.

fielddescriptions
fielddescriptions string

iSheet에 대한 필드 설명입니다.

enablerowlocking
enablerowlocking string

행 수준 잠금을 사용하도록 설정합니다.

setcharlimittruncatemultilinetextenabled
setcharlimittruncatemultilinetextenabled string

여러 줄 텍스트 플래그를 자립니다.

setcharlimittruncatemultilinetextval
setcharlimittruncatemultilinetextval string

여러 줄 잘림에 대한 문자 제한입니다.

allowchoicelistvaluesforreuse
allowchoicelistvaluesforreuse string

선택 목록 값을 다시 사용할 수 있습니다.

allowscorelistvaluesforreuse
allowscorelistvaluesforreuse string

점수 목록 값을 다시 사용할 수 있습니다.

allowIsheetComments
allowIsheetComments string

iSheet에서 메모를 허용합니다.

shareRecordsLimit
shareRecordsLimit integer

공유할 수 있는 레코드 제한입니다.

shareRecordsLimitEnabled
shareRecordsLimitEnabled integer

사용 가능한 레코드 공유 제한

enableIsheetAddRecordFormSharing
enableIsheetAddRecordFormSharing string

레코드를 추가하기 위해 양식 공유를 사용하도록 설정합니다.

recordcount
recordcount string

현재 레코드 수입니다.

sheettypeid
sheettypeid integer

iSheet의 형식 ID

QaDBO

Name 경로 형식 Description
enable
enable string

QA 기능을 사용하도록 설정합니다.

PeopleDBO

Name 경로 형식 Description
사람
person array of PersonDBO

PersonDBO

Name 경로 형식 Description
userid
userid integer

사용자 ID.

메일 주소
email string

전자 메일 주소입니다.

httpavatar
httpavatar string

아바타의 HTTP URL입니다.

아바타
avatar string

아바타 이미지입니다.

userlink
userlink string

사용자 프로필에 연결합니다.

httplink
httplink string

사용자 프로필에 대한 HTTP 링크입니다.

phone
phone string

전화번호.

mobile
mobile string

휴대폰 번호입니다.

부서
department string

사용자의 부서입니다.

ContractExpressDBO

Name 경로 형식 Description
enable
enable string

Contract Express 통합을 사용하도록 설정합니다.

FolderDBOV2

Name 경로 형식 Description
이름
name string

폴더 이름입니다.

description
description string

폴더 설명입니다.

parentFolderID
parentFolderID integer

부모 폴더 ID입니다.

accessInherited
accessInherited integer

상속 상태에 액세스합니다.

batchID
batchID string

일괄 처리 식별자

디엠스
dms DmsDBO
아이디
id integer

폴더 ID입니다.

link
link string

폴더 링크입니다.

createddate
createddate string

생성 날짜입니다.

modifieddate
modifieddate string

수정된 날짜입니다.

아이
child integer

자식 폴더.

filecount
filecount integer

파일 수입니다.

만든 사람
createdby UserDBO
수정자
modifiedby UserDBO
folderid
folderid integer

폴더 ID입니다.

dmsfolderid
dmsfolderid string

DMS 폴더 식별자입니다.

siteid
siteid integer

사이트 아이디

location
location string

폴더 위치입니다.

허가
permission PermissionDBO
contentstatus
contentstatus integer

콘텐츠 상태입니다.

자동 열거형
autonumbering string

자동 번호 매기기 구성.

foldersize
foldersize string

폴더 크기입니다.

sharedstatus
sharedstatus integer

공유 상태.

favouritestatus
favouritestatus integer

즐겨찾기 상태.

foldertype
foldertype string

폴더 유형입니다.

아이템 ID
itemId integer

항목 ID

folderMetadataSheetId
folderMetadataSheetId integer

시트 ID의 폴더 메타데이터입니다.

UserDBO

Name 경로 형식 Description
이름
firstname string

이름.

lastname
lastname string

성.

메일 주소
email string

이메일 주소.

userid
userid integer

사용자 ID.

PermissionDBO

Name 경로 형식 Description
view
view integer

사용 권한을 봅니다.

edit
edit integer

사용 권한 편집

delete
delete integer

사용 권한을 삭제합니다.

addEditAllFiles
addEditAllFiles integer

모든 파일 사용 권한을 추가/편집합니다.

관리자
admin integer

관리자 권한.

viewAllFiles
viewAllFiles integer

모든 파일 사용 권한을 봅니다.

disableSave
disableSave integer

사용 권한 저장을 사용하지 않도록 설정합니다.

uploadFile
uploadFile integer

파일 사용 권한을 업로드합니다.

updateFile
updateFile integer

파일 권한을 업데이트합니다.

deleteFile
deleteFile integer

파일 사용 권한을 삭제합니다.

ProgressiveKeyDBO

Name 경로 형식 Description
프로그레시브 키
progressivekey string

점진적 작업의 키입니다.

siteid
siteid integer

사이트의 식별자입니다.

progressivekeystatus
progressivekeystatus string

프로그레시브 키의 상태입니다.

userid
userid integer

사용자의 식별자입니다.

responsebody
responsebody string

응답의 본문입니다.

message
message string

메시지 콘텐츠입니다.

messagecode
messagecode string

메시지와 연결된 코드입니다.

integrationResponseDBO
integrationResponseDBO IntegrationResponseDBO
columns
columns ColumnErrorsDBO
items
items ItemErrorsDBO
importisheettemplate
importisheettemplate importISheetTemplateDBO
오류
error ErrorDBO
콘텐츠 유형
contentType string

콘텐츠 형식입니다.

failedEntities
failedEntities integer

실패한 엔터티 수입니다.

다운로드 링크
downloadlink string

콘텐츠를 다운로드하는 링크입니다.

첨부 파일
attachment Attachment
link
link string

연결된 링크입니다.

documentid
documentid integer

문서의 식별자입니다.

progresskey
progresskey string

추적을 위한 진행률 키입니다.

progresskeystatus
progresskeystatus string

진행률 키의 상태입니다.

IntegrationResponseDBO

Name 경로 형식 Description
integrationResponseUsersObject
integrationResponseUsersObject IntegrationResponseUsersObject
failedEntities
failedEntities integer

처리에 실패한 엔터티 수입니다.

successEntities
successEntities integer

성공적으로 처리된 엔터티 수입니다.

IntegrationResponseUsersObject

Name 경로 형식 Description
사용자
user array of IntegrationUserDBO

ColumnErrorsDBO

Name 경로 형식 Description
칼럼
column array of ColumnErrorDBO
failedEntities
failedEntities integer

열 오류로 인해 실패한 엔터티 수입니다.

successEntities
successEntities integer

성공적으로 처리된 엔터티 수입니다.

ColumnErrorDBO

Name 경로 형식 Description
index
index integer

오류가 있는 열의 인덱스 위치입니다.

columnid
columnid integer

오류가 있는 열의 고유 식별자입니다.

이름
name string

오류가 있는 열의 이름입니다.

status
status string

오류 조건을 나타내는 상태입니다.

상태 코드
statuscode string

오류 상태를 나타내는 코드입니다.

message
message string

자세한 오류 메시지입니다.

ItemErrorsDBO

Name 경로 형식 Description
물품
item array of ItemErrorDBO
failedEntities
failedEntities integer

항목 오류로 인해 실패한 엔터티 수입니다.

successEntities
successEntities integer

항목 오류에도 불구하고 성공적으로 처리된 엔터티 수입니다.

ItemErrorDBO

Name 경로 형식 Description
index
index integer

오류가 있는 항목의 인덱스 위치입니다.

columns
columns ColumnErrorsDBO
itemid
itemid string

오류가 있는 항목의 고유 식별자입니다.

externalid
externalid string

항목과 연결된 외부 식별자입니다.

아이디
id string

항목의 내부 식별자입니다.

이름
name string

오류가 있는 항목의 이름입니다.

status
status string

오류 조건을 나타내는 상태입니다.

상태 코드
statuscode string

오류 상태를 나타내는 코드입니다.

message
message string

자세한 오류 메시지입니다.

successdeletedcount
successdeletedcount integer

성공적으로 삭제된 엔터티의 수입니다.

failurecount
failurecount integer

처리에 실패한 엔터티 수입니다.

failedEntities
failedEntities integer

항목 오류로 인해 실패한 엔터티 수입니다.

successEntities
successEntities integer

성공적으로 처리된 엔터티 수입니다.

importISheetTemplateDBO

Name 경로 형식 Description
linkedtemplateid
linkedtemplateid integer

연결된 템플릿의 식별자입니다.

별칭 이름
aliasname string

템플릿의 별칭 이름입니다.

linkedisheet
linkedisheet string

연결된 입력 시트의 식별자입니다.

importdata
importdata string

템플릿에서 가져올 데이터입니다.

appendisheetname
appendisheetname string

데이터를 추가할 시트의 이름입니다.

templateparametergroups
templateparametergroups ISheetTemplateParameterGroups
templateSheetIdMap
templateSheetIdMap object
템플릿ID
templateId integer

템플릿의 식별자입니다.

templateTitle
templateTitle string

템플릿의 제목입니다.

viewIDs
viewIDs string

보기 ID의 쉼표로 구분된 목록입니다.

ISheetTemplateParameterGroups

Name 경로 형식 Description
templateparametergroup
templateparametergroup array of ISheetTemplateParameterGroup

ISheetTemplateParameterGroup

Name 경로 형식 Description
templateruleid
templateruleid integer

Isheet 템플릿 매개 변수 그룹입니다.

templateparameter
templateparameter array of ISheetTemplateParameter

ISheetTemplateParameter

Name 경로 형식 Description
아이디
id integer

isheet 템플릿 매개 변수의 식별자입니다.

이름
name string

isheet 템플릿 매개 변수의 이름입니다.

데이터
data string

isheet 템플릿 매개 변수의 데이터입니다.

Attachment

Name 경로 형식 Description
file
file string

파일 콘텐츠입니다.

이름
name string

첨부 파일의 이름입니다.

order
order string

첨부 파일의 순서입니다.

아이디
id integer

첨부 파일의 고유 식별자입니다.

확장
extension string

파일 확장명입니다.

parentfolderid
parentfolderid integer

부모 폴더의 ID입니다.

filehttplink
filehttplink string

파일에 액세스하기 위한 HTTP 링크입니다.

folderpath
folderpath string

파일이 포함된 폴더의 경로입니다.

folderhttplink
folderhttplink string

폴더에 대한 HTTP 링크입니다.

filesize
filesize integer

파일의 크기(바이트)입니다.

redactionStatus
redactionStatus boolean

파일이 수정되었는지를 나타냅니다.

displayname
displayname string

첨부 파일의 표시 이름입니다.

siteid
siteid integer

첨부 파일과 연결된 사이트의 ID입니다.