Oodrive 기호(미리 보기)
워크플로를 통해 Oodrive 기호의 서비스를 연결하고 사용합니다.
이 커넥터는 다음 제품 및 지역에서 사용할 수 있습니다.
| 서비스 | 클래스 | 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) |
| 연락처 | |
|---|---|
| 이름 | Oodrive 기호 |
| URL | https://www.oodrive.com/products/oodrive-sign/ |
| 전자 메일 | support-sign@oodrive.com |
| 커넥터 메타데이터 | |
|---|---|
| 게시자 | Oodrive 기호 |
| 웹 사이트 | https://www.oodrive.com/products/oodrive-sign/ |
| 개인 정보 보호 정책 | https://www.oodrive.com/privacy-policy/ |
| 카테고리 | IT 작업; 생산력 |
Oodrive Sign의 커넥터를 사용하면 작업을 자동화하고 전자 서명 에코시스템에 대한 프로세스를 쉽게 관리할 수 있습니다. 예를 들어 자동화된 워크플로는 템플릿으로 새 계약을 만들고, 받는 사람을 자동으로 추가하고, 서명을 위한 계약을 보내도록 디자인할 수 있습니다. 모든 번들, 받는 사람, 키 매개 변수 등을 관리할 수도 있습니다. 서명의 모든 프로세스 후에 수동 작업을 하는 데 사용되는 시간을 줄일 수 있는 가능성을 고객에게 제공합니다. 웹 애플리케이션에서 사용할 수 있는 모든 기능은 커넥터를 사용하여 Power Automate에서 재현할 수 있습니다.
필수 조건
Oodrive Sign의 서비스에 유료 플랜이 있는 계정이 필요합니다.
자격 증명을 가져오는 방법
또한 지원 서비스에 요청할 수 있는 API 토큰을 가져와야 합니다. 또는 서명 서비스에 적용할 때 사서함으로 전송된 환영 전자 메일에서 검색할 수 있습니다.
Note: If you are a employee, you can get the token by contacting your IT service.
커넥터 시작
커넥터 사용을 시작하려면 먼저 Power Platform 계정으로 Power Automate 를 열어야 합니다.
Note: you'll need to be premium on Power Automate in order to use the connector.
다음 단계에 따라 새 워크플로를 만들고 커넥터를 사용합니다.
- Power Automate 환경에서 "만들기" 탭을 클릭합니다.
- 필요에 따라 "자동화된 클라우드 흐름" 또는 "인스턴트 클라우드 흐름"을 선택합니다.
- 새 워크플로에 이름을 지정하고 필요에 맞는 트리거를 선택합니다. Oodrive Sign's 중 하나를 사용할 수 있습니다.
- 카탈로그에서 "Oodrive Sign"을 검색하기만 하면 커넥터에서 작업을 추가하여 커넥터 사용을 시작합니다.
- 커넥터에서 작업 또는 트리거를 처음 추가할 때 Power Automate는 사용자 환경에 연결하도록 요청합니다. 여기서는 Microsoft에서 제공하는 API 토큰을 사용합니다.
- 그런 다음 연결을 클릭합니다. 모든 작업이 완료되고 원하는 커넥터에서 많은 작업을 사용할 수 있습니다.
알려진 문제 및 제한 사항
Oodrive Sign 관련 문제는 지원 서비스에 문의하세요.
일반적인 오류 및 해결
HTTP 오류 404
일반적으로 Oodrive Sign's와 함께 오류 404가 표시되면 찾으려는 리소스가 사용자 환경에 존재하지 않는다고 표시됩니다. 일반적으로 특정 계약 또는 특정 받는 사람에 대해 제공된 ID에 오류가 있을 수 있으며, 이는 존재하지 않습니다. 이 문제를 해결하려면 가져오려는 리소스의 알려진 ID와 함께 작업을 사용하세요.
HTTP 오류 501
HTTP 오류 501은 Oodrive Sign의 서비스가 사용자의 요구를 잘 인식하지 못했거나 잘못된 유형의 데이터를 서비스에 전달했음을 나타냅니다. 작업 또는 트리거에 전달하는 데이터에 대해 Sign의 설명서를 읽어 조사해 봅니다.
자주 묻는 질문(FAQ)
1. 특정 계약에 문서를 업로드하려면 어떻게 해야 하나요?
"문서 업로드 및 계약에 첨부" 작업을 사용하여 원격으로 저장된 pdf 파일을 쉽게 업로드할 수 있습니다.
첫 번째 단계에서는 업로드하려는 파일의 콘텐츠를 가져와야 합니다. 여러 커넥터를 사용하여 가져올 수 있습니다. 예를 들어 SharePoint 커넥터의 "파일 콘텐츠 가져오기" 작업을 사용하여 파일 콘텐츠를 검색할 수 있습니다.
- 특정 계약에 대한 문서로 업로드하려는 파일의 콘텐츠를 가져옵니다. 이 예제에서는 SharePoint Online 커넥터의 "파일 콘텐츠 가져오기" 작업을 사용합니다.
- 그런 다음 새 "작성" 작업을 추가합니다. "파일 콘텐츠 가져오기" 작업의 출력 본문을 작성에 대한 입력으로 사용합니다.
- Oodrive Sign 커넥터에서 "문서 업로드 및 계약에 추가"라는 작업을 추가합니다.
- 입력 "계약 ID"에서 문서를 첨부할 계약의 ID를 지정합니다.
- 입력 "파일"에서 이전 "작성" 작업의 출력을 삽입합니다.
- "파일(파일 이름)" 입력에서 업로드할 문서의 이름을 삽입합니다.
- 문서 업로드를 완료했습니다.
2. 내 환경 내의 모든 계약을 볼 수 있나요?
토큰이 "관리자" 토큰인 경우 그렇습니다. 그렇지 않으면 정상적으로 액세스한 계약만 볼 수 있습니다.
3. 커넥터에 대한 제안이 있습니다. 어디에서 제출할 수 있나요?
지원 서비스에 문의하여 커넥터에 대한 제안을 제출할 수 있습니다. 우리는 당신의 기여에 정말 감사 할 것입니다!
연결을 만드는 중
커넥터는 다음 인증 유형을 지원합니다.
| 기본값 | 연결을 만들기 위한 매개 변수입니다. | 모든 지역 | 공유할 수 없음 |
기본값
적용 가능: 모든 지역
연결을 만들기 위한 매개 변수입니다.
공유 가능한 연결이 아닙니다. 전원 앱이 다른 사용자와 공유되면 다른 사용자에게 새 연결을 명시적으로 만들라는 메시지가 표시됩니다.
| 이름 | 유형 | Description | 필수 |
|---|---|---|---|
| API 키 | 시큐어스트링 (보안 문자열) | 이 API의 API 키 | 진실 |
제한 한도
| Name | 호출 | 갱신 기간 |
|---|---|---|
| 연결당 API 호출 | 100 | 60초 |
동작
| 계약 만들기 |
환경에서 새 계약을 만듭니다. |
| 계약 만들기 및 서명을 위해 보내기 |
모두 하나의 작업으로 수행됩니다. 계약을 만들고, 받는 사람, 문서를 추가하고, 서명을 받는 사람에게 보냅니다. |
| 계약 유효성 검사 |
계약의 유효성을 검사(카운터 서명)합니다. |
| 계약 철회 |
서명을 위해 계약이 전송된 경우에도 계약의 상태를 ABANDONED로 설정합니다. |
| 계약에 대한 받는 사람 삭제 |
계약 ID에 대한 받는 사람이 계약에서 받는 사람을 삭제합니다. 설명서의 자세한 정보입니다. |
| 계약에 받는 사람 추가 |
기존 받는 사람을 계약에 연결합니다. |
| 계약의 문서 나열 |
계약에 바인딩된 모든 문서를 검색합니다. |
| 계약의 문서 다운로드 |
계약에서 모든 문서를 포함하는 PDF 파일을 검색합니다. |
| 계약의 받는 사람 나열 |
특정 계약에 대한 모든 받는 사람을 검색합니다. |
| 계약의 상태 가져오기 |
특정 계약의 상태를 확인합니다. |
| 계약의 서명 가져오기 |
특정 계약의 모든 서명 정보를 나열합니다. |
| 계약의 서명된 문서 다운로드 |
계약의 서명된 문서에서 pdf 파일을 검색합니다. |
| 계약의 증명 파일 다운로드 |
계약의 증명 파일을 다운로드합니다. |
| 계약의 트랜잭션 중지 |
계약 문서 및/또는 서명자를 수정할 수 있도록 계약의 트랜잭션을 중지합니다. |
| 모든 경계 나열 |
연결된 환경에 연결된 모든 경계를 검색합니다. |
| 모든 계약 목록 가져오기 |
연결된 라이선스에서 모든 계약을 검색합니다. |
| 모든 받는 사람 나열 |
현재 라이선스에 연결된 모든 받는 사람을 검색합니다. |
| 모든 받는 사람에게 알림 전자 메일 다시 보내기 |
특정 계약의 모든 받는 사람에게 알림 전자 메일을 보냅니다. |
| 문서 업로드 및 계약에 첨부 |
환경에 문서를 업로드하고 특정 계약에 첨부합니다. |
| 받는 사람에게 알림 전자 메일 다시 보내기 |
계약을 위해 특정 받는 사람에게 알림 전자 메일을 보냅니다. |
| 번들 만들기 |
하나 이상의 기존 계약을 사용하여 새 번들을 만듭니다. |
| 번들 철회 |
번들에 있는 모든 계약을 철회합니다. |
| 번들 트랜잭션 중지 |
번들 트랜잭션을 중지합니다. |
| 번들에 계약 추가 |
기존 번들에 기존 계약을 추가합니다. |
| 번들에서 계약 유효성 검사 |
번들에 있는 모든 계약을 카운터 서명(유효성 검사)합니다. |
| 번들의 계약 나열 |
특정 번들에서 모든 계약을 검색합니다. |
| 서명을 위한 번들 보내기 |
서명을 위해 번들을 보냅니다. |
| 서명할 계약 보내기 |
받는 사람이 서명할 특정 계약 및 모든 문서를 보냅니다. |
| 첨부 파일을 업로드하고 계약에 추가 |
환경에 새 첨부 파일을 업로드하고 특정 계약에 첨부합니다. |
| 특정 계약 가져오기 |
특정 계약의 메타데이터를 검색합니다. |
| 특정 받는 사람 가져오기 |
현재 환경의 저장된 받는 사람 목록에서 특정 받는 사람을 검색합니다. |
계약 만들기
환경에서 새 계약을 만듭니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
계약 이름
|
name | string |
새로 만든 계약의 이름(필수)입니다. |
|
|
계약 정의 ID
|
contract_definition_id | integer |
계약 정의의 ID입니다. 라이선스의 API 변수를 참조하세요. 기본값은 PDF AdHoc 템플릿입니다. |
|
|
공급업체 전자 메일
|
vendor_email | string |
라이선스 소유자의 전자 메일입니다. |
|
|
만든 날짜
|
date | integer |
계약 날짜입니다. 기본값은 Date.Now()입니다. 밀리초 단위여야 합니다. |
|
|
메시지 제목
|
message_title | string |
보낸 전자 메일의 개체입니다. 기본 제목은 비워 둡니다. |
|
|
메시지 본문
|
message_body | string |
보낸 전자 메일의 본문입니다. 기본 메시지의 경우 비워 둡니다. |
|
|
계속 이동
|
keep_on_move | boolean |
모바일 디바이스에서 오프라인 서명 활성화 여부 |
|
|
자동 닫기
|
auto_close | integer |
사람의 개입 없이 카운터 서명이 수행되는지 지정합니다. |
|
|
순차
|
sequential | boolean |
순차적인지 여부를 지정합니다. |
|
|
고객 번호
|
customer_number | string |
레거시 모바일 애플리케이션의 경우 호환성만 해당합니다. |
|
|
경계 목록
|
perimeters | array of string | ||
|
요소 정의 ID
|
element_definition_id | integer |
요소의 정의 ID입니다. |
|
|
가치
|
value | string |
요소 옵션의 값입니다. |
|
|
속성 ID
|
id | integer |
사용자 지정 속성의 ID입니다. |
|
|
속성 키
|
key | string |
사용자 지정 속성의 키입니다. |
|
|
속성 자리 표시자
|
placeholder | string |
속성을 입력하도록 초대된 경우 받는 사람에게 표시되는 레이블입니다. |
|
|
속성 값
|
value | string |
사용자 지정 속성의 값입니다. |
|
|
속성 계약 ID
|
contract_id | integer |
이 사용자 지정 속성에 연결된 계약의 ID입니다. |
|
|
속성이 필요합니다.
|
to_fill_by_user | boolean |
사용자가 속성을 채워야 하는지 여부를 지정합니다. |
|
|
속성 형식
|
field_type | string |
사용자 지정 속성의 형식을 지정합니다. 설명서의 추가 정보입니다. |
|
|
속성 선택
|
input_filter | string |
속성에 사용할 수 있는 목록입니다. |
|
|
계약에 사용되는 속성
|
used_by_contract | boolean |
계약 문서에 정보가 표시되어야 하는 경우 true로 설정합니다. |
|
|
속성이 필요합니다.
|
required | boolean |
속성이 필요한지 여부를 지정합니다. |
반환
- 몸
- Contract
계약 만들기 및 서명을 위해 보내기
모두 하나의 작업으로 수행됩니다. 계약을 만들고, 받는 사람, 문서를 추가하고, 서명을 받는 사람에게 보냅니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
계약 ID
|
contract_id | integer |
계약의 ID입니다. |
|
|
만든 날짜
|
date | integer |
계약이 만들어진 날짜입니다. |
|
|
공급업체 전자 메일 주소
|
vendor_email | string |
Oodrive 라이선스 소유자의 전자 메일 주소입니다. |
|
|
계약 정의 ID
|
contract_definition_id | integer |
이 계약에 사용되는 계약 정의의 ID입니다. |
|
|
메시지 제목
|
message_title | string |
서명을 위해 보낸 전자 메일 제목입니다. |
|
|
메시지 본문
|
message_body | string |
서명을 위해 전송되는 전자 메일 본문입니다. |
|
|
계약 이름
|
name | True | string |
계약의 주 문서 이름입니다. |
|
오프라인 서명이 활성화됨
|
keep_on_move | boolean |
모바일 디바이스의 오프라인 서명이 활성화되었는지 확인합니다. |
|
|
계약 종료 날짜
|
closed_date | integer |
계약 종료 날짜(있는 경우)입니다. |
|
|
계약 취소 이유
|
canceled_reason | string |
취소 이유(있는 경우)입니다. |
|
|
자동 닫기 사용
|
auto_close | integer |
계약이 자동으로 서명될지 아니면 사람의 개입이 필요한지 지정합니다. |
|
|
삭제됨
|
deleted | integer |
계약이 삭제되었는지 여부를 지정합니다. |
|
|
경계 키
|
Perimeters | string |
경계의 키입니다. |
|
|
옵션 ID
|
id | integer |
계약 옵션의 ID입니다. |
|
|
계약 ID
|
contract_id | integer |
이 옵션에 바인딩된 계약의 ID입니다. |
|
|
요소 정의 ID
|
element_definition_id | integer |
옵션의 요소 정의 ID입니다. |
|
|
동기화 타이머
|
sync_timer | integer |
동기화 문제에 사용되는 타이머입니다. |
|
|
옵션 값
|
value | string |
옵션의 값입니다. |
|
|
마지막 수정 위치
|
last_modification_place | string |
마지막 수정이 발생한 위치를 나타냅니다. |
|
|
옵션 컨트롤
|
control | string |
제어 필드입니다. |
|
|
속성 ID
|
id | integer |
사용자 지정 속성의 ID입니다. |
|
|
속성 키
|
key | string |
사용자 지정 속성의 키입니다. |
|
|
속성 자리 표시자
|
placeholder | string |
속성을 입력하도록 초대된 경우 받는 사람에게 표시되는 레이블입니다. |
|
|
속성 값
|
value | string |
사용자 지정 속성의 값입니다. |
|
|
속성 계약 ID
|
contract_id | integer |
이 사용자 지정 속성에 연결된 계약의 ID입니다. |
|
|
속성이 필요합니다.
|
to_fill_by_user | boolean |
사용자가 속성을 채워야 하는지 여부를 지정합니다. |
|
|
속성 형식
|
field_type | string |
사용자 지정 속성의 형식을 지정합니다. 설명서의 추가 정보입니다. |
|
|
속성 선택
|
input_filter | string |
속성에 사용할 수 있는 목록입니다. |
|
|
계약에 사용되는 속성
|
used_by_contract | boolean |
계약 문서에 정보가 표시되어야 하는 경우 true로 설정합니다. |
|
|
속성이 필요합니다.
|
required | boolean |
속성이 필요한지 여부를 지정합니다. |
|
|
서명 모드
|
signature_mode | integer | ||
|
이름
|
firstname | string | ||
|
lastname
|
lastname | string | ||
|
메일 주소
|
string | |||
|
cell_phone
|
cell_phone | string | ||
|
pdfparts
|
pdfparts | string | ||
|
appendixparts
|
appendixparts | string |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
받는 사람
|
recipients | array of Recipient | |
|
recipientForcontract
|
recipientForcontract | array of ContractRecipient | |
|
계약
|
contract | Contract | |
|
PDF 파일
|
pdfparts | array of object |
계약에 바인딩된 PDF 배열입니다. |
|
PDF ID
|
pdfparts.id | integer |
PDF의 ID입니다. |
|
PDF 순위
|
pdfparts.rank | integer |
PDF의 순위입니다. |
|
SmartFields가 있습니다.
|
pdfparts.has_smart_field | boolean |
계약에 스마트 필드가 있는지 지정합니다. |
|
PDF 크기
|
pdfparts.size | integer |
문서의 크기입니다. |
|
파일 이름
|
pdfparts.filename | string |
pdf의 이름입니다. |
|
appendixparts
|
appendixparts | array of object | |
|
아이디
|
appendixparts.id | integer |
계약 유효성 검사
계약의 유효성을 검사(카운터 서명)합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
계약 ID
|
id | True | string |
유효성을 검사할 계약의 ID입니다. |
|
포스
|
force | boolean |
일부 서명자가 아직 서명하지 않은 경우에도 계약 유효성 검사를 강제로 적용해야 하는지 지정합니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
유효성 검사 날짜
|
date | string |
유효성 검사 날짜입니다. |
|
트랜잭션 ID
|
id | string |
인증 기관의 트랜잭션 ID입니다. |
계약 철회
서명을 위해 계약이 전송된 경우에도 계약의 상태를 ABANDONED로 설정합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
계약 ID
|
id | True | string |
철회할 계약의 ID입니다. |
|
이유
|
reason | string |
철회의 이유입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
성공하다
|
succeed | boolean |
계약이 취소되었는지 지정합니다. |
계약에 대한 받는 사람 삭제
계약 ID에 대한 받는 사람이 계약에서 받는 사람을 삭제합니다. 설명서의 자세한 정보입니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
계약 ID의 받는 사람
|
cfc_id | True | string |
삭제할 계약 개체에 대한 받는 사람의 ID입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
성공하다
|
succeed | boolean |
성공적으로 제거되었는지 지정합니다. |
계약에 받는 사람 추가
기존 받는 사람을 계약에 연결합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
계약 ID
|
id | True | string |
받는 사람을 연결할 계약의 ID입니다. |
|
받는 사람 ID
|
recipient_id | integer |
계약에 첨부할 받는 사람의 ID입니다. |
|
|
서명 모드
|
signature_mode | integer |
서명 모드입니다. 자세한 내용은 설명서를 참조하세요. |
|
|
메시지 제목
|
message_title | string |
전자 메일로 보낼 메시지의 제목입니다(있는 경우). |
|
|
메시지 콘텐츠
|
message_body | string |
전자 메일로 보낼 메시지 본문입니다(있는 경우). |
|
|
등급
|
rank | integer |
서명 프로세스에서 받는 사람의 위치입니다. 순위와 스마트롤은 함께 사용할 수 없습니다. 그 중 하나만 선택하거나 전혀 선택하지 않습니다. |
|
|
스마트 역할 이름
|
smartrole | string |
받는 사람에게 제공할 스마트 역할입니다. 자세한 내용은 설명서를 참조하세요. |
|
|
전송 모드
|
transport_mode | integer |
서명의 전송 모드입니다. 자세한 내용은 설명서를 참조하세요. |
반환
- response
- array of ContractRecipient
계약의 문서 나열
계약에 바인딩된 모든 문서를 검색합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
계약 ID
|
id | True | string |
문서를 검색할 계약의 ID입니다. |
반환
- response
- array of DocumentAdded
계약의 문서 다운로드
계약에서 모든 문서를 포함하는 PDF 파일을 검색합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
계약 ID
|
id | True | string |
PDF 파일을 검색할 계약의 ID입니다. |
|
출력 파일 이름
|
filename | string |
다운로드할 파일의 이름입니다. |
반환
- PDF 문서 이진
- file
계약의 받는 사람 나열
특정 계약에 대한 모든 받는 사람을 검색합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
계약 ID
|
id | True | string |
모든 받는 사람을 검색할 계약의 ID입니다. |
반환
- response
- array of ContractRecipient
계약의 상태 가져오기
특정 계약의 상태를 확인합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
계약 ID
|
id | True | integer |
상태를 검색할 계약의 ID입니다. |
반환
계약의 서명 가져오기
특정 계약의 모든 서명 정보를 나열합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
계약 ID
|
id | True | string |
모든 서명을 나열하는 계약의 ID입니다. |
반환
계약의 서명된 문서 다운로드
계약의 서명된 문서에서 pdf 파일을 검색합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
계약 ID
|
id | True | integer |
문서를 포함하는 계약의 ID입니다. |
|
파일 이름
|
filename | string |
다운로드한 문서에 제공할 이름입니다. |
반환
pdf 파일의 이진 콘텐츠입니다.
- 문서 이진
- file
계약의 증명 파일 다운로드
계약의 증명 파일을 다운로드합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
계약 ID
|
id | True | string |
증명 파일을 다운로드할 계약의 ID입니다. |
|
출력 파일 이름
|
filename | string |
다운로드할 파일의 이름입니다. |
반환
- response
- file
계약의 트랜잭션 중지
계약 문서 및/또는 서명자를 수정할 수 있도록 계약의 트랜잭션을 중지합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
계약 ID
|
id | True | string |
중지할 계약의 ID입니다. |
|
포스
|
force | boolean |
서명자가 이미 서명한 경우에도 트랜잭션을 강제로 닫습니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
성공하다
|
succeed | boolean |
계약이 취소되었는지 지정합니다. |
모든 경계 나열
모든 계약 목록 가져오기
연결된 라이선스에서 모든 계약을 검색합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
반환된 배열의 크기
|
size | integer |
반환된 계약 배열의 최대 크기입니다. |
|
|
첫 번째 n 계약 건너뛰기
|
offset | integer |
건너뛸 계약의 시퀀스 번호입니다. |
|
|
계약 속성 표시
|
get_properties | boolean |
true이면 계약 속성이 응답에 나열됩니다. |
|
|
계약 경계 표시
|
get_perimeters | boolean |
true이면 계약 경계가 응답에 나열됩니다. |
|
|
이전에 만든 경우
|
before | integer |
지정된 날짜 이전에 만든 계약을 나열합니다. |
|
|
만든 후
|
after | integer |
지정된 날짜 이후에 만든 계약을 나열합니다. |
|
|
경계만 사용
|
perimeter | string |
지정된 경계에서만 계약을 나열합니다. |
|
|
상태만 사용
|
status | array |
지정된 상태의 계약만 검색합니다. |
반환
- 아이템
- ArrayOfContract
모든 받는 사람 나열
현재 라이선스에 연결된 모든 받는 사람을 검색합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Size
|
size | integer |
반환된 배열의 최대 크기입니다. |
|
|
상쇄
|
offset | integer |
나열된 첫 번째 받는 사람의 시퀀스 번호입니다. |
|
|
둘레
|
perimeter | string |
지정된 경계에서만 검색합니다. |
|
|
사용자 지정 소품 가져오기
|
get_custom_props | boolean |
받는 사람 사용자 지정 속성을 나열합니다(응답 시간 증가). |
|
|
경계 가져오기
|
get_perimeters | boolean |
응답에 받는 사람의 경계를 나열합니다(응답 시간 증가). |
|
|
필터 성(포함)
|
name | string |
마지막 이름을 필터링합니다. |
|
|
메일 필터링(포함)
|
string |
전자 메일을 필터링합니다. |
반환
- 받는 사람
- array of Recipient
모든 받는 사람에게 알림 전자 메일 다시 보내기
특정 계약의 모든 받는 사람에게 알림 전자 메일을 보냅니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
계약 ID
|
id | True | string |
알림을 다시 전송할 계약의 ID입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
성공하다
|
succeed | boolean |
알림이 성공적으로 다시 전송되었는지 지정합니다. |
문서 업로드 및 계약에 첨부
환경에 문서를 업로드하고 특정 계약에 첨부합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
계약 ID
|
id | True | string |
새 문서를 첨부할 계약의 ID입니다. |
|
File
|
file | file |
업로드할 파일 이진 파일입니다. |
반환
- response
- array of DocumentAdded
받는 사람에게 알림 전자 메일 다시 보내기
계약을 위해 특정 받는 사람에게 알림 전자 메일을 보냅니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
계약 ID
|
id | True | string |
알림을 다시 전송할 계약의 ID입니다. |
|
계약 ID에 대한 받는 사람
|
cfc_id | True | string |
알림을 보낼 계약 개체의 받는 사람 ID입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
성공하다
|
succeed | boolean |
알림이 성공적으로 다시 전송되었는지 지정합니다. |
번들 만들기
하나 이상의 기존 계약을 사용하여 새 번들을 만듭니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
계약 ID
|
contract_id | integer |
번들 첫 번째 계약의 ID입니다. |
|
|
동일한 서명자
|
same_signatories | boolean |
번들의 계약에 동일한 서명자 집합이 없으면 false로 설정합니다. |
반환
번들 철회
번들에 있는 모든 계약을 철회합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
번들 ID
|
id | True | string |
모든 계약을 철회할 번들의 ID입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
성공하다
|
succeed | boolean |
번들을 철회했는지 말합니다. |
번들 트랜잭션 중지
번들 트랜잭션을 중지합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
번들 ID
|
id | True | string |
트랜잭션을 중지할 번들의 ID입니다. |
|
강제 닫기
|
force | boolean |
서명자가 이미 서명한 경우에도 트랜잭션을 강제로 닫습니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
성공하다
|
succeed | boolean |
번들을 성공적으로 중지했다고 말합니다. |
번들에 계약 추가
기존 번들에 기존 계약을 추가합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
번들 ID
|
id | True | string |
계약을 추가할 번들의 ID입니다. |
|
계약 ID
|
contract_id | integer |
번들에 추가할 계약의 ID입니다. |
반환
번들에서 계약 유효성 검사
번들에 있는 모든 계약을 카운터 서명(유효성 검사)합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
번들 ID
|
id | True | string |
모든 계약의 유효성을 검사할 번들의 ID입니다. |
|
강제 유효성 검사
|
force | boolean |
일부 서명자가 아직 서명하지 않았거나 서명을 거부한 경우 계약 유효성 검사를 강제로 적용합니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
|
array of object | ||
|
date
|
date | string |
종가 상태의 날짜입니다. |
|
계약 ID
|
id | string |
계약의 ID가 중지되었습니다. |
번들의 계약 나열
특정 번들에서 모든 계약을 검색합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
번들 ID
|
id | True | string |
계약을 검색할 번들의 ID입니다. |
반환
- response
- array of ContractInBundle
서명을 위한 번들 보내기
서명을 위해 번들을 보냅니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
번들 ID
|
id | True | string |
서명을 위해 보낼 번들의 ID입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
성공하다
|
succeed | boolean |
트랜잭션이 전송되었는지 여부를 말합니다. |
서명할 계약 보내기
받는 사람이 서명할 특정 계약 및 모든 문서를 보냅니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
계약 ID
|
id | True | string |
서명을 위해 보낼 계약의 ID입니다. |
반환
첨부 파일을 업로드하고 계약에 추가
환경에 새 첨부 파일을 업로드하고 특정 계약에 첨부합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
계약 ID
|
id | True | string |
첨부 파일을 추가할 계약의 ID입니다. |
|
계약 정의 ID
|
contract_definition_id | integer |
사용자 환경에 정의된 계약 정의 ID입니다. 기본값은 pdfadhoc입니다. |
|
|
옵션 정의 이름
|
option_definition_name | string |
정의 이름입니다. |
|
|
Files
|
file | array |
첨부 파일로 추가할 파일 |
반환
특정 계약 가져오기
특정 계약의 메타데이터를 검색합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
계약 ID
|
id | True | string |
검색할 계약 ID입니다. |
반환
- 몸
- Contract
특정 받는 사람 가져오기
현재 환경의 저장된 받는 사람 목록에서 특정 받는 사람을 검색합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
받는 사람 ID
|
id | True | string |
검색할 받는 사람의 ID입니다. |
반환
트리거
| 계약의 상태가 변경되는 경우 |
이 작업은 계약의 상태가 변경될 때마다 트리거됩니다. |
계약의 상태가 변경되는 경우
이 작업은 계약의 상태가 변경될 때마다 트리거됩니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
description
|
description | string |
description |
|
|
events
|
events | array of string |
events |
|
|
contractDefinition
|
contractDefinition | array of integer |
contractDefinition |
|
|
둘레
|
perimeter | array of integer |
둘레 |
|
|
concernedUserEmail
|
concernedUserEmail | string |
concernedUserEmail |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
type
|
type | string |
type |
|
contractId
|
contractId | integer |
contractId |
|
시간표시
|
timestamp | integer |
시간표시 |
|
contractStatus
|
contractStatus | string |
contractStatus |
정의
ArrayOfContract
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
Contract |
계약서
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
계약 ID
|
contract_id | integer |
계약의 ID입니다. |
|
만든 날짜
|
date | integer |
계약이 만들어진 날짜입니다. |
|
문서 토큰
|
document_token | string |
계약의 주 문서의 토큰입니다. |
|
공급업체 전자 메일 주소
|
vendor_email | string |
Oodrive 라이선스 소유자의 전자 메일 주소입니다. |
|
닫힘
|
closed | boolean |
계약이 닫혀 있는지 여부를 지정합니다. |
|
계약 상태
|
status | string |
계약의 현재 상태입니다. |
|
계약 정의 ID
|
contract_definition_id | integer |
이 계약에 사용되는 계약 정의의 ID입니다. |
|
메시지 제목
|
message_title | string |
서명을 위해 보낸 전자 메일 제목입니다. |
|
메시지 본문
|
message_body | string |
서명을 위해 전송되는 전자 메일 본문입니다. |
|
계약 이름
|
name | string |
계약의 주 문서 이름입니다. |
|
오프라인 서명이 활성화됨
|
keep_on_move | boolean |
모바일 디바이스의 오프라인 서명이 활성화되었는지 확인합니다. |
|
계약 종료 날짜
|
closed_date | integer |
계약 종료 날짜(있는 경우)입니다. |
|
계약 취소 이유
|
canceled_reason | string |
취소 이유(있는 경우)입니다. |
|
계약 버전 번호
|
version_number | integer |
계약의 버전 번호입니다. |
|
계약 크기
|
size | integer |
계약의 전체 크기입니다. |
|
자동 닫기 사용
|
auto_close | integer |
계약이 자동으로 서명될지 아니면 사람의 개입이 필요한지 지정합니다. |
|
삭제됨
|
deleted | integer |
계약이 삭제되었는지 여부를 지정합니다. |
|
경계
|
perimeters | array of ContractPerimeterKey |
계약의 모든 경계 목록입니다(쿼리된 경우). |
|
Options
|
options | array of ContractOption |
계약의 모든 특정 옵션 목록입니다(쿼리된 경우). |
|
사용자 지정 속성
|
contract_properties | array of ContractProperty |
모든 선택적 계약 속성 목록입니다(쿼리된 경우). |
ContractOption
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
옵션 ID
|
id | integer |
계약 옵션의 ID입니다. |
|
계약 ID
|
contract_id | integer |
이 옵션에 바인딩된 계약의 ID입니다. |
|
요소 정의 ID
|
element_definition_id | integer |
옵션의 요소 정의 ID입니다. |
|
동기화 타이머
|
sync_timer | integer |
동기화 문제에 사용되는 타이머입니다. |
|
옵션 값
|
value | string |
옵션의 값입니다. |
|
마지막 수정 위치
|
last_modification_place | string |
마지막 수정이 발생한 위치를 나타냅니다. |
|
옵션 컨트롤
|
control | string |
제어 필드입니다. |
ContractProperty
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
속성 ID
|
id | integer |
사용자 지정 속성의 ID입니다. |
|
속성 키
|
key | string |
사용자 지정 속성의 키입니다. |
|
속성 자리 표시자
|
placeholder | string |
속성을 입력하도록 초대된 경우 받는 사람에게 표시되는 레이블입니다. |
|
속성 값
|
value | string |
사용자 지정 속성의 값입니다. |
|
속성 계약 ID
|
contract_id | integer |
이 사용자 지정 속성에 연결된 계약의 ID입니다. |
|
속성이 필요합니다.
|
to_fill_by_user | boolean |
사용자가 속성을 채워야 하는지 여부를 지정합니다. |
|
속성 형식
|
field_type | string |
사용자 지정 속성의 형식을 지정합니다. 설명서의 추가 정보입니다. |
|
속성 선택
|
input_filter | string |
속성에 사용할 수 있는 목록입니다. |
|
계약에 사용되는 속성
|
used_by_contract | boolean |
계약 문서에 정보가 표시되어야 하는 경우 true로 설정합니다. |
|
속성이 필요합니다.
|
required | boolean |
속성이 필요한지 여부를 지정합니다. |
ContractPerimeterKey
ContractRecipient
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
계약 ID의 받는 사람
|
recipient_for_contract_id | integer |
부부 계약 및 받는 사람의 고유 식별자입니다. |
|
받는 사람 ID
|
recipient_id | integer |
받는 사람의 ID입니다. |
|
계약 ID
|
contract_id | integer |
계약의 ID입니다. |
|
서명 상태
|
signature_status | string |
기호의 상태입니다. |
|
서명 날짜
|
signature_date | integer |
기호 날짜의 타임스탬프입니다. |
|
서명 모드
|
signature_mode | integer |
서명 표시 모드입니다. |
|
메시지 제목
|
message_title | string |
메시지의 제목입니다. |
|
메시지 콘텐츠
|
message_body | string |
메시지의 본문입니다. |
|
등급
|
rank | integer |
서명 프로세스에서 순위를 지정합니다. |
|
스마트 역할
|
smartrole | string |
받는 사람과 연결된 스마트 역할입니다. |
|
전송 모드
|
transport_mode | integer |
전송 모드입니다. |
|
서명 ID
|
signature_id | string |
받는 사람의 서명 ID입니다. |
DocumentAdded
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
문서 ID
|
id | integer |
문서의 ID입니다. |
|
등급
|
rank | integer |
문서 목록에 배치합니다. |
|
SmartField가 있습니다.
|
has_smart_field | boolean |
문서에 SmartFields가 있는지 지정합니다. |
|
문서 크기
|
size | integer |
문서의 크기(바이트)입니다. |
|
문서 이름
|
filename | string |
문서의 이름입니다. |
트랜잭션
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
계약 트랜잭션 ID
|
transaction_id | string |
계약에 바인딩된 트랜잭션 ID를 지정합니다. |
|
닫힘
|
is_closed | boolean |
계약이 닫혀 있는지 지정합니다. |
|
계약 이름
|
contract_name | string |
계약의 이름입니다. |
|
계약 상태
|
status | string |
계약의 상태를 지정합니다. |
둘레
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
경계 ID
|
id | integer |
경계의 ID입니다. |
|
경계 키
|
key | string |
경계의 키입니다(계약에서 사용됨). |
|
description
|
description | string |
경계에 대한 설명입니다. |
RecipientForContractWithRefusal
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
계약 ID의 받는 사람
|
recipient_for_contract_id | integer |
계약과 받는 사람을 바인딩한 개체의 ID입니다. |
|
받는 사람 ID
|
recipient_id | integer |
서명 받는 사람의 ID입니다. |
|
서명 상태
|
signature_status | string |
서명의 상태입니다. |
|
서명 날짜
|
signature_date | integer |
서명의 마지막 변경 날짜입니다. |
|
서명 모드
|
signature_mode | integer |
서명의 모드입니다. |
|
메시지 제목
|
message_title | string |
계약의 서명에 바인딩된 메시지의 제목입니다. |
|
메시지 콘텐츠
|
message_body | string |
계약 서명에 바인딩된 메시지의 본문입니다. |
|
등급
|
rank | integer |
계약 프로세스에서 서명의 받는 사람 순위입니다. |
|
스마트 역할 이름
|
smartrole | string |
계약에서 서명 받는 사람의 역할입니다. |
|
전송 모드
|
transport_mode | integer |
서명에 바인딩된 계약의 전송 모드입니다. |
|
서명 ID
|
signature_id | string |
서명의 ID입니다. |
|
거부가 있습니다.
|
has_refusal | boolean |
받는 사람이 계약을 거부했는지 지정합니다. |
|
마지막 거부 날짜
|
last_refusal_date | integer |
거부 날짜를 지정합니다. |
|
마지막 거부 메시지
|
last_refusal_message | string |
거부 메시지를 지정합니다. |
ContractInBundle
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
계약 ID
|
id | integer |
계약의 ID입니다. |
|
계약 이름
|
name | string |
계약의 이름입니다. |
|
계약 정의 형식
|
contract_definition_type | string |
계약의 정의 유형입니다. |
|
계약 정의 ID
|
contract_definition_id | integer |
계약 정의의 ID입니다. |
|
회사 이름
|
company_name | string |
계약에 바인딩된 회사의 이름입니다. |
Recipient
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
받는 사람 ID
|
id | integer |
받는 사람의 ID입니다. |
|
공손
|
civility | string |
받는 사람의 예의 |
|
이름 (First Name)
|
firstname | string |
받는 사람의 이름입니다. |
|
성 이름
|
lastname | string |
받는 사람의 성입니다. |
|
주 주소
|
address_1 | string |
받는 사람의 주 우편 주소입니다. |
|
우편 번호
|
postal_code | string |
받는 사람의 우편 번호입니다. |
|
도시
|
city | string |
받는 사람의 도시입니다. |
|
휴대폰 번호
|
cell_phone | string |
받는 사람의 휴대폰 번호입니다. |
|
메일 주소
|
string |
받는 사람의 메일 주소입니다. |
|
|
국가
|
country | string |
받는 사람의 국가입니다. |
|
보조 주소
|
address_2 | string |
받는 사람의 보조 우편 주소입니다. |
|
회사 이름
|
company_name | string |
받는 사람의 회사 이름입니다. |
|
전화번호
|
phone | string |
받는 사람의 전화 번호입니다. |
|
직위
|
job_title | string |
받는 사람의 직호입니다. |
|
생년월일
|
birthdate | integer |
받는 사람의 생년월일(타임스탬프)입니다. |
|
출생지
|
birthplace | string |
받는 사람의 출생지입니다. |
|
custom_properties
|
custom_properties | array of RecipientProperty | |
|
경계
|
perimeters | array of string |
RecipientProperty
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
속성 ID
|
id | integer |
속성의 ID입니다. |
|
속성 키
|
key | string |
속성의 키입니다. |
|
속성 값
|
value | string |
속성의 값입니다. |
|
계약자 ID
|
contractor_id | integer |
계약자의 ID입니다. |
|
동기화 타이머
|
sync_timer | integer |
마지막 동기화의 타이머입니다. |
|
마지막 수정 위치
|
last_modification_place | string |
마지막으로 수정한 위치입니다. |
AppendixAdded
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
부록 ID
|
id | integer |
부록의 ID입니다. |
|
부록 이름
|
filename | string |
부록의 이름입니다. |
|
부록 옵션 ID
|
option_id | integer |
부록의 옵션 ID |
|
부록 콘텐츠 형식
|
content_type | string |
부록의 콘텐츠 형식(예: image/jpeg)입니다. |
BundleResponse
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
번들 ID
|
id | integer |
번들의 ID입니다. |
|
작성자 ID
|
actor_id | integer |
번들 작성자의 ID입니다. |
|
첫 번째 계약 ID
|
contract_id | integer |
만든 번들의 첫 번째 계약의 ID입니다. |
|
번들 상태
|
status | integer |
번들의 상태입니다. |
|
번들 마스터
|
master | integer |
번들의 마스터입니다. |
file
기본 데이터 형식 'file'입니다.