Get Plan Java Parameters

Endpoint Information

  • URL: <your-gateway-url>/plan/{planId}/parameter

  • Method: GET

  • Authentication: Required (Bearer Token)

Response Body

{
    "data": [
        {
            "name": "env",
            "value": "prod",
            "description": "Environment selection parameter",
            "type": "ENVIRONMENT_PARAMETER"
        }
    ],
    "result": {
        "code": 0,
        "message": "success"
    }
}
Parameter
Type
Description

data

Object

The payload of the response. In this case null since no extra data is returned.

result

Object

Contains details about the outcome of the operation.

result.code

Integer

The result code (e.g., 0 indicates success).

result.message

String

A message describing the outcome (e.g., "success").

Error Codes

HTTP Code
Error Message
Description

401

Unauthorized

Authorization failed. The user is not logged in.

500

Internal Server Error

An unexpected error occurred on the server side.

Example Request

curl --location '<your-gateway-url>/plan/767/parameter' \
--header 'accept: application/json, text/plain, */*' \
--header 'authorization: Bearer <your_access_token>' \
--header 'content-type: application/json'

Last updated