POST Flag

Overview

---

The following table contains important information about the POST method in regards to posting a new flag.

POST Flag
Method	POST
URL or Endpoint	/api/projects/projectId/flags
Headers	Authorization
Parameters	projectId
Body	Check request body below.

The description of the URL parameter is as follows:

projectId URL Parameter
URL Parameter Name	projectId
Mandatory	Yes
Type	string
Description	Unique Id of the project.

Request Body

{
  "name": "string",
  "value": "string",
  "active": true,
  "description": "string",
  "systemInfo": "string"
}

Field Name	Type	Description
name	string	The name of the flag.
value	string	The value of the flag.
active	boolean	Indicates whether the flag is active.
description	string	The description of the flag.
systemInfo	string	The system information of the flag.

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 Name	Type	Description
success	bool	If the response is successful it will return true. Otherwise will return false.
errors	array[]	Indicates if there was an error.
messages	array[]	Returns the response message from back-end.
result	array[Object]	Returns the response object.
id	integer($int32)	The id of the flag.
name	string	The name of the flag.
flagTypeId	integer($int32)	The ID of the flag type.
flagTypeName	string	The name of the flag type.
value	string	The value of the flag.
active	boolean	Indicates whether the flag is active.
description	string	The description of the flag.
systemInfo	string	The system information of the flag.
resultInfo	string	Returns extra information about the result.
statusCode	integer($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