Updated on 2022-09-15 GMT+08:00

Obtaining Application Details

Description

This API is used to obtain details of an application.

This function is only used for displaying application details and not for processing. Therefore, background parameters such as the ID are not displayed.

URL

  • URI format

    GET /v1/{project_id}/service/applys/{apply_id}

  • Parameter description

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID. For details about how to obtain the project ID, see Project ID and Account ID.

    apply_id

    Yes

    String

    Application/message ID

Request Message

  • Example request

    None

Response

  • Example response
    {
      "id": null,
      "api_apply_status": "STATUS_TYPE_PASSED",
      "api_apply_type": "APPLY_TYPE_APPLY",
      "api_id": null,
      "api_name": "api_demo",
      "api_using_time": 1580452617000,
      "app_id": null,
      "app_name": "app_demo",
      "apply_time": 1578875421000,
      "approval_time": null,
      "approver_name": null,
      "comment": "Pass",
      "user_name": "Tim"
    }
  • Response parameter description

    Parameter

    Type

    Description

    id

    String

    Application No. (not displayed)

    api_apply_status

    String

    Application status. Available values include:

    STATUS_TYPE_PENDING_APPROVAL: The application is pending review.

    STATUS_TYPE_REJECTED: The application has been rejected.

    STATUS_TYPE_PENDING_CHECK: The application is pending check.

    STATUS_TYPE_PENDING_EXECUTE: The application is pending execution.

    STATUS_TYPE_SYNCHRONOUS_EXECUTE: The application is synchronously executed.

    STATUS_TYPE_FORCED_CANCEL: The application has been forcibly canceled.

    STATUS_TYPE_PASSED: The application has been approved.

    api_apply_type

    String

    Application type. Available values include:

    APPLY_TYPE_PUBLISH: publishing an API

    APPLY_TYPE_AUTHORIZE: authorizing an API

    APPLY_TYPE_APPLY: applying for authorization

    APPLY_TYPE_RENEW: applying for renewing the validity period

    APPLY_TYPE_STOP: suspending an API

    APPLY_TYPE_RECOVER: restoring an API

    APPLY_TYPE_API_CANCEL_AUTHORIZE: canceling API authorization (by the API reviewer)

    APPLY_TYPE_APP_CANCEL_AUTHORIZE: canceling API authorization (by the app owner)

    APPLY_TYPE_OFFLINE: unpublishing an API

    api_id

    String

    API ID (not displayed)

    api_name

    String

    API name

    api_using_time

    Long

    Expiry time of using the API, which is a 13-digit timestamp

    app_id

    String

    App ID (not displayed)

    app_name

    String

    App name

    apply_time

    Long

    Application time, which is a 13-digit timestamp

    approval_time

    Long

    Authorization time, which is a 13-digit timestamp (not displayed)

    approver_name

    String

    Reviewer name (not displayed)

    comment

    String

    Review comment

    user_name

    String

    Applicant name

Status Code

Status Code

Description

200

The message list is obtained.

For details about status codes, see Status Codes.