투표소
폴링 자원은 데이터에 대한 특정 요청에 대한 정보를 포함합니다. 설문 조사가 만들어지면 요청을 완료하기 위해 하나 이상의 작업 생성이 시작됩니다.
속성
| 이름 | 유형 | 기술 |
|---|---|---|
id | 폴링 ID | 자원 식별자. |
resource | 문자열, 항상 poll | 자원 유형 지정자. |
organisation | 조직 ID | 이 리소스와 연결된 조직입니다. |
key | 키 ID | 이 자원과 관련된 키입니다. |
user | 사용자 ID | 이 리소스와 연결된 사용자입니다. |
source | 출처 ID | 설문 조사의 출처입니다. 이것은 세션 소스의 하위 소스 일 수 있습니다. |
session | 세션 ID | 투표가 사용하는 세션. |
subscription | 선택적 가입 ID | 적용 가능한 경우 연관된 구독 오브젝트 ID |
tasks_pending | 작업 ID 목록 | 처리 대기중인 설문과 관련된 작업입니다. |
tasks_processing | 작업 ID 목록 | 처리중인 폴링과 관련된 작업입니다. |
tasks_succeeded | 작업 ID 목록 | 성공한 폴링과 관련된 작업. |
tasks_failed | 작업 ID 목록 | 실패한 폴링과 연관된 태스크. |
tasks_suspended | 작업 ID 목록 | 일시 중단 된 폴링과 관련된 작업입니다. |
results | 결과 객체를 포함하는리스트 객체 | 설문 조사 작업에 의해 생성 된 결과 오브젝트 목록. |
state | 끈 | 다음 중 하나 : pending , processing , completed . |
date_created | 날짜 시간 | 리소스가 생성 된 시점. |
date_started | 선택적 날짜 / 시간 | 설문 조사 처리가 시작된 시점 |
date_completed | 선택적 날짜 / 시간 | 폴링 처리가 완료된 경우 |
작업
폴링 리소스의 가장 중요한 역할은 관련 작업의 진행률을 반영하고 최종 사용자가 결과가 나 오자마자 결과를 가져 오는 것을 허용하는 것입니다. 따라서 폴 자원은 관련 태스크가 해당 상태에 따라 분류되는 태스크 관련 속성을 노출합니다.
결과
설문 조사 내에서 실행중인 태스크가 공개 한 모든 결과는 설문 조사의 results 속성에 표시됩니다.
상태
설문 조사 상태는 설문 조사가 초기화 pending ( pending ), 진행 중 ( processing ) 또는 모든 작업 완료 ( completed pending )인지 여부 만 반영합니다.
설문 조사는 관련 작업을 통한 오류 상태 이외의 오류 상태를 반영하지 않습니다.
폴링 페이로드는 검색해야하는 정보 유형, 데이터 유형 및 파일 유형을 나타냅니다. 폴 페이로드 속성 스키마는 아래에 설명되어 있습니다.
| 이름 | 유형 | 기술 |
|---|---|---|
info_types | info_type 객체 목록 | 검색 할 정보 유형을 지정합니다. 와일드 카드 * 지원합니다. |
data_types | data_type 객체 목록 | 검색 할 데이터 유형을 지정합니다. |
files | file ID 목록. | 검색 할 파일을 지정합니다. |
filters | 중첩 filters 객체 | 검색된 데이터에 적용 할 필터를 지정합니다. |
예를 들어, iCloud 계정 소스에서 모든 유형의 정보를 검색하기위한 폴 페이로드는 다음과 같습니다.
{ "info_types": ["*"] }
iCloud 백업 또는 Reincubate Relay 소스에서 특정 날짜에서만 다양한 메시징 데이터를 검색하려면 다음을 수행하십시오.
{ "data_types": ["ios_messages.messages", "whatsapp.messages", "viber.messages"], "filters": { "since": "2019-09-15T22:04:12Z" } }
iCloud 사진 보관함 결과에서 참조 된 이미지의 파일 데이터를 검색하려면 :
{ "files": ["icpl://xyz123", "icpl://abc321"] }
다른 속성을 동시에 사용할 수도 있습니다.
{ "info_types": ["*"], "data_types": ["ios_phone.calls"] }
변경 로그
2020-02-20
- Major : poll 객체의
results속성은 이제 단순한 list 속성이 아니라 중첩 된 목록 객체입니다. 따라서 설문 조사에서 많은 수의 결과를 게시 할 때 결과를 페이지 매김 할 수 있습니다.
2019-10-16
-
subscription이 폴링을 트리거했는지 여부를 표시하기 위해subscription속성을 폴링 오브젝트에 추가합니다.
2019-06-01
- 폴링 오브젝트
payload속성은 이제 여러 조작 유형으로 구성 될 수 있습니다. 이는 페이로드에서info-types,data-types및files중 일부 또는 전부를 사용하여 폴링을 작성할 수 있음을 의미합니다. - 중요 사항 폴링 오브젝트의
type속성은 작성 가능한 폴링 페이로드를 위해 더 이상 사용되지 않습니다.
POST /polls 만들기 만들기
특정 세션에 대한 데이터 폴링을 작성하십시오.
세션 리소스가 이미 특정 소스에 직접 연결되어 있으므로 source 매개 변수를 제공 할 필요가 없습니다. 그러나 폴링이 세션이 연결된 기본 소스의 하위 소스를 대상으로 지정하도록 제공 할 수 있습니다. 예를 들어, iCloud 서비스에서 세션은 iCloud 계정 소스 (iCloud 서비스의 기본 소스)에 대해서만 생성 될 수 있지만, 특정 iCloud 백업 (iCloud 계정의 하위 소스)에서만 데이터를 대상으로 지정할 수 있습니다. 신분증.
| 이름 | 유형 | 기술 |
|---|---|---|
key | 선택적, 키 ID | 선택적으로이 폴링에 사용 된 키를 무시하십시오. 이는 사용자가 새로운 기능을 시험 사용하게 할 때 유용합니다. |
source | 선택적 소스 ID | 선택적으로 세션 링크 소스의 하위 소스를 대상으로합니다. |
session | 세션 ID | 데이터 검색을 인증하는 데 사용할 세션입니다. |
payload | 중첩 된 폴 페이로드 | 설문 조사를 지정하는 데 사용되는 설문 조사 페이로드 |
cURL 사용
curl https://ricloud-api.reincubate.com/polls \ -X POST \ -H 'Authorization: Token <your key_token>' \ -H 'Content-Type: application/json' \ -d '{ "session": "<session ID>", "payload": { "info_types": ["*"] } }'
ricloud-py 사용하기
import ricloud poll_payload = { 'info_types': ['*'], } poll = ricloud.Poll.create( session='<session ID or ricloud.Session instance>', payload=poll_payload, )
샘플 응답
{ "id": "54554389-5f1a-4ccf-9bb8-024a031cf948", "resource": "poll", "organisation": 1, "key": 1, "user": 1, "source": 1, "session": "f5a7a7ef-ff21-47fe-9aa6-7ebd08123623", "subscription": null, "tasks_pending": [], "tasks_processing": [], "tasks_succeeded": [], "tasks_failed": [], "tasks_suspended": [], "results": { "data": [], "has_more": false, "total_count": 0, "url": "/polls/54554389-5f1a-4ccf-9bb8-024a031cf948/results" }, "state": "pending", "date_created": "2020-02-20T11:59:14.694337Z", "date_started": null, "date_completed": null }
GET /polls/{poll ID}
cURL 사용
curl https://ricloud-api.reincubate.com/polls/<poll ID> \ -H 'Authorization: Token <your key_token>'
ricloud-py 사용하기
import ricloud poll = ricloud.Poll.retrieve(<poll ID>)
GET /polls 나열
| 이름 | 유형 | 기술 |
|---|---|---|
key | 키 ID | 연결된 키별로 필터링합니다. 이 시간에 사용자가 사용하는 키입니다. |
user | 사용자 ID | 연관된 사용자별로 필터링하십시오. |
source | 출처 ID | 대상 소스별로 필터링하십시오. |
session | 세션 ID | 대상 세션별로 필터링하십시오. |
subscription | 구독 ID | 연관된 구독으로 필터링하십시오. |
state | 끈 | 세션 상태별로 필터링하십시오. |
date_created | 날짜 시간 필터 | 리소스가 생성되었을 때 필터링합니다. |
date_started | 날짜 시간 필터 | 설문 조사가 시작된 시점을 기준으로 필터링합니다. |
date_completed | 날짜 시간 필터 | 설문 조사가 완료되면 필터링 |
cURL 사용
curl https://ricloud-api.reincubate.com/polls \ -H 'Authorization: Token <your key_token>'
ricloud-py 사용하기
import ricloud polls = ricloud.Poll.list()
