할 일 목록

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

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

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

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

속성

소스 유형

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

종류

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

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

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

표적

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

상태

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

오류

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

변경 로그

2020-02-20

• 주요 작업 개체의 results 속성이 이제 단순 목록 속성이 아닌 중첩 된 목록 개체가되었습니다.

2019-10-16

• 태스크 오브젝트의 state 속성은 이제 값을 suspended 할 수 있습니다. 이는 API가 작업을 재개하고 완료하기 위해 파일 업로드 또는 메타 데이터 업데이트와 같은 Reincubate Relay 응용 프로그램의 작업 완료를 기다리고 있음을 나타냅니다.

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>)

샘플 응답

{
  "id": "00000001-1234-1234-1234-9876543210",
  "resource": "task",
  "organisation": 1,
  "key": 1,
  "user": 1,
  "source": 1,
  "session": "00000002-1234-1234-1234-9876543210",
  "poll": "00000003-1234-1234-1234-9876543210",
  "source_type": "mocks.mock",
  "type": "info",
  "target": null,
  "results": {
    "data": [],
    "has_more": false,
    "total_count": 1,
    "url": "/tasks/00000001-1234-1234-1234-9876543210/results"
  },
  "state": "processing",
  "error": null,
  "date_created": "2020-02-20T11:59:15.110451Z",
  "date_started": "2020-02-20T11:59:15.207932Z",
  "date_completed": null
}

GET /tasks 목록

매개 변수

cURL 사용

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

ricloud-py 사용하기

import ricloud

tasks = ricloud.Task.list()