Skip to main content

GET Flag Details

Overview


The following table contains important information about the GET method in regards to getting flag details.

GET Flag Details
MethodGET
URL or Endpoint/api/projects/projectId/flags/id
HeadersAuthorization
ParametersprojectId, id
BodyCheck request body below.

The description of the URL parameter is as follows:

Parameter NameMandatoryTypeDescription
projectIdYesstringThe Id of the project.
idYesinteger($int32)The Id of the flag.

Request Body

The request does not contain a request body.

Response

{
"success": true,
"errors": [
"string"
],
"messages": [
"string"
],
"result": {
"id": 0,
"name": "string",
"flagTypeId": 0,
"flagTypeName": "string",
"value": "string",
"active": true,
"description": "string",
"systemInfo": "string"
},
"resultInfo": "string",
"statusCode": 0
}
Field NameTypeDescription
successboolIf the response is successful it will return true. Otherwise will return false.
errorsarray[]Indicates if there was an error.
messagesarray[]Returns the response message from back-end.
resultarray[Object]Returns the response object.
idinteger($int32)The id of the flag.
namestringThe name of the flag.
valuestringThe value of the flag.
activebooleanIndicates whether the flag is active.
descriptionstringThe description of the flag.
systemInfostringThe system information of the flag.
resultInfostringReturns extra information about the result.
statusCodeinteger($int32)Returns the HTTP Status Code.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

  • HTTP Status Code 400: Bad Request

  • HTTP Status Code 401: Unauthorized

  • HTTP Status Code 403: Forbidden

  • HTTP Status Code 404: Result Not Found

  • HTTP Status Code 500: Internal Server Error

  • HTTP Status Code 503: Backend Fetch Failed