Unarchive one or more Flags in a project.
\nThis operation corresponds to the unarchive_url in a Flags response.
Successful unarchive of Flags.
\nThe response includes RESTful JSON (https://restfuljson.org/) styled links. If a\nlink is not present in the response, it indicates a user is not authorized to access\nthe related resource.
", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"recurring_deposit\":{\"account_id\":12345,\"archive_url\":\"...\",\"archived\":false,\"created_time\":\"2019-05-08T00:00:00.000Z\",\"delete_url\":\"string\",\"description\":\"Flag used for driving customers to use recurring deposits by showing a graph of compound interest over time\",\"environments\":{\"development\":{\"disable_url\":\"...\",\"enable_url\":\"...\",\"enabled\":false,\"is_primary\":false,\"key\":\"development\",\"name\":\"Development\",\"priority\":2,\"rules_summary\":[{\"audience_ids\":[1],\"created_time\":\"2022-01-08T00:00:00.000Z\",\"days_running\":30,\"enabled\":true,\"key\":\"a/b\",\"name\":\"A/B Test\",\"primary_metric\":\"conversion_rate\",\"traffic_allocation\":100,\"type\":\"experiment\",\"updated_time\":\"2022-01-08T00:00:00.000Z\"}]},\"production\":{\"disable_url\":\"...\",\"enable_url\":\"...\",\"enabled\":false,\"key\":\"production\",\"name\":\"Production\",\"priority\":1,\"rules_detail\":[{\"audience_ids\":[1],\"created_time\":\"2022-01-08T00:00:00.000Z\",\"days_running\":30,\"enabled\":true,\"id\":123,\"key\":\"a/b\",\"name\":\"A/B Test\",\"primary_metric\":\"conversion_rate\",\"traffic_allocation\":100,\"type\":\"experiment\",\"updated_time\":\"2022-01-08T00:00:00.000Z\"}],\"rules_summary\":{\"a/b\":{\"keys\":[\"new_users\"]},\"targeted_delivery\":{\"keys\":[\"paid_users\",\"trial_users\"]}}}},\"id\":45633994,\"key\":\"recurring_deposit\",\"name\":\"Recurring Deposit\",\"outlier_filtering_enabled\":false,\"project_id\":12345,\"unarchive_url\":\"...\",\"update_url\":\"...\",\"updated_time\":\"2019-05-08T00:00:00.000Z\",\"url\":\"...\",\"urn\":\"flags.flag.optimizely.com::asdfsdf-2344-efadf03-343434-efrrr\",\"variable_definitions\":{\"advanced\":{\"default_value\":\"{\\n\\t\\\"hello\\\": 123\\n}\",\"description\":\"This variable is used to configure the advanced used for advanced purposes\",\"key\":\"advanced\",\"type\":\"json\"},\"amount\":{\"default_value\":\"0.0\",\"description\":\"This variable is used to configure the amount used for computing the discount\",\"key\":\"amount\",\"type\":\"double\"},\"message\":{\"default_value\":\"Use recurring deposits to compound interest\",\"description\":\"This variable is used to configure the message used for displaying the discount\",\"key\":\"message\",\"type\":\"string\"}}}}", "description": "Map of flags that include flag key as key and flag payload as value.", "customType": "FlagMap", "schema": [], "modelRef": "#/components/schemas/FlagMap", "isExpanded": true } ] }, { "statusCode": "400", "description": "Malformed requests and invalid parameter names and types", "jsonExample": "", "isExpanded": true }, { "statusCode": "401", "description": "Invalid credentials", "jsonExample": "", "isExpanded": true }, { "statusCode": "403", "description": "Do not have permission to perform the operation", "jsonExample": "", "isExpanded": true }, { "statusCode": "404", "description": "Not found. No content", "jsonExample": "", "isExpanded": true }, { "statusCode": "409", "description": "The Flags cannot be unarchived in their current state. No Flag in the batch\nis unarchived.
\nTwo body shapes are possible. A failed precondition returns a\nFlagConflictError naming the Flags that blocked the request; its error\nfield says which precondition failed. Every other conflict returns a\nProblemDetail.
Discriminate on the presence of the error field rather than on the\nresponse's content type: a ProblemDetail may arrive as either\napplication/json or application/problem+json.
Returned when an archive or unarchive request is rejected. When the rejection is\na failed precondition, error, message and flag_keys are all present and\nname the Flags that blocked the request. Any other conflict omits all three,\nand carries only title alongside the standard problem fields.
A human-readable explanation specific to this occurrence of the problem.
", "example": "Cannot modify flag as it is referenced by ruleset" }, { "name": "error", "kind": "optional", "type": "stringThe reason the request was rejected.
\nPENDING_APPROVALS_EXIST — at least one Flag has an open approval request.\nCannot be overridden.
A human-readable explanation of the conflict.
", "example": "Cannot archive flag(s) with pending approval requests" }, { "name": "status", "kind": "optional", "type": "integer", "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", "example": 409 }, { "name": "title", "kind": "required", "type": "string", "description": "A short, human-readable summary of the problem type.
", "example": "Conflict" }, { "name": "type", "kind": "optional", "type": "string", "description": "A URI reference that identifies the problem type. Contains 'about
' if unspecified.", "example": "about:blank" }, { "name": "uuid", "kind": "optional", "type": "string", "description": "Error reference for customer support.", "example": "3f2b9c14-7a0e-4d55-9e21-6c8b0a7d4e13" } ], "modelRef": "#/components/schemas/FlagConflictError", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "bj7FSEDhtbmLgp5izmphr", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://api.optimizely.com/flags/v1//projects/{project_id}/flags/unarchived \\\n --header 'accept: application/json'" }, { "id": "i1gnaavyDB8Coxfn5ueZ6", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.optimizely.com/flags/v1//projects/{project_id}/flags/unarchived\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "6YLjAG6Nmdh2De5EMe5I0", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.optimizely.com/flags/v1//projects/{project_id}/flags/unarchived\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "QSae4HGFy5056M16E9agA", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.optimizely.com/flags/v1//projects/{project_id}/flags/unarchived\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "bj7FSEDhtbmLgp5izmphr" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// Successful unarchive of Flags.\nThe response includes RESTful JSON (https://restfuljson.org/) styled links. If a\nlink is not present in the response, it indicates a user is not authorized to access\nthe related resource.\n{}" }, { "id": "response-1-400", "language": "400", "code": "// Malformed requests and invalid parameter names and types\n" }, { "id": "response-2-401", "language": "401", "code": "// Invalid credentials\n" }, { "id": "response-3-403", "language": "403", "code": "// Do not have permission to perform the operation\n" }, { "id": "response-4-404", "language": "404", "code": "// Not found. No content\n" }, { "id": "response-5-409", "language": "409", "code": "// The Flags cannot be unarchived in their current state. No Flag in the batch\nis unarchived.\nTwo body shapes are possible. A failed precondition returns a\nFlagConflictError naming the Flags that blocked the request; its error\nfield says which precondition failed. Every other conflict returns a\nProblemDetail.\nDiscriminate on the presence of the error field rather than on the\nresponse's content type: a ProblemDetail may arrive as either\napplication/json or application/problem+json.\n{\n \"detail\": \"Cannot modify flag as it is referenced by ruleset\",\n \"error\": \"PENDING_APPROVALS_EXIST\",\n \"flag_keys\": [\n \"\"\n ],\n \"message\": \"Cannot archive flag(s) with pending approval requests\",\n \"status\": 409,\n \"title\": \"Conflict\",\n \"type\": \"about:blank\",\n \"uuid\": \"3f2b9c14-7a0e-4d55-9e21-6c8b0a7d4e13\"\n}" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }