Get Task Detail by Task ID API

Owned by Alex Xie
Jan 31, 2022
1 min read

This API is required when the Get Task List API does not always return the complete task detail due to performance consideration. It is called by OneList Adapter to retrieve the details for new or updated tasks.

Input parameters:

  • Source System Task ID – required, single value or an array of values.

Return parameter:

  • Task information including

    • Source System Task ID (mandatory)

    • Request ID (mandatory)

    • Supporting Actions (mandatory if not returned by Get Task List API)

    • Task Detail information (can contain hierarchical structure of header and detail information, of unlimited levels)

    • Request Status

    • Attachment meta data list (optional)

      • Attachment ID (mandatory)

      • Attachment description

      • Attachment type – id, description

      • Attached by user

      • Attached on date & time

      • Attachment version

      • Line ID (optional for line level attachment)