GET all Flags

Overview

---

The following table contains important information about the GET method in regards to getting all flags of a project.

GET Flag
Method	GET
URL or Endpoint	/api/projects/projectId/flags
Headers	Authorization
Parameters	projectId, search, page, take, order, insertedDate, flagTypeId
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.

The description of the parameters is as follows:

Parameter Name	Mandatory	Type	Description
search	Yes	string	A word you want to filter.
page	Yes	integer($int32)	The page in which the flag is located
take	Yes	integer($int32)	The number of videos to take from the flag
order	Yes	string	The order in which you receive the flags.
insertedDate	No	Date	The date when the flag was inserted.
flagTypeId	Yes	integer($int32)	The pageId of the flag type.

Request Body

The request does not contain a request body.

Response

{
  "success": true,
  "errors": [
    "string"
  ],
  "messages": [
    "string"
  ],
  "result": {
    "currentPage": 0,
    "totalPages": 0,
    "pageSize": 0,
    "totalCount": 0,
    "items": [
      {
        "id": 0,
        "name": "string",
        "flagTypeId": 0,
        "flagTypeName": "string",
        "value": "string",
        "active": true,
        "description": "string",
        "systemInfo": "string",
        "flagCustomSetting": {
          "id": 0,
          "flagId": 0,
          "name": "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.
currentPage	integer($int32)	Indicates the current page of where the flag is located.
totalPages	integer($int32)	The total number of pages.
pageSize	integer($int32)	Indicates how many flags are per page.
totalCount	integer($int32)	The total number of flags received by the filter.
items	array[Object]	Returns the flags on the current page as an array of objects.
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.
flagCustomSetting	Object	The custom settings of the flag.
id	integer($int32)	The ID of the custom flag setting.
flagId	integer($int32)	The ID of the flag.
name	string	The name of the custom flag setting.
active	boolean	Indicates whether the custom flag settings are active.
description	string	The description of the custom flag setting.
systemInfo	string	The system information of the custom flag setting.
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