IDaaS Open Platform
Employee Identity (EIAM)

Query To-Do by External To-Do ID

Interface

# Permissions

The Identity Management API is authorized at the application level. Before calling the interface, you need to set interface permissions for different applications. For details, please refer to API Permissions.

Permission Code Description
app_todo_msg Application-side task and to-do management permission
all Full interface read and write permissions

# Request Specification

GET https://{your_domain}/api/v2/tenant/todo/task/sources/{external_id}

# Request Headers

Parameter Name Chinese Name Required Type Description
Authorization Authorization Yes String Format: Bearer {access_token}
Content-Type Content Type Yes String Fixed value: application/json; charset=utf-8

# Request Example

None

# Request Parameters

Parameter Name Chinese Name Required Type Description
external_id External To-Do ID Yes String To-do ID generated by the third-party application

# Return Example

Success Example:
HTTP/1.1 200 OK
Content-Type: application/json
{
    "id": "20220809162630548-9D52-E085BA68A",
    "source_id": "20220119111936362-77E4-C4A94DFC6",
    "source_type": "APP",
    "title": "Todo Title 67",
    "content": "Todo Content 67",
    "message_type": "TEXT",
    "external_id": "67",
    "detail_url": {
        "web_url": "https://www.baidu.com/",
        "mobile_url": "https://www.baidu.com/"
    },
    "user_id": "20220615161810047-F95F-B61E1C44F",
    "deal": false,
    "dealt_at": null,
    "ending_at": "2022-08-14 12:00:00",
    "created_at": "2022-08-09 16:26:30.548",
    "updated_at": "2022-08-09 16:26:30.548"
}


Error Example:
HTTP/1.1 400 Bad Request
{
  "error_code": "TODOTASK.0001",
  "error_msg": "Todo does not exist"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

# Return Parameters

Parameter Name Chinese Name Type Description
id Primary Key ID String Primary Key ID, unique
source_id Source ID String Source ID
source_type Source Type String SYSTEM=System APP=Application
title Title String Title
content Content String Content
message_type Message Type String TEXT=Text MARKDOWN=markdown
created_at Creation Time String Creation Time
updated_at Modification Time String Modification Time
dealt_at Processing Time String Processing Time
ending_at Deadline String Deadline
userId User ID String User ID
deal Processing Status Boolean Processing Status
external_id External Todo ID String Third-party Todo ID
detail_url URL to jump to for the todo event Map Includes URLs for PC and mobile
--web_url PC URL String PC URL
--mobile_url Mobile URL String Mobile URL

# Error Codes

Status Code Error Code Error Message Handling Measures
402 TODOTASK.0001 Todo does not exist Please check if the corresponding todo exists

Modify Todo Status