Fxiaoke Developer Manual Fxiaoke Developer Manual
  • APL Development Manual
  • PWC Development Manual
  • OpenAPI Documentation
  • Quick Start
  • API Authorization
  • API Basics
  • OpenAPI
  • SSO Integration
  • Client Development
  • FAQ
  • OpenApi Version V1 (opens new window)
  • 简体中文
  • English
  • Quick Start
  • API Authorization
  • API Basics
  • OpenAPI
  • SSO Integration
  • Client Development
  • FAQ
  • OpenApi Version V1 (opens new window)
  • 简体中文
  • English
  • Quick Start

  • API Authorization

  • API Basics

  • OpenAPI

    • CRM Object API

    • CRM Common API

      • Object Description API

      • Approval Process API

        • Query Approval Definitions
        • Get Single Approval Task Details
        • Cancel Workflow Instance
        • Get Workflow Info
          • Complete Or Reject Workflow
          • Trigger Stage Advancer
          • Approval Task
          • Complete Approval
          • Query Approval Instance
          • Reject To Previous Node
          • Complete Object Task
          • Query Workflow Instance
          • Cancel Approval
          • Complete Workflow Task
          • Query Approval Instance List
          • Query Approval Details
          • Query Rejectable Nodes
          • Get Task Details
          • Update Stage By Instance
        • Custom Function API

        • Lock Unlock API

        • Related Team API

        • Currency API

        • Business Process API

        • Stage Progression API

        • product Categories API

        • Other Common API

      • Address Book API

      • Other API

    • SSO Integration

    • Client Development

    • FAQ

    Table of Contents

    Retrieve Various Business Process Information of Object Data

    # Description

    Retrieve various business process information of object data.

    # Request Specification

    Method: POST + application/json

    Endpoint: https://${Cloud Domain}/cgi/crm/v2/special/instance/progress?thirdTraceId=${Random String}

    Headers: Refer to Common Parameters

    # Request Parameters

    Parameter Type Required Description
    data Map Yes Data map
      instanceId String Yes Process instance ID
      pageSize Int Yes Items per page
      pageNumber String Yes Page number

    # Request Example

    {
      "data": {
        "instanceId": "5f68c4b68c0f3100014611df",
        "pageNumber": 1,
        "pageSize": 100
      }
    }
    

    # Response Parameters

    Parameter Type Description
    traceId string Unique request ID
    errorDescription string Error description
    errorMessage string Error message
    errorCode Int Error Codes

    # Response Example

    {
      "traceId": "E-O.827xxxxxx",
      "errorDescription": "success",
      "errorMessage": "OK",
      "errorCode": 0
    }
    

    # Notes

    • Do not use the message field in the response for logical judgments, as errorMessage may change.
    Cancel Workflow Instance
    Complete Or Reject Workflow

    ← Cancel Workflow Instance Complete Or Reject Workflow →

    • 跟随系统
    • 浅色模式
    • 深色模式
    • 阅读模式