할 일 목록

업데이트 됨

작업

작업은 외부 서비스와의 세션 설정, 데이터 검색 및 처리와 같이 API에서 모든 비동기 작업을 수행하는 일을 담당합니다.

작업은 세션 리소스를 생성하거나 폴링을 실행하는 동안 가장 일반적으로 만들어집니다.

작업에서 반환 된 모든 데이터는 연관된 결과 리소스에 의해 설명됩니다.

주로 시스템 및 조직 관리와 관련된 일부 작업은 사용자, 소스 또는 세션을 대상으로하거나 설문 조사와 연관되지 않을 수 있습니다. 이러한 종류의 작업의 예로는 저장소 및 webhook 구성 테스트 작업이 있습니다.

속성

이름 유형 기술
id 작업 ID 자원 식별자.
resource 문자열, 항상 task 자원 유형 지정자.
organisation 조직 ID 리소스가 속한 조직입니다.
key 키 ID 이 작업과 관련된 키입니다.
user 선택적, 사용자 ID 이 작업과 연결된 사용자입니다.
source 선택적, 출처 ID 이 작업의 대상이되는 소스입니다.
session 선택적 세션 ID 이 작업에서 사용하는 세션입니다.
poll 선택 사항, 폴링 ID 이 작업이 연결된 설문 조사입니다.
source_type 선택 사항, 문자열 이 작업이 목표로 삼는 소스 유형입니다.
type 태스크의 태스크 유형.
target 작업에 대한 가장 높은 수준의 인수입니다. 예를 들어, data 유형 태스크는 대상으로 검색하는 데이터 유형 (즉, messages.sms )을 갖습니다.
state pending , processing , suspended , succeeded , failed 중 하나입니다.
results 선택적, 결과 자원 목록 작업 실행으로 게시 된 모든 결과.
error 선택 사항, 문자열 오류 코드가있는 경우 오류 코드가 채워집니다.
date_created 날짜 시간 리소스가 생성 된 시점.
date_started 선택적, datetime 작업 처리가 시작될 때.
date_completed 선택적, datetime 작업 처리가 끝났을 때.

소스 유형

타스크가 소스와 연관되어 있으면 소스 유형이 source_type 타스크 속성으로 비정규 화됩니다. 이는 특정 유형의 태스크에 대한 조회를 단순화하는 데 도움이됩니다.

유형

작업 유형은 API 내에서 실행되는 기본 작업을 식별하는 짧은 슬러그입니다.

작업이 자원에 대한 활동 (예 : webhook_config.test 구성 테스트)과 관련이 webhook_config.test 와 같은 형식이 webhook_config.test .

태스크가 특정 소스를 대상으로하는 경우 source_type 속성은 소스 관련 정보를 저장하고 type 속성은 기본 조치 만 저장합니다. 예를 들어 세션을 만들면 icloud.account 유형의 소스에 대해 session.init 작업이 생성됩니다.

목표

기본 작업의 대상을 지정하며 항상 설정되는 것은 아닙니다. 예를 들어, webhook_config.test 의 대상은 webhook_config.testwebhook_config.test 구성의 ID입니다. A에 대한 data 에 대한 작업 icloud.account 입력 소스가 같이 검색 할 수있는 데이터 유형이어야합니다 messages.whatsapp .

상태

  • pending 작업이 생성되었지만 현재 대기열에서 대기 중입니다.
  • API 작업자가 작업 processing 실행 중입니다.
  • suspended 된 작업은 진행하기 전에 작업 차단이 완료되기를 기다리는 중입니다.
  • succeeded 오류없이 완료 작업을.
  • failed 작업 발생한 오류입니다.

오류

작업 중에 문제가 발생하면이 필드에 발생한 오류 코드가 설정됩니다.

검색

GET /tasks/{task ID}

cURL 사용

curl https://ricloud-api.reincubate.com/tasks/<task ID> \
  -H 'Authorization: Token <your key_token>'

* ricloud-py * 사용

import ricloud

task = ricloud.Task.retrieve(<task ID>)

명부

GET /tasks

매개 변수

이름 유형 기술
key 키 ID 연결된 조직별로 필터링합니다.
user 사용자 ID 연관된 사용자별로 필터링하십시오.
source 출처 ID 연관된 소스별로 필터링하십시오.
session 세션 ID 연관된 세션별로 필터링하십시오.
poll 폴링 ID 소유 투표로 필터링하십시오.
source_type 소스 유형별로 필터링하십시오.
type 작업 유형별로 필터링하십시오.
state 작업 상태별로 필터링하십시오.
date_created 날짜 시간 필터 자원 생성 날짜별로 필터링하십시오.
date_started 날짜 시간 필터 작업 처리가 시작된 시점을 기준으로 필터링합니다.
date_completed 날짜 시간 필터 작업 처리가 완료된 시점을 기준으로 필터링합니다.

cURL 사용

curl https://ricloud-api.reincubate.com/tasks \
  -H 'Authorization: Token <your key_token>'

* ricloud-py * 사용

import ricloud

tasks = ricloud.Task.list()

어떻게 도와 드릴까요?

지원 팀이 도와 드리겠습니다!

근무 시간은 월요일부터 금요일, 오전 9 시부 터 오후 5시 (그리니치 표준시)입니다. 시간은 현재 5:18 오후 GMT입니다.

우리는 1 일 이내에 모든 메시지에 답장하고자합니다.

지원 섹션으로 이동 › 엔터프라이즈 팀에 문의하십시오. ›
우리의 멋진 지원 팀

이 기사를 개선 할 수 있습니까?

사용자의 의견을 듣고 싶습니다. 전자 메일을 보내지 말고, 의견을 남기거나, 트윗하지 마십시오. @reincubate?

© 2008 - 2019 Reincubate Ltd. 판권 소유. 영국과 웨일즈에 등록 #5189175, VAT GB151788978. Reincubate®는 등록 상표입니다. 개인 정보 및 이용 약관. 우리는 2FA를 권장합니다. 런던에서 Built로 지어졌습니다.